---
swagger: "2.0"
info:
  version: "1.0"
  title: "A Bit of Everything"
  contact:
    name: "gRPC-Gateway project"
    url: "https://github.com/grpc-ecosystem/grpc-gateway"
    email: "none@example.com"
  license:
    name: "BSD 3-Clause License"
    url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt"
  x-something-something: "yadda"
schemes:
- "http"
- "https"
- "wss"
consumes:
- "application/json"
- "application/x-foo-mime"
produces:
- "application/json"
- "application/x-foo-mime"
security:
- ApiKeyAuth: []
  BasicAuth: []
- ApiKeyAuth: []
  OAuth2:
  - "read"
  - "write"
paths:
  /v1/example/a_bit_of_everything:
    post:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_CreateBody"
      parameters:
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbABitOfEverything"
        x-exportParamName: "Body"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverything"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v1/example/a_bit_of_everything/echo/{value}:
    get:
      tags:
      - "echo rpc"
      summary: "Summary: Echo rpc"
      description: "Description Echo"
      operationId: "ABitOfEverythingService_Echo"
      parameters:
      - name: "value"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "Value"
      responses:
        200:
          description: "A successful response."
          examples:
            application/json:
              value: "the input value"
          schema:
            $ref: "#/definitions/subStringMessage"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "integer"
            format: "integer"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        503:
          description: "Returned when the resource is temporarily unavailable."
          schema: {}
          x-number: 100
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
      externalDocs:
        description: "Find out more Echo"
        url: "https://github.com/grpc-ecosystem/grpc-gateway"
  /v1/example/a_bit_of_everything/params/get/nested_enum/{single_nested.ok}:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_CheckNestedEnumGetQueryParams"
      parameters:
      - name: "single_nested.ok"
        in: "path"
        description: "DeepEnum description."
        required: true
        type: "string"
        enum:
        - "FALSE"
        - "TRUE"
        x-exportParamName: "SingleNestedOk"
      - name: "single_nested.name"
        in: "query"
        description: "name is nested field."
        required: false
        type: "string"
        x-exportParamName: "SingleNestedName"
        x-optionalDataType: "String"
      - name: "single_nested.amount"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "SingleNestedAmount"
        x-optionalDataType: "Int64"
      - name: "uuid"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "Uuid"
        x-optionalDataType: "String"
      - name: "float_value"
        in: "query"
        description: "Float value field"
        required: true
        type: "number"
        default: 0.2
        format: "float"
        x-exportParamName: "FloatValue"
      - name: "double_value"
        in: "query"
        required: false
        type: "number"
        format: "double"
        x-exportParamName: "DoubleValue"
        x-optionalDataType: "Float64"
      - name: "int64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Int64Value"
        x-optionalDataType: "String"
      - name: "uint64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Uint64Value"
        x-optionalDataType: "String"
      - name: "int32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Int32Value"
        x-optionalDataType: "Int32"
      - name: "fixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Fixed64Value"
        x-optionalDataType: "String"
      - name: "fixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Fixed32Value"
        x-optionalDataType: "Int64"
      - name: "bool_value"
        in: "query"
        required: false
        type: "boolean"
        x-exportParamName: "BoolValue"
        x-optionalDataType: "Bool"
      - name: "string_value"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "StringValue"
        x-optionalDataType: "String"
      - name: "bytes_value"
        in: "query"
        required: false
        type: "string"
        format: "byte"
        x-exportParamName: "BytesValue"
        x-optionalDataType: "String"
      - name: "uint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Uint32Value"
        x-optionalDataType: "Int64"
      - name: "enum_value"
        in: "query"
        description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValue"
        x-optionalDataType: "String"
      - name: "path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "ABC"
        enum:
        - "ABC"
        - "DEF"
        x-exportParamName: "PathEnumValue"
        x-optionalDataType: "String"
      - name: "nested_path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "GHI"
        enum:
        - "GHI"
        - "JKL"
        x-exportParamName: "NestedPathEnumValue"
        x-optionalDataType: "String"
      - name: "sfixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sfixed32Value"
        x-optionalDataType: "Int32"
      - name: "sfixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sfixed64Value"
        x-optionalDataType: "String"
      - name: "sint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sint32Value"
        x-optionalDataType: "Int32"
      - name: "sint64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sint64Value"
        x-optionalDataType: "String"
      - name: "repeated_string_value"
        in: "query"
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringValue"
      - name: "oneof_string"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "OneofString"
        x-optionalDataType: "String"
      - name: "nonConventionalNameValue"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "NonConventionalNameValue"
        x-optionalDataType: "String"
      - name: "timestamp_value"
        in: "query"
        required: false
        type: "string"
        format: "date-time"
        x-exportParamName: "TimestampValue"
        x-optionalDataType: "Time"
      - name: "repeated_enum_value"
        in: "query"
        description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
          \ ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumValue"
      - name: "repeated_enum_annotation"
        in: "query"
        description: "Repeated numeric enum title. Repeated numeric enum description.\n\
          \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumAnnotation"
      - name: "enum_value_annotation"
        in: "query"
        description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
          \ means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValueAnnotation"
        x-optionalDataType: "String"
      - name: "repeated_string_annotation"
        in: "query"
        description: "Repeated string title. Repeated string description."
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringAnnotation"
      - name: "nested_annotation.name"
        in: "query"
        description: "name is nested field."
        required: false
        type: "string"
        x-exportParamName: "NestedAnnotationName"
        x-optionalDataType: "String"
      - name: "nested_annotation.amount"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "NestedAnnotationAmount"
        x-optionalDataType: "Int64"
      - name: "int64_override_type"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Int64OverrideType"
        x-optionalDataType: "Int64"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverything"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v1/example/a_bit_of_everything/params/get/{single_nested.name}:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_CheckGetQueryParams"
      parameters:
      - name: "single_nested.name"
        in: "path"
        description: "name is nested field."
        required: true
        type: "string"
        x-exportParamName: "SingleNestedName"
      - name: "single_nested.amount"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "SingleNestedAmount"
        x-optionalDataType: "Int64"
      - name: "single_nested.ok"
        in: "query"
        description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
          \ TRUE is true."
        required: false
        type: "string"
        default: "FALSE"
        enum:
        - "FALSE"
        - "TRUE"
        x-exportParamName: "SingleNestedOk"
        x-optionalDataType: "String"
      - name: "uuid"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "Uuid"
        x-optionalDataType: "String"
      - name: "float_value"
        in: "query"
        description: "Float value field"
        required: true
        type: "number"
        default: 0.2
        format: "float"
        x-exportParamName: "FloatValue"
      - name: "double_value"
        in: "query"
        required: false
        type: "number"
        format: "double"
        x-exportParamName: "DoubleValue"
        x-optionalDataType: "Float64"
      - name: "int64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Int64Value"
        x-optionalDataType: "String"
      - name: "uint64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Uint64Value"
        x-optionalDataType: "String"
      - name: "int32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Int32Value"
        x-optionalDataType: "Int32"
      - name: "fixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Fixed64Value"
        x-optionalDataType: "String"
      - name: "fixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Fixed32Value"
        x-optionalDataType: "Int64"
      - name: "bool_value"
        in: "query"
        required: false
        type: "boolean"
        x-exportParamName: "BoolValue"
        x-optionalDataType: "Bool"
      - name: "string_value"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "StringValue"
        x-optionalDataType: "String"
      - name: "bytes_value"
        in: "query"
        required: false
        type: "string"
        format: "byte"
        x-exportParamName: "BytesValue"
        x-optionalDataType: "String"
      - name: "uint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Uint32Value"
        x-optionalDataType: "Int64"
      - name: "enum_value"
        in: "query"
        description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValue"
        x-optionalDataType: "String"
      - name: "path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "ABC"
        enum:
        - "ABC"
        - "DEF"
        x-exportParamName: "PathEnumValue"
        x-optionalDataType: "String"
      - name: "nested_path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "GHI"
        enum:
        - "GHI"
        - "JKL"
        x-exportParamName: "NestedPathEnumValue"
        x-optionalDataType: "String"
      - name: "sfixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sfixed32Value"
        x-optionalDataType: "Int32"
      - name: "sfixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sfixed64Value"
        x-optionalDataType: "String"
      - name: "sint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sint32Value"
        x-optionalDataType: "Int32"
      - name: "sint64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sint64Value"
        x-optionalDataType: "String"
      - name: "repeated_string_value"
        in: "query"
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringValue"
      - name: "oneof_string"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "OneofString"
        x-optionalDataType: "String"
      - name: "nonConventionalNameValue"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "NonConventionalNameValue"
        x-optionalDataType: "String"
      - name: "timestamp_value"
        in: "query"
        required: false
        type: "string"
        format: "date-time"
        x-exportParamName: "TimestampValue"
        x-optionalDataType: "Time"
      - name: "repeated_enum_value"
        in: "query"
        description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
          \ ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumValue"
      - name: "repeated_enum_annotation"
        in: "query"
        description: "Repeated numeric enum title. Repeated numeric enum description.\n\
          \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumAnnotation"
      - name: "enum_value_annotation"
        in: "query"
        description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
          \ means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValueAnnotation"
        x-optionalDataType: "String"
      - name: "repeated_string_annotation"
        in: "query"
        description: "Repeated string title. Repeated string description."
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringAnnotation"
      - name: "nested_annotation.amount"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "NestedAnnotationAmount"
        x-optionalDataType: "Int64"
      - name: "nested_annotation.ok"
        in: "query"
        description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
          \ TRUE is true."
        required: false
        type: "string"
        default: "FALSE"
        enum:
        - "FALSE"
        - "TRUE"
        x-exportParamName: "NestedAnnotationOk"
        x-optionalDataType: "String"
      - name: "int64_override_type"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Int64OverrideType"
        x-optionalDataType: "Int64"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverything"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v1/example/a_bit_of_everything/params/post/{string_value}:
    post:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_CheckPostQueryParams"
      parameters:
      - name: "string_value"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "StringValue"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/ABitOfEverythingNested"
        x-exportParamName: "Body"
      - name: "uuid"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "Uuid"
        x-optionalDataType: "String"
      - name: "float_value"
        in: "query"
        description: "Float value field"
        required: true
        type: "number"
        default: 0.2
        format: "float"
        x-exportParamName: "FloatValue"
      - name: "double_value"
        in: "query"
        required: false
        type: "number"
        format: "double"
        x-exportParamName: "DoubleValue"
        x-optionalDataType: "Float64"
      - name: "int64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Int64Value"
        x-optionalDataType: "String"
      - name: "uint64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Uint64Value"
        x-optionalDataType: "String"
      - name: "int32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Int32Value"
        x-optionalDataType: "Int32"
      - name: "fixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Fixed64Value"
        x-optionalDataType: "String"
      - name: "fixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Fixed32Value"
        x-optionalDataType: "Int64"
      - name: "bool_value"
        in: "query"
        required: false
        type: "boolean"
        x-exportParamName: "BoolValue"
        x-optionalDataType: "Bool"
      - name: "bytes_value"
        in: "query"
        required: false
        type: "string"
        format: "byte"
        x-exportParamName: "BytesValue"
        x-optionalDataType: "String"
      - name: "uint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Uint32Value"
        x-optionalDataType: "Int64"
      - name: "enum_value"
        in: "query"
        description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValue"
        x-optionalDataType: "String"
      - name: "path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "ABC"
        enum:
        - "ABC"
        - "DEF"
        x-exportParamName: "PathEnumValue"
        x-optionalDataType: "String"
      - name: "nested_path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "GHI"
        enum:
        - "GHI"
        - "JKL"
        x-exportParamName: "NestedPathEnumValue"
        x-optionalDataType: "String"
      - name: "sfixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sfixed32Value"
        x-optionalDataType: "Int32"
      - name: "sfixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sfixed64Value"
        x-optionalDataType: "String"
      - name: "sint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sint32Value"
        x-optionalDataType: "Int32"
      - name: "sint64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sint64Value"
        x-optionalDataType: "String"
      - name: "repeated_string_value"
        in: "query"
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringValue"
      - name: "oneof_string"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "OneofString"
        x-optionalDataType: "String"
      - name: "nonConventionalNameValue"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "NonConventionalNameValue"
        x-optionalDataType: "String"
      - name: "timestamp_value"
        in: "query"
        required: false
        type: "string"
        format: "date-time"
        x-exportParamName: "TimestampValue"
        x-optionalDataType: "Time"
      - name: "repeated_enum_value"
        in: "query"
        description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
          \ ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumValue"
      - name: "repeated_enum_annotation"
        in: "query"
        description: "Repeated numeric enum title. Repeated numeric enum description.\n\
          \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumAnnotation"
      - name: "enum_value_annotation"
        in: "query"
        description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
          \ means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValueAnnotation"
        x-optionalDataType: "String"
      - name: "repeated_string_annotation"
        in: "query"
        description: "Repeated string title. Repeated string description."
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringAnnotation"
      - name: "nested_annotation.name"
        in: "query"
        description: "name is nested field."
        required: false
        type: "string"
        x-exportParamName: "NestedAnnotationName"
        x-optionalDataType: "String"
      - name: "nested_annotation.amount"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "NestedAnnotationAmount"
        x-optionalDataType: "Int64"
      - name: "nested_annotation.ok"
        in: "query"
        description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
          \ TRUE is true."
        required: false
        type: "string"
        default: "FALSE"
        enum:
        - "FALSE"
        - "TRUE"
        x-exportParamName: "NestedAnnotationOk"
        x-optionalDataType: "String"
      - name: "int64_override_type"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Int64OverrideType"
        x-optionalDataType: "Int64"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverything"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v1/example/a_bit_of_everything/query/{uuid}:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_GetQuery"
      parameters:
      - name: "uuid"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "Uuid"
      - name: "single_nested.name"
        in: "query"
        description: "name is nested field."
        required: false
        type: "string"
        x-exportParamName: "SingleNestedName"
        x-optionalDataType: "String"
      - name: "single_nested.amount"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "SingleNestedAmount"
        x-optionalDataType: "Int64"
      - name: "single_nested.ok"
        in: "query"
        description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
          \ TRUE is true."
        required: false
        type: "string"
        default: "FALSE"
        enum:
        - "FALSE"
        - "TRUE"
        x-exportParamName: "SingleNestedOk"
        x-optionalDataType: "String"
      - name: "float_value"
        in: "query"
        description: "Float value field"
        required: true
        type: "number"
        default: 0.2
        format: "float"
        x-exportParamName: "FloatValue"
      - name: "double_value"
        in: "query"
        required: false
        type: "number"
        format: "double"
        x-exportParamName: "DoubleValue"
        x-optionalDataType: "Float64"
      - name: "int64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Int64Value"
        x-optionalDataType: "String"
      - name: "uint64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Uint64Value"
        x-optionalDataType: "String"
      - name: "int32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Int32Value"
        x-optionalDataType: "Int32"
      - name: "fixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "uint64"
        x-exportParamName: "Fixed64Value"
        x-optionalDataType: "String"
      - name: "fixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Fixed32Value"
        x-optionalDataType: "Int64"
      - name: "bool_value"
        in: "query"
        required: false
        type: "boolean"
        x-exportParamName: "BoolValue"
        x-optionalDataType: "Bool"
      - name: "string_value"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "StringValue"
        x-optionalDataType: "String"
      - name: "bytes_value"
        in: "query"
        required: false
        type: "string"
        format: "byte"
        x-exportParamName: "BytesValue"
        x-optionalDataType: "String"
      - name: "uint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Uint32Value"
        x-optionalDataType: "Int64"
      - name: "enum_value"
        in: "query"
        description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValue"
        x-optionalDataType: "String"
      - name: "path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "ABC"
        enum:
        - "ABC"
        - "DEF"
        x-exportParamName: "PathEnumValue"
        x-optionalDataType: "String"
      - name: "nested_path_enum_value"
        in: "query"
        required: false
        type: "string"
        default: "GHI"
        enum:
        - "GHI"
        - "JKL"
        x-exportParamName: "NestedPathEnumValue"
        x-optionalDataType: "String"
      - name: "sfixed32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sfixed32Value"
        x-optionalDataType: "Int32"
      - name: "sfixed64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sfixed64Value"
        x-optionalDataType: "String"
      - name: "sint32_value"
        in: "query"
        required: false
        type: "integer"
        format: "int32"
        x-exportParamName: "Sint32Value"
        x-optionalDataType: "Int32"
      - name: "sint64_value"
        in: "query"
        required: false
        type: "string"
        format: "int64"
        x-exportParamName: "Sint64Value"
        x-optionalDataType: "String"
      - name: "repeated_string_value"
        in: "query"
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringValue"
      - name: "oneof_string"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "OneofString"
        x-optionalDataType: "String"
      - name: "nonConventionalNameValue"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "NonConventionalNameValue"
        x-optionalDataType: "String"
      - name: "timestamp_value"
        in: "query"
        required: false
        type: "string"
        format: "date-time"
        x-exportParamName: "TimestampValue"
        x-optionalDataType: "Time"
      - name: "repeated_enum_value"
        in: "query"
        description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
          \ ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumValue"
      - name: "repeated_enum_annotation"
        in: "query"
        description: "Repeated numeric enum title. Repeated numeric enum description.\n\
          \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
        required: false
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedEnumAnnotation"
      - name: "enum_value_annotation"
        in: "query"
        description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
          \ means 0\n - ONE: ONE means 1"
        required: false
        type: "string"
        default: "ZERO"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValueAnnotation"
        x-optionalDataType: "String"
      - name: "repeated_string_annotation"
        in: "query"
        description: "Repeated string title. Repeated string description."
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "RepeatedStringAnnotation"
      - name: "nested_annotation.name"
        in: "query"
        description: "name is nested field."
        required: false
        type: "string"
        x-exportParamName: "NestedAnnotationName"
        x-optionalDataType: "String"
      - name: "nested_annotation.amount"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "NestedAnnotationAmount"
        x-optionalDataType: "Int64"
      - name: "nested_annotation.ok"
        in: "query"
        description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
          \ TRUE is true."
        required: false
        type: "string"
        default: "FALSE"
        enum:
        - "FALSE"
        - "TRUE"
        x-exportParamName: "NestedAnnotationOk"
        x-optionalDataType: "String"
      - name: "int64_override_type"
        in: "query"
        required: false
        type: "integer"
        format: "int64"
        x-exportParamName: "Int64OverrideType"
        x-optionalDataType: "Int64"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
      security: []
      externalDocs:
        description: "Find out more about GetQuery"
        url: "https://github.com/grpc-ecosystem/grpc-gateway"
      deprecated: true
  ? /v1/example/a_bit_of_everything/{float_value}/{double_value}/{int64_value}/separator/{uint64_value}/{int32_value}/{fixed64_value}/{fixed32_value}/{bool_value}/{string_value}/{uint32_value}/{sfixed32_value}/{sfixed64_value}/{sint32_value}/{sint64_value}/{nonConventionalNameValue}/{enum_value}/{path_enum_value}/{nested_path_enum_value}/{enum_value_annotation}
  : post:
      tags:
      - "ABitOfEverythingService"
      summary: "Create a new ABitOfEverything"
      description: "This API creates a new ABitOfEverything"
      operationId: "ABitOfEverythingService_Create"
      parameters:
      - name: "float_value"
        in: "path"
        description: "Float value field"
        required: true
        type: "number"
        default: 0.2
        format: "float"
        x-exportParamName: "FloatValue"
      - name: "double_value"
        in: "path"
        required: true
        type: "number"
        format: "double"
        x-exportParamName: "DoubleValue"
      - name: "int64_value"
        in: "path"
        required: true
        type: "string"
        format: "int64"
        x-exportParamName: "Int64Value"
      - name: "uint64_value"
        in: "path"
        required: true
        type: "string"
        format: "uint64"
        x-exportParamName: "Uint64Value"
      - name: "int32_value"
        in: "path"
        required: true
        type: "integer"
        format: "int32"
        x-exportParamName: "Int32Value"
      - name: "fixed64_value"
        in: "path"
        required: true
        type: "string"
        format: "uint64"
        x-exportParamName: "Fixed64Value"
      - name: "fixed32_value"
        in: "path"
        required: true
        type: "integer"
        format: "int64"
        x-exportParamName: "Fixed32Value"
      - name: "bool_value"
        in: "path"
        required: true
        type: "boolean"
        x-exportParamName: "BoolValue"
      - name: "string_value"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "StringValue"
      - name: "uint32_value"
        in: "path"
        required: true
        type: "integer"
        format: "int64"
        x-exportParamName: "Uint32Value"
      - name: "sfixed32_value"
        in: "path"
        required: true
        type: "integer"
        format: "int32"
        x-exportParamName: "Sfixed32Value"
      - name: "sfixed64_value"
        in: "path"
        required: true
        type: "string"
        format: "int64"
        x-exportParamName: "Sfixed64Value"
      - name: "sint32_value"
        in: "path"
        required: true
        type: "integer"
        format: "int32"
        x-exportParamName: "Sint32Value"
      - name: "sint64_value"
        in: "path"
        required: true
        type: "string"
        format: "int64"
        x-exportParamName: "Sint64Value"
      - name: "nonConventionalNameValue"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "NonConventionalNameValue"
      - name: "enum_value"
        in: "path"
        required: true
        type: "string"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValue"
      - name: "path_enum_value"
        in: "path"
        required: true
        type: "string"
        enum:
        - "ABC"
        - "DEF"
        x-exportParamName: "PathEnumValue"
      - name: "nested_path_enum_value"
        in: "path"
        required: true
        type: "string"
        enum:
        - "GHI"
        - "JKL"
        x-exportParamName: "NestedPathEnumValue"
      - name: "enum_value_annotation"
        in: "path"
        description: "Numeric enum description."
        required: true
        type: "string"
        enum:
        - "ZERO"
        - "ONE"
        x-exportParamName: "EnumValueAnnotation"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverything"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v1/example/a_bit_of_everything/{single_nested.name}:
    post:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_DeepPathEcho"
      parameters:
      - name: "single_nested.name"
        in: "path"
        description: "name is nested field."
        required: true
        type: "string"
        x-exportParamName: "SingleNestedName"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbABitOfEverything"
        x-exportParamName: "Body"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverything"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v1/example/a_bit_of_everything/{uuid}:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_Lookup"
      parameters:
      - name: "uuid"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "Uuid"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverything"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
    put:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_Update"
      parameters:
      - name: "uuid"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "Uuid"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbABitOfEverything"
        x-exportParamName: "Body"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
    delete:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_Delete"
      parameters:
      - name: "uuid"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "Uuid"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
      security:
      - ApiKeyAuth: []
        OAuth2:
        - "read"
        - "write"
      x-irreversible: true
  ? /v1/example/a_bit_of_everything_repeated/{path_repeated_float_value}/{path_repeated_double_value}/{path_repeated_int64_value}/{path_repeated_uint64_value}/{path_repeated_int32_value}/{path_repeated_fixed64_value}/{path_repeated_fixed32_value}/{path_repeated_bool_value}/{path_repeated_string_value}/{path_repeated_bytes_value}/{path_repeated_uint32_value}/{path_repeated_enum_value}/{path_repeated_sfixed32_value}/{path_repeated_sfixed64_value}/{path_repeated_sint32_value}/{path_repeated_sint64_value}
  : get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_GetRepeatedQuery"
      parameters:
      - name: "path_repeated_float_value"
        in: "path"
        description: "repeated values. they are comma-separated in path"
        required: true
        type: "array"
        items:
          type: "number"
          format: "float"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedFloatValue"
      - name: "path_repeated_double_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "number"
          format: "double"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedDoubleValue"
      - name: "path_repeated_int64_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
          format: "int64"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedInt64Value"
      - name: "path_repeated_uint64_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
          format: "uint64"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedUint64Value"
      - name: "path_repeated_int32_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "integer"
          format: "int32"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedInt32Value"
      - name: "path_repeated_fixed64_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
          format: "uint64"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedFixed64Value"
      - name: "path_repeated_fixed32_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "integer"
          format: "int64"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedFixed32Value"
      - name: "path_repeated_bool_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "boolean"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedBoolValue"
      - name: "path_repeated_string_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedStringValue"
      - name: "path_repeated_bytes_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
          format: "byte"
          pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedBytesValue"
      - name: "path_repeated_uint32_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "integer"
          format: "int64"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedUint32Value"
      - name: "path_repeated_enum_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
          enum:
          - "ZERO"
          - "ONE"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedEnumValue"
      - name: "path_repeated_sfixed32_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "integer"
          format: "int32"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedSfixed32Value"
      - name: "path_repeated_sfixed64_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
          format: "int64"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedSfixed64Value"
      - name: "path_repeated_sint32_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "integer"
          format: "int32"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedSint32Value"
      - name: "path_repeated_sint64_value"
        in: "path"
        required: true
        type: "array"
        items:
          type: "string"
          format: "int64"
        collectionFormat: "csv"
        minItems: 1
        x-exportParamName: "PathRepeatedSint64Value"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbABitOfEverythingRepeated"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v1/{parent=publishers/*}/books:
    post:
      tags:
      - "ABitOfEverythingService"
      summary: "Create a book."
      operationId: "ABitOfEverythingService_CreateBook"
      parameters:
      - name: "parent"
        in: "path"
        description: "The publisher in which to create the book.\n\nFormat: `publishers/{publisher}`\n\
          \nExample: `publishers/1257894000000000000`"
        required: true
        type: "string"
        x-exportParamName: "Parent"
      - in: "body"
        name: "body"
        description: "The book to create."
        required: true
        schema:
          $ref: "#/definitions/examplepbBook"
        x-exportParamName: "Body"
      - name: "book_id"
        in: "query"
        description: "The ID to use for the book.\n\nThis must start with an alphanumeric\
          \ character."
        required: false
        type: "string"
        x-exportParamName: "BookId"
        x-optionalDataType: "String"
      responses:
        200:
          description: "A successful response."
          schema:
            $ref: "#/definitions/examplepbBook"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/example/a_bit_of_everything/{abe.uuid}:
    put:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_UpdateV2"
      parameters:
      - name: "abe.uuid"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "AbeUuid"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbABitOfEverything"
        x-exportParamName: "Body"
      - name: "update_mask.paths"
        in: "query"
        description: "The set of field mask paths."
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "UpdateMaskPaths"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
    patch:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_UpdateV22"
      parameters:
      - name: "abe.uuid"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "AbeUuid"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbABitOfEverything"
        x-exportParamName: "Body"
      - name: "update_mask.paths"
        in: "query"
        description: "The set of field mask paths."
        required: false
        type: "array"
        items:
          type: "string"
        collectionFormat: "multi"
        x-exportParamName: "UpdateMaskPaths"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/example/echo:
    get:
      tags:
      - "echo rpc"
      summary: "Summary: Echo rpc"
      description: "Description Echo"
      operationId: "ABitOfEverythingService_Echo3"
      parameters:
      - name: "value"
        in: "query"
        required: false
        type: "string"
        x-exportParamName: "Value"
        x-optionalDataType: "String"
      responses:
        200:
          description: "A successful response."
          examples:
            application/json:
              value: "the input value"
          schema:
            $ref: "#/definitions/subStringMessage"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "integer"
            format: "integer"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        503:
          description: "Returned when the resource is temporarily unavailable."
          schema: {}
          x-number: 100
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
      externalDocs:
        description: "Find out more Echo"
        url: "https://github.com/grpc-ecosystem/grpc-gateway"
    post:
      tags:
      - "echo rpc"
      summary: "Summary: Echo rpc"
      description: "Description Echo"
      operationId: "ABitOfEverythingService_Echo2"
      parameters:
      - in: "body"
        name: "body"
        required: true
        schema:
          type: "string"
        x-exportParamName: "Body"
      responses:
        200:
          description: "A successful response."
          examples:
            application/json:
              value: "the input value"
          schema:
            $ref: "#/definitions/subStringMessage"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "integer"
            format: "integer"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        503:
          description: "Returned when the resource is temporarily unavailable."
          schema: {}
          x-number: 100
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
      externalDocs:
        description: "Find out more Echo"
        url: "https://github.com/grpc-ecosystem/grpc-gateway"
  /v2/example/empty:
    get:
      tags:
      - "camelCaseServiceName"
      operationId: "camelCaseServiceName_Empty"
      parameters: []
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/example/errorwithdetails:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_ErrorWithDetails"
      parameters: []
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/example/overwriteresponsecontenttype:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_OverwriteResponseContentType"
      produces:
      - "application/text"
      parameters: []
      responses:
        200:
          description: "A successful response."
          schema:
            type: "string"
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/example/postwithemptybody/{name}:
    post:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_PostWithEmptyBody"
      parameters:
      - name: "name"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "Name"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbBody"
        x-exportParamName: "Body"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/example/timeout:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_Timeout"
      parameters: []
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/example/withbody/{id}:
    post:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_GetMessageWithBody"
      parameters:
      - name: "id"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "Id"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbBody"
        x-exportParamName: "Body"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2/{value}:check:
    get:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_CheckExternalNestedPathEnum"
      parameters:
      - name: "value"
        in: "path"
        required: true
        type: "string"
        enum:
        - "GHI"
        - "JKL"
        x-exportParamName: "Value"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
  /v2a/example/a_bit_of_everything/{abe.uuid}:
    patch:
      tags:
      - "ABitOfEverythingService"
      operationId: "ABitOfEverythingService_UpdateV23"
      parameters:
      - name: "abe.uuid"
        in: "path"
        required: true
        type: "string"
        x-exportParamName: "AbeUuid"
      - in: "body"
        name: "body"
        required: true
        schema:
          $ref: "#/definitions/examplepbUpdateV2Request"
        x-exportParamName: "Body"
      responses:
        200:
          description: "A successful response."
          schema: {}
        403:
          description: "Returned when the user does not have permission to access\
            \ the resource."
          schema: {}
        404:
          description: "Returned when the resource does not exist."
          schema:
            type: "string"
            format: "string"
        418:
          description: "I'm a teapot."
          schema:
            $ref: "#/definitions/examplepbNumericEnum"
        500:
          description: "Server error"
          schema:
            $ref: "#/definitions/examplepbErrorResponse"
        default:
          description: "An unexpected error response."
          schema:
            $ref: "#/definitions/runtimeError"
securityDefinitions:
  ApiKeyAuth:
    type: "apiKey"
    name: "X-API-Key"
    in: "header"
    x-amazon-apigateway-authorizer:
      authorizerResultTtlInSeconds: 60
      type: "token"
    x-amazon-apigateway-authtype: "oauth2"
  BasicAuth:
    type: "basic"
  OAuth2:
    type: "oauth2"
    authorizationUrl: "https://example.com/oauth/authorize"
    tokenUrl: "https://example.com/oauth/token"
    flow: "accessCode"
    scopes:
      admin: "Grants read and write access to administrative information"
      read: "Grants read access"
      write: "Grants write access"
definitions:
  ABitOfEverythingNested:
    type: "object"
    properties:
      name:
        type: "string"
        description: "name is nested field."
      amount:
        type: "integer"
        format: "int64"
      ok:
        description: "DeepEnum description."
        $ref: "#/definitions/NestedDeepEnum"
    description: "Nested is nested type."
    example:
      ok: "TRUE"
  MessagePathEnumNestedPathEnum:
    type: "string"
    enum:
    - "GHI"
    - "JKL"
    default: "GHI"
  NestedDeepEnum:
    type: "string"
    description: "DeepEnum is one or zero.\n\n - FALSE: FALSE is false.\n - TRUE:\
      \ TRUE is true."
    enum:
    - "FALSE"
    - "TRUE"
    default: "FALSE"
  examplepbABitOfEverything:
    type: "object"
    required:
    - "double_value"
    - "int64_value"
    - "uuid"
    properties:
      single_nested:
        $ref: "#/definitions/ABitOfEverythingNested"
      uuid:
        type: "string"
        minLength: 1
        pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
      nested:
        type: "array"
        items:
          $ref: "#/definitions/ABitOfEverythingNested"
      float_value:
        type: "number"
        format: "float"
        description: "Float value field"
        default: 0.2
      double_value:
        type: "number"
        format: "double"
      int64_value:
        type: "string"
        format: "int64"
      uint64_value:
        type: "string"
        format: "uint64"
      int32_value:
        type: "integer"
        format: "int32"
      fixed64_value:
        type: "string"
        format: "uint64"
      fixed32_value:
        type: "integer"
        format: "int64"
      bool_value:
        type: "boolean"
      string_value:
        type: "string"
      bytes_value:
        type: "string"
        format: "byte"
        pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
      uint32_value:
        type: "integer"
        format: "int64"
      enum_value:
        $ref: "#/definitions/examplepbNumericEnum"
      path_enum_value:
        $ref: "#/definitions/pathenumPathEnum"
      nested_path_enum_value:
        $ref: "#/definitions/MessagePathEnumNestedPathEnum"
      sfixed32_value:
        type: "integer"
        format: "int32"
      sfixed64_value:
        type: "string"
        format: "int64"
      sint32_value:
        type: "integer"
        format: "int32"
      sint64_value:
        type: "string"
        format: "int64"
      repeated_string_value:
        type: "array"
        items:
          type: "string"
      oneof_empty:
        type: "object"
        properties: {}
      oneof_string:
        type: "string"
      map_value:
        type: "object"
        additionalProperties:
          $ref: "#/definitions/examplepbNumericEnum"
      mapped_string_value:
        type: "object"
        additionalProperties:
          type: "string"
      mapped_nested_value:
        type: "object"
        additionalProperties:
          $ref: "#/definitions/ABitOfEverythingNested"
      nonConventionalNameValue:
        type: "string"
      timestamp_value:
        type: "string"
        format: "date-time"
      repeated_enum_value:
        type: "array"
        title: "repeated enum value. it is comma-separated in query"
        items:
          $ref: "#/definitions/examplepbNumericEnum"
      repeated_enum_annotation:
        type: "array"
        description: "Repeated numeric enum description."
        title: "Repeated numeric enum title"
        items:
          $ref: "#/definitions/examplepbNumericEnum"
      enum_value_annotation:
        description: "Numeric enum description."
        title: "Numeric enum title"
        $ref: "#/definitions/examplepbNumericEnum"
      repeated_string_annotation:
        type: "array"
        description: "Repeated string description."
        title: "Repeated string title"
        items:
          type: "string"
      repeated_nested_annotation:
        type: "array"
        description: "Repeated nested object description."
        title: "Repeated nested object title"
        items:
          $ref: "#/definitions/ABitOfEverythingNested"
      nested_annotation:
        description: "Nested object description."
        title: "Nested object title"
        $ref: "#/definitions/ABitOfEverythingNested"
      int64_override_type:
        type: "integer"
        format: "int64"
    externalDocs:
      description: "Find out more about ABitOfEverything"
      url: "https://github.com/grpc-ecosystem/grpc-gateway"
    title: "A bit of everything"
    description: "Intentionaly complicated message type to cover many features of\
      \ Protobuf."
    example:
      uuid: "0cf361e1-4b44-483d-a159-54dabdf7e814"
  examplepbABitOfEverythingRepeated:
    type: "object"
    properties:
      path_repeated_float_value:
        type: "array"
        title: "repeated values. they are comma-separated in path"
        items:
          type: "number"
          format: "float"
      path_repeated_double_value:
        type: "array"
        items:
          type: "number"
          format: "double"
      path_repeated_int64_value:
        type: "array"
        items:
          type: "string"
          format: "int64"
      path_repeated_uint64_value:
        type: "array"
        items:
          type: "string"
          format: "uint64"
      path_repeated_int32_value:
        type: "array"
        items:
          type: "integer"
          format: "int32"
      path_repeated_fixed64_value:
        type: "array"
        items:
          type: "string"
          format: "uint64"
      path_repeated_fixed32_value:
        type: "array"
        items:
          type: "integer"
          format: "int64"
      path_repeated_bool_value:
        type: "array"
        items:
          type: "boolean"
      path_repeated_string_value:
        type: "array"
        items:
          type: "string"
      path_repeated_bytes_value:
        type: "array"
        items:
          type: "string"
          format: "byte"
          pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
      path_repeated_uint32_value:
        type: "array"
        items:
          type: "integer"
          format: "int64"
      path_repeated_enum_value:
        type: "array"
        items:
          $ref: "#/definitions/examplepbNumericEnum"
      path_repeated_sfixed32_value:
        type: "array"
        items:
          type: "integer"
          format: "int32"
      path_repeated_sfixed64_value:
        type: "array"
        items:
          type: "string"
          format: "int64"
      path_repeated_sint32_value:
        type: "array"
        items:
          type: "integer"
          format: "int32"
      path_repeated_sint64_value:
        type: "array"
        items:
          type: "string"
          format: "int64"
    title: "ABitOfEverythingRepeated is used to validate repeated path parameter functionality"
    example:
      path_repeated_bool_value:
      - true
      - true
      - false
      - true
      path_repeated_int32_value:
      - 1
      - 2
      - 3
  examplepbBody:
    type: "object"
    properties:
      name:
        type: "string"
  examplepbBook:
    type: "object"
    properties:
      name:
        type: "string"
        description: "The resource name of the book.\n\nFormat: `publishers/{publisher}/books/{book}`\n\
          \nExample: `publishers/1257894000000000000/books/my-book`"
      id:
        type: "string"
        description: "Output only. The book's ID."
        readOnly: true
      create_time:
        type: "string"
        format: "date-time"
        description: "Output only. Creation time of the book."
        readOnly: true
    description: "An example resource type from AIP-123 used to test the behavior\
      \ described in\nthe CreateBookRequest message.\n\nSee: https://google.aip.dev/123"
    example:
      create_time: "2000-01-23T04:56:07.000+00:00"
      name: "name"
      id: "id"
  examplepbErrorObject:
    type: "object"
    properties:
      code:
        type: "integer"
        format: "integer"
        description: "Response code"
        title: "code"
      message:
        type: "string"
        description: "Response message"
        title: "message"
        pattern: "^[a-zA-Z0-9]{1, 32}$"
  examplepbErrorResponse:
    type: "object"
    properties:
      correlationId:
        type: "string"
        format: "uuid"
        example: "2438ac3c-37eb-4902-adef-ed16b4431030"
        description: "Unique event identifier for server requests"
        title: "x-correlation-id"
        pattern: "^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$"
      error:
        $ref: "#/definitions/examplepbErrorObject"
  examplepbNumericEnum:
    type: "string"
    description: "NumericEnum is one or zero.\n\n - ZERO: ZERO means 0\n - ONE: ONE\
      \ means 1"
    enum:
    - "ZERO"
    - "ONE"
    default: "ZERO"
  examplepbUpdateV2Request:
    type: "object"
    properties:
      abe:
        $ref: "#/definitions/examplepbABitOfEverything"
      update_mask:
        $ref: "#/definitions/protobufFieldMask"
    title: "UpdateV2Request request for update includes the message and the update\
      \ mask"
  pathenumPathEnum:
    type: "string"
    enum:
    - "ABC"
    - "DEF"
    default: "ABC"
  protobufAny:
    type: "object"
    properties:
      type_url:
        type: "string"
        description: "A URL/resource name that uniquely identifies the type of the\
          \ serialized\nprotocol buffer message. This string must contain at least\n\
          one \"/\" character. The last segment of the URL's path must represent\n\
          the fully qualified name of the type (as in\n`path/google.protobuf.Duration`).\
          \ The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\
          \nIn practice, teams usually precompile into the binary all types that they\n\
          expect it to use in the context of Any. However, for URLs which use the\n\
          scheme `http`, `https`, or no scheme, one can optionally set up a type\n\
          server that maps type URLs to message definitions as follows:\n\n* If no\
          \ scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must\
          \ yield a [google.protobuf.Type][]\n  value in binary format, or produce\
          \ an error.\n* Applications are allowed to cache lookup results based on\
          \ the\n  URL, or have them precompiled into a binary to avoid any\n  lookup.\
          \ Therefore, binary compatibility needs to be preserved\n  on changes to\
          \ types. (Use versioned type names to manage\n  breaking changes.)\n\nNote:\
          \ this functionality is not currently available in the official\nprotobuf\
          \ release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\
          \nSchemes other than `http`, `https` (or the empty scheme) might be\nused\
          \ with implementation specific semantics."
      value:
        type: "string"
        format: "byte"
        description: "Must be a valid serialized protocol buffer of the above specified\
          \ type."
        pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
    description: "`Any` contains an arbitrary serialized protocol buffer message along\
      \ with a\nURL that describes the type of the serialized message.\n\nProtobuf\
      \ library provides support to pack/unpack Any values in the form\nof utility\
      \ functions or additional generated methods of the Any type.\n\nExample 1: Pack\
      \ and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n\
      \    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack\
      \ and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n\
      \    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n\
      \    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n\
      \    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n\
      \      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in\
      \ Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n\
      \     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo);\
      \ err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf\
      \ library will by default use\n'type.googleapis.com/full.type.name' as the type\
      \ URL and the unpack\nmethods only use the fully qualified type name after the\
      \ last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\n\
      name \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses\
      \ the regular\nrepresentation of the deserialized, embedded message, with an\n\
      additional field `@type` which contains the type URL. Example:\n\n    package\
      \ google.profile;\n    message Person {\n      string first_name = 1;\n    \
      \  string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\"\
      ,\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf\
      \ the embedded message type is well-known and has a custom JSON\nrepresentation,\
      \ that representation will be embedded adding a field\n`value` which holds the\
      \ custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\
      \n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n\
      \      \"value\": \"1.212s\"\n    }"
  protobufFieldMask:
    type: "object"
    properties:
      paths:
        type: "array"
        description: "The set of field mask paths."
        items:
          type: "string"
    title: "`FieldMask` represents a set of symbolic field paths, for example:"
    description: "paths: \"f.a\"\n    paths: \"f.b.d\"\n\nHere `f` represents a field\
      \ in some root message, `a` and `b`\nfields in the message found in `f`, and\
      \ `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify\
      \ a subset of fields that should be\nreturned by a get operation or modified\
      \ by an update operation.\nField masks also have a custom JSON encoding (see\
      \ below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection,\
      \ a response message or\nsub-message is filtered by the API to only contain\
      \ those fields as\nspecified in the mask. For example, if the mask in the previous\n\
      example is applied to a response message as follows:\n\n    f {\n      a : 22\n\
      \      b {\n        d : 1\n        x : 2\n      }\n      y : 13\n    }\n   \
      \ z: 8\n\nThe result will not contain specific values for fields x,y and z\n\
      (their value will be set to the default, and omitted in proto text\noutput):\n\
      \n\n    f {\n      a : 22\n      b {\n        d : 1\n      }\n    }\n\nA repeated\
      \ field is not allowed except at the last position of a\npaths string.\n\nIf\
      \ a FieldMask object is not present in a get operation, the\noperation applies\
      \ to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote\
      \ that a field mask does not necessarily apply to the\ntop-level response message.\
      \ In case of a REST get operation, the\nfield mask applies directly to the response,\
      \ but in case of a REST\nlist operation, the mask instead applies to each individual\
      \ message\nin the returned resource list. In case of a REST custom method,\n\
      other definitions may be used. Where the mask applies will be\nclearly documented\
      \ together with its declaration in the API.  In\nany case, the effect on the\
      \ returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks\
      \ in Update Operations\n\nA field mask in update operations specifies which\
      \ fields of the\ntargeted resource are going to be updated. The API is required\n\
      to only change the values of the fields as specified in the mask\nand leave\
      \ the others untouched. If a resource is passed in to\ndescribe the updated\
      \ values, the API ignores the values of all\nfields not covered by the mask.\n\
      \nIf a repeated field is specified for an update operation, new values will\n\
      be appended to the existing repeated field in the target resource. Note that\n\
      a repeated field is only allowed in the last position of a `paths` string.\n\
      \nIf a sub-message is specified in the last position of the field mask for an\n\
      update operation, then new value will be merged into the existing sub-message\n\
      in the target resource.\n\nFor example, given the target message:\n\n    f {\n\
      \      b {\n        d: 1\n        x: 2\n      }\n      c: [1]\n    }\n\nAnd\
      \ an update message:\n\n    f {\n      b {\n        d: 10\n      }\n      c:\
      \ [2]\n    }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\n\
      then the result will be:\n\n    f {\n      b {\n        d: 10\n        x: 2\n\
      \      }\n      c: [1, 2]\n    }\n\nAn implementation may provide options to\
      \ override this default behavior for\nrepeated and message fields.\n\nIn order\
      \ to reset a field's value to the default, the field must\nbe in the mask and\
      \ set to the default value in the provided resource.\nHence, in order to reset\
      \ all fields of a resource, provide a default\ninstance of the resource and\
      \ set all fields in the mask, or do\nnot provide a mask as described below.\n\
      \nIf a field mask is not present on update, the operation applies to\nall fields\
      \ (as if a field mask of all fields has been specified).\nNote that in the presence\
      \ of schema evolution, this may mean that\nfields the client does not know and\
      \ has therefore not filled into\nthe request will be reset to their default.\
      \ If this is unwanted\nbehavior, a specific service may require a client to\
      \ always specify\na field mask, producing an error if not.\n\nAs with get operations,\
      \ the location of the resource which\ndescribes the updated values in the request\
      \ message depends on the\noperation kind. In any case, the effect of the field\
      \ mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP\
      \ REST\n\nThe HTTP kind of an update operation which uses a field mask must\n\
      be set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must\
      \ only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON,\
      \ a field mask is encoded as a single string where paths are\nseparated by a\
      \ comma. Fields name in each path are converted\nto/from lower-camel naming\
      \ conventions.\n\nAs an example, consider the following message declarations:\n\
      \n    message Profile {\n      User user = 1;\n      Photo photo = 2;\n    }\n\
      \    message User {\n      string display_name = 1;\n      string address =\
      \ 2;\n    }\n\nIn proto a field mask for `Profile` may look as such:\n\n   \
      \ mask {\n      paths: \"user.display_name\"\n      paths: \"photo\"\n    }\n\
      \nIn JSON, the same mask is represented as below:\n\n    {\n      mask: \"user.displayName,photo\"\
      \n    }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs\
      \ just as regular fields. Consider the\nfollowing message:\n\n    message SampleMessage\
      \ {\n      oneof test_oneof {\n        string name = 4;\n        SubMessage\
      \ sub_message = 9;\n      }\n    }\n\nThe field mask can be:\n\n    mask {\n\
      \      paths: \"name\"\n    }\n\nOr:\n\n    mask {\n      paths: \"sub_message\"\
      \n    }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be\
      \ used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any\
      \ API method which has a FieldMask type field in the\nrequest should verify\
      \ the included field paths, and return an\n`INVALID_ARGUMENT` error if any path\
      \ is unmappable."
  runtimeError:
    type: "object"
    properties:
      error:
        type: "string"
      code:
        type: "integer"
        format: "int32"
      message:
        type: "string"
      details:
        type: "array"
        items:
          $ref: "#/definitions/protobufAny"
  subStringMessage:
    type: "object"
    properties:
      value:
        type: "string"
externalDocs:
  description: "More about gRPC-Gateway"
  url: "https://github.com/grpc-ecosystem/grpc-gateway"
x-grpc-gateway-baz-list:
- "one"
- true
x-grpc-gateway-foo: "bar"
