gRPC API Gateway & OpenAPI Config
Config file for gRPC API Gateway & OpenAPI v3.1 generation
| Type | object |
|---|---|
| File match |
grpc_api_gateway.yaml
grpc_api_gateway.yml
grpc_api_gateway.json
*_gateway.yml
*_gateway.yaml
*_gateway.json
*_openapi.yml
*_openapi.yaml
*_openapi.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/grpc-api-gateway-openapi-config/latest.json |
| Source | https://www.schemastore.org/grpc-api-gateway.json |
Validate with Lintel
npx @lintel/lintel checkConfiguration files for gRPC API Gateway & OpenAPI generation plugin for protobuf (https://github.com/meshapi/grpc-api-gateway)
Properties
GatewaySpec holds gRPC gateway configurations.
1 nested properties
endpoints hold a series of endpoint binding specs.
OpenAPISpec defines the overall OpenAPI documentation configuration.
4 nested properties
This is the root object of the OpenAPI document. See: https://spec.openapis.org/oas/v3.1.0#openapi-object
8 nested properties
Info captures OpenAPI Info object. NOTE: A generated value will be used for the required fields if they are left empty. See: https://spec.openapis.org/oas/v3.1.0#info-object
8 nested properties
REQUIRED. The title of the API.
A short summary of the API.
A description of the API. CommonMark syntax MAY be used for rich text representation.
A URL to the Terms of Service for the API. This MUST be in the form of a URL.
Contact information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#contact-object
License information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#license-object
REQUIRED. The version of the OpenAPI document.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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 /. See: https://spec.openapis.org/oas/latest.html#server-object
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. See: https://spec.openapis.org/oas/latest.html#components-object
9 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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. See: https://spec.openapis.org/oas/v3.1.0#security-requirement-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 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: https://spec.openapis.org/oas/v3.1.0#tag-object
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
services is used to configure OpenAPI v3.1 output for gRPC services.
messages is used to configure OpenAPI v3.1 output for protobuf messages.
enums is used to configure OpenAPI v3.1 output for protobuf enums.
Definitions
AdditionalEndpointBinding is an additional gRPC method - HTTP endpoint binding specification.
CustomPattern describes an HTTP pattern and custom method.
2 nested properties
method is the custom HTTP method.
path is the HTTP path pattern.
body is a request message field selector that will be read via HTTP body. '*' indicates that the entire request message gets decoded from the body. An empty string indicates that no part of the request gets decoded from the body. NOTE: Not all methods support HTTP body.
response_body is a response message field selector that will be written to HTTP response. '*' or an empty string indicates that the entire response message gets encoded.
query_params are explicit query parameter bindings that can be used to rename or ignore query parameters.
disable_query_param_discovery can be used to avoid auto binding query parameters.
StreamConfig sets the behavior of the HTTP server for gRPC streaming methods.
3 nested properties
disable_websockets indicates whether or not websockets are allowed for this method. The client must still ask for a connection upgrade.
disable_sse indicates whether or not server-sent events are allowed. see: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events SSE is only used when Accept-Type from the request includes MIME type text/event-stream.
disable_chunked indicates whether or not chunked transfer encoding is allowed. NOTE: Chunked transfer encoding is disabled in HTTP/2 so this option will only be available if the request is HTTP/1.
CustomPattern describes an HTTP pattern and custom method.
method is the custom HTTP method.
path is the HTTP path pattern.
EndpointBinding is a gRPC method - HTTP endpoint binding specification.
selector is a dot-separated gRPC service method selector. If the selector begins with '.', the current proto package will be added to the beginning of the path. For instance: .', it will be treated as a fully qualified method name (FQMN).~.MyService. Since no proto package can be deduced in the global config file, this alias cannot be used in the global config file. If the selector does not begin with '
CustomPattern describes an HTTP pattern and custom method.
2 nested properties
method is the custom HTTP method.
path is the HTTP path pattern.
body is a request message field selector that will be read via HTTP body. '*' indicates that the entire request message gets decoded from the body. An empty string indicates that no part of the request gets decoded from the body. NOTE: Not all methods support HTTP body.
response_body is a response message field selector that will be written to HTTP response. '*' or an empty string indicates that the entire response message gets encoded.
query_params are explicit query parameter bindings that can be used to rename or ignore query parameters.
additional_bindings holds additional bindings for the same gRPC service method.
disable_query_param_discovery can be used to avoid auto binding query parameters.
StreamConfig sets the behavior of the HTTP server for gRPC streaming methods.
3 nested properties
disable_websockets indicates whether or not websockets are allowed for this method. The client must still ask for a connection upgrade.
disable_sse indicates whether or not server-sent events are allowed. see: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events SSE is only used when Accept-Type from the request includes MIME type text/event-stream.
disable_chunked indicates whether or not chunked transfer encoding is allowed. NOTE: Chunked transfer encoding is disabled in HTTP/2 so this option will only be available if the request is HTTP/1.
GatewaySpec holds gRPC gateway configurations.
endpoints hold a series of endpoint binding specs.
OpenAPIEnumSpec defines configuration for generating OpenAPI documentation for protobuf enums.
selector is a dot-separated protobuf enum selector. If the selector begins with a '.', it will be treated as an absolute path. If it begins with '.', the current proto package will be added to the beginning of the path. For instance: .', it will be treated as a relative path and a search from the current proto package will be performed in order to find the enum.~.MyEnum. Since no proto package can be deduced in the global config file, this alias cannot be used in the global config file. If the path does not begin with a '.' or '
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
OpenAPIMessageSpec defines configuration for generating OpenAPI documentation for protobuf messages.
selector is a dot-separated protobuf message selector. If the selector begins with a '.', it will be treated as an absolute path. If it begins with '.', the current proto package will be added to the beginning of the path. For instance: .', it will be treated as a relative path and a search from the current proto package will be performed in order to find the message.~.MyMessage. Since no proto package can be deduced in the global config file, this alias cannot be used in the global config file. If the path does not begin with a '.' or '
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
fields allows controlling the OpenAPI v3.1 generation for individual fields in this proto message.
OpenAPIServiceSpec defines configuration for generating OpenAPI documentation for gRPC services.
selector is a dot-separated gRPC service method selector. If the selector begins with '.', the current proto package will be added to the beginning of the path. For instance: .', it will be treated as a fully qualified method name (FQMN).~.MyService. Since no proto package can be deduced in the global config file, this alias cannot be used in the global config file. If the selector does not begin with '
This is the root object of the OpenAPI document. See: https://spec.openapis.org/oas/v3.1.0#openapi-object
8 nested properties
Info captures OpenAPI Info object. NOTE: A generated value will be used for the required fields if they are left empty. See: https://spec.openapis.org/oas/v3.1.0#info-object
8 nested properties
REQUIRED. The title of the API.
A short summary of the API.
A description of the API. CommonMark syntax MAY be used for rich text representation.
A URL to the Terms of Service for the API. This MUST be in the form of a URL.
Contact information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#contact-object
License information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#license-object
REQUIRED. The version of the OpenAPI document.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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 /. See: https://spec.openapis.org/oas/latest.html#server-object
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. See: https://spec.openapis.org/oas/latest.html#components-object
9 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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. See: https://spec.openapis.org/oas/v3.1.0#security-requirement-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 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: https://spec.openapis.org/oas/v3.1.0#tag-object
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
methods maps each method to an operation configuration.
OpenAPISpec defines the overall OpenAPI documentation configuration.
This is the root object of the OpenAPI document. See: https://spec.openapis.org/oas/v3.1.0#openapi-object
8 nested properties
Info captures OpenAPI Info object. NOTE: A generated value will be used for the required fields if they are left empty. See: https://spec.openapis.org/oas/v3.1.0#info-object
8 nested properties
REQUIRED. The title of the API.
A short summary of the API.
A description of the API. CommonMark syntax MAY be used for rich text representation.
A URL to the Terms of Service for the API. This MUST be in the form of a URL.
Contact information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#contact-object
License information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#license-object
REQUIRED. The version of the OpenAPI document.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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 /. See: https://spec.openapis.org/oas/latest.html#server-object
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. See: https://spec.openapis.org/oas/latest.html#components-object
9 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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. See: https://spec.openapis.org/oas/v3.1.0#security-requirement-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 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: https://spec.openapis.org/oas/v3.1.0#tag-object
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
services is used to configure OpenAPI v3.1 output for gRPC services.
messages is used to configure OpenAPI v3.1 output for protobuf messages.
enums is used to configure OpenAPI v3.1 output for protobuf enums.
QueryParameterBinding describes a query parameter to request message binding.
selector is a dot-separated path to the request message's field.
name is the name of the HTTP query parameter that will be used.
ignore avoids reading this query parameter altogether (default: false).
StreamConfig sets the behavior of the HTTP server for gRPC streaming methods.
disable_websockets indicates whether or not websockets are allowed for this method. The client must still ask for a connection upgrade.
disable_sse indicates whether or not server-sent events are allowed. see: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events SSE is only used when Accept-Type from the request includes MIME type text/event-stream.
disable_chunked indicates whether or not chunked transfer encoding is allowed. NOTE: Chunked transfer encoding is disabled in HTTP/2 so this option will only be available if the request is HTTP/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. See: https://spec.openapis.org/oas/latest.html#components-object
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Contact information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#contact-object
The identifying name of the contact person/organization.
The URL pointing to the contact information. This MUST be in the form of a URL.
The email address of the contact person/organization. This MUST be in the form of an email address.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
This is the root object of the OpenAPI document. See: https://spec.openapis.org/oas/v3.1.0#openapi-object
Info captures OpenAPI Info object. NOTE: A generated value will be used for the required fields if they are left empty. See: https://spec.openapis.org/oas/v3.1.0#info-object
8 nested properties
REQUIRED. The title of the API.
A short summary of the API.
A description of the API. CommonMark syntax MAY be used for rich text representation.
A URL to the Terms of Service for the API. This MUST be in the form of a URL.
Contact information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#contact-object
4 nested properties
The identifying name of the contact person/organization.
The URL pointing to the contact information. This MUST be in the form of a URL.
The email address of the contact person/organization. This MUST be in the form of an email address.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
License information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#license-object
4 nested properties
REQUIRED. The license name used for the API.
An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.
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.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
REQUIRED. The version of the OpenAPI document.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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 /. See: https://spec.openapis.org/oas/latest.html#server-object
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. See: https://spec.openapis.org/oas/latest.html#components-object
9 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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. See: https://spec.openapis.org/oas/v3.1.0#security-requirement-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 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: https://spec.openapis.org/oas/v3.1.0#tag-object
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
DocumentConfiguration allows for controlling the default responses
default_responses is used to control the default responses generated in this OpenAPI document.
A single encoding definition applied to a single schema property. See: https://spec.openapis.org/oas/latest.html#encoding-object
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.
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.
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. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.
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. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.
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 or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
3 nested properties
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
Short description for the example.
Long description for the example. CommonMark syntax MAY be used for rich text representation.
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
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.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
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). See: https://spec.openapis.org/oas/v3.1.0#header-object
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
3 nested properties
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
A description of the link. CommonMark syntax MAY be used for rich text representation.
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.
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
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 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.
Describes how the parameter value will be serialized depending on the type of the parameter value. Default value for header parameters is "simple".
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.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
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.
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.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Info captures OpenAPI Info object. NOTE: A generated value will be used for the required fields if they are left empty. See: https://spec.openapis.org/oas/v3.1.0#info-object
REQUIRED. The title of the API.
A short summary of the API.
A description of the API. CommonMark syntax MAY be used for rich text representation.
A URL to the Terms of Service for the API. This MUST be in the form of a URL.
Contact information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#contact-object
4 nested properties
The identifying name of the contact person/organization.
The URL pointing to the contact information. This MUST be in the form of a URL.
The email address of the contact person/organization. This MUST be in the form of an email address.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
License information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#license-object
4 nested properties
REQUIRED. The license name used for the API.
An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.
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.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
REQUIRED. The version of the OpenAPI document.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
License information for the exposed API. See: https://spec.openapis.org/oas/v3.1.0#license-object
REQUIRED. The license name used for the API.
An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.
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.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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. See: https://spec.openapis.org/oas/v3.1.0#link-object
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
3 nested properties
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
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. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.
The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. NOTE: If a path (relative or absolute) to another service method is used, that operation ID will be substituted. Example: ".google.protobuf.Timestamp"
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).
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
A description of the link. CommonMark syntax MAY be used for rich text representation.
An object representing a Server. See: https://spec.openapis.org/oas/v3.1.0#server-object
4 nested properties
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}.
An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
A map between a variable name and its value. The value is used for substitution in the server’s URL template.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Each Media Type Object provides schema and examples for the media type identified by its key. See: https://spec.openapis.org/oas/latest.html#media-type-object
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
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.
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.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Describes a single API operation on a path. NOTE: this operation object is a partial implementation of the OpenAPI Operation object. Fields overridden here will only impact this method but will be used for all different HTTP bindings of the same method. See: https://spec.openapis.org/oas/v3.1.0#operation-object
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
A short summary of what the operation does. Default is the proto docstring for this method.
A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Override the operation ID, if left unset, a default value will be provided.
A list of parameters that are applicable for this operation. Note that path and query parameters get populated by the generator and will override any overlapping keys. You might use this to define headers and values that are not defined on the request payload.
The list of possible responses returned from executing this operation. NOTE: This list is additive meaning that it will override any generated response from the proto files.
Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.
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. To remove a top-level security declaration, an empty array can be used.
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.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. See: https://spec.openapis.org/oas/latest.html#parameter-object
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
3 nested properties
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information. If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored. For all other cases, the name corresponds to the parameter name used by the in property.
REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".
A description of the link. CommonMark syntax MAY be used for rich text representation.
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.
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
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 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.
Describes how the parameter value will be serialized depending on the type of the parameter value. Default value for header parameters is "simple".
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.
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.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
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.
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.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
Describes a single request body. See: https://spec.openapis.org/oas/latest.html#request-body-object
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
3 nested properties
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
Determines if the request body is required in the request. Defaults to false.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
3 nested properties
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
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.
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/*
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.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Represents a list of schemas for array validation or for object properties.
1 nested properties
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Represents an item in a SchemaList, which can be a schema or another SchemaList.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
3 nested properties
REQUIRED. The name of the property in the payload that will hold the discriminator value.
An object to hold mappings between payload values and schema names or references.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
2 nested properties
Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto-generated path parameter names for overlapping paths.
Marks this field as required.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
2 nested properties
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Represents a list of schemas for array validation or for object properties.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
37 nested properties
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI objects.
Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference and start with a '.', and that type must be available in the proto files or their dependencies. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp". NOTE: This reference will only be honored when used in top-level schemas in responses only.
FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.
The "$schema" keyword is used to identify the schema dialect and its associated URI for validation. See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
The title of the schema.
A regular expression pattern that the schema value should match. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
A list of property names that are required in this schema.
An array of unique values for enum validation. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number, representing an inclusive upper limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number, representing an inclusive lower limit for a numeric instance. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
If set to true, all items must be unique.
Enum for the data type of a schema.
A description of the schema using CommonMark syntax.
Represents an item in a SchemaList, which can be a schema or another SchemaList.
The properties keyword specifies the schema for properties in an object. Defining any property here for proto messages merges them with the automatically generated ones.
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for Value is JSON value.
The allOf keyword specifies that an instance must validate against all the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array. See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API. For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
The readOnly keyword specifies that a property is read-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
The writeOnly keyword specifies that a property is write-only. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
Examples of valid instances for the schema. See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
The format keyword specifies a predefined format for the schema value. See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
The deprecated keyword specifies that the schema is deprecated. See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
Represents a list of schemas for array validation or for object properties.
1 nested properties
Represents a list of schemas for array validation or for object properties.
Lists the required security schemes to execute this operation. See: https://spec.openapis.org/oas/v3.1.0#security-requirement-object
Each name MUST correspond to a security scheme which is declared in the Security Schemes under the 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.
Defines a security scheme that can be used by the operations. See: https://spec.openapis.org/oas/latest.html#security-scheme-object
Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object
3 nested properties
REQUIRED. The reference identifier. This MUST be in the form of a URI. For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced). Example: ".google.protobuf.Timestamp"
A short summary that, 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.
A description that, by default, SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.
REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect".
A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The name of the header, query or cookie parameter to be used.
REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".
REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry.
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.
5 nested properties
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
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.
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Configuration details for a supported OAuth Flow See: https://spec.openapis.org/oas/latest.html#oauth-flow-object
5 nested properties
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
An object representing a Server. See: https://spec.openapis.org/oas/v3.1.0#server-object
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}.
An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
A map between a variable name and its value. The value is used for substitution in the server’s URL template.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
An object representing a Server Variable for server URL template substitution. See: https://spec.openapis.org/oas/v3.1.0#server-variable-object
An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty.
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 treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value MUST exist in the enum’s values.
An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Adds metadata to a single tag that is used by the Operation Object. See: https://spec.openapis.org/oas/v3.1.0#tag-object
REQUIRED. The name of the tag.
A description for the tag. CommonMark syntax MAY be used for rich text representation.
Allows referencing an external resource for extended documentation. See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
3 nested properties
A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions
Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by standard OpenAPI specification. See: https://spec.openapis.org/oas/latest.html#specification-extensions