package openapi.v3

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Schema

• oneof oneof

  • SchemaOrReference schema_or_reference = 1

  • bool boolean = 2

Used in: AnyOrExpression, Example, Header, MediaType, NamedAny, Parameter, Schema

• optional google.protobuf.Any value = 1

• string yaml = 2

Used in: Link

• oneof oneof

  • Any any = 1

  • Expression expression = 2

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

Used in: CallbackOrReference

• repeated NamedPathItem path = 1

• repeated NamedAny specification_extension = 2

Used in: NamedCallbackOrReference

• oneof oneof

  • Callback callback = 1

  • Reference reference = 2

Used in: Components, Operation

• repeated NamedCallbackOrReference additional_properties = 1

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.

Used in: Document

• optional SchemasOrReferences schemas = 1

• optional ResponsesOrReferences responses = 2

• optional ParametersOrReferences parameters = 3

• optional ExamplesOrReferences examples = 4

• optional RequestBodiesOrReferences request_bodies = 5

• optional HeadersOrReferences headers = 6

• optional SecuritySchemesOrReferences security_schemes = 7

• optional LinksOrReferences links = 8

• optional CallbacksOrReferences callbacks = 9

• repeated NamedAny specification_extension = 10

Contact information for the exposed API.

Used in: Info

• string name = 1

• string url = 2

• string email = 3

• repeated NamedAny specification_extension = 4

Used in: Schema

• oneof oneof

  • double number = 1

  • bool boolean = 2

  • string string = 3

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.

Used in: Schema

• string property_name = 1

• optional Strings mapping = 2

• repeated NamedAny specification_extension = 3

• string openapi = 1

• optional Info info = 2

• repeated Server servers = 3

• optional Paths paths = 4

• optional Components components = 5

• repeated SecurityRequirement security = 6

• repeated Tag tags = 7

• optional ExternalDocs external_docs = 8

• repeated NamedAny specification_extension = 9

A single encoding definition applied to a single schema property.

Used in: NamedEncoding

• string content_type = 1

• optional HeadersOrReferences headers = 2

• string style = 3

• bool explode = 4

• bool allow_reserved = 5

• repeated NamedAny specification_extension = 6

Used in: MediaType

• repeated NamedEncoding additional_properties = 1

Used in: ExampleOrReference

• string summary = 1

• string description = 2

• optional Any value = 3

• string external_value = 4

• repeated NamedAny specification_extension = 5

Used in: NamedExampleOrReference

• oneof oneof

  • Example example = 1

  • Reference reference = 2

Used in: Components, Header, MediaType, Parameter

• repeated NamedExampleOrReference additional_properties = 1

Used in: AnyOrExpression

• repeated NamedAny additional_properties = 1

Allows referencing an external resource for extended documentation.

Used in: Document, Operation, Schema, Tag

• string description = 1

• string url = 2

• repeated NamedAny specification_extension = 3

The 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. 1. `in` MUST NOT be specified, it is implicitly in `header`. 1. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`).

Used in: HeaderOrReference

• string description = 1

• bool required = 2

• bool deprecated = 3

• bool allow_empty_value = 4

• string style = 5

• bool explode = 6

• bool allow_reserved = 7

• optional SchemaOrReference schema = 8

• optional Any example = 9

• optional ExamplesOrReferences examples = 10

• optional MediaTypes content = 11

• repeated NamedAny specification_extension = 12

Used in: NamedHeaderOrReference

• oneof oneof

  • Header header = 1

  • Reference reference = 2

Used in: Components, Encoding, Response

• repeated NamedHeaderOrReference additional_properties = 1

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

Used in: Document

• string title = 1

• string description = 2

• string terms_of_service = 3

• optional Contact contact = 4

• optional License license = 5

• string version = 6

• repeated NamedAny specification_extension = 7

• string summary = 8

Used in: Schema

• repeated SchemaOrReference schema_or_reference = 1

License information for the exposed API.

Used in: Info

• string name = 1

• string url = 2

• repeated NamedAny specification_extension = 3

The `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. 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 is used for accessing values in an operation and using them as parameters while invoking the linked operation.

Used in: LinkOrReference

• string operation_ref = 1

• string operation_id = 2

• optional AnyOrExpression parameters = 3

• optional AnyOrExpression request_body = 4

• string description = 5

• optional Server server = 6

• repeated NamedAny specification_extension = 7

Used in: NamedLinkOrReference

• oneof oneof

  • Link link = 1

  • Reference reference = 2

Used in: Components, Response

• repeated NamedLinkOrReference additional_properties = 1

Each Media Type Object provides schema and examples for the media type identified by its key.

Used in: NamedMediaType

• optional SchemaOrReference schema = 1

• optional Any example = 2

• optional ExamplesOrReferences examples = 3

• optional Encodings encoding = 4

• repeated NamedAny specification_extension = 5

Used in: Header, Parameter, RequestBody, Response

• repeated NamedMediaType additional_properties = 1

Automatically-generated message used to represent maps of Any as ordered (name,value) pairs.

Used in: Callback, Components, Contact, Discriminator, Document, Encoding, Example, Expression, ExternalDocs, Header, Info, License, Link, MediaType, OauthFlow, OauthFlows, Object, Operation, Parameter, PathItem, Paths, RequestBody, Response, Responses, Schema, SecurityScheme, Server, ServerVariable, Tag, Xml

• string name = 1

  Map key

• optional Any value = 2

  Mapped value

Automatically-generated message used to represent maps of CallbackOrReference as ordered (name,value) pairs.

Used in: CallbacksOrReferences

• string name = 1

  Map key

• optional CallbackOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of Encoding as ordered (name,value) pairs.

Used in: Encodings

• string name = 1

  Map key

• optional Encoding value = 2

  Mapped value

Automatically-generated message used to represent maps of ExampleOrReference as ordered (name,value) pairs.

Used in: ExamplesOrReferences

• string name = 1

  Map key

• optional ExampleOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of HeaderOrReference as ordered (name,value) pairs.

Used in: HeadersOrReferences

• string name = 1

  Map key

• optional HeaderOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of LinkOrReference as ordered (name,value) pairs.

Used in: LinksOrReferences

• string name = 1

  Map key

• optional LinkOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of MediaType as ordered (name,value) pairs.

Used in: MediaTypes

• string name = 1

  Map key

• optional MediaType value = 2

  Mapped value

Automatically-generated message used to represent maps of ParameterOrReference as ordered (name,value) pairs.

Used in: ParametersOrReferences

• string name = 1

  Map key

• optional ParameterOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of PathItem as ordered (name,value) pairs.

Used in: Callback, Paths

• string name = 1

  Map key

• optional PathItem value = 2

  Mapped value

Automatically-generated message used to represent maps of RequestBodyOrReference as ordered (name,value) pairs.

Used in: RequestBodiesOrReferences

• string name = 1

  Map key

• optional RequestBodyOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of ResponseOrReference as ordered (name,value) pairs.

Used in: Responses, ResponsesOrReferences

• string name = 1

  Map key

• optional ResponseOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of SchemaOrReference as ordered (name,value) pairs.

Used in: Properties, SchemasOrReferences

• string name = 1

  Map key

• optional SchemaOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of SecuritySchemeOrReference as ordered (name,value) pairs.

Used in: SecuritySchemesOrReferences

• string name = 1

  Map key

• optional SecuritySchemeOrReference value = 2

  Mapped value

Automatically-generated message used to represent maps of ServerVariable as ordered (name,value) pairs.

Used in: ServerVariables

• string name = 1

  Map key

• optional ServerVariable value = 2

  Mapped value

Automatically-generated message used to represent maps of string as ordered (name,value) pairs.

Used in: Strings

• string name = 1

  Map key

• string value = 2

  Mapped value

Automatically-generated message used to represent maps of StringArray as ordered (name,value) pairs.

Used in: SecurityRequirement

• string name = 1

  Map key

• optional StringArray value = 2

  Mapped value

Configuration details for a supported OAuth Flow

Used in: OauthFlows

• string authorization_url = 1

• string token_url = 2

• string refresh_url = 3

• optional Strings scopes = 4

• repeated NamedAny specification_extension = 5

Allows configuration of the supported OAuth Flows.

Used in: SecurityScheme

• optional OauthFlow implicit = 1

• optional OauthFlow password = 2

• optional OauthFlow client_credentials = 3

• optional OauthFlow authorization_code = 4

• repeated NamedAny specification_extension = 5

• repeated NamedAny additional_properties = 1

Describes a single API operation on a path.

Used in: PathItem

• repeated string tags = 1

• string summary = 2

• string description = 3

• optional ExternalDocs external_docs = 4

• string operation_id = 5

• repeated ParameterOrReference parameters = 6

• optional RequestBodyOrReference request_body = 7

• optional Responses responses = 8

• optional CallbacksOrReferences callbacks = 9

• bool deprecated = 10

• repeated SecurityRequirement security = 11

• repeated Server servers = 12

• repeated NamedAny specification_extension = 13

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.

Used in: ParameterOrReference

• string name = 1

• string in = 2

• string description = 3

• bool required = 4

• bool deprecated = 5

• bool allow_empty_value = 6

• string style = 7

• bool explode = 8

• bool allow_reserved = 9

• optional SchemaOrReference schema = 10

• optional Any example = 11

• optional ExamplesOrReferences examples = 12

• optional MediaTypes content = 13

• repeated NamedAny specification_extension = 14

Used in: NamedParameterOrReference, Operation, PathItem

• oneof oneof

  • Parameter parameter = 1

  • Reference reference = 2

Used in: Components

• repeated NamedParameterOrReference additional_properties = 1

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

Used in: NamedPathItem

• string _ref = 1

• string summary = 2

• string description = 3

• optional Operation get = 4

• optional Operation put = 5

• optional Operation post = 6

• optional Operation delete = 7

• optional Operation options = 8

• optional Operation head = 9

• optional Operation patch = 10

• optional Operation trace = 11

• repeated Server servers = 12

• repeated ParameterOrReference parameters = 13

• repeated NamedAny specification_extension = 14

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.

Used in: Document

• repeated NamedPathItem path = 1

• repeated NamedAny specification_extension = 2

Used in: Schema

• repeated NamedSchemaOrReference additional_properties = 1

A simple object to allow referencing other components in the specification, internally and externally. The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules. For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification.

Used in: CallbackOrReference, ExampleOrReference, HeaderOrReference, LinkOrReference, ParameterOrReference, RequestBodyOrReference, ResponseOrReference, SchemaOrReference, SecuritySchemeOrReference

• string _ref = 1

• string summary = 2

• string description = 3

Used in: Components

• repeated NamedRequestBodyOrReference additional_properties = 1

Describes a single request body.

Used in: RequestBodyOrReference

• string description = 1

• optional MediaTypes content = 2

• bool required = 3

• repeated NamedAny specification_extension = 4

Used in: NamedRequestBodyOrReference, Operation

• oneof oneof

  • RequestBody request_body = 1

  • Reference reference = 2

Describes a single response from an API Operation, including design-time, static `links` to operations based on the response.

Used in: ResponseOrReference

• string description = 1

• optional HeadersOrReferences headers = 2

• optional MediaTypes content = 3

• optional LinksOrReferences links = 4

• repeated NamedAny specification_extension = 5

Used in: NamedResponseOrReference, Responses

• oneof oneof

  • Response response = 1

  • Reference reference = 2

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors. The `default` MAY be used as a default response object for all HTTP codes that are not covered individually by the specification. The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call.

Used in: Operation

• optional ResponseOrReference default = 1

• repeated NamedResponseOrReference response_or_reference = 2

• repeated NamedAny specification_extension = 3

Used in: Components

• repeated NamedResponseOrReference additional_properties = 1

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.

Used in: SchemaOrReference

• bool nullable = 1

• optional Discriminator discriminator = 2

• bool read_only = 3

• bool write_only = 4

• optional Xml xml = 5

• optional ExternalDocs external_docs = 6

• optional Any example = 7

• bool deprecated = 8

• string title = 9

• double multiple_of = 10

• double maximum = 11

• bool exclusive_maximum = 12

• double minimum = 13

• bool exclusive_minimum = 14

• int64 max_length = 15

• int64 min_length = 16

• string pattern = 17

• int64 max_items = 18

• int64 min_items = 19

• bool unique_items = 20

• int64 max_properties = 21

• int64 min_properties = 22

• repeated string required = 23

• repeated Any enum = 24

• string type = 25

• repeated SchemaOrReference all_of = 26

• repeated SchemaOrReference one_of = 27

• repeated SchemaOrReference any_of = 28

• optional Schema not = 29

• optional ItemsItem items = 30

• optional Properties properties = 31

• optional AdditionalPropertiesItem additional_properties = 32

• optional DefaultType default = 33

• string description = 34

• string format = 35

• repeated NamedAny specification_extension = 36

Used in: AdditionalPropertiesItem, Header, ItemsItem, MediaType, NamedSchemaOrReference, Parameter, Schema

• oneof oneof

  • Schema schema = 1

  • Reference reference = 2

Used in: Components

• repeated NamedSchemaOrReference additional_properties = 1

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. 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 OpenAPI Object or Operation Object, only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.

Used in: Document, Operation

• repeated NamedStringArray additional_properties = 1

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), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect. Please note that currently (2019) the implicit flow is about to be deprecated OAuth 2.0 Security Best Current Practice. Recommended for most use case is Authorization Code Grant flow with PKCE.

Used in: SecuritySchemeOrReference

• string type = 1

• string description = 2

• string name = 3

• string in = 4

• string scheme = 5

• string bearer_format = 6

• optional OauthFlows flows = 7

• string open_id_connect_url = 8

• repeated NamedAny specification_extension = 9

Used in: NamedSecuritySchemeOrReference

• oneof oneof

  • SecurityScheme security_scheme = 1

  • Reference reference = 2

Used in: Components

• repeated NamedSecuritySchemeOrReference additional_properties = 1

An object representing a Server.

Used in: Document, Link, Operation, PathItem

• string url = 1

• string description = 2

• optional ServerVariables variables = 3

• repeated NamedAny specification_extension = 4

An object representing a Server Variable for server URL template substitution.

Used in: NamedServerVariable

• repeated string enum = 1

• string default = 2

• string description = 3

• repeated NamedAny specification_extension = 4

Used in: Server

• repeated NamedServerVariable additional_properties = 1

Any property starting with x- is valid.

• oneof oneof

  • double number = 1

  • bool boolean = 2

  • string string = 3

Used in: NamedStringArray

• repeated string value = 1

Used in: Discriminator, OauthFlow

• repeated NamedString additional_properties = 1

Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.

Used in: Document

• string name = 1

• string description = 2

• optional ExternalDocs external_docs = 3

• repeated NamedAny specification_extension = 4

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.

Used in: Schema

• string name = 1

• string namespace = 2

• string prefix = 3

• bool attribute = 4

• bool wrapped = 5

• repeated NamedAny specification_extension = 6