...

Text file src/github.com/grpc-ecosystem/grpc-gateway/v2/examples/internal/proto/examplepb/generate_unbound_methods.swagger.json

Documentation: github.com/grpc-ecosystem/grpc-gateway/v2/examples/internal/proto/examplepb

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

View as plain text