...

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

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

     1{
     2  "swagger": "2.0",
     3  "info": {
     4    "title": "examples/internal/helloworld/helloworld.proto",
     5    "version": "version not set"
     6  },
     7  "tags": [
     8    {
     9      "name": "Greeter"
    10    }
    11  ],
    12  "consumes": [
    13    "application/json"
    14  ],
    15  "produces": [
    16    "application/json"
    17  ],
    18  "paths": {
    19    "/say/boolval/{boolVal}": {
    20      "get": {
    21        "operationId": "Greeter_SayHello5",
    22        "responses": {
    23          "200": {
    24            "description": "A successful response.",
    25            "schema": {
    26              "$ref": "#/definitions/helloworldHelloReply"
    27            }
    28          },
    29          "default": {
    30            "description": "An unexpected error response.",
    31            "schema": {
    32              "$ref": "#/definitions/rpcStatus"
    33            }
    34          }
    35        },
    36        "parameters": [
    37          {
    38            "name": "boolVal",
    39            "in": "path",
    40            "required": true,
    41            "type": "boolean"
    42          },
    43          {
    44            "name": "name",
    45            "in": "query",
    46            "required": false,
    47            "type": "string"
    48          },
    49          {
    50            "name": "strVal",
    51            "in": "query",
    52            "required": false,
    53            "type": "string"
    54          },
    55          {
    56            "name": "floatVal",
    57            "in": "query",
    58            "required": false,
    59            "type": "number",
    60            "format": "float"
    61          },
    62          {
    63            "name": "doubleVal",
    64            "in": "query",
    65            "required": false,
    66            "type": "number",
    67            "format": "double"
    68          },
    69          {
    70            "name": "bytesVal",
    71            "in": "query",
    72            "required": false,
    73            "type": "string",
    74            "format": "byte"
    75          },
    76          {
    77            "name": "int32Val",
    78            "in": "query",
    79            "required": false,
    80            "type": "integer",
    81            "format": "int32"
    82          },
    83          {
    84            "name": "uint32Val",
    85            "in": "query",
    86            "required": false,
    87            "type": "integer",
    88            "format": "int64"
    89          },
    90          {
    91            "name": "int64Val",
    92            "in": "query",
    93            "required": false,
    94            "type": "string",
    95            "format": "int64"
    96          },
    97          {
    98            "name": "uint64Val",
    99            "in": "query",
   100            "required": false,
   101            "type": "string",
   102            "format": "uint64"
   103          }
   104        ],
   105        "tags": [
   106          "Greeter"
   107        ]
   108      }
   109    },
   110    "/say/bytesval/{bytesVal}": {
   111      "get": {
   112        "operationId": "Greeter_SayHello6",
   113        "responses": {
   114          "200": {
   115            "description": "A successful response.",
   116            "schema": {
   117              "$ref": "#/definitions/helloworldHelloReply"
   118            }
   119          },
   120          "default": {
   121            "description": "An unexpected error response.",
   122            "schema": {
   123              "$ref": "#/definitions/rpcStatus"
   124            }
   125          }
   126        },
   127        "parameters": [
   128          {
   129            "name": "bytesVal",
   130            "in": "path",
   131            "required": true,
   132            "type": "string",
   133            "format": "byte"
   134          },
   135          {
   136            "name": "name",
   137            "in": "query",
   138            "required": false,
   139            "type": "string"
   140          },
   141          {
   142            "name": "strVal",
   143            "in": "query",
   144            "required": false,
   145            "type": "string"
   146          },
   147          {
   148            "name": "floatVal",
   149            "in": "query",
   150            "required": false,
   151            "type": "number",
   152            "format": "float"
   153          },
   154          {
   155            "name": "doubleVal",
   156            "in": "query",
   157            "required": false,
   158            "type": "number",
   159            "format": "double"
   160          },
   161          {
   162            "name": "boolVal",
   163            "in": "query",
   164            "required": false,
   165            "type": "boolean"
   166          },
   167          {
   168            "name": "int32Val",
   169            "in": "query",
   170            "required": false,
   171            "type": "integer",
   172            "format": "int32"
   173          },
   174          {
   175            "name": "uint32Val",
   176            "in": "query",
   177            "required": false,
   178            "type": "integer",
   179            "format": "int64"
   180          },
   181          {
   182            "name": "int64Val",
   183            "in": "query",
   184            "required": false,
   185            "type": "string",
   186            "format": "int64"
   187          },
   188          {
   189            "name": "uint64Val",
   190            "in": "query",
   191            "required": false,
   192            "type": "string",
   193            "format": "uint64"
   194          }
   195        ],
   196        "tags": [
   197          "Greeter"
   198        ]
   199      }
   200    },
   201    "/say/doubleval/{doubleVal}": {
   202      "get": {
   203        "operationId": "Greeter_SayHello4",
   204        "responses": {
   205          "200": {
   206            "description": "A successful response.",
   207            "schema": {
   208              "$ref": "#/definitions/helloworldHelloReply"
   209            }
   210          },
   211          "default": {
   212            "description": "An unexpected error response.",
   213            "schema": {
   214              "$ref": "#/definitions/rpcStatus"
   215            }
   216          }
   217        },
   218        "parameters": [
   219          {
   220            "name": "doubleVal",
   221            "in": "path",
   222            "required": true,
   223            "type": "number",
   224            "format": "double"
   225          },
   226          {
   227            "name": "name",
   228            "in": "query",
   229            "required": false,
   230            "type": "string"
   231          },
   232          {
   233            "name": "strVal",
   234            "in": "query",
   235            "required": false,
   236            "type": "string"
   237          },
   238          {
   239            "name": "floatVal",
   240            "in": "query",
   241            "required": false,
   242            "type": "number",
   243            "format": "float"
   244          },
   245          {
   246            "name": "boolVal",
   247            "in": "query",
   248            "required": false,
   249            "type": "boolean"
   250          },
   251          {
   252            "name": "bytesVal",
   253            "in": "query",
   254            "required": false,
   255            "type": "string",
   256            "format": "byte"
   257          },
   258          {
   259            "name": "int32Val",
   260            "in": "query",
   261            "required": false,
   262            "type": "integer",
   263            "format": "int32"
   264          },
   265          {
   266            "name": "uint32Val",
   267            "in": "query",
   268            "required": false,
   269            "type": "integer",
   270            "format": "int64"
   271          },
   272          {
   273            "name": "int64Val",
   274            "in": "query",
   275            "required": false,
   276            "type": "string",
   277            "format": "int64"
   278          },
   279          {
   280            "name": "uint64Val",
   281            "in": "query",
   282            "required": false,
   283            "type": "string",
   284            "format": "uint64"
   285          }
   286        ],
   287        "tags": [
   288          "Greeter"
   289        ]
   290      }
   291    },
   292    "/say/floatval/{floatVal}": {
   293      "get": {
   294        "operationId": "Greeter_SayHello3",
   295        "responses": {
   296          "200": {
   297            "description": "A successful response.",
   298            "schema": {
   299              "$ref": "#/definitions/helloworldHelloReply"
   300            }
   301          },
   302          "default": {
   303            "description": "An unexpected error response.",
   304            "schema": {
   305              "$ref": "#/definitions/rpcStatus"
   306            }
   307          }
   308        },
   309        "parameters": [
   310          {
   311            "name": "floatVal",
   312            "in": "path",
   313            "required": true,
   314            "type": "number",
   315            "format": "float"
   316          },
   317          {
   318            "name": "name",
   319            "in": "query",
   320            "required": false,
   321            "type": "string"
   322          },
   323          {
   324            "name": "strVal",
   325            "in": "query",
   326            "required": false,
   327            "type": "string"
   328          },
   329          {
   330            "name": "doubleVal",
   331            "in": "query",
   332            "required": false,
   333            "type": "number",
   334            "format": "double"
   335          },
   336          {
   337            "name": "boolVal",
   338            "in": "query",
   339            "required": false,
   340            "type": "boolean"
   341          },
   342          {
   343            "name": "bytesVal",
   344            "in": "query",
   345            "required": false,
   346            "type": "string",
   347            "format": "byte"
   348          },
   349          {
   350            "name": "int32Val",
   351            "in": "query",
   352            "required": false,
   353            "type": "integer",
   354            "format": "int32"
   355          },
   356          {
   357            "name": "uint32Val",
   358            "in": "query",
   359            "required": false,
   360            "type": "integer",
   361            "format": "int64"
   362          },
   363          {
   364            "name": "int64Val",
   365            "in": "query",
   366            "required": false,
   367            "type": "string",
   368            "format": "int64"
   369          },
   370          {
   371            "name": "uint64Val",
   372            "in": "query",
   373            "required": false,
   374            "type": "string",
   375            "format": "uint64"
   376          }
   377        ],
   378        "tags": [
   379          "Greeter"
   380        ]
   381      }
   382    },
   383    "/say/int32val/{int32Val}": {
   384      "get": {
   385        "operationId": "Greeter_SayHello7",
   386        "responses": {
   387          "200": {
   388            "description": "A successful response.",
   389            "schema": {
   390              "$ref": "#/definitions/helloworldHelloReply"
   391            }
   392          },
   393          "default": {
   394            "description": "An unexpected error response.",
   395            "schema": {
   396              "$ref": "#/definitions/rpcStatus"
   397            }
   398          }
   399        },
   400        "parameters": [
   401          {
   402            "name": "int32Val",
   403            "in": "path",
   404            "required": true,
   405            "type": "integer",
   406            "format": "int32"
   407          },
   408          {
   409            "name": "name",
   410            "in": "query",
   411            "required": false,
   412            "type": "string"
   413          },
   414          {
   415            "name": "strVal",
   416            "in": "query",
   417            "required": false,
   418            "type": "string"
   419          },
   420          {
   421            "name": "floatVal",
   422            "in": "query",
   423            "required": false,
   424            "type": "number",
   425            "format": "float"
   426          },
   427          {
   428            "name": "doubleVal",
   429            "in": "query",
   430            "required": false,
   431            "type": "number",
   432            "format": "double"
   433          },
   434          {
   435            "name": "boolVal",
   436            "in": "query",
   437            "required": false,
   438            "type": "boolean"
   439          },
   440          {
   441            "name": "bytesVal",
   442            "in": "query",
   443            "required": false,
   444            "type": "string",
   445            "format": "byte"
   446          },
   447          {
   448            "name": "uint32Val",
   449            "in": "query",
   450            "required": false,
   451            "type": "integer",
   452            "format": "int64"
   453          },
   454          {
   455            "name": "int64Val",
   456            "in": "query",
   457            "required": false,
   458            "type": "string",
   459            "format": "int64"
   460          },
   461          {
   462            "name": "uint64Val",
   463            "in": "query",
   464            "required": false,
   465            "type": "string",
   466            "format": "uint64"
   467          }
   468        ],
   469        "tags": [
   470          "Greeter"
   471        ]
   472      }
   473    },
   474    "/say/int64val/{int64Val}": {
   475      "get": {
   476        "operationId": "Greeter_SayHello9",
   477        "responses": {
   478          "200": {
   479            "description": "A successful response.",
   480            "schema": {
   481              "$ref": "#/definitions/helloworldHelloReply"
   482            }
   483          },
   484          "default": {
   485            "description": "An unexpected error response.",
   486            "schema": {
   487              "$ref": "#/definitions/rpcStatus"
   488            }
   489          }
   490        },
   491        "parameters": [
   492          {
   493            "name": "int64Val",
   494            "in": "path",
   495            "required": true,
   496            "type": "string",
   497            "format": "int64"
   498          },
   499          {
   500            "name": "name",
   501            "in": "query",
   502            "required": false,
   503            "type": "string"
   504          },
   505          {
   506            "name": "strVal",
   507            "in": "query",
   508            "required": false,
   509            "type": "string"
   510          },
   511          {
   512            "name": "floatVal",
   513            "in": "query",
   514            "required": false,
   515            "type": "number",
   516            "format": "float"
   517          },
   518          {
   519            "name": "doubleVal",
   520            "in": "query",
   521            "required": false,
   522            "type": "number",
   523            "format": "double"
   524          },
   525          {
   526            "name": "boolVal",
   527            "in": "query",
   528            "required": false,
   529            "type": "boolean"
   530          },
   531          {
   532            "name": "bytesVal",
   533            "in": "query",
   534            "required": false,
   535            "type": "string",
   536            "format": "byte"
   537          },
   538          {
   539            "name": "int32Val",
   540            "in": "query",
   541            "required": false,
   542            "type": "integer",
   543            "format": "int32"
   544          },
   545          {
   546            "name": "uint32Val",
   547            "in": "query",
   548            "required": false,
   549            "type": "integer",
   550            "format": "int64"
   551          },
   552          {
   553            "name": "uint64Val",
   554            "in": "query",
   555            "required": false,
   556            "type": "string",
   557            "format": "uint64"
   558          }
   559        ],
   560        "tags": [
   561          "Greeter"
   562        ]
   563      }
   564    },
   565    "/say/strval/{strVal}": {
   566      "get": {
   567        "operationId": "Greeter_SayHello2",
   568        "responses": {
   569          "200": {
   570            "description": "A successful response.",
   571            "schema": {
   572              "$ref": "#/definitions/helloworldHelloReply"
   573            }
   574          },
   575          "default": {
   576            "description": "An unexpected error response.",
   577            "schema": {
   578              "$ref": "#/definitions/rpcStatus"
   579            }
   580          }
   581        },
   582        "parameters": [
   583          {
   584            "name": "strVal",
   585            "in": "path",
   586            "required": true,
   587            "type": "string"
   588          },
   589          {
   590            "name": "name",
   591            "in": "query",
   592            "required": false,
   593            "type": "string"
   594          },
   595          {
   596            "name": "floatVal",
   597            "in": "query",
   598            "required": false,
   599            "type": "number",
   600            "format": "float"
   601          },
   602          {
   603            "name": "doubleVal",
   604            "in": "query",
   605            "required": false,
   606            "type": "number",
   607            "format": "double"
   608          },
   609          {
   610            "name": "boolVal",
   611            "in": "query",
   612            "required": false,
   613            "type": "boolean"
   614          },
   615          {
   616            "name": "bytesVal",
   617            "in": "query",
   618            "required": false,
   619            "type": "string",
   620            "format": "byte"
   621          },
   622          {
   623            "name": "int32Val",
   624            "in": "query",
   625            "required": false,
   626            "type": "integer",
   627            "format": "int32"
   628          },
   629          {
   630            "name": "uint32Val",
   631            "in": "query",
   632            "required": false,
   633            "type": "integer",
   634            "format": "int64"
   635          },
   636          {
   637            "name": "int64Val",
   638            "in": "query",
   639            "required": false,
   640            "type": "string",
   641            "format": "int64"
   642          },
   643          {
   644            "name": "uint64Val",
   645            "in": "query",
   646            "required": false,
   647            "type": "string",
   648            "format": "uint64"
   649          }
   650        ],
   651        "tags": [
   652          "Greeter"
   653        ]
   654      }
   655    },
   656    "/say/uint32val/{uint32Val}": {
   657      "get": {
   658        "operationId": "Greeter_SayHello8",
   659        "responses": {
   660          "200": {
   661            "description": "A successful response.",
   662            "schema": {
   663              "$ref": "#/definitions/helloworldHelloReply"
   664            }
   665          },
   666          "default": {
   667            "description": "An unexpected error response.",
   668            "schema": {
   669              "$ref": "#/definitions/rpcStatus"
   670            }
   671          }
   672        },
   673        "parameters": [
   674          {
   675            "name": "uint32Val",
   676            "in": "path",
   677            "required": true,
   678            "type": "integer",
   679            "format": "int64"
   680          },
   681          {
   682            "name": "name",
   683            "in": "query",
   684            "required": false,
   685            "type": "string"
   686          },
   687          {
   688            "name": "strVal",
   689            "in": "query",
   690            "required": false,
   691            "type": "string"
   692          },
   693          {
   694            "name": "floatVal",
   695            "in": "query",
   696            "required": false,
   697            "type": "number",
   698            "format": "float"
   699          },
   700          {
   701            "name": "doubleVal",
   702            "in": "query",
   703            "required": false,
   704            "type": "number",
   705            "format": "double"
   706          },
   707          {
   708            "name": "boolVal",
   709            "in": "query",
   710            "required": false,
   711            "type": "boolean"
   712          },
   713          {
   714            "name": "bytesVal",
   715            "in": "query",
   716            "required": false,
   717            "type": "string",
   718            "format": "byte"
   719          },
   720          {
   721            "name": "int32Val",
   722            "in": "query",
   723            "required": false,
   724            "type": "integer",
   725            "format": "int32"
   726          },
   727          {
   728            "name": "int64Val",
   729            "in": "query",
   730            "required": false,
   731            "type": "string",
   732            "format": "int64"
   733          },
   734          {
   735            "name": "uint64Val",
   736            "in": "query",
   737            "required": false,
   738            "type": "string",
   739            "format": "uint64"
   740          }
   741        ],
   742        "tags": [
   743          "Greeter"
   744        ]
   745      }
   746    },
   747    "/say/uint64val/{uint64Val}": {
   748      "get": {
   749        "operationId": "Greeter_SayHello10",
   750        "responses": {
   751          "200": {
   752            "description": "A successful response.",
   753            "schema": {
   754              "$ref": "#/definitions/helloworldHelloReply"
   755            }
   756          },
   757          "default": {
   758            "description": "An unexpected error response.",
   759            "schema": {
   760              "$ref": "#/definitions/rpcStatus"
   761            }
   762          }
   763        },
   764        "parameters": [
   765          {
   766            "name": "uint64Val",
   767            "in": "path",
   768            "required": true,
   769            "type": "string",
   770            "format": "uint64"
   771          },
   772          {
   773            "name": "name",
   774            "in": "query",
   775            "required": false,
   776            "type": "string"
   777          },
   778          {
   779            "name": "strVal",
   780            "in": "query",
   781            "required": false,
   782            "type": "string"
   783          },
   784          {
   785            "name": "floatVal",
   786            "in": "query",
   787            "required": false,
   788            "type": "number",
   789            "format": "float"
   790          },
   791          {
   792            "name": "doubleVal",
   793            "in": "query",
   794            "required": false,
   795            "type": "number",
   796            "format": "double"
   797          },
   798          {
   799            "name": "boolVal",
   800            "in": "query",
   801            "required": false,
   802            "type": "boolean"
   803          },
   804          {
   805            "name": "bytesVal",
   806            "in": "query",
   807            "required": false,
   808            "type": "string",
   809            "format": "byte"
   810          },
   811          {
   812            "name": "int32Val",
   813            "in": "query",
   814            "required": false,
   815            "type": "integer",
   816            "format": "int32"
   817          },
   818          {
   819            "name": "uint32Val",
   820            "in": "query",
   821            "required": false,
   822            "type": "integer",
   823            "format": "int64"
   824          },
   825          {
   826            "name": "int64Val",
   827            "in": "query",
   828            "required": false,
   829            "type": "string",
   830            "format": "int64"
   831          }
   832        ],
   833        "tags": [
   834          "Greeter"
   835        ]
   836      }
   837    },
   838    "/say/{name}": {
   839      "get": {
   840        "operationId": "Greeter_SayHello",
   841        "responses": {
   842          "200": {
   843            "description": "A successful response.",
   844            "schema": {
   845              "$ref": "#/definitions/helloworldHelloReply"
   846            }
   847          },
   848          "default": {
   849            "description": "An unexpected error response.",
   850            "schema": {
   851              "$ref": "#/definitions/rpcStatus"
   852            }
   853          }
   854        },
   855        "parameters": [
   856          {
   857            "name": "name",
   858            "in": "path",
   859            "required": true,
   860            "type": "string"
   861          },
   862          {
   863            "name": "strVal",
   864            "in": "query",
   865            "required": false,
   866            "type": "string"
   867          },
   868          {
   869            "name": "floatVal",
   870            "in": "query",
   871            "required": false,
   872            "type": "number",
   873            "format": "float"
   874          },
   875          {
   876            "name": "doubleVal",
   877            "in": "query",
   878            "required": false,
   879            "type": "number",
   880            "format": "double"
   881          },
   882          {
   883            "name": "boolVal",
   884            "in": "query",
   885            "required": false,
   886            "type": "boolean"
   887          },
   888          {
   889            "name": "bytesVal",
   890            "in": "query",
   891            "required": false,
   892            "type": "string",
   893            "format": "byte"
   894          },
   895          {
   896            "name": "int32Val",
   897            "in": "query",
   898            "required": false,
   899            "type": "integer",
   900            "format": "int32"
   901          },
   902          {
   903            "name": "uint32Val",
   904            "in": "query",
   905            "required": false,
   906            "type": "integer",
   907            "format": "int64"
   908          },
   909          {
   910            "name": "int64Val",
   911            "in": "query",
   912            "required": false,
   913            "type": "string",
   914            "format": "int64"
   915          },
   916          {
   917            "name": "uint64Val",
   918            "in": "query",
   919            "required": false,
   920            "type": "string",
   921            "format": "uint64"
   922          }
   923        ],
   924        "tags": [
   925          "Greeter"
   926        ]
   927      }
   928    }
   929  },
   930  "definitions": {
   931    "helloworldHelloReply": {
   932      "type": "object",
   933      "properties": {
   934        "message": {
   935          "type": "string"
   936        }
   937      }
   938    },
   939    "protobufAny": {
   940      "type": "object",
   941      "properties": {
   942        "@type": {
   943          "type": "string"
   944        }
   945      },
   946      "additionalProperties": {}
   947    },
   948    "rpcStatus": {
   949      "type": "object",
   950      "properties": {
   951        "code": {
   952          "type": "integer",
   953          "format": "int32"
   954        },
   955        "message": {
   956          "type": "string"
   957        },
   958        "details": {
   959          "type": "array",
   960          "items": {
   961            "type": "object",
   962            "$ref": "#/definitions/protobufAny"
   963          }
   964        }
   965      }
   966    }
   967  }
   968}

View as plain text