github.com/grpc-ecosystem/grpc-gateway/v2@v2.19.1/examples/internal/clients/generateunboundmethods/api/swagger.yaml (about)

     1  ---
     2  swagger: "2.0"
     3  info:
     4    description: "Generate Unannotated Methods Echo Service\nSimilar to echo_service.proto\
     5      \ but without annotations and without external configuration.\n\nGenerate Unannotated\
     6      \ Methods Echo Service API consists of a single service which returns\na message."
     7    version: "version not set"
     8    title: "examples/internal/proto/examplepb/generate_unbound_methods.proto"
     9  tags:
    10  - name: "GenerateUnboundMethodsEchoService"
    11  consumes:
    12  - "application/json"
    13  produces:
    14  - "application/json"
    15  paths:
    16    /grpc.gateway.examples.internal.proto.examplepb.GenerateUnboundMethodsEchoService/Echo:
    17      post:
    18        tags:
    19        - "GenerateUnboundMethodsEchoService"
    20        summary: "Echo method receives a simple message and returns it."
    21        description: "The message posted as the id parameter will also be\nreturned."
    22        operationId: "GenerateUnboundMethodsEchoService_Echo"
    23        parameters:
    24        - in: "body"
    25          name: "body"
    26          description: "GenerateUnboundMethodsSimpleMessage represents a simple message\
    27            \ sent to the unannotated GenerateUnboundMethodsEchoService service."
    28          required: true
    29          schema:
    30            $ref: "#/definitions/examplepbGenerateUnboundMethodsSimpleMessage"
    31          x-exportParamName: "Body"
    32        responses:
    33          200:
    34            description: "A successful response."
    35            schema:
    36              $ref: "#/definitions/examplepbGenerateUnboundMethodsSimpleMessage"
    37          default:
    38            description: "An unexpected error response."
    39            schema:
    40              $ref: "#/definitions/rpcStatus"
    41    /grpc.gateway.examples.internal.proto.examplepb.GenerateUnboundMethodsEchoService/EchoBody:
    42      post:
    43        tags:
    44        - "GenerateUnboundMethodsEchoService"
    45        summary: "EchoBody method receives a simple message and returns it."
    46        operationId: "GenerateUnboundMethodsEchoService_EchoBody"
    47        parameters:
    48        - in: "body"
    49          name: "body"
    50          description: "GenerateUnboundMethodsSimpleMessage represents a simple message\
    51            \ sent to the unannotated GenerateUnboundMethodsEchoService service."
    52          required: true
    53          schema:
    54            $ref: "#/definitions/examplepbGenerateUnboundMethodsSimpleMessage"
    55          x-exportParamName: "Body"
    56        responses:
    57          200:
    58            description: "A successful response."
    59            schema:
    60              $ref: "#/definitions/examplepbGenerateUnboundMethodsSimpleMessage"
    61          default:
    62            description: "An unexpected error response."
    63            schema:
    64              $ref: "#/definitions/rpcStatus"
    65    /grpc.gateway.examples.internal.proto.examplepb.GenerateUnboundMethodsEchoService/EchoDelete:
    66      post:
    67        tags:
    68        - "GenerateUnboundMethodsEchoService"
    69        summary: "EchoDelete method receives a simple message and returns it."
    70        operationId: "GenerateUnboundMethodsEchoService_EchoDelete"
    71        parameters:
    72        - in: "body"
    73          name: "body"
    74          description: "GenerateUnboundMethodsSimpleMessage represents a simple message\
    75            \ sent to the unannotated GenerateUnboundMethodsEchoService service."
    76          required: true
    77          schema:
    78            $ref: "#/definitions/examplepbGenerateUnboundMethodsSimpleMessage"
    79          x-exportParamName: "Body"
    80        responses:
    81          200:
    82            description: "A successful response."
    83            schema:
    84              $ref: "#/definitions/examplepbGenerateUnboundMethodsSimpleMessage"
    85          default:
    86            description: "An unexpected error response."
    87            schema:
    88              $ref: "#/definitions/rpcStatus"
    89  definitions:
    90    examplepbGenerateUnboundMethodsSimpleMessage:
    91      type: "object"
    92      properties:
    93        id:
    94          type: "string"
    95          description: "Id represents the message identifier."
    96        num:
    97          type: "string"
    98          format: "int64"
    99        duration:
   100          type: "string"
   101      description: "GenerateUnboundMethodsSimpleMessage represents a simple message\
   102        \ sent to the unannotated GenerateUnboundMethodsEchoService service."
   103      example:
   104        duration: "duration"
   105        num: "num"
   106        id: "id"
   107    protobufAny:
   108      type: "object"
   109      properties:
   110        '@type':
   111          type: "string"
   112      additionalProperties: {}
   113    rpcStatus:
   114      type: "object"
   115      properties:
   116        code:
   117          type: "integer"
   118          format: "int32"
   119        message:
   120          type: "string"
   121        details:
   122          type: "array"
   123          items:
   124            $ref: "#/definitions/protobufAny"