1{
2  "swagger": "2.0",
3  "info": {
4    "title": "Echo Service",
5    "description": "Echo Service API consists of a single service which returns\na message.",
6    "version": "version not set"
7  },
8  "schemes": [
9    "http",
10    "https"
11  ],
12  "consumes": [
13    "application/json"
14  ],
15  "produces": [
16    "application/json"
17  ],
18  "paths": {
19    "/v1/example/echo/{id}": {
20      "post": {
21        "summary": "Echo method receives a simple message and returns it.",
22        "description": "The message posted as the id parameter will also be\nreturned.",
23        "operationId": "Echo",
24        "responses": {
25          "200": {
26            "description": "A successful response.",
27            "schema": {
28              "$ref": "#/definitions/examplepbSimpleMessage"
29            }
30          }
31        },
32        "parameters": [
33          {
34            "name": "id",
35            "description": "Id represents the message identifier.",
36            "in": "path",
37            "required": true,
38            "type": "string"
39          }
40        ],
41        "tags": [
42          "EchoService"
43        ]
44      }
45    },
46    "/v1/example/echo/{id}/{num}": {
47      "get": {
48        "summary": "Echo method receives a simple message and returns it.",
49        "description": "The message posted as the id parameter will also be\nreturned.",
50        "operationId": "Echo2",
51        "responses": {
52          "200": {
53            "description": "A successful response.",
54            "schema": {
55              "$ref": "#/definitions/examplepbSimpleMessage"
56            }
57          }
58        },
59        "parameters": [
60          {
61            "name": "id",
62            "description": "Id represents the message identifier.",
63            "in": "path",
64            "required": true,
65            "type": "string"
66          },
67          {
68            "name": "num",
69            "in": "path",
70            "required": true,
71            "type": "string",
72            "format": "int64"
73          },
74          {
75            "name": "line_num",
76            "in": "query",
77            "required": false,
78            "type": "string",
79            "format": "int64"
80          },
81          {
82            "name": "lang",
83            "in": "query",
84            "required": false,
85            "type": "string"
86          },
87          {
88            "name": "status.progress",
89            "in": "query",
90            "required": false,
91            "type": "string",
92            "format": "int64"
93          },
94          {
95            "name": "status.note",
96            "in": "query",
97            "required": false,
98            "type": "string"
99          },
100          {
101            "name": "en",
102            "in": "query",
103            "required": false,
104            "type": "string",
105            "format": "int64"
106          },
107          {
108            "name": "no.progress",
109            "in": "query",
110            "required": false,
111            "type": "string",
112            "format": "int64"
113          },
114          {
115            "name": "no.note",
116            "in": "query",
117            "required": false,
118            "type": "string"
119          }
120        ],
121        "tags": [
122          "EchoService"
123        ]
124      }
125    },
126    "/v1/example/echo/{id}/{num}/{lang}": {
127      "get": {
128        "summary": "Echo method receives a simple message and returns it.",
129        "description": "The message posted as the id parameter will also be\nreturned.",
130        "operationId": "Echo3",
131        "responses": {
132          "200": {
133            "description": "A successful response.",
134            "schema": {
135              "$ref": "#/definitions/examplepbSimpleMessage"
136            }
137          }
138        },
139        "parameters": [
140          {
141            "name": "id",
142            "description": "Id represents the message identifier.",
143            "in": "path",
144            "required": true,
145            "type": "string"
146          },
147          {
148            "name": "num",
149            "in": "path",
150            "required": true,
151            "type": "string",
152            "format": "int64"
153          },
154          {
155            "name": "lang",
156            "in": "path",
157            "required": true,
158            "type": "string"
159          },
160          {
161            "name": "line_num",
162            "in": "query",
163            "required": false,
164            "type": "string",
165            "format": "int64"
166          },
167          {
168            "name": "status.progress",
169            "in": "query",
170            "required": false,
171            "type": "string",
172            "format": "int64"
173          },
174          {
175            "name": "status.note",
176            "in": "query",
177            "required": false,
178            "type": "string"
179          },
180          {
181            "name": "en",
182            "in": "query",
183            "required": false,
184            "type": "string",
185            "format": "int64"
186          },
187          {
188            "name": "no.progress",
189            "in": "query",
190            "required": false,
191            "type": "string",
192            "format": "int64"
193          },
194          {
195            "name": "no.note",
196            "in": "query",
197            "required": false,
198            "type": "string"
199          }
200        ],
201        "tags": [
202          "EchoService"
203        ]
204      }
205    },
206    "/v1/example/echo1/{id}/{line_num}/{status.note}": {
207      "get": {
208        "summary": "Echo method receives a simple message and returns it.",
209        "description": "The message posted as the id parameter will also be\nreturned.",
210        "operationId": "Echo4",
211        "responses": {
212          "200": {
213            "description": "A successful response.",
214            "schema": {
215              "$ref": "#/definitions/examplepbSimpleMessage"
216            }
217          }
218        },
219        "parameters": [
220          {
221            "name": "id",
222            "description": "Id represents the message identifier.",
223            "in": "path",
224            "required": true,
225            "type": "string"
226          },
227          {
228            "name": "line_num",
229            "in": "path",
230            "required": true,
231            "type": "string",
232            "format": "int64"
233          },
234          {
235            "name": "status.note",
236            "in": "path",
237            "required": true,
238            "type": "string"
239          },
240          {
241            "name": "num",
242            "in": "query",
243            "required": false,
244            "type": "string",
245            "format": "int64"
246          },
247          {
248            "name": "lang",
249            "in": "query",
250            "required": false,
251            "type": "string"
252          },
253          {
254            "name": "status.progress",
255            "in": "query",
256            "required": false,
257            "type": "string",
258            "format": "int64"
259          },
260          {
261            "name": "en",
262            "in": "query",
263            "required": false,
264            "type": "string",
265            "format": "int64"
266          },
267          {
268            "name": "no.progress",
269            "in": "query",
270            "required": false,
271            "type": "string",
272            "format": "int64"
273          }
274        ],
275        "tags": [
276          "EchoService"
277        ]
278      }
279    },
280    "/v1/example/echo2/{no.note}": {
281      "get": {
282        "summary": "Echo method receives a simple message and returns it.",
283        "description": "The message posted as the id parameter will also be\nreturned.",
284        "operationId": "Echo5",
285        "responses": {
286          "200": {
287            "description": "A successful response.",
288            "schema": {
289              "$ref": "#/definitions/examplepbSimpleMessage"
290            }
291          }
292        },
293        "parameters": [
294          {
295            "name": "no.note",
296            "in": "path",
297            "required": true,
298            "type": "string"
299          },
300          {
301            "name": "id",
302            "description": "Id represents the message identifier.",
303            "in": "query",
304            "required": false,
305            "type": "string"
306          },
307          {
308            "name": "num",
309            "in": "query",
310            "required": false,
311            "type": "string",
312            "format": "int64"
313          },
314          {
315            "name": "line_num",
316            "in": "query",
317            "required": false,
318            "type": "string",
319            "format": "int64"
320          },
321          {
322            "name": "lang",
323            "in": "query",
324            "required": false,
325            "type": "string"
326          },
327          {
328            "name": "status.progress",
329            "in": "query",
330            "required": false,
331            "type": "string",
332            "format": "int64"
333          },
334          {
335            "name": "en",
336            "in": "query",
337            "required": false,
338            "type": "string",
339            "format": "int64"
340          },
341          {
342            "name": "no.progress",
343            "in": "query",
344            "required": false,
345            "type": "string",
346            "format": "int64"
347          }
348        ],
349        "tags": [
350          "EchoService"
351        ]
352      }
353    },
354    "/v1/example/echo_body": {
355      "post": {
356        "summary": "EchoBody method receives a simple message and returns it.",
357        "operationId": "EchoBody",
358        "responses": {
359          "200": {
360            "description": "A successful response.",
361            "schema": {
362              "$ref": "#/definitions/examplepbSimpleMessage"
363            }
364          }
365        },
366        "parameters": [
367          {
368            "name": "body",
369            "in": "body",
370            "required": true,
371            "schema": {
372              "$ref": "#/definitions/examplepbSimpleMessage"
373            }
374          }
375        ],
376        "tags": [
377          "EchoService"
378        ]
379      }
380    },
381    "/v1/example/echo_delete": {
382      "delete": {
383        "summary": "EchoDelete method receives a simple message and returns it.",
384        "operationId": "EchoDelete",
385        "responses": {
386          "200": {
387            "description": "A successful response.",
388            "schema": {
389              "$ref": "#/definitions/examplepbSimpleMessage"
390            }
391          }
392        },
393        "parameters": [
394          {
395            "name": "id",
396            "description": "Id represents the message identifier.",
397            "in": "query",
398            "required": false,
399            "type": "string"
400          },
401          {
402            "name": "num",
403            "in": "query",
404            "required": false,
405            "type": "string",
406            "format": "int64"
407          },
408          {
409            "name": "line_num",
410            "in": "query",
411            "required": false,
412            "type": "string",
413            "format": "int64"
414          },
415          {
416            "name": "lang",
417            "in": "query",
418            "required": false,
419            "type": "string"
420          },
421          {
422            "name": "status.progress",
423            "in": "query",
424            "required": false,
425            "type": "string",
426            "format": "int64"
427          },
428          {
429            "name": "status.note",
430            "in": "query",
431            "required": false,
432            "type": "string"
433          },
434          {
435            "name": "en",
436            "in": "query",
437            "required": false,
438            "type": "string",
439            "format": "int64"
440          },
441          {
442            "name": "no.progress",
443            "in": "query",
444            "required": false,
445            "type": "string",
446            "format": "int64"
447          },
448          {
449            "name": "no.note",
450            "in": "query",
451            "required": false,
452            "type": "string"
453          }
454        ],
455        "tags": [
456          "EchoService"
457        ]
458      }
459    }
460  },
461  "definitions": {
462    "examplepbEmbedded": {
463      "type": "object",
464      "properties": {
465        "progress": {
466          "type": "string",
467          "format": "int64"
468        },
469        "note": {
470          "type": "string"
471        }
472      },
473      "description": "Embedded represents a message embedded in SimpleMessage."
474    },
475    "examplepbSimpleMessage": {
476      "type": "object",
477      "properties": {
478        "id": {
479          "type": "string",
480          "description": "Id represents the message identifier."
481        },
482        "num": {
483          "type": "string",
484          "format": "int64"
485        },
486        "line_num": {
487          "type": "string",
488          "format": "int64"
489        },
490        "lang": {
491          "type": "string"
492        },
493        "status": {
494          "$ref": "#/definitions/examplepbEmbedded"
495        },
496        "en": {
497          "type": "string",
498          "format": "int64"
499        },
500        "no": {
501          "$ref": "#/definitions/examplepbEmbedded"
502        }
503      },
504      "description": "SimpleMessage represents a simple message sent to the Echo service."
505    }
506  }
507}
508