package openapi.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Schema

• oneof oneof

  • Schema schema = 1

  • bool boolean = 2

Used in: FileSchema, FormDataParameterSubSchema, Header, HeaderParameterSubSchema, NamedAny, PathParameterSubSchema, PrimitivesItems, QueryParameterSubSchema, Schema

• optional google.protobuf.Any value = 1

• string yaml = 2

Used in: SecurityDefinitionsItem

• string type = 1

• string name = 2

• string in = 3

• string description = 4

• repeated NamedAny vendor_extension = 5

Used in: SecurityDefinitionsItem

• string type = 1

• string description = 2

• repeated NamedAny vendor_extension = 3

Used in: Parameter

• string description = 1

  A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

• string name = 2

  The name of the parameter.

• string in = 3

  Determines the location of the parameter.

• bool required = 4

  Determines whether or not this parameter is required or optional.

• optional Schema schema = 5

• repeated NamedAny vendor_extension = 6

Contact information for the owners of the API.

Used in: Info

• string name = 1

  The identifying name of the contact person/organization.

• string url = 2

  The URL pointing to the contact information.

• string email = 3

  The email address of the contact person/organization.

• repeated NamedAny vendor_extension = 4

• repeated NamedAny additional_properties = 1

One or more JSON objects describing the schemas being consumed and produced by the API.

Used in: Document

• repeated NamedSchema additional_properties = 1

• string swagger = 1

  The Swagger version of this document.

• optional Info info = 2

• string host = 3

  The host (name or ip) of the API. Example: 'swagger.io'

• string base_path = 4

  The base path to the API. Example: '/api'.

• repeated string schemes = 5

  The transfer protocol of the API.

• repeated string consumes = 6

  A list of MIME types accepted by the API.

• repeated string produces = 7

  A list of MIME types the API can produce.

• optional Paths paths = 8

• optional Definitions definitions = 9

• optional ParameterDefinitions parameters = 10

• optional ResponseDefinitions responses = 11

• repeated SecurityRequirement security = 12

• optional SecurityDefinitions security_definitions = 13

• repeated Tag tags = 14

• optional ExternalDocs external_docs = 15

• repeated NamedAny vendor_extension = 16

Used in: Response

• repeated NamedAny additional_properties = 1

information about external documentation

Used in: Document, FileSchema, Operation, Schema, Tag

• string description = 1

• string url = 2

• repeated NamedAny vendor_extension = 3

A deterministic version of a JSON Schema object.

Used in: SchemaItem

• string format = 1

• string title = 2

• string description = 3

• optional Any default = 4

• repeated string required = 5

• string type = 6

• bool read_only = 7

• optional ExternalDocs external_docs = 8

• optional Any example = 9

• repeated NamedAny vendor_extension = 10

Used in: NonBodyParameter

• bool required = 1

  Determines whether or not this parameter is required or optional.

• string in = 2

  Determines the location of the parameter.

• string description = 3

  A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

• string name = 4

  The name of the parameter.

• bool allow_empty_value = 5

  allows sending a parameter by name only or with an empty value.

• string type = 6

• string format = 7

• optional PrimitivesItems items = 8

• string collection_format = 9

• optional Any default = 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

• repeated Any enum = 21

• double multiple_of = 22

• repeated NamedAny vendor_extension = 23

Used in: NamedHeader

• string type = 1

• string format = 2

• optional PrimitivesItems items = 3

• string collection_format = 4

• optional Any default = 5

• double maximum = 6

• bool exclusive_maximum = 7

• double minimum = 8

• bool exclusive_minimum = 9

• int64 max_length = 10

• int64 min_length = 11

• string pattern = 12

• int64 max_items = 13

• int64 min_items = 14

• bool unique_items = 15

• repeated Any enum = 16

• double multiple_of = 17

• string description = 18

• repeated NamedAny vendor_extension = 19

Used in: NonBodyParameter

• bool required = 1

  Determines whether or not this parameter is required or optional.

• string in = 2

  Determines the location of the parameter.

• string description = 3

  A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

• string name = 4

  The name of the parameter.

• string type = 5

• string format = 6

• optional PrimitivesItems items = 7

• string collection_format = 8

• optional Any default = 9

• double maximum = 10

• bool exclusive_maximum = 11

• double minimum = 12

• bool exclusive_minimum = 13

• int64 max_length = 14

• int64 min_length = 15

• string pattern = 16

• int64 max_items = 17

• int64 min_items = 18

• bool unique_items = 19

• repeated Any enum = 20

• double multiple_of = 21

• repeated NamedAny vendor_extension = 22

Used in: Response

• repeated NamedHeader additional_properties = 1

General information about the API.

Used in: Document

• string title = 1

  A unique and precise title of the API.

• string version = 2

  A semantic version number of the API.

• string description = 3

  A longer description of the API. Should be different from the title. GitHub Flavored Markdown is allowed.

• string terms_of_service = 4

  The terms of service for the API.

• optional Contact contact = 5

• optional License license = 6

• repeated NamedAny vendor_extension = 7

Used in: Schema

• repeated Schema schema = 1

Used in: ParametersItem, ResponseValue

• string _ref = 1

• string description = 2

Used in: Info

• string name = 1

  The name of the license type. It's encouraged to use an OSI compatible license.

• string url = 2

  The URL pointing to the license.

• repeated NamedAny vendor_extension = 3

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

Used in: ApiKeySecurity, BasicAuthenticationSecurity, BodyParameter, Contact, Default, Document, Examples, ExternalDocs, FileSchema, FormDataParameterSubSchema, Header, HeaderParameterSubSchema, Info, License, Oauth2AccessCodeSecurity, Oauth2ApplicationSecurity, Oauth2ImplicitSecurity, Oauth2PasswordSecurity, Operation, PathItem, PathParameterSubSchema, Paths, PrimitivesItems, QueryParameterSubSchema, Response, Responses, Schema, Tag, VendorExtension, Xml

• string name = 1

  Map key

• optional Any value = 2

  Mapped value

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

Used in: Headers

• string name = 1

  Map key

• optional Header value = 2

  Mapped value

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

Used in: ParameterDefinitions

• string name = 1

  Map key

• optional Parameter value = 2

  Mapped value

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

Used in: Paths

• string name = 1

  Map key

• optional PathItem value = 2

  Mapped value

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

Used in: ResponseDefinitions

• string name = 1

  Map key

• optional Response value = 2

  Mapped value

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

Used in: Responses

• string name = 1

  Map key

• optional ResponseValue value = 2

  Mapped value

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

Used in: Definitions, Properties

• string name = 1

  Map key

• optional Schema value = 2

  Mapped value

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

Used in: SecurityDefinitions

• string name = 1

  Map key

• optional SecurityDefinitionsItem value = 2

  Mapped value

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

Used in: Oauth2Scopes

• 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

Used in: Parameter

• oneof oneof

  • HeaderParameterSubSchema header_parameter_sub_schema = 1

  • FormDataParameterSubSchema form_data_parameter_sub_schema = 2

  • QueryParameterSubSchema query_parameter_sub_schema = 3

  • PathParameterSubSchema path_parameter_sub_schema = 4

Used in: SecurityDefinitionsItem

• string type = 1

• string flow = 2

• optional Oauth2Scopes scopes = 3

• string authorization_url = 4

• string token_url = 5

• string description = 6

• repeated NamedAny vendor_extension = 7

Used in: SecurityDefinitionsItem

• string type = 1

• string flow = 2

• optional Oauth2Scopes scopes = 3

• string token_url = 4

• string description = 5

• repeated NamedAny vendor_extension = 6

Used in: SecurityDefinitionsItem

• string type = 1

• string flow = 2

• optional Oauth2Scopes scopes = 3

• string authorization_url = 4

• string description = 5

• repeated NamedAny vendor_extension = 6

Used in: SecurityDefinitionsItem

• string type = 1

• string flow = 2

• optional Oauth2Scopes scopes = 3

• string token_url = 4

• string description = 5

• repeated NamedAny vendor_extension = 6

Used in: Oauth2AccessCodeSecurity, Oauth2ApplicationSecurity, Oauth2ImplicitSecurity, Oauth2PasswordSecurity

• repeated NamedString additional_properties = 1

Used in: PathItem

• repeated string tags = 1

• string summary = 2

  A brief summary of the operation.

• string description = 3

  A longer description of the operation, GitHub Flavored Markdown is allowed.

• optional ExternalDocs external_docs = 4

• string operation_id = 5

  A unique identifier of the operation.

• repeated string produces = 6

  A list of MIME types the API can produce.

• repeated string consumes = 7

  A list of MIME types the API can consume.

• repeated ParametersItem parameters = 8

  The parameters needed to send a valid API call.

• optional Responses responses = 9

• repeated string schemes = 10

  The transfer protocol of the API.

• bool deprecated = 11

• repeated SecurityRequirement security = 12

• repeated NamedAny vendor_extension = 13

Used in: NamedParameter, ParametersItem

• oneof oneof

  • BodyParameter body_parameter = 1

  • NonBodyParameter non_body_parameter = 2

One or more JSON representations for parameters

Used in: Document

• repeated NamedParameter additional_properties = 1

Used in: Operation, PathItem

• oneof oneof

  • Parameter parameter = 1

  • JsonReference json_reference = 2

Used in: NamedPathItem

• string _ref = 1

• optional Operation get = 2

• optional Operation put = 3

• optional Operation post = 4

• optional Operation delete = 5

• optional Operation options = 6

• optional Operation head = 7

• optional Operation patch = 8

• repeated ParametersItem parameters = 9

  The parameters needed to send a valid API call.

• repeated NamedAny vendor_extension = 10

Used in: NonBodyParameter

• bool required = 1

  Determines whether or not this parameter is required or optional.

• string in = 2

  Determines the location of the parameter.

• string description = 3

  A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

• string name = 4

  The name of the parameter.

• string type = 5

• string format = 6

• optional PrimitivesItems items = 7

• string collection_format = 8

• optional Any default = 9

• double maximum = 10

• bool exclusive_maximum = 11

• double minimum = 12

• bool exclusive_minimum = 13

• int64 max_length = 14

• int64 min_length = 15

• string pattern = 16

• int64 max_items = 17

• int64 min_items = 18

• bool unique_items = 19

• repeated Any enum = 20

• double multiple_of = 21

• repeated NamedAny vendor_extension = 22

Relative paths to the individual endpoints. They must be relative to the 'basePath'.

Used in: Document

• repeated NamedAny vendor_extension = 1

• repeated NamedPathItem path = 2

Used in: FormDataParameterSubSchema, Header, HeaderParameterSubSchema, PathParameterSubSchema, QueryParameterSubSchema

• string type = 1

• string format = 2

• optional PrimitivesItems items = 3

• string collection_format = 4

• optional Any default = 5

• double maximum = 6

• bool exclusive_maximum = 7

• double minimum = 8

• bool exclusive_minimum = 9

• int64 max_length = 10

• int64 min_length = 11

• string pattern = 12

• int64 max_items = 13

• int64 min_items = 14

• bool unique_items = 15

• repeated Any enum = 16

• double multiple_of = 17

• repeated NamedAny vendor_extension = 18

Used in: Schema

• repeated NamedSchema additional_properties = 1

Used in: NonBodyParameter

• bool required = 1

  Determines whether or not this parameter is required or optional.

• string in = 2

  Determines the location of the parameter.

• string description = 3

  A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

• string name = 4

  The name of the parameter.

• bool allow_empty_value = 5

  allows sending a parameter by name only or with an empty value.

• string type = 6

• string format = 7

• optional PrimitivesItems items = 8

• string collection_format = 9

• optional Any default = 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

• repeated Any enum = 21

• double multiple_of = 22

• repeated NamedAny vendor_extension = 23

Used in: NamedResponse, ResponseValue

• string description = 1

• optional SchemaItem schema = 2

• optional Headers headers = 3

• optional Examples examples = 4

• repeated NamedAny vendor_extension = 5

One or more JSON representations for responses

Used in: Document

• repeated NamedResponse additional_properties = 1

Used in: NamedResponseValue

• oneof oneof

  • Response response = 1

  • JsonReference json_reference = 2

Response objects names can either be any valid HTTP status code or 'default'.

Used in: Operation

• repeated NamedResponseValue response_code = 1

• repeated NamedAny vendor_extension = 2

A deterministic version of a JSON Schema object.

Used in: AdditionalPropertiesItem, BodyParameter, ItemsItem, NamedSchema, SchemaItem

• string _ref = 1

• string format = 2

• string title = 3

• string description = 4

• optional Any default = 5

• double multiple_of = 6

• double maximum = 7

• bool exclusive_maximum = 8

• double minimum = 9

• bool exclusive_minimum = 10

• int64 max_length = 11

• int64 min_length = 12

• string pattern = 13

• int64 max_items = 14

• int64 min_items = 15

• bool unique_items = 16

• int64 max_properties = 17

• int64 min_properties = 18

• repeated string required = 19

• repeated Any enum = 20

• optional AdditionalPropertiesItem additional_properties = 21

• optional TypeItem type = 22

• optional ItemsItem items = 23

• repeated Schema all_of = 24

• optional Properties properties = 25

• string discriminator = 26

• bool read_only = 27

• optional Xml xml = 28

• optional ExternalDocs external_docs = 29

• optional Any example = 30

• repeated NamedAny vendor_extension = 31

Used in: Response

• oneof oneof

  • Schema schema = 1

  • FileSchema file_schema = 2

Used in: Document

• repeated NamedSecurityDefinitionsItem additional_properties = 1

Used in: NamedSecurityDefinitionsItem

• oneof oneof

  • BasicAuthenticationSecurity basic_authentication_security = 1

  • ApiKeySecurity api_key_security = 2

  • Oauth2ImplicitSecurity oauth2_implicit_security = 3

  • Oauth2PasswordSecurity oauth2_password_security = 4

  • Oauth2ApplicationSecurity oauth2_application_security = 5

  • Oauth2AccessCodeSecurity oauth2_access_code_security = 6

Used in: Document, Operation

• repeated NamedStringArray additional_properties = 1

Used in: NamedStringArray

• repeated string value = 1

Used in: Document

• string name = 1

• string description = 2

• optional ExternalDocs external_docs = 3

• repeated NamedAny vendor_extension = 4

Used in: Schema

• repeated string value = 1

Any property starting with x- is valid.

• repeated NamedAny additional_properties = 1

Used in: Schema

• string name = 1

• string namespace = 2

• string prefix = 3

• bool attribute = 4

• bool wrapped = 5

• repeated NamedAny vendor_extension = 6