github.com/grpc-ecosystem/grpc-gateway/v2@v2.19.1/examples/internal/proto/examplepb/ignore_comment.swagger.json (about)

     1  {
     2    "swagger": "2.0",
     3    "info": {
     4      "title": "examples/internal/proto/examplepb/ignore_comment.proto",
     5      "version": "version not set"
     6    },
     7    "tags": [
     8      {
     9        "name": "FooService"
    10      }
    11    ],
    12    "consumes": [
    13      "application/json"
    14    ],
    15    "produces": [
    16      "application/json"
    17    ],
    18    "paths": {
    19      "/v1/example/foo": {
    20        "post": {
    21          "operationId": "FooService_Foo",
    22          "responses": {
    23            "200": {
    24              "description": "A successful response.",
    25              "schema": {
    26                "$ref": "#/definitions/examplepbFooReply"
    27              }
    28            },
    29            "default": {
    30              "description": "An unexpected error response.",
    31              "schema": {
    32                "$ref": "#/definitions/rpcStatus"
    33              }
    34            }
    35          },
    36          "parameters": [
    37            {
    38              "name": "body",
    39              "in": "body",
    40              "required": true,
    41              "schema": {
    42                "$ref": "#/definitions/examplepbFooRequest"
    43              }
    44            }
    45          ],
    46          "tags": [
    47            "FooService"
    48          ]
    49        }
    50      }
    51    },
    52    "definitions": {
    53      "examplepbFooReply": {
    54        "type": "object"
    55      },
    56      "examplepbFooRequest": {
    57        "type": "object",
    58        "properties": {
    59          "username": {
    60            "type": "string",
    61            "description": "This annotation should be preserved"
    62          },
    63          "password": {
    64            "type": "string",
    65            "title": "This annotation should be preserved"
    66          }
    67        }
    68      },
    69      "protobufAny": {
    70        "type": "object",
    71        "properties": {
    72          "@type": {
    73            "type": "string"
    74          }
    75        },
    76        "additionalProperties": {}
    77      },
    78      "rpcStatus": {
    79        "type": "object",
    80        "properties": {
    81          "code": {
    82            "type": "integer",
    83            "format": "int32"
    84          },
    85          "message": {
    86            "type": "string"
    87          },
    88          "details": {
    89            "type": "array",
    90            "items": {
    91              "type": "object",
    92              "$ref": "#/definitions/protobufAny"
    93            }
    94          }
    95        }
    96      }
    97    }
    98  }