1---
2swagger: "2.0"
3info:
4 description: "Echo Service API consists of a single service which returns\na message."
5 version: "version not set"
6 title: "Echo Service"
7tags:
8- name: "EchoService"
9consumes:
10- "application/json"
11produces:
12- "application/json"
13paths:
14 /v1/example/echo/nested/{nId.nId}:
15 get:
16 tags:
17 - "EchoService"
18 summary: "Echo method receives a simple message and returns it."
19 description: "The message posted as the id parameter will also be\nreturned."
20 operationId: "EchoService_Echo7"
21 parameters:
22 - name: "nId.nId"
23 in: "path"
24 required: true
25 type: "string"
26 x-exportParamName: "NIdNId"
27 - name: "id"
28 in: "query"
29 description: "Id represents the message identifier."
30 required: false
31 type: "string"
32 x-exportParamName: "Id"
33 x-optionalDataType: "String"
34 - name: "num"
35 in: "query"
36 required: false
37 type: "string"
38 format: "int64"
39 x-exportParamName: "Num"
40 x-optionalDataType: "String"
41 - name: "lineNum"
42 in: "query"
43 required: false
44 type: "string"
45 format: "int64"
46 x-exportParamName: "LineNum"
47 x-optionalDataType: "String"
48 - name: "lang"
49 in: "query"
50 required: false
51 type: "string"
52 x-exportParamName: "Lang"
53 x-optionalDataType: "String"
54 - name: "status.progress"
55 in: "query"
56 required: false
57 type: "string"
58 format: "int64"
59 x-exportParamName: "StatusProgress"
60 x-optionalDataType: "String"
61 - name: "status.note"
62 in: "query"
63 required: false
64 type: "string"
65 x-exportParamName: "StatusNote"
66 x-optionalDataType: "String"
67 - name: "en"
68 in: "query"
69 required: false
70 type: "string"
71 format: "int64"
72 x-exportParamName: "En"
73 x-optionalDataType: "String"
74 - name: "no.progress"
75 in: "query"
76 required: false
77 type: "string"
78 format: "int64"
79 x-exportParamName: "NoProgress"
80 x-optionalDataType: "String"
81 - name: "no.note"
82 in: "query"
83 required: false
84 type: "string"
85 x-exportParamName: "NoNote"
86 x-optionalDataType: "String"
87 - name: "resourceId"
88 in: "query"
89 required: false
90 type: "string"
91 x-exportParamName: "ResourceId"
92 x-optionalDataType: "String"
93 - name: "nId.val"
94 in: "query"
95 required: false
96 type: "string"
97 x-exportParamName: "NIdVal"
98 x-optionalDataType: "String"
99 responses:
100 200:
101 description: "A successful response."
102 schema:
103 $ref: "#/definitions/examplepbSimpleMessage"
104 default:
105 description: "An unexpected error response."
106 schema:
107 $ref: "#/definitions/rpcStatus"
108 /v1/example/echo/resource/{resourceId}:
109 get:
110 tags:
111 - "EchoService"
112 summary: "Echo method receives a simple message and returns it."
113 description: "The message posted as the id parameter will also be\nreturned."
114 operationId: "EchoService_Echo6"
115 parameters:
116 - name: "resourceId"
117 in: "path"
118 required: true
119 type: "string"
120 x-exportParamName: "ResourceId"
121 - name: "id"
122 in: "query"
123 description: "Id represents the message identifier."
124 required: false
125 type: "string"
126 x-exportParamName: "Id"
127 x-optionalDataType: "String"
128 - name: "num"
129 in: "query"
130 required: false
131 type: "string"
132 format: "int64"
133 x-exportParamName: "Num"
134 x-optionalDataType: "String"
135 - name: "lineNum"
136 in: "query"
137 required: false
138 type: "string"
139 format: "int64"
140 x-exportParamName: "LineNum"
141 x-optionalDataType: "String"
142 - name: "lang"
143 in: "query"
144 required: false
145 type: "string"
146 x-exportParamName: "Lang"
147 x-optionalDataType: "String"
148 - name: "status.progress"
149 in: "query"
150 required: false
151 type: "string"
152 format: "int64"
153 x-exportParamName: "StatusProgress"
154 x-optionalDataType: "String"
155 - name: "status.note"
156 in: "query"
157 required: false
158 type: "string"
159 x-exportParamName: "StatusNote"
160 x-optionalDataType: "String"
161 - name: "en"
162 in: "query"
163 required: false
164 type: "string"
165 format: "int64"
166 x-exportParamName: "En"
167 x-optionalDataType: "String"
168 - name: "no.progress"
169 in: "query"
170 required: false
171 type: "string"
172 format: "int64"
173 x-exportParamName: "NoProgress"
174 x-optionalDataType: "String"
175 - name: "no.note"
176 in: "query"
177 required: false
178 type: "string"
179 x-exportParamName: "NoNote"
180 x-optionalDataType: "String"
181 - name: "nId.nId"
182 in: "query"
183 required: false
184 type: "string"
185 x-exportParamName: "NIdNId"
186 x-optionalDataType: "String"
187 - name: "nId.val"
188 in: "query"
189 required: false
190 type: "string"
191 x-exportParamName: "NIdVal"
192 x-optionalDataType: "String"
193 responses:
194 200:
195 description: "A successful response."
196 schema:
197 $ref: "#/definitions/examplepbSimpleMessage"
198 default:
199 description: "An unexpected error response."
200 schema:
201 $ref: "#/definitions/rpcStatus"
202 /v1/example/echo/{id}:
203 post:
204 tags:
205 - "EchoService"
206 summary: "Echo method receives a simple message and returns it."
207 description: "The message posted as the id parameter will also be\nreturned."
208 operationId: "EchoService_Echo"
209 parameters:
210 - name: "id"
211 in: "path"
212 description: "Id represents the message identifier."
213 required: true
214 type: "string"
215 x-exportParamName: "Id"
216 - name: "num"
217 in: "query"
218 required: false
219 type: "string"
220 format: "int64"
221 x-exportParamName: "Num"
222 x-optionalDataType: "String"
223 - name: "lineNum"
224 in: "query"
225 required: false
226 type: "string"
227 format: "int64"
228 x-exportParamName: "LineNum"
229 x-optionalDataType: "String"
230 - name: "lang"
231 in: "query"
232 required: false
233 type: "string"
234 x-exportParamName: "Lang"
235 x-optionalDataType: "String"
236 - name: "status.progress"
237 in: "query"
238 required: false
239 type: "string"
240 format: "int64"
241 x-exportParamName: "StatusProgress"
242 x-optionalDataType: "String"
243 - name: "status.note"
244 in: "query"
245 required: false
246 type: "string"
247 x-exportParamName: "StatusNote"
248 x-optionalDataType: "String"
249 - name: "en"
250 in: "query"
251 required: false
252 type: "string"
253 format: "int64"
254 x-exportParamName: "En"
255 x-optionalDataType: "String"
256 - name: "no.progress"
257 in: "query"
258 required: false
259 type: "string"
260 format: "int64"
261 x-exportParamName: "NoProgress"
262 x-optionalDataType: "String"
263 - name: "no.note"
264 in: "query"
265 required: false
266 type: "string"
267 x-exportParamName: "NoNote"
268 x-optionalDataType: "String"
269 - name: "resourceId"
270 in: "query"
271 required: false
272 type: "string"
273 x-exportParamName: "ResourceId"
274 x-optionalDataType: "String"
275 - name: "nId.nId"
276 in: "query"
277 required: false
278 type: "string"
279 x-exportParamName: "NIdNId"
280 x-optionalDataType: "String"
281 - name: "nId.val"
282 in: "query"
283 required: false
284 type: "string"
285 x-exportParamName: "NIdVal"
286 x-optionalDataType: "String"
287 responses:
288 200:
289 description: "A successful response."
290 schema:
291 $ref: "#/definitions/examplepbSimpleMessage"
292 default:
293 description: "An unexpected error response."
294 schema:
295 $ref: "#/definitions/rpcStatus"
296 /v1/example/echo/{id}/{num}:
297 get:
298 tags:
299 - "EchoService"
300 summary: "Echo method receives a simple message and returns it."
301 description: "The message posted as the id parameter will also be\nreturned."
302 operationId: "EchoService_Echo2"
303 parameters:
304 - name: "id"
305 in: "path"
306 description: "Id represents the message identifier."
307 required: true
308 type: "string"
309 x-exportParamName: "Id"
310 - name: "num"
311 in: "path"
312 required: true
313 type: "string"
314 format: "int64"
315 x-exportParamName: "Num"
316 - name: "lineNum"
317 in: "query"
318 required: false
319 type: "string"
320 format: "int64"
321 x-exportParamName: "LineNum"
322 x-optionalDataType: "String"
323 - name: "lang"
324 in: "query"
325 required: false
326 type: "string"
327 x-exportParamName: "Lang"
328 x-optionalDataType: "String"
329 - name: "status.progress"
330 in: "query"
331 required: false
332 type: "string"
333 format: "int64"
334 x-exportParamName: "StatusProgress"
335 x-optionalDataType: "String"
336 - name: "status.note"
337 in: "query"
338 required: false
339 type: "string"
340 x-exportParamName: "StatusNote"
341 x-optionalDataType: "String"
342 - name: "en"
343 in: "query"
344 required: false
345 type: "string"
346 format: "int64"
347 x-exportParamName: "En"
348 x-optionalDataType: "String"
349 - name: "no.progress"
350 in: "query"
351 required: false
352 type: "string"
353 format: "int64"
354 x-exportParamName: "NoProgress"
355 x-optionalDataType: "String"
356 - name: "no.note"
357 in: "query"
358 required: false
359 type: "string"
360 x-exportParamName: "NoNote"
361 x-optionalDataType: "String"
362 - name: "resourceId"
363 in: "query"
364 required: false
365 type: "string"
366 x-exportParamName: "ResourceId"
367 x-optionalDataType: "String"
368 - name: "nId.nId"
369 in: "query"
370 required: false
371 type: "string"
372 x-exportParamName: "NIdNId"
373 x-optionalDataType: "String"
374 - name: "nId.val"
375 in: "query"
376 required: false
377 type: "string"
378 x-exportParamName: "NIdVal"
379 x-optionalDataType: "String"
380 responses:
381 200:
382 description: "A successful response."
383 schema:
384 $ref: "#/definitions/examplepbSimpleMessage"
385 default:
386 description: "An unexpected error response."
387 schema:
388 $ref: "#/definitions/rpcStatus"
389 /v1/example/echo/{id}/{num}/{lang}:
390 get:
391 tags:
392 - "EchoService"
393 summary: "Echo method receives a simple message and returns it."
394 description: "The message posted as the id parameter will also be\nreturned."
395 operationId: "EchoService_Echo3"
396 parameters:
397 - name: "id"
398 in: "path"
399 description: "Id represents the message identifier."
400 required: true
401 type: "string"
402 x-exportParamName: "Id"
403 - name: "num"
404 in: "path"
405 required: true
406 type: "string"
407 format: "int64"
408 x-exportParamName: "Num"
409 - name: "lang"
410 in: "path"
411 required: true
412 type: "string"
413 x-exportParamName: "Lang"
414 - name: "lineNum"
415 in: "query"
416 required: false
417 type: "string"
418 format: "int64"
419 x-exportParamName: "LineNum"
420 x-optionalDataType: "String"
421 - name: "status.progress"
422 in: "query"
423 required: false
424 type: "string"
425 format: "int64"
426 x-exportParamName: "StatusProgress"
427 x-optionalDataType: "String"
428 - name: "status.note"
429 in: "query"
430 required: false
431 type: "string"
432 x-exportParamName: "StatusNote"
433 x-optionalDataType: "String"
434 - name: "en"
435 in: "query"
436 required: false
437 type: "string"
438 format: "int64"
439 x-exportParamName: "En"
440 x-optionalDataType: "String"
441 - name: "no.progress"
442 in: "query"
443 required: false
444 type: "string"
445 format: "int64"
446 x-exportParamName: "NoProgress"
447 x-optionalDataType: "String"
448 - name: "no.note"
449 in: "query"
450 required: false
451 type: "string"
452 x-exportParamName: "NoNote"
453 x-optionalDataType: "String"
454 - name: "resourceId"
455 in: "query"
456 required: false
457 type: "string"
458 x-exportParamName: "ResourceId"
459 x-optionalDataType: "String"
460 - name: "nId.nId"
461 in: "query"
462 required: false
463 type: "string"
464 x-exportParamName: "NIdNId"
465 x-optionalDataType: "String"
466 - name: "nId.val"
467 in: "query"
468 required: false
469 type: "string"
470 x-exportParamName: "NIdVal"
471 x-optionalDataType: "String"
472 responses:
473 200:
474 description: "A successful response."
475 schema:
476 $ref: "#/definitions/examplepbSimpleMessage"
477 default:
478 description: "An unexpected error response."
479 schema:
480 $ref: "#/definitions/rpcStatus"
481 /v1/example/echo1/{id}/{lineNum}/{status.note}:
482 get:
483 tags:
484 - "EchoService"
485 summary: "Echo method receives a simple message and returns it."
486 description: "The message posted as the id parameter will also be\nreturned."
487 operationId: "EchoService_Echo4"
488 parameters:
489 - name: "id"
490 in: "path"
491 description: "Id represents the message identifier."
492 required: true
493 type: "string"
494 x-exportParamName: "Id"
495 - name: "lineNum"
496 in: "path"
497 required: true
498 type: "string"
499 format: "int64"
500 x-exportParamName: "LineNum"
501 - name: "status.note"
502 in: "path"
503 required: true
504 type: "string"
505 x-exportParamName: "StatusNote"
506 - name: "num"
507 in: "query"
508 required: false
509 type: "string"
510 format: "int64"
511 x-exportParamName: "Num"
512 x-optionalDataType: "String"
513 - name: "lang"
514 in: "query"
515 required: false
516 type: "string"
517 x-exportParamName: "Lang"
518 x-optionalDataType: "String"
519 - name: "status.progress"
520 in: "query"
521 required: false
522 type: "string"
523 format: "int64"
524 x-exportParamName: "StatusProgress"
525 x-optionalDataType: "String"
526 - name: "en"
527 in: "query"
528 required: false
529 type: "string"
530 format: "int64"
531 x-exportParamName: "En"
532 x-optionalDataType: "String"
533 - name: "no.progress"
534 in: "query"
535 required: false
536 type: "string"
537 format: "int64"
538 x-exportParamName: "NoProgress"
539 x-optionalDataType: "String"
540 - name: "resourceId"
541 in: "query"
542 required: false
543 type: "string"
544 x-exportParamName: "ResourceId"
545 x-optionalDataType: "String"
546 - name: "nId.nId"
547 in: "query"
548 required: false
549 type: "string"
550 x-exportParamName: "NIdNId"
551 x-optionalDataType: "String"
552 - name: "nId.val"
553 in: "query"
554 required: false
555 type: "string"
556 x-exportParamName: "NIdVal"
557 x-optionalDataType: "String"
558 responses:
559 200:
560 description: "A successful response."
561 schema:
562 $ref: "#/definitions/examplepbSimpleMessage"
563 default:
564 description: "An unexpected error response."
565 schema:
566 $ref: "#/definitions/rpcStatus"
567 /v1/example/echo2/{no.note}:
568 get:
569 tags:
570 - "EchoService"
571 summary: "Echo method receives a simple message and returns it."
572 description: "The message posted as the id parameter will also be\nreturned."
573 operationId: "EchoService_Echo5"
574 parameters:
575 - name: "no.note"
576 in: "path"
577 required: true
578 type: "string"
579 x-exportParamName: "NoNote"
580 - name: "id"
581 in: "query"
582 description: "Id represents the message identifier."
583 required: false
584 type: "string"
585 x-exportParamName: "Id"
586 x-optionalDataType: "String"
587 - name: "num"
588 in: "query"
589 required: false
590 type: "string"
591 format: "int64"
592 x-exportParamName: "Num"
593 x-optionalDataType: "String"
594 - name: "lineNum"
595 in: "query"
596 required: false
597 type: "string"
598 format: "int64"
599 x-exportParamName: "LineNum"
600 x-optionalDataType: "String"
601 - name: "lang"
602 in: "query"
603 required: false
604 type: "string"
605 x-exportParamName: "Lang"
606 x-optionalDataType: "String"
607 - name: "status.progress"
608 in: "query"
609 required: false
610 type: "string"
611 format: "int64"
612 x-exportParamName: "StatusProgress"
613 x-optionalDataType: "String"
614 - name: "en"
615 in: "query"
616 required: false
617 type: "string"
618 format: "int64"
619 x-exportParamName: "En"
620 x-optionalDataType: "String"
621 - name: "no.progress"
622 in: "query"
623 required: false
624 type: "string"
625 format: "int64"
626 x-exportParamName: "NoProgress"
627 x-optionalDataType: "String"
628 - name: "resourceId"
629 in: "query"
630 required: false
631 type: "string"
632 x-exportParamName: "ResourceId"
633 x-optionalDataType: "String"
634 - name: "nId.nId"
635 in: "query"
636 required: false
637 type: "string"
638 x-exportParamName: "NIdNId"
639 x-optionalDataType: "String"
640 - name: "nId.val"
641 in: "query"
642 required: false
643 type: "string"
644 x-exportParamName: "NIdVal"
645 x-optionalDataType: "String"
646 responses:
647 200:
648 description: "A successful response."
649 schema:
650 $ref: "#/definitions/examplepbSimpleMessage"
651 default:
652 description: "An unexpected error response."
653 schema:
654 $ref: "#/definitions/rpcStatus"
655 /v1/example/echo_body:
656 post:
657 tags:
658 - "EchoService"
659 summary: "EchoBody method receives a simple message and returns it."
660 operationId: "EchoService_EchoBody"
661 parameters:
662 - in: "body"
663 name: "body"
664 description: "SimpleMessage represents a simple message sent to the Echo service."
665 required: true
666 schema:
667 $ref: "#/definitions/examplepbSimpleMessage"
668 x-exportParamName: "Body"
669 responses:
670 200:
671 description: "A successful response."
672 schema:
673 $ref: "#/definitions/examplepbSimpleMessage"
674 default:
675 description: "An unexpected error response."
676 schema:
677 $ref: "#/definitions/rpcStatus"
678 /v1/example/echo_body/{id}:
679 put:
680 tags:
681 - "EchoService"
682 summary: "EchoBody method receives a simple message and returns it."
683 operationId: "EchoService_EchoBody2"
684 parameters:
685 - name: "id"
686 in: "path"
687 description: "Id represents the message identifier."
688 required: true
689 type: "string"
690 x-exportParamName: "Id"
691 - in: "body"
692 name: "no"
693 required: true
694 schema:
695 $ref: "#/definitions/examplepbEmbedded"
696 x-exportParamName: "No"
697 - name: "num"
698 in: "query"
699 required: false
700 type: "string"
701 format: "int64"
702 x-exportParamName: "Num"
703 x-optionalDataType: "String"
704 - name: "lineNum"
705 in: "query"
706 required: false
707 type: "string"
708 format: "int64"
709 x-exportParamName: "LineNum"
710 x-optionalDataType: "String"
711 - name: "lang"
712 in: "query"
713 required: false
714 type: "string"
715 x-exportParamName: "Lang"
716 x-optionalDataType: "String"
717 - name: "status.progress"
718 in: "query"
719 required: false
720 type: "string"
721 format: "int64"
722 x-exportParamName: "StatusProgress"
723 x-optionalDataType: "String"
724 - name: "status.note"
725 in: "query"
726 required: false
727 type: "string"
728 x-exportParamName: "StatusNote"
729 x-optionalDataType: "String"
730 - name: "resourceId"
731 in: "query"
732 required: false
733 type: "string"
734 x-exportParamName: "ResourceId"
735 x-optionalDataType: "String"
736 - name: "nId.nId"
737 in: "query"
738 required: false
739 type: "string"
740 x-exportParamName: "NIdNId"
741 x-optionalDataType: "String"
742 - name: "nId.val"
743 in: "query"
744 required: false
745 type: "string"
746 x-exportParamName: "NIdVal"
747 x-optionalDataType: "String"
748 responses:
749 200:
750 description: "A successful response."
751 schema:
752 $ref: "#/definitions/examplepbSimpleMessage"
753 default:
754 description: "An unexpected error response."
755 schema:
756 $ref: "#/definitions/rpcStatus"
757 /v1/example/echo_delete:
758 delete:
759 tags:
760 - "EchoService"
761 summary: "EchoDelete method receives a simple message and returns it."
762 operationId: "EchoService_EchoDelete"
763 parameters:
764 - name: "id"
765 in: "query"
766 description: "Id represents the message identifier."
767 required: false
768 type: "string"
769 x-exportParamName: "Id"
770 x-optionalDataType: "String"
771 - name: "num"
772 in: "query"
773 required: false
774 type: "string"
775 format: "int64"
776 x-exportParamName: "Num"
777 x-optionalDataType: "String"
778 - name: "lineNum"
779 in: "query"
780 required: false
781 type: "string"
782 format: "int64"
783 x-exportParamName: "LineNum"
784 x-optionalDataType: "String"
785 - name: "lang"
786 in: "query"
787 required: false
788 type: "string"
789 x-exportParamName: "Lang"
790 x-optionalDataType: "String"
791 - name: "status.progress"
792 in: "query"
793 required: false
794 type: "string"
795 format: "int64"
796 x-exportParamName: "StatusProgress"
797 x-optionalDataType: "String"
798 - name: "status.note"
799 in: "query"
800 required: false
801 type: "string"
802 x-exportParamName: "StatusNote"
803 x-optionalDataType: "String"
804 - name: "en"
805 in: "query"
806 required: false
807 type: "string"
808 format: "int64"
809 x-exportParamName: "En"
810 x-optionalDataType: "String"
811 - name: "no.progress"
812 in: "query"
813 required: false
814 type: "string"
815 format: "int64"
816 x-exportParamName: "NoProgress"
817 x-optionalDataType: "String"
818 - name: "no.note"
819 in: "query"
820 required: false
821 type: "string"
822 x-exportParamName: "NoNote"
823 x-optionalDataType: "String"
824 - name: "resourceId"
825 in: "query"
826 required: false
827 type: "string"
828 x-exportParamName: "ResourceId"
829 x-optionalDataType: "String"
830 - name: "nId.nId"
831 in: "query"
832 required: false
833 type: "string"
834 x-exportParamName: "NIdNId"
835 x-optionalDataType: "String"
836 - name: "nId.val"
837 in: "query"
838 required: false
839 type: "string"
840 x-exportParamName: "NIdVal"
841 x-optionalDataType: "String"
842 responses:
843 200:
844 description: "A successful response."
845 schema:
846 $ref: "#/definitions/examplepbSimpleMessage"
847 default:
848 description: "An unexpected error response."
849 schema:
850 $ref: "#/definitions/rpcStatus"
851 /v1/example/echo_patch:
852 patch:
853 tags:
854 - "EchoService"
855 summary: "EchoPatch method receives a NonStandardUpdateRequest and returns it."
856 operationId: "EchoService_EchoPatch"
857 parameters:
858 - in: "body"
859 name: "body"
860 required: true
861 schema:
862 $ref: "#/definitions/examplepbDynamicMessage"
863 x-exportParamName: "Body"
864 responses:
865 200:
866 description: "A successful response."
867 schema:
868 $ref: "#/definitions/examplepbDynamicMessageUpdate"
869 default:
870 description: "An unexpected error response."
871 schema:
872 $ref: "#/definitions/rpcStatus"
873 /v1/example/echo_unauthorized:
874 get:
875 tags:
876 - "EchoService"
877 summary: "EchoUnauthorized method receives a simple message and returns it.\
878 \ It must\nalways return a google.rpc.Code of `UNAUTHENTICATED` and a HTTP\
879 \ Status code\nof 401."
880 operationId: "EchoService_EchoUnauthorized"
881 parameters:
882 - name: "id"
883 in: "query"
884 description: "Id represents the message identifier."
885 required: false
886 type: "string"
887 x-exportParamName: "Id"
888 x-optionalDataType: "String"
889 - name: "num"
890 in: "query"
891 required: false
892 type: "string"
893 format: "int64"
894 x-exportParamName: "Num"
895 x-optionalDataType: "String"
896 - name: "lineNum"
897 in: "query"
898 required: false
899 type: "string"
900 format: "int64"
901 x-exportParamName: "LineNum"
902 x-optionalDataType: "String"
903 - name: "lang"
904 in: "query"
905 required: false
906 type: "string"
907 x-exportParamName: "Lang"
908 x-optionalDataType: "String"
909 - name: "status.progress"
910 in: "query"
911 required: false
912 type: "string"
913 format: "int64"
914 x-exportParamName: "StatusProgress"
915 x-optionalDataType: "String"
916 - name: "status.note"
917 in: "query"
918 required: false
919 type: "string"
920 x-exportParamName: "StatusNote"
921 x-optionalDataType: "String"
922 - name: "en"
923 in: "query"
924 required: false
925 type: "string"
926 format: "int64"
927 x-exportParamName: "En"
928 x-optionalDataType: "String"
929 - name: "no.progress"
930 in: "query"
931 required: false
932 type: "string"
933 format: "int64"
934 x-exportParamName: "NoProgress"
935 x-optionalDataType: "String"
936 - name: "no.note"
937 in: "query"
938 required: false
939 type: "string"
940 x-exportParamName: "NoNote"
941 x-optionalDataType: "String"
942 - name: "resourceId"
943 in: "query"
944 required: false
945 type: "string"
946 x-exportParamName: "ResourceId"
947 x-optionalDataType: "String"
948 - name: "nId.nId"
949 in: "query"
950 required: false
951 type: "string"
952 x-exportParamName: "NIdNId"
953 x-optionalDataType: "String"
954 - name: "nId.val"
955 in: "query"
956 required: false
957 type: "string"
958 x-exportParamName: "NIdVal"
959 x-optionalDataType: "String"
960 responses:
961 200:
962 description: "A successful response."
963 schema:
964 $ref: "#/definitions/examplepbSimpleMessage"
965 default:
966 description: "An unexpected error response."
967 schema:
968 $ref: "#/definitions/rpcStatus"
969definitions:
970 examplepbDynamicMessage:
971 type: "object"
972 properties:
973 structField:
974 type: "object"
975 properties: {}
976 valueField: {}
977 description: "DynamicMessage represents a message which can have its structure\n\
978 built dynamically using Struct and Values."
979 example:
980 structField: "{}"
981 valueField: ""
982 examplepbDynamicMessageUpdate:
983 type: "object"
984 properties:
985 body:
986 $ref: "#/definitions/examplepbDynamicMessage"
987 updateMask:
988 type: "string"
989 example:
990 body:
991 structField: "{}"
992 valueField: ""
993 updateMask: "updateMask"
994 examplepbEmbedded:
995 type: "object"
996 properties:
997 progress:
998 type: "string"
999 format: "int64"
1000 note:
1001 type: "string"
1002 description: "Embedded represents a message embedded in SimpleMessage."
1003 example:
1004 note: "note"
1005 progress: "progress"
1006 examplepbNestedMessage:
1007 type: "object"
1008 properties:
1009 nId:
1010 type: "string"
1011 val:
1012 type: "string"
1013 example:
1014 val: "val"
1015 nId: "nId"
1016 examplepbSimpleMessage:
1017 type: "object"
1018 properties:
1019 id:
1020 type: "string"
1021 description: "Id represents the message identifier."
1022 num:
1023 type: "string"
1024 format: "int64"
1025 lineNum:
1026 type: "string"
1027 format: "int64"
1028 lang:
1029 type: "string"
1030 status:
1031 $ref: "#/definitions/examplepbEmbedded"
1032 en:
1033 type: "string"
1034 format: "int64"
1035 "no":
1036 $ref: "#/definitions/examplepbEmbedded"
1037 resourceId:
1038 type: "string"
1039 nId:
1040 $ref: "#/definitions/examplepbNestedMessage"
1041 description: "SimpleMessage represents a simple message sent to the Echo service."
1042 example:
1043 "no":
1044 note: "note"
1045 progress: "progress"
1046 resourceId: "resourceId"
1047 num: "num"
1048 nId:
1049 val: "val"
1050 nId: "nId"
1051 lineNum: "lineNum"
1052 en: "en"
1053 id: "id"
1054 lang: "lang"
1055 status:
1056 note: "note"
1057 progress: "progress"
1058 protobufAny:
1059 type: "object"
1060 properties:
1061 '@type':
1062 type: "string"
1063 description: "A URL/resource name that uniquely identifies the type of the\
1064 \ serialized\nprotocol buffer message. This string must contain at least\n\
1065 one \"/\" character. The last segment of the URL's path must represent\n\
1066 the fully qualified name of the type (as in\n`path/google.protobuf.Duration`).\
1067 \ The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\
1068 \nIn practice, teams usually precompile into the binary all types that they\n\
1069 expect it to use in the context of Any. However, for URLs which use the\n\
1070 scheme `http`, `https`, or no scheme, one can optionally set up a type\n\
1071 server that maps type URLs to message definitions as follows:\n\n* If no\
1072 \ scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must\
1073 \ yield a [google.protobuf.Type][]\n value in binary format, or produce\
1074 \ an error.\n* Applications are allowed to cache lookup results based on\
1075 \ the\n URL, or have them precompiled into a binary to avoid any\n lookup.\
1076 \ Therefore, binary compatibility needs to be preserved\n on changes to\
1077 \ types. (Use versioned type names to manage\n breaking changes.)\n\nNote:\
1078 \ this functionality is not currently available in the official\nprotobuf\
1079 \ release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\
1080 \nSchemes other than `http`, `https` (or the empty scheme) might be\nused\
1081 \ with implementation specific semantics."
1082 description: "`Any` contains an arbitrary serialized protocol buffer message along\
1083 \ with a\nURL that describes the type of the serialized message.\n\nProtobuf\
1084 \ library provides support to pack/unpack Any values in the form\nof utility\
1085 \ functions or additional generated methods of the Any type.\n\nExample 1: Pack\
1086 \ and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n\
1087 \ ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack\
1088 \ and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n\
1089 \ ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n\
1090 \ }\n\nExample 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n\
1091 \ any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n\
1092 \ any.Unpack(foo)\n ...\n\nExample 4: Pack and unpack a message in\
1093 \ Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err\
1094 \ != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err\
1095 \ := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods\
1096 \ provided by protobuf library will by default use\n'type.googleapis.com/full.type.name'\
1097 \ as the type URL and the unpack\nmethods only use the fully qualified type\
1098 \ name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\"\
1099 \ will yield type\nname \"y.z\".\n\n\nJSON\n\nThe JSON representation of an\
1100 \ `Any` value uses the regular\nrepresentation of the deserialized, embedded\
1101 \ message, with an\nadditional field `@type` which contains the type URL. Example:\n\
1102 \n package google.profile;\n message Person {\n string first_name\
1103 \ = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\"\
1104 ,\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf\
1105 \ the embedded message type is well-known and has a custom JSON\nrepresentation,\
1106 \ that representation will be embedded adding a field\n`value` which holds the\
1107 \ custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\
1108 \n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n\
1109 \ \"value\": \"1.212s\"\n }"
1110 additionalProperties: {}
1111 protobufNullValue:
1112 type: "string"
1113 description: "`NullValue` is a singleton enumeration to represent the null value\
1114 \ for the\n`Value` type union.\n\n The JSON representation for `NullValue` is\
1115 \ JSON `null`.\n\n - NULL_VALUE: Null value."
1116 enum:
1117 - "NULL_VALUE"
1118 default: "NULL_VALUE"
1119 rpcStatus:
1120 type: "object"
1121 properties:
1122 code:
1123 type: "integer"
1124 format: "int32"
1125 description: "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]."
1126 message:
1127 type: "string"
1128 description: "A developer-facing error message, which should be in English.\
1129 \ Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details]\
1130 \ field, or localized by the client."
1131 details:
1132 type: "array"
1133 description: "A list of messages that carry the error details. There is a\
1134 \ common set of\nmessage types for APIs to use."
1135 items:
1136 $ref: "#/definitions/protobufAny"
1137 description: "The `Status` type defines a logical error model that is suitable\
1138 \ for\ndifferent programming environments, including REST APIs and RPC APIs.\
1139 \ It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\n\
1140 three pieces of data: error code, error message, and error details.\n\nYou can\
1141 \ find out more about this error model and how to work with it in the\n[API\
1142 \ Design Guide](https://cloud.google.com/apis/design/errors)."
View as plain text