1---
2swagger: "2.0"
3info:
4 version: "1.0"
5 title: "A Bit of Everything"
6 contact:
7 name: "gRPC-Gateway project"
8 url: "https://github.com/grpc-ecosystem/grpc-gateway"
9 email: "none@example.com"
10 license:
11 name: "BSD 3-Clause License"
12 url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt"
13 x-something-something: "yadda"
14schemes:
15- "http"
16- "https"
17- "wss"
18consumes:
19- "application/json"
20- "application/x-foo-mime"
21produces:
22- "application/json"
23- "application/x-foo-mime"
24security:
25- ApiKeyAuth: []
26 BasicAuth: []
27- ApiKeyAuth: []
28 OAuth2:
29 - "read"
30 - "write"
31paths:
32 /v1/example/a_bit_of_everything:
33 post:
34 tags:
35 - "ABitOfEverythingService"
36 operationId: "ABitOfEverythingService_CreateBody"
37 parameters:
38 - in: "body"
39 name: "body"
40 required: true
41 schema:
42 $ref: "#/definitions/examplepbABitOfEverything"
43 x-exportParamName: "Body"
44 responses:
45 200:
46 description: "A successful response."
47 schema:
48 $ref: "#/definitions/examplepbABitOfEverything"
49 403:
50 description: "Returned when the user does not have permission to access\
51 \ the resource."
52 schema: {}
53 404:
54 description: "Returned when the resource does not exist."
55 schema:
56 type: "string"
57 format: "string"
58 418:
59 description: "I'm a teapot."
60 schema:
61 $ref: "#/definitions/examplepbNumericEnum"
62 500:
63 description: "Server error"
64 schema:
65 $ref: "#/definitions/examplepbErrorResponse"
66 default:
67 description: "An unexpected error response."
68 schema:
69 $ref: "#/definitions/runtimeError"
70 /v1/example/a_bit_of_everything/echo/{value}:
71 get:
72 tags:
73 - "echo rpc"
74 summary: "Summary: Echo rpc"
75 description: "Description Echo"
76 operationId: "ABitOfEverythingService_Echo"
77 parameters:
78 - name: "value"
79 in: "path"
80 required: true
81 type: "string"
82 x-exportParamName: "Value"
83 responses:
84 200:
85 description: "A successful response."
86 examples:
87 application/json:
88 value: "the input value"
89 schema:
90 $ref: "#/definitions/subStringMessage"
91 403:
92 description: "Returned when the user does not have permission to access\
93 \ the resource."
94 schema: {}
95 404:
96 description: "Returned when the resource does not exist."
97 schema:
98 type: "integer"
99 format: "integer"
100 418:
101 description: "I'm a teapot."
102 schema:
103 $ref: "#/definitions/examplepbNumericEnum"
104 500:
105 description: "Server error"
106 schema:
107 $ref: "#/definitions/examplepbErrorResponse"
108 503:
109 description: "Returned when the resource is temporarily unavailable."
110 schema: {}
111 x-number: 100
112 default:
113 description: "An unexpected error response."
114 schema:
115 $ref: "#/definitions/runtimeError"
116 externalDocs:
117 description: "Find out more Echo"
118 url: "https://github.com/grpc-ecosystem/grpc-gateway"
119 /v1/example/a_bit_of_everything/params/get/nested_enum/{single_nested.ok}:
120 get:
121 tags:
122 - "ABitOfEverythingService"
123 operationId: "ABitOfEverythingService_CheckNestedEnumGetQueryParams"
124 parameters:
125 - name: "single_nested.ok"
126 in: "path"
127 description: "DeepEnum description."
128 required: true
129 type: "string"
130 enum:
131 - "FALSE"
132 - "TRUE"
133 x-exportParamName: "SingleNestedOk"
134 - name: "single_nested.name"
135 in: "query"
136 description: "name is nested field."
137 required: false
138 type: "string"
139 x-exportParamName: "SingleNestedName"
140 x-optionalDataType: "String"
141 - name: "single_nested.amount"
142 in: "query"
143 required: false
144 type: "integer"
145 format: "int64"
146 x-exportParamName: "SingleNestedAmount"
147 x-optionalDataType: "Int64"
148 - name: "uuid"
149 in: "query"
150 required: false
151 type: "string"
152 x-exportParamName: "Uuid"
153 x-optionalDataType: "String"
154 - name: "float_value"
155 in: "query"
156 description: "Float value field"
157 required: true
158 type: "number"
159 default: 0.2
160 format: "float"
161 x-exportParamName: "FloatValue"
162 - name: "double_value"
163 in: "query"
164 required: false
165 type: "number"
166 format: "double"
167 x-exportParamName: "DoubleValue"
168 x-optionalDataType: "Float64"
169 - name: "int64_value"
170 in: "query"
171 required: false
172 type: "string"
173 format: "int64"
174 x-exportParamName: "Int64Value"
175 x-optionalDataType: "String"
176 - name: "uint64_value"
177 in: "query"
178 required: false
179 type: "string"
180 format: "uint64"
181 x-exportParamName: "Uint64Value"
182 x-optionalDataType: "String"
183 - name: "int32_value"
184 in: "query"
185 required: false
186 type: "integer"
187 format: "int32"
188 x-exportParamName: "Int32Value"
189 x-optionalDataType: "Int32"
190 - name: "fixed64_value"
191 in: "query"
192 required: false
193 type: "string"
194 format: "uint64"
195 x-exportParamName: "Fixed64Value"
196 x-optionalDataType: "String"
197 - name: "fixed32_value"
198 in: "query"
199 required: false
200 type: "integer"
201 format: "int64"
202 x-exportParamName: "Fixed32Value"
203 x-optionalDataType: "Int64"
204 - name: "bool_value"
205 in: "query"
206 required: false
207 type: "boolean"
208 x-exportParamName: "BoolValue"
209 x-optionalDataType: "Bool"
210 - name: "string_value"
211 in: "query"
212 required: false
213 type: "string"
214 x-exportParamName: "StringValue"
215 x-optionalDataType: "String"
216 - name: "bytes_value"
217 in: "query"
218 required: false
219 type: "string"
220 format: "byte"
221 x-exportParamName: "BytesValue"
222 x-optionalDataType: "String"
223 - name: "uint32_value"
224 in: "query"
225 required: false
226 type: "integer"
227 format: "int64"
228 x-exportParamName: "Uint32Value"
229 x-optionalDataType: "Int64"
230 - name: "enum_value"
231 in: "query"
232 description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
233 required: false
234 type: "string"
235 default: "ZERO"
236 enum:
237 - "ZERO"
238 - "ONE"
239 x-exportParamName: "EnumValue"
240 x-optionalDataType: "String"
241 - name: "path_enum_value"
242 in: "query"
243 required: false
244 type: "string"
245 default: "ABC"
246 enum:
247 - "ABC"
248 - "DEF"
249 x-exportParamName: "PathEnumValue"
250 x-optionalDataType: "String"
251 - name: "nested_path_enum_value"
252 in: "query"
253 required: false
254 type: "string"
255 default: "GHI"
256 enum:
257 - "GHI"
258 - "JKL"
259 x-exportParamName: "NestedPathEnumValue"
260 x-optionalDataType: "String"
261 - name: "sfixed32_value"
262 in: "query"
263 required: false
264 type: "integer"
265 format: "int32"
266 x-exportParamName: "Sfixed32Value"
267 x-optionalDataType: "Int32"
268 - name: "sfixed64_value"
269 in: "query"
270 required: false
271 type: "string"
272 format: "int64"
273 x-exportParamName: "Sfixed64Value"
274 x-optionalDataType: "String"
275 - name: "sint32_value"
276 in: "query"
277 required: false
278 type: "integer"
279 format: "int32"
280 x-exportParamName: "Sint32Value"
281 x-optionalDataType: "Int32"
282 - name: "sint64_value"
283 in: "query"
284 required: false
285 type: "string"
286 format: "int64"
287 x-exportParamName: "Sint64Value"
288 x-optionalDataType: "String"
289 - name: "repeated_string_value"
290 in: "query"
291 required: false
292 type: "array"
293 items:
294 type: "string"
295 collectionFormat: "multi"
296 x-exportParamName: "RepeatedStringValue"
297 - name: "oneof_string"
298 in: "query"
299 required: false
300 type: "string"
301 x-exportParamName: "OneofString"
302 x-optionalDataType: "String"
303 - name: "nonConventionalNameValue"
304 in: "query"
305 required: false
306 type: "string"
307 x-exportParamName: "NonConventionalNameValue"
308 x-optionalDataType: "String"
309 - name: "timestamp_value"
310 in: "query"
311 required: false
312 type: "string"
313 format: "date-time"
314 x-exportParamName: "TimestampValue"
315 x-optionalDataType: "Time"
316 - name: "repeated_enum_value"
317 in: "query"
318 description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
319 \ ZERO means 0\n - ONE: ONE means 1"
320 required: false
321 type: "array"
322 items:
323 type: "string"
324 enum:
325 - "ZERO"
326 - "ONE"
327 collectionFormat: "multi"
328 x-exportParamName: "RepeatedEnumValue"
329 - name: "repeated_enum_annotation"
330 in: "query"
331 description: "Repeated numeric enum title. Repeated numeric enum description.\n\
332 \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
333 required: false
334 type: "array"
335 items:
336 type: "string"
337 enum:
338 - "ZERO"
339 - "ONE"
340 collectionFormat: "multi"
341 x-exportParamName: "RepeatedEnumAnnotation"
342 - name: "enum_value_annotation"
343 in: "query"
344 description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
345 \ means 0\n - ONE: ONE means 1"
346 required: false
347 type: "string"
348 default: "ZERO"
349 enum:
350 - "ZERO"
351 - "ONE"
352 x-exportParamName: "EnumValueAnnotation"
353 x-optionalDataType: "String"
354 - name: "repeated_string_annotation"
355 in: "query"
356 description: "Repeated string title. Repeated string description."
357 required: false
358 type: "array"
359 items:
360 type: "string"
361 collectionFormat: "multi"
362 x-exportParamName: "RepeatedStringAnnotation"
363 - name: "nested_annotation.name"
364 in: "query"
365 description: "name is nested field."
366 required: false
367 type: "string"
368 x-exportParamName: "NestedAnnotationName"
369 x-optionalDataType: "String"
370 - name: "nested_annotation.amount"
371 in: "query"
372 required: false
373 type: "integer"
374 format: "int64"
375 x-exportParamName: "NestedAnnotationAmount"
376 x-optionalDataType: "Int64"
377 - name: "int64_override_type"
378 in: "query"
379 required: false
380 type: "integer"
381 format: "int64"
382 x-exportParamName: "Int64OverrideType"
383 x-optionalDataType: "Int64"
384 responses:
385 200:
386 description: "A successful response."
387 schema:
388 $ref: "#/definitions/examplepbABitOfEverything"
389 403:
390 description: "Returned when the user does not have permission to access\
391 \ the resource."
392 schema: {}
393 404:
394 description: "Returned when the resource does not exist."
395 schema:
396 type: "string"
397 format: "string"
398 418:
399 description: "I'm a teapot."
400 schema:
401 $ref: "#/definitions/examplepbNumericEnum"
402 500:
403 description: "Server error"
404 schema:
405 $ref: "#/definitions/examplepbErrorResponse"
406 default:
407 description: "An unexpected error response."
408 schema:
409 $ref: "#/definitions/runtimeError"
410 /v1/example/a_bit_of_everything/params/get/{single_nested.name}:
411 get:
412 tags:
413 - "ABitOfEverythingService"
414 operationId: "ABitOfEverythingService_CheckGetQueryParams"
415 parameters:
416 - name: "single_nested.name"
417 in: "path"
418 description: "name is nested field."
419 required: true
420 type: "string"
421 x-exportParamName: "SingleNestedName"
422 - name: "single_nested.amount"
423 in: "query"
424 required: false
425 type: "integer"
426 format: "int64"
427 x-exportParamName: "SingleNestedAmount"
428 x-optionalDataType: "Int64"
429 - name: "single_nested.ok"
430 in: "query"
431 description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
432 \ TRUE is true."
433 required: false
434 type: "string"
435 default: "FALSE"
436 enum:
437 - "FALSE"
438 - "TRUE"
439 x-exportParamName: "SingleNestedOk"
440 x-optionalDataType: "String"
441 - name: "uuid"
442 in: "query"
443 required: false
444 type: "string"
445 x-exportParamName: "Uuid"
446 x-optionalDataType: "String"
447 - name: "float_value"
448 in: "query"
449 description: "Float value field"
450 required: true
451 type: "number"
452 default: 0.2
453 format: "float"
454 x-exportParamName: "FloatValue"
455 - name: "double_value"
456 in: "query"
457 required: false
458 type: "number"
459 format: "double"
460 x-exportParamName: "DoubleValue"
461 x-optionalDataType: "Float64"
462 - name: "int64_value"
463 in: "query"
464 required: false
465 type: "string"
466 format: "int64"
467 x-exportParamName: "Int64Value"
468 x-optionalDataType: "String"
469 - name: "uint64_value"
470 in: "query"
471 required: false
472 type: "string"
473 format: "uint64"
474 x-exportParamName: "Uint64Value"
475 x-optionalDataType: "String"
476 - name: "int32_value"
477 in: "query"
478 required: false
479 type: "integer"
480 format: "int32"
481 x-exportParamName: "Int32Value"
482 x-optionalDataType: "Int32"
483 - name: "fixed64_value"
484 in: "query"
485 required: false
486 type: "string"
487 format: "uint64"
488 x-exportParamName: "Fixed64Value"
489 x-optionalDataType: "String"
490 - name: "fixed32_value"
491 in: "query"
492 required: false
493 type: "integer"
494 format: "int64"
495 x-exportParamName: "Fixed32Value"
496 x-optionalDataType: "Int64"
497 - name: "bool_value"
498 in: "query"
499 required: false
500 type: "boolean"
501 x-exportParamName: "BoolValue"
502 x-optionalDataType: "Bool"
503 - name: "string_value"
504 in: "query"
505 required: false
506 type: "string"
507 x-exportParamName: "StringValue"
508 x-optionalDataType: "String"
509 - name: "bytes_value"
510 in: "query"
511 required: false
512 type: "string"
513 format: "byte"
514 x-exportParamName: "BytesValue"
515 x-optionalDataType: "String"
516 - name: "uint32_value"
517 in: "query"
518 required: false
519 type: "integer"
520 format: "int64"
521 x-exportParamName: "Uint32Value"
522 x-optionalDataType: "Int64"
523 - name: "enum_value"
524 in: "query"
525 description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
526 required: false
527 type: "string"
528 default: "ZERO"
529 enum:
530 - "ZERO"
531 - "ONE"
532 x-exportParamName: "EnumValue"
533 x-optionalDataType: "String"
534 - name: "path_enum_value"
535 in: "query"
536 required: false
537 type: "string"
538 default: "ABC"
539 enum:
540 - "ABC"
541 - "DEF"
542 x-exportParamName: "PathEnumValue"
543 x-optionalDataType: "String"
544 - name: "nested_path_enum_value"
545 in: "query"
546 required: false
547 type: "string"
548 default: "GHI"
549 enum:
550 - "GHI"
551 - "JKL"
552 x-exportParamName: "NestedPathEnumValue"
553 x-optionalDataType: "String"
554 - name: "sfixed32_value"
555 in: "query"
556 required: false
557 type: "integer"
558 format: "int32"
559 x-exportParamName: "Sfixed32Value"
560 x-optionalDataType: "Int32"
561 - name: "sfixed64_value"
562 in: "query"
563 required: false
564 type: "string"
565 format: "int64"
566 x-exportParamName: "Sfixed64Value"
567 x-optionalDataType: "String"
568 - name: "sint32_value"
569 in: "query"
570 required: false
571 type: "integer"
572 format: "int32"
573 x-exportParamName: "Sint32Value"
574 x-optionalDataType: "Int32"
575 - name: "sint64_value"
576 in: "query"
577 required: false
578 type: "string"
579 format: "int64"
580 x-exportParamName: "Sint64Value"
581 x-optionalDataType: "String"
582 - name: "repeated_string_value"
583 in: "query"
584 required: false
585 type: "array"
586 items:
587 type: "string"
588 collectionFormat: "multi"
589 x-exportParamName: "RepeatedStringValue"
590 - name: "oneof_string"
591 in: "query"
592 required: false
593 type: "string"
594 x-exportParamName: "OneofString"
595 x-optionalDataType: "String"
596 - name: "nonConventionalNameValue"
597 in: "query"
598 required: false
599 type: "string"
600 x-exportParamName: "NonConventionalNameValue"
601 x-optionalDataType: "String"
602 - name: "timestamp_value"
603 in: "query"
604 required: false
605 type: "string"
606 format: "date-time"
607 x-exportParamName: "TimestampValue"
608 x-optionalDataType: "Time"
609 - name: "repeated_enum_value"
610 in: "query"
611 description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
612 \ ZERO means 0\n - ONE: ONE means 1"
613 required: false
614 type: "array"
615 items:
616 type: "string"
617 enum:
618 - "ZERO"
619 - "ONE"
620 collectionFormat: "multi"
621 x-exportParamName: "RepeatedEnumValue"
622 - name: "repeated_enum_annotation"
623 in: "query"
624 description: "Repeated numeric enum title. Repeated numeric enum description.\n\
625 \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
626 required: false
627 type: "array"
628 items:
629 type: "string"
630 enum:
631 - "ZERO"
632 - "ONE"
633 collectionFormat: "multi"
634 x-exportParamName: "RepeatedEnumAnnotation"
635 - name: "enum_value_annotation"
636 in: "query"
637 description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
638 \ means 0\n - ONE: ONE means 1"
639 required: false
640 type: "string"
641 default: "ZERO"
642 enum:
643 - "ZERO"
644 - "ONE"
645 x-exportParamName: "EnumValueAnnotation"
646 x-optionalDataType: "String"
647 - name: "repeated_string_annotation"
648 in: "query"
649 description: "Repeated string title. Repeated string description."
650 required: false
651 type: "array"
652 items:
653 type: "string"
654 collectionFormat: "multi"
655 x-exportParamName: "RepeatedStringAnnotation"
656 - name: "nested_annotation.amount"
657 in: "query"
658 required: false
659 type: "integer"
660 format: "int64"
661 x-exportParamName: "NestedAnnotationAmount"
662 x-optionalDataType: "Int64"
663 - name: "nested_annotation.ok"
664 in: "query"
665 description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
666 \ TRUE is true."
667 required: false
668 type: "string"
669 default: "FALSE"
670 enum:
671 - "FALSE"
672 - "TRUE"
673 x-exportParamName: "NestedAnnotationOk"
674 x-optionalDataType: "String"
675 - name: "int64_override_type"
676 in: "query"
677 required: false
678 type: "integer"
679 format: "int64"
680 x-exportParamName: "Int64OverrideType"
681 x-optionalDataType: "Int64"
682 responses:
683 200:
684 description: "A successful response."
685 schema:
686 $ref: "#/definitions/examplepbABitOfEverything"
687 403:
688 description: "Returned when the user does not have permission to access\
689 \ the resource."
690 schema: {}
691 404:
692 description: "Returned when the resource does not exist."
693 schema:
694 type: "string"
695 format: "string"
696 418:
697 description: "I'm a teapot."
698 schema:
699 $ref: "#/definitions/examplepbNumericEnum"
700 500:
701 description: "Server error"
702 schema:
703 $ref: "#/definitions/examplepbErrorResponse"
704 default:
705 description: "An unexpected error response."
706 schema:
707 $ref: "#/definitions/runtimeError"
708 /v1/example/a_bit_of_everything/params/post/{string_value}:
709 post:
710 tags:
711 - "ABitOfEverythingService"
712 operationId: "ABitOfEverythingService_CheckPostQueryParams"
713 parameters:
714 - name: "string_value"
715 in: "path"
716 required: true
717 type: "string"
718 x-exportParamName: "StringValue"
719 - in: "body"
720 name: "body"
721 required: true
722 schema:
723 $ref: "#/definitions/ABitOfEverythingNested"
724 x-exportParamName: "Body"
725 - name: "uuid"
726 in: "query"
727 required: false
728 type: "string"
729 x-exportParamName: "Uuid"
730 x-optionalDataType: "String"
731 - name: "float_value"
732 in: "query"
733 description: "Float value field"
734 required: true
735 type: "number"
736 default: 0.2
737 format: "float"
738 x-exportParamName: "FloatValue"
739 - name: "double_value"
740 in: "query"
741 required: false
742 type: "number"
743 format: "double"
744 x-exportParamName: "DoubleValue"
745 x-optionalDataType: "Float64"
746 - name: "int64_value"
747 in: "query"
748 required: false
749 type: "string"
750 format: "int64"
751 x-exportParamName: "Int64Value"
752 x-optionalDataType: "String"
753 - name: "uint64_value"
754 in: "query"
755 required: false
756 type: "string"
757 format: "uint64"
758 x-exportParamName: "Uint64Value"
759 x-optionalDataType: "String"
760 - name: "int32_value"
761 in: "query"
762 required: false
763 type: "integer"
764 format: "int32"
765 x-exportParamName: "Int32Value"
766 x-optionalDataType: "Int32"
767 - name: "fixed64_value"
768 in: "query"
769 required: false
770 type: "string"
771 format: "uint64"
772 x-exportParamName: "Fixed64Value"
773 x-optionalDataType: "String"
774 - name: "fixed32_value"
775 in: "query"
776 required: false
777 type: "integer"
778 format: "int64"
779 x-exportParamName: "Fixed32Value"
780 x-optionalDataType: "Int64"
781 - name: "bool_value"
782 in: "query"
783 required: false
784 type: "boolean"
785 x-exportParamName: "BoolValue"
786 x-optionalDataType: "Bool"
787 - name: "bytes_value"
788 in: "query"
789 required: false
790 type: "string"
791 format: "byte"
792 x-exportParamName: "BytesValue"
793 x-optionalDataType: "String"
794 - name: "uint32_value"
795 in: "query"
796 required: false
797 type: "integer"
798 format: "int64"
799 x-exportParamName: "Uint32Value"
800 x-optionalDataType: "Int64"
801 - name: "enum_value"
802 in: "query"
803 description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
804 required: false
805 type: "string"
806 default: "ZERO"
807 enum:
808 - "ZERO"
809 - "ONE"
810 x-exportParamName: "EnumValue"
811 x-optionalDataType: "String"
812 - name: "path_enum_value"
813 in: "query"
814 required: false
815 type: "string"
816 default: "ABC"
817 enum:
818 - "ABC"
819 - "DEF"
820 x-exportParamName: "PathEnumValue"
821 x-optionalDataType: "String"
822 - name: "nested_path_enum_value"
823 in: "query"
824 required: false
825 type: "string"
826 default: "GHI"
827 enum:
828 - "GHI"
829 - "JKL"
830 x-exportParamName: "NestedPathEnumValue"
831 x-optionalDataType: "String"
832 - name: "sfixed32_value"
833 in: "query"
834 required: false
835 type: "integer"
836 format: "int32"
837 x-exportParamName: "Sfixed32Value"
838 x-optionalDataType: "Int32"
839 - name: "sfixed64_value"
840 in: "query"
841 required: false
842 type: "string"
843 format: "int64"
844 x-exportParamName: "Sfixed64Value"
845 x-optionalDataType: "String"
846 - name: "sint32_value"
847 in: "query"
848 required: false
849 type: "integer"
850 format: "int32"
851 x-exportParamName: "Sint32Value"
852 x-optionalDataType: "Int32"
853 - name: "sint64_value"
854 in: "query"
855 required: false
856 type: "string"
857 format: "int64"
858 x-exportParamName: "Sint64Value"
859 x-optionalDataType: "String"
860 - name: "repeated_string_value"
861 in: "query"
862 required: false
863 type: "array"
864 items:
865 type: "string"
866 collectionFormat: "multi"
867 x-exportParamName: "RepeatedStringValue"
868 - name: "oneof_string"
869 in: "query"
870 required: false
871 type: "string"
872 x-exportParamName: "OneofString"
873 x-optionalDataType: "String"
874 - name: "nonConventionalNameValue"
875 in: "query"
876 required: false
877 type: "string"
878 x-exportParamName: "NonConventionalNameValue"
879 x-optionalDataType: "String"
880 - name: "timestamp_value"
881 in: "query"
882 required: false
883 type: "string"
884 format: "date-time"
885 x-exportParamName: "TimestampValue"
886 x-optionalDataType: "Time"
887 - name: "repeated_enum_value"
888 in: "query"
889 description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
890 \ ZERO means 0\n - ONE: ONE means 1"
891 required: false
892 type: "array"
893 items:
894 type: "string"
895 enum:
896 - "ZERO"
897 - "ONE"
898 collectionFormat: "multi"
899 x-exportParamName: "RepeatedEnumValue"
900 - name: "repeated_enum_annotation"
901 in: "query"
902 description: "Repeated numeric enum title. Repeated numeric enum description.\n\
903 \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
904 required: false
905 type: "array"
906 items:
907 type: "string"
908 enum:
909 - "ZERO"
910 - "ONE"
911 collectionFormat: "multi"
912 x-exportParamName: "RepeatedEnumAnnotation"
913 - name: "enum_value_annotation"
914 in: "query"
915 description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
916 \ means 0\n - ONE: ONE means 1"
917 required: false
918 type: "string"
919 default: "ZERO"
920 enum:
921 - "ZERO"
922 - "ONE"
923 x-exportParamName: "EnumValueAnnotation"
924 x-optionalDataType: "String"
925 - name: "repeated_string_annotation"
926 in: "query"
927 description: "Repeated string title. Repeated string description."
928 required: false
929 type: "array"
930 items:
931 type: "string"
932 collectionFormat: "multi"
933 x-exportParamName: "RepeatedStringAnnotation"
934 - name: "nested_annotation.name"
935 in: "query"
936 description: "name is nested field."
937 required: false
938 type: "string"
939 x-exportParamName: "NestedAnnotationName"
940 x-optionalDataType: "String"
941 - name: "nested_annotation.amount"
942 in: "query"
943 required: false
944 type: "integer"
945 format: "int64"
946 x-exportParamName: "NestedAnnotationAmount"
947 x-optionalDataType: "Int64"
948 - name: "nested_annotation.ok"
949 in: "query"
950 description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
951 \ TRUE is true."
952 required: false
953 type: "string"
954 default: "FALSE"
955 enum:
956 - "FALSE"
957 - "TRUE"
958 x-exportParamName: "NestedAnnotationOk"
959 x-optionalDataType: "String"
960 - name: "int64_override_type"
961 in: "query"
962 required: false
963 type: "integer"
964 format: "int64"
965 x-exportParamName: "Int64OverrideType"
966 x-optionalDataType: "Int64"
967 responses:
968 200:
969 description: "A successful response."
970 schema:
971 $ref: "#/definitions/examplepbABitOfEverything"
972 403:
973 description: "Returned when the user does not have permission to access\
974 \ the resource."
975 schema: {}
976 404:
977 description: "Returned when the resource does not exist."
978 schema:
979 type: "string"
980 format: "string"
981 418:
982 description: "I'm a teapot."
983 schema:
984 $ref: "#/definitions/examplepbNumericEnum"
985 500:
986 description: "Server error"
987 schema:
988 $ref: "#/definitions/examplepbErrorResponse"
989 default:
990 description: "An unexpected error response."
991 schema:
992 $ref: "#/definitions/runtimeError"
993 /v1/example/a_bit_of_everything/query/{uuid}:
994 get:
995 tags:
996 - "ABitOfEverythingService"
997 operationId: "ABitOfEverythingService_GetQuery"
998 parameters:
999 - name: "uuid"
1000 in: "path"
1001 required: true
1002 type: "string"
1003 x-exportParamName: "Uuid"
1004 - name: "single_nested.name"
1005 in: "query"
1006 description: "name is nested field."
1007 required: false
1008 type: "string"
1009 x-exportParamName: "SingleNestedName"
1010 x-optionalDataType: "String"
1011 - name: "single_nested.amount"
1012 in: "query"
1013 required: false
1014 type: "integer"
1015 format: "int64"
1016 x-exportParamName: "SingleNestedAmount"
1017 x-optionalDataType: "Int64"
1018 - name: "single_nested.ok"
1019 in: "query"
1020 description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
1021 \ TRUE is true."
1022 required: false
1023 type: "string"
1024 default: "FALSE"
1025 enum:
1026 - "FALSE"
1027 - "TRUE"
1028 x-exportParamName: "SingleNestedOk"
1029 x-optionalDataType: "String"
1030 - name: "float_value"
1031 in: "query"
1032 description: "Float value field"
1033 required: true
1034 type: "number"
1035 default: 0.2
1036 format: "float"
1037 x-exportParamName: "FloatValue"
1038 - name: "double_value"
1039 in: "query"
1040 required: false
1041 type: "number"
1042 format: "double"
1043 x-exportParamName: "DoubleValue"
1044 x-optionalDataType: "Float64"
1045 - name: "int64_value"
1046 in: "query"
1047 required: false
1048 type: "string"
1049 format: "int64"
1050 x-exportParamName: "Int64Value"
1051 x-optionalDataType: "String"
1052 - name: "uint64_value"
1053 in: "query"
1054 required: false
1055 type: "string"
1056 format: "uint64"
1057 x-exportParamName: "Uint64Value"
1058 x-optionalDataType: "String"
1059 - name: "int32_value"
1060 in: "query"
1061 required: false
1062 type: "integer"
1063 format: "int32"
1064 x-exportParamName: "Int32Value"
1065 x-optionalDataType: "Int32"
1066 - name: "fixed64_value"
1067 in: "query"
1068 required: false
1069 type: "string"
1070 format: "uint64"
1071 x-exportParamName: "Fixed64Value"
1072 x-optionalDataType: "String"
1073 - name: "fixed32_value"
1074 in: "query"
1075 required: false
1076 type: "integer"
1077 format: "int64"
1078 x-exportParamName: "Fixed32Value"
1079 x-optionalDataType: "Int64"
1080 - name: "bool_value"
1081 in: "query"
1082 required: false
1083 type: "boolean"
1084 x-exportParamName: "BoolValue"
1085 x-optionalDataType: "Bool"
1086 - name: "string_value"
1087 in: "query"
1088 required: false
1089 type: "string"
1090 x-exportParamName: "StringValue"
1091 x-optionalDataType: "String"
1092 - name: "bytes_value"
1093 in: "query"
1094 required: false
1095 type: "string"
1096 format: "byte"
1097 x-exportParamName: "BytesValue"
1098 x-optionalDataType: "String"
1099 - name: "uint32_value"
1100 in: "query"
1101 required: false
1102 type: "integer"
1103 format: "int64"
1104 x-exportParamName: "Uint32Value"
1105 x-optionalDataType: "Int64"
1106 - name: "enum_value"
1107 in: "query"
1108 description: " - ZERO: ZERO means 0\n - ONE: ONE means 1"
1109 required: false
1110 type: "string"
1111 default: "ZERO"
1112 enum:
1113 - "ZERO"
1114 - "ONE"
1115 x-exportParamName: "EnumValue"
1116 x-optionalDataType: "String"
1117 - name: "path_enum_value"
1118 in: "query"
1119 required: false
1120 type: "string"
1121 default: "ABC"
1122 enum:
1123 - "ABC"
1124 - "DEF"
1125 x-exportParamName: "PathEnumValue"
1126 x-optionalDataType: "String"
1127 - name: "nested_path_enum_value"
1128 in: "query"
1129 required: false
1130 type: "string"
1131 default: "GHI"
1132 enum:
1133 - "GHI"
1134 - "JKL"
1135 x-exportParamName: "NestedPathEnumValue"
1136 x-optionalDataType: "String"
1137 - name: "sfixed32_value"
1138 in: "query"
1139 required: false
1140 type: "integer"
1141 format: "int32"
1142 x-exportParamName: "Sfixed32Value"
1143 x-optionalDataType: "Int32"
1144 - name: "sfixed64_value"
1145 in: "query"
1146 required: false
1147 type: "string"
1148 format: "int64"
1149 x-exportParamName: "Sfixed64Value"
1150 x-optionalDataType: "String"
1151 - name: "sint32_value"
1152 in: "query"
1153 required: false
1154 type: "integer"
1155 format: "int32"
1156 x-exportParamName: "Sint32Value"
1157 x-optionalDataType: "Int32"
1158 - name: "sint64_value"
1159 in: "query"
1160 required: false
1161 type: "string"
1162 format: "int64"
1163 x-exportParamName: "Sint64Value"
1164 x-optionalDataType: "String"
1165 - name: "repeated_string_value"
1166 in: "query"
1167 required: false
1168 type: "array"
1169 items:
1170 type: "string"
1171 collectionFormat: "multi"
1172 x-exportParamName: "RepeatedStringValue"
1173 - name: "oneof_string"
1174 in: "query"
1175 required: false
1176 type: "string"
1177 x-exportParamName: "OneofString"
1178 x-optionalDataType: "String"
1179 - name: "nonConventionalNameValue"
1180 in: "query"
1181 required: false
1182 type: "string"
1183 x-exportParamName: "NonConventionalNameValue"
1184 x-optionalDataType: "String"
1185 - name: "timestamp_value"
1186 in: "query"
1187 required: false
1188 type: "string"
1189 format: "date-time"
1190 x-exportParamName: "TimestampValue"
1191 x-optionalDataType: "Time"
1192 - name: "repeated_enum_value"
1193 in: "query"
1194 description: "repeated enum value. it is comma-separated in query.\n\n - ZERO:\
1195 \ ZERO means 0\n - ONE: ONE means 1"
1196 required: false
1197 type: "array"
1198 items:
1199 type: "string"
1200 enum:
1201 - "ZERO"
1202 - "ONE"
1203 collectionFormat: "multi"
1204 x-exportParamName: "RepeatedEnumValue"
1205 - name: "repeated_enum_annotation"
1206 in: "query"
1207 description: "Repeated numeric enum title. Repeated numeric enum description.\n\
1208 \n - ZERO: ZERO means 0\n - ONE: ONE means 1"
1209 required: false
1210 type: "array"
1211 items:
1212 type: "string"
1213 enum:
1214 - "ZERO"
1215 - "ONE"
1216 collectionFormat: "multi"
1217 x-exportParamName: "RepeatedEnumAnnotation"
1218 - name: "enum_value_annotation"
1219 in: "query"
1220 description: "Numeric enum title. Numeric enum description.\n\n - ZERO: ZERO\
1221 \ means 0\n - ONE: ONE means 1"
1222 required: false
1223 type: "string"
1224 default: "ZERO"
1225 enum:
1226 - "ZERO"
1227 - "ONE"
1228 x-exportParamName: "EnumValueAnnotation"
1229 x-optionalDataType: "String"
1230 - name: "repeated_string_annotation"
1231 in: "query"
1232 description: "Repeated string title. Repeated string description."
1233 required: false
1234 type: "array"
1235 items:
1236 type: "string"
1237 collectionFormat: "multi"
1238 x-exportParamName: "RepeatedStringAnnotation"
1239 - name: "nested_annotation.name"
1240 in: "query"
1241 description: "name is nested field."
1242 required: false
1243 type: "string"
1244 x-exportParamName: "NestedAnnotationName"
1245 x-optionalDataType: "String"
1246 - name: "nested_annotation.amount"
1247 in: "query"
1248 required: false
1249 type: "integer"
1250 format: "int64"
1251 x-exportParamName: "NestedAnnotationAmount"
1252 x-optionalDataType: "Int64"
1253 - name: "nested_annotation.ok"
1254 in: "query"
1255 description: "DeepEnum description.\n\n - FALSE: FALSE is false.\n - TRUE:\
1256 \ TRUE is true."
1257 required: false
1258 type: "string"
1259 default: "FALSE"
1260 enum:
1261 - "FALSE"
1262 - "TRUE"
1263 x-exportParamName: "NestedAnnotationOk"
1264 x-optionalDataType: "String"
1265 - name: "int64_override_type"
1266 in: "query"
1267 required: false
1268 type: "integer"
1269 format: "int64"
1270 x-exportParamName: "Int64OverrideType"
1271 x-optionalDataType: "Int64"
1272 responses:
1273 200:
1274 description: "A successful response."
1275 schema: {}
1276 403:
1277 description: "Returned when the user does not have permission to access\
1278 \ the resource."
1279 schema: {}
1280 404:
1281 description: "Returned when the resource does not exist."
1282 schema:
1283 type: "string"
1284 format: "string"
1285 418:
1286 description: "I'm a teapot."
1287 schema:
1288 $ref: "#/definitions/examplepbNumericEnum"
1289 500:
1290 description: "Server error"
1291 schema:
1292 $ref: "#/definitions/examplepbErrorResponse"
1293 default:
1294 description: "An unexpected error response."
1295 schema:
1296 $ref: "#/definitions/runtimeError"
1297 security: []
1298 externalDocs:
1299 description: "Find out more about GetQuery"
1300 url: "https://github.com/grpc-ecosystem/grpc-gateway"
1301 deprecated: true
1302 ? /v1/example/a_bit_of_everything/{float_value}/{double_value}/{int64_value}/separator/{uint64_value}/{int32_value}/{fixed64_value}/{fixed32_value}/{bool_value}/{string_value}/{uint32_value}/{sfixed32_value}/{sfixed64_value}/{sint32_value}/{sint64_value}/{nonConventionalNameValue}/{enum_value}/{path_enum_value}/{nested_path_enum_value}/{enum_value_annotation}
1303 : post:
1304 tags:
1305 - "ABitOfEverythingService"
1306 summary: "Create a new ABitOfEverything"
1307 description: "This API creates a new ABitOfEverything"
1308 operationId: "ABitOfEverythingService_Create"
1309 parameters:
1310 - name: "float_value"
1311 in: "path"
1312 description: "Float value field"
1313 required: true
1314 type: "number"
1315 default: 0.2
1316 format: "float"
1317 x-exportParamName: "FloatValue"
1318 - name: "double_value"
1319 in: "path"
1320 required: true
1321 type: "number"
1322 format: "double"
1323 x-exportParamName: "DoubleValue"
1324 - name: "int64_value"
1325 in: "path"
1326 required: true
1327 type: "string"
1328 format: "int64"
1329 x-exportParamName: "Int64Value"
1330 - name: "uint64_value"
1331 in: "path"
1332 required: true
1333 type: "string"
1334 format: "uint64"
1335 x-exportParamName: "Uint64Value"
1336 - name: "int32_value"
1337 in: "path"
1338 required: true
1339 type: "integer"
1340 format: "int32"
1341 x-exportParamName: "Int32Value"
1342 - name: "fixed64_value"
1343 in: "path"
1344 required: true
1345 type: "string"
1346 format: "uint64"
1347 x-exportParamName: "Fixed64Value"
1348 - name: "fixed32_value"
1349 in: "path"
1350 required: true
1351 type: "integer"
1352 format: "int64"
1353 x-exportParamName: "Fixed32Value"
1354 - name: "bool_value"
1355 in: "path"
1356 required: true
1357 type: "boolean"
1358 x-exportParamName: "BoolValue"
1359 - name: "string_value"
1360 in: "path"
1361 required: true
1362 type: "string"
1363 x-exportParamName: "StringValue"
1364 - name: "uint32_value"
1365 in: "path"
1366 required: true
1367 type: "integer"
1368 format: "int64"
1369 x-exportParamName: "Uint32Value"
1370 - name: "sfixed32_value"
1371 in: "path"
1372 required: true
1373 type: "integer"
1374 format: "int32"
1375 x-exportParamName: "Sfixed32Value"
1376 - name: "sfixed64_value"
1377 in: "path"
1378 required: true
1379 type: "string"
1380 format: "int64"
1381 x-exportParamName: "Sfixed64Value"
1382 - name: "sint32_value"
1383 in: "path"
1384 required: true
1385 type: "integer"
1386 format: "int32"
1387 x-exportParamName: "Sint32Value"
1388 - name: "sint64_value"
1389 in: "path"
1390 required: true
1391 type: "string"
1392 format: "int64"
1393 x-exportParamName: "Sint64Value"
1394 - name: "nonConventionalNameValue"
1395 in: "path"
1396 required: true
1397 type: "string"
1398 x-exportParamName: "NonConventionalNameValue"
1399 - name: "enum_value"
1400 in: "path"
1401 required: true
1402 type: "string"
1403 enum:
1404 - "ZERO"
1405 - "ONE"
1406 x-exportParamName: "EnumValue"
1407 - name: "path_enum_value"
1408 in: "path"
1409 required: true
1410 type: "string"
1411 enum:
1412 - "ABC"
1413 - "DEF"
1414 x-exportParamName: "PathEnumValue"
1415 - name: "nested_path_enum_value"
1416 in: "path"
1417 required: true
1418 type: "string"
1419 enum:
1420 - "GHI"
1421 - "JKL"
1422 x-exportParamName: "NestedPathEnumValue"
1423 - name: "enum_value_annotation"
1424 in: "path"
1425 description: "Numeric enum description."
1426 required: true
1427 type: "string"
1428 enum:
1429 - "ZERO"
1430 - "ONE"
1431 x-exportParamName: "EnumValueAnnotation"
1432 responses:
1433 200:
1434 description: "A successful response."
1435 schema:
1436 $ref: "#/definitions/examplepbABitOfEverything"
1437 403:
1438 description: "Returned when the user does not have permission to access\
1439 \ the resource."
1440 schema: {}
1441 404:
1442 description: "Returned when the resource does not exist."
1443 schema:
1444 type: "string"
1445 format: "string"
1446 418:
1447 description: "I'm a teapot."
1448 schema:
1449 $ref: "#/definitions/examplepbNumericEnum"
1450 500:
1451 description: "Server error"
1452 schema:
1453 $ref: "#/definitions/examplepbErrorResponse"
1454 default:
1455 description: "An unexpected error response."
1456 schema:
1457 $ref: "#/definitions/runtimeError"
1458 /v1/example/a_bit_of_everything/{single_nested.name}:
1459 post:
1460 tags:
1461 - "ABitOfEverythingService"
1462 operationId: "ABitOfEverythingService_DeepPathEcho"
1463 parameters:
1464 - name: "single_nested.name"
1465 in: "path"
1466 description: "name is nested field."
1467 required: true
1468 type: "string"
1469 x-exportParamName: "SingleNestedName"
1470 - in: "body"
1471 name: "body"
1472 required: true
1473 schema:
1474 $ref: "#/definitions/examplepbABitOfEverything"
1475 x-exportParamName: "Body"
1476 responses:
1477 200:
1478 description: "A successful response."
1479 schema:
1480 $ref: "#/definitions/examplepbABitOfEverything"
1481 403:
1482 description: "Returned when the user does not have permission to access\
1483 \ the resource."
1484 schema: {}
1485 404:
1486 description: "Returned when the resource does not exist."
1487 schema:
1488 type: "string"
1489 format: "string"
1490 418:
1491 description: "I'm a teapot."
1492 schema:
1493 $ref: "#/definitions/examplepbNumericEnum"
1494 500:
1495 description: "Server error"
1496 schema:
1497 $ref: "#/definitions/examplepbErrorResponse"
1498 default:
1499 description: "An unexpected error response."
1500 schema:
1501 $ref: "#/definitions/runtimeError"
1502 /v1/example/a_bit_of_everything/{uuid}:
1503 get:
1504 tags:
1505 - "ABitOfEverythingService"
1506 operationId: "ABitOfEverythingService_Lookup"
1507 parameters:
1508 - name: "uuid"
1509 in: "path"
1510 required: true
1511 type: "string"
1512 x-exportParamName: "Uuid"
1513 responses:
1514 200:
1515 description: "A successful response."
1516 schema:
1517 $ref: "#/definitions/examplepbABitOfEverything"
1518 403:
1519 description: "Returned when the user does not have permission to access\
1520 \ the resource."
1521 schema: {}
1522 404:
1523 description: "Returned when the resource does not exist."
1524 schema:
1525 type: "string"
1526 format: "string"
1527 418:
1528 description: "I'm a teapot."
1529 schema:
1530 $ref: "#/definitions/examplepbNumericEnum"
1531 500:
1532 description: "Server error"
1533 schema:
1534 $ref: "#/definitions/examplepbErrorResponse"
1535 default:
1536 description: "An unexpected error response."
1537 schema:
1538 $ref: "#/definitions/runtimeError"
1539 put:
1540 tags:
1541 - "ABitOfEverythingService"
1542 operationId: "ABitOfEverythingService_Update"
1543 parameters:
1544 - name: "uuid"
1545 in: "path"
1546 required: true
1547 type: "string"
1548 x-exportParamName: "Uuid"
1549 - in: "body"
1550 name: "body"
1551 required: true
1552 schema:
1553 $ref: "#/definitions/examplepbABitOfEverything"
1554 x-exportParamName: "Body"
1555 responses:
1556 200:
1557 description: "A successful response."
1558 schema: {}
1559 403:
1560 description: "Returned when the user does not have permission to access\
1561 \ the resource."
1562 schema: {}
1563 404:
1564 description: "Returned when the resource does not exist."
1565 schema:
1566 type: "string"
1567 format: "string"
1568 418:
1569 description: "I'm a teapot."
1570 schema:
1571 $ref: "#/definitions/examplepbNumericEnum"
1572 500:
1573 description: "Server error"
1574 schema:
1575 $ref: "#/definitions/examplepbErrorResponse"
1576 default:
1577 description: "An unexpected error response."
1578 schema:
1579 $ref: "#/definitions/runtimeError"
1580 delete:
1581 tags:
1582 - "ABitOfEverythingService"
1583 operationId: "ABitOfEverythingService_Delete"
1584 parameters:
1585 - name: "uuid"
1586 in: "path"
1587 required: true
1588 type: "string"
1589 x-exportParamName: "Uuid"
1590 responses:
1591 200:
1592 description: "A successful response."
1593 schema: {}
1594 403:
1595 description: "Returned when the user does not have permission to access\
1596 \ the resource."
1597 schema: {}
1598 404:
1599 description: "Returned when the resource does not exist."
1600 schema:
1601 type: "string"
1602 format: "string"
1603 418:
1604 description: "I'm a teapot."
1605 schema:
1606 $ref: "#/definitions/examplepbNumericEnum"
1607 500:
1608 description: "Server error"
1609 schema:
1610 $ref: "#/definitions/examplepbErrorResponse"
1611 default:
1612 description: "An unexpected error response."
1613 schema:
1614 $ref: "#/definitions/runtimeError"
1615 security:
1616 - ApiKeyAuth: []
1617 OAuth2:
1618 - "read"
1619 - "write"
1620 x-irreversible: true
1621 ? /v1/example/a_bit_of_everything_repeated/{path_repeated_float_value}/{path_repeated_double_value}/{path_repeated_int64_value}/{path_repeated_uint64_value}/{path_repeated_int32_value}/{path_repeated_fixed64_value}/{path_repeated_fixed32_value}/{path_repeated_bool_value}/{path_repeated_string_value}/{path_repeated_bytes_value}/{path_repeated_uint32_value}/{path_repeated_enum_value}/{path_repeated_sfixed32_value}/{path_repeated_sfixed64_value}/{path_repeated_sint32_value}/{path_repeated_sint64_value}
1622 : get:
1623 tags:
1624 - "ABitOfEverythingService"
1625 operationId: "ABitOfEverythingService_GetRepeatedQuery"
1626 parameters:
1627 - name: "path_repeated_float_value"
1628 in: "path"
1629 description: "repeated values. they are comma-separated in path"
1630 required: true
1631 type: "array"
1632 items:
1633 type: "number"
1634 format: "float"
1635 collectionFormat: "csv"
1636 minItems: 1
1637 x-exportParamName: "PathRepeatedFloatValue"
1638 - name: "path_repeated_double_value"
1639 in: "path"
1640 required: true
1641 type: "array"
1642 items:
1643 type: "number"
1644 format: "double"
1645 collectionFormat: "csv"
1646 minItems: 1
1647 x-exportParamName: "PathRepeatedDoubleValue"
1648 - name: "path_repeated_int64_value"
1649 in: "path"
1650 required: true
1651 type: "array"
1652 items:
1653 type: "string"
1654 format: "int64"
1655 collectionFormat: "csv"
1656 minItems: 1
1657 x-exportParamName: "PathRepeatedInt64Value"
1658 - name: "path_repeated_uint64_value"
1659 in: "path"
1660 required: true
1661 type: "array"
1662 items:
1663 type: "string"
1664 format: "uint64"
1665 collectionFormat: "csv"
1666 minItems: 1
1667 x-exportParamName: "PathRepeatedUint64Value"
1668 - name: "path_repeated_int32_value"
1669 in: "path"
1670 required: true
1671 type: "array"
1672 items:
1673 type: "integer"
1674 format: "int32"
1675 collectionFormat: "csv"
1676 minItems: 1
1677 x-exportParamName: "PathRepeatedInt32Value"
1678 - name: "path_repeated_fixed64_value"
1679 in: "path"
1680 required: true
1681 type: "array"
1682 items:
1683 type: "string"
1684 format: "uint64"
1685 collectionFormat: "csv"
1686 minItems: 1
1687 x-exportParamName: "PathRepeatedFixed64Value"
1688 - name: "path_repeated_fixed32_value"
1689 in: "path"
1690 required: true
1691 type: "array"
1692 items:
1693 type: "integer"
1694 format: "int64"
1695 collectionFormat: "csv"
1696 minItems: 1
1697 x-exportParamName: "PathRepeatedFixed32Value"
1698 - name: "path_repeated_bool_value"
1699 in: "path"
1700 required: true
1701 type: "array"
1702 items:
1703 type: "boolean"
1704 collectionFormat: "csv"
1705 minItems: 1
1706 x-exportParamName: "PathRepeatedBoolValue"
1707 - name: "path_repeated_string_value"
1708 in: "path"
1709 required: true
1710 type: "array"
1711 items:
1712 type: "string"
1713 collectionFormat: "csv"
1714 minItems: 1
1715 x-exportParamName: "PathRepeatedStringValue"
1716 - name: "path_repeated_bytes_value"
1717 in: "path"
1718 required: true
1719 type: "array"
1720 items:
1721 type: "string"
1722 format: "byte"
1723 pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
1724 collectionFormat: "csv"
1725 minItems: 1
1726 x-exportParamName: "PathRepeatedBytesValue"
1727 - name: "path_repeated_uint32_value"
1728 in: "path"
1729 required: true
1730 type: "array"
1731 items:
1732 type: "integer"
1733 format: "int64"
1734 collectionFormat: "csv"
1735 minItems: 1
1736 x-exportParamName: "PathRepeatedUint32Value"
1737 - name: "path_repeated_enum_value"
1738 in: "path"
1739 required: true
1740 type: "array"
1741 items:
1742 type: "string"
1743 enum:
1744 - "ZERO"
1745 - "ONE"
1746 collectionFormat: "csv"
1747 minItems: 1
1748 x-exportParamName: "PathRepeatedEnumValue"
1749 - name: "path_repeated_sfixed32_value"
1750 in: "path"
1751 required: true
1752 type: "array"
1753 items:
1754 type: "integer"
1755 format: "int32"
1756 collectionFormat: "csv"
1757 minItems: 1
1758 x-exportParamName: "PathRepeatedSfixed32Value"
1759 - name: "path_repeated_sfixed64_value"
1760 in: "path"
1761 required: true
1762 type: "array"
1763 items:
1764 type: "string"
1765 format: "int64"
1766 collectionFormat: "csv"
1767 minItems: 1
1768 x-exportParamName: "PathRepeatedSfixed64Value"
1769 - name: "path_repeated_sint32_value"
1770 in: "path"
1771 required: true
1772 type: "array"
1773 items:
1774 type: "integer"
1775 format: "int32"
1776 collectionFormat: "csv"
1777 minItems: 1
1778 x-exportParamName: "PathRepeatedSint32Value"
1779 - name: "path_repeated_sint64_value"
1780 in: "path"
1781 required: true
1782 type: "array"
1783 items:
1784 type: "string"
1785 format: "int64"
1786 collectionFormat: "csv"
1787 minItems: 1
1788 x-exportParamName: "PathRepeatedSint64Value"
1789 responses:
1790 200:
1791 description: "A successful response."
1792 schema:
1793 $ref: "#/definitions/examplepbABitOfEverythingRepeated"
1794 403:
1795 description: "Returned when the user does not have permission to access\
1796 \ the resource."
1797 schema: {}
1798 404:
1799 description: "Returned when the resource does not exist."
1800 schema:
1801 type: "string"
1802 format: "string"
1803 418:
1804 description: "I'm a teapot."
1805 schema:
1806 $ref: "#/definitions/examplepbNumericEnum"
1807 500:
1808 description: "Server error"
1809 schema:
1810 $ref: "#/definitions/examplepbErrorResponse"
1811 default:
1812 description: "An unexpected error response."
1813 schema:
1814 $ref: "#/definitions/runtimeError"
1815 /v1/{parent=publishers/*}/books:
1816 post:
1817 tags:
1818 - "ABitOfEverythingService"
1819 summary: "Create a book."
1820 operationId: "ABitOfEverythingService_CreateBook"
1821 parameters:
1822 - name: "parent"
1823 in: "path"
1824 description: "The publisher in which to create the book.\n\nFormat: `publishers/{publisher}`\n\
1825 \nExample: `publishers/1257894000000000000`"
1826 required: true
1827 type: "string"
1828 x-exportParamName: "Parent"
1829 - in: "body"
1830 name: "body"
1831 description: "The book to create."
1832 required: true
1833 schema:
1834 $ref: "#/definitions/examplepbBook"
1835 x-exportParamName: "Body"
1836 - name: "book_id"
1837 in: "query"
1838 description: "The ID to use for the book.\n\nThis must start with an alphanumeric\
1839 \ character."
1840 required: false
1841 type: "string"
1842 x-exportParamName: "BookId"
1843 x-optionalDataType: "String"
1844 responses:
1845 200:
1846 description: "A successful response."
1847 schema:
1848 $ref: "#/definitions/examplepbBook"
1849 403:
1850 description: "Returned when the user does not have permission to access\
1851 \ the resource."
1852 schema: {}
1853 404:
1854 description: "Returned when the resource does not exist."
1855 schema:
1856 type: "string"
1857 format: "string"
1858 418:
1859 description: "I'm a teapot."
1860 schema:
1861 $ref: "#/definitions/examplepbNumericEnum"
1862 500:
1863 description: "Server error"
1864 schema:
1865 $ref: "#/definitions/examplepbErrorResponse"
1866 default:
1867 description: "An unexpected error response."
1868 schema:
1869 $ref: "#/definitions/runtimeError"
1870 /v2/example/a_bit_of_everything/{abe.uuid}:
1871 put:
1872 tags:
1873 - "ABitOfEverythingService"
1874 operationId: "ABitOfEverythingService_UpdateV2"
1875 parameters:
1876 - name: "abe.uuid"
1877 in: "path"
1878 required: true
1879 type: "string"
1880 x-exportParamName: "AbeUuid"
1881 - in: "body"
1882 name: "body"
1883 required: true
1884 schema:
1885 $ref: "#/definitions/examplepbABitOfEverything"
1886 x-exportParamName: "Body"
1887 - name: "update_mask.paths"
1888 in: "query"
1889 description: "The set of field mask paths."
1890 required: false
1891 type: "array"
1892 items:
1893 type: "string"
1894 collectionFormat: "multi"
1895 x-exportParamName: "UpdateMaskPaths"
1896 responses:
1897 200:
1898 description: "A successful response."
1899 schema: {}
1900 403:
1901 description: "Returned when the user does not have permission to access\
1902 \ the resource."
1903 schema: {}
1904 404:
1905 description: "Returned when the resource does not exist."
1906 schema:
1907 type: "string"
1908 format: "string"
1909 418:
1910 description: "I'm a teapot."
1911 schema:
1912 $ref: "#/definitions/examplepbNumericEnum"
1913 500:
1914 description: "Server error"
1915 schema:
1916 $ref: "#/definitions/examplepbErrorResponse"
1917 default:
1918 description: "An unexpected error response."
1919 schema:
1920 $ref: "#/definitions/runtimeError"
1921 patch:
1922 tags:
1923 - "ABitOfEverythingService"
1924 operationId: "ABitOfEverythingService_UpdateV22"
1925 parameters:
1926 - name: "abe.uuid"
1927 in: "path"
1928 required: true
1929 type: "string"
1930 x-exportParamName: "AbeUuid"
1931 - in: "body"
1932 name: "body"
1933 required: true
1934 schema:
1935 $ref: "#/definitions/examplepbABitOfEverything"
1936 x-exportParamName: "Body"
1937 - name: "update_mask.paths"
1938 in: "query"
1939 description: "The set of field mask paths."
1940 required: false
1941 type: "array"
1942 items:
1943 type: "string"
1944 collectionFormat: "multi"
1945 x-exportParamName: "UpdateMaskPaths"
1946 responses:
1947 200:
1948 description: "A successful response."
1949 schema: {}
1950 403:
1951 description: "Returned when the user does not have permission to access\
1952 \ the resource."
1953 schema: {}
1954 404:
1955 description: "Returned when the resource does not exist."
1956 schema:
1957 type: "string"
1958 format: "string"
1959 418:
1960 description: "I'm a teapot."
1961 schema:
1962 $ref: "#/definitions/examplepbNumericEnum"
1963 500:
1964 description: "Server error"
1965 schema:
1966 $ref: "#/definitions/examplepbErrorResponse"
1967 default:
1968 description: "An unexpected error response."
1969 schema:
1970 $ref: "#/definitions/runtimeError"
1971 /v2/example/echo:
1972 get:
1973 tags:
1974 - "echo rpc"
1975 summary: "Summary: Echo rpc"
1976 description: "Description Echo"
1977 operationId: "ABitOfEverythingService_Echo3"
1978 parameters:
1979 - name: "value"
1980 in: "query"
1981 required: false
1982 type: "string"
1983 x-exportParamName: "Value"
1984 x-optionalDataType: "String"
1985 responses:
1986 200:
1987 description: "A successful response."
1988 examples:
1989 application/json:
1990 value: "the input value"
1991 schema:
1992 $ref: "#/definitions/subStringMessage"
1993 403:
1994 description: "Returned when the user does not have permission to access\
1995 \ the resource."
1996 schema: {}
1997 404:
1998 description: "Returned when the resource does not exist."
1999 schema:
2000 type: "integer"
2001 format: "integer"
2002 418:
2003 description: "I'm a teapot."
2004 schema:
2005 $ref: "#/definitions/examplepbNumericEnum"
2006 500:
2007 description: "Server error"
2008 schema:
2009 $ref: "#/definitions/examplepbErrorResponse"
2010 503:
2011 description: "Returned when the resource is temporarily unavailable."
2012 schema: {}
2013 x-number: 100
2014 default:
2015 description: "An unexpected error response."
2016 schema:
2017 $ref: "#/definitions/runtimeError"
2018 externalDocs:
2019 description: "Find out more Echo"
2020 url: "https://github.com/grpc-ecosystem/grpc-gateway"
2021 post:
2022 tags:
2023 - "echo rpc"
2024 summary: "Summary: Echo rpc"
2025 description: "Description Echo"
2026 operationId: "ABitOfEverythingService_Echo2"
2027 parameters:
2028 - in: "body"
2029 name: "body"
2030 required: true
2031 schema:
2032 type: "string"
2033 x-exportParamName: "Body"
2034 responses:
2035 200:
2036 description: "A successful response."
2037 examples:
2038 application/json:
2039 value: "the input value"
2040 schema:
2041 $ref: "#/definitions/subStringMessage"
2042 403:
2043 description: "Returned when the user does not have permission to access\
2044 \ the resource."
2045 schema: {}
2046 404:
2047 description: "Returned when the resource does not exist."
2048 schema:
2049 type: "integer"
2050 format: "integer"
2051 418:
2052 description: "I'm a teapot."
2053 schema:
2054 $ref: "#/definitions/examplepbNumericEnum"
2055 500:
2056 description: "Server error"
2057 schema:
2058 $ref: "#/definitions/examplepbErrorResponse"
2059 503:
2060 description: "Returned when the resource is temporarily unavailable."
2061 schema: {}
2062 x-number: 100
2063 default:
2064 description: "An unexpected error response."
2065 schema:
2066 $ref: "#/definitions/runtimeError"
2067 externalDocs:
2068 description: "Find out more Echo"
2069 url: "https://github.com/grpc-ecosystem/grpc-gateway"
2070 /v2/example/empty:
2071 get:
2072 tags:
2073 - "camelCaseServiceName"
2074 operationId: "camelCaseServiceName_Empty"
2075 parameters: []
2076 responses:
2077 200:
2078 description: "A successful response."
2079 schema: {}
2080 403:
2081 description: "Returned when the user does not have permission to access\
2082 \ the resource."
2083 schema: {}
2084 404:
2085 description: "Returned when the resource does not exist."
2086 schema:
2087 type: "string"
2088 format: "string"
2089 418:
2090 description: "I'm a teapot."
2091 schema:
2092 $ref: "#/definitions/examplepbNumericEnum"
2093 500:
2094 description: "Server error"
2095 schema:
2096 $ref: "#/definitions/examplepbErrorResponse"
2097 default:
2098 description: "An unexpected error response."
2099 schema:
2100 $ref: "#/definitions/runtimeError"
2101 /v2/example/errorwithdetails:
2102 get:
2103 tags:
2104 - "ABitOfEverythingService"
2105 operationId: "ABitOfEverythingService_ErrorWithDetails"
2106 parameters: []
2107 responses:
2108 200:
2109 description: "A successful response."
2110 schema: {}
2111 403:
2112 description: "Returned when the user does not have permission to access\
2113 \ the resource."
2114 schema: {}
2115 404:
2116 description: "Returned when the resource does not exist."
2117 schema:
2118 type: "string"
2119 format: "string"
2120 418:
2121 description: "I'm a teapot."
2122 schema:
2123 $ref: "#/definitions/examplepbNumericEnum"
2124 500:
2125 description: "Server error"
2126 schema:
2127 $ref: "#/definitions/examplepbErrorResponse"
2128 default:
2129 description: "An unexpected error response."
2130 schema:
2131 $ref: "#/definitions/runtimeError"
2132 /v2/example/overwriteresponsecontenttype:
2133 get:
2134 tags:
2135 - "ABitOfEverythingService"
2136 operationId: "ABitOfEverythingService_OverwriteResponseContentType"
2137 produces:
2138 - "application/text"
2139 parameters: []
2140 responses:
2141 200:
2142 description: "A successful response."
2143 schema:
2144 type: "string"
2145 403:
2146 description: "Returned when the user does not have permission to access\
2147 \ the resource."
2148 schema: {}
2149 404:
2150 description: "Returned when the resource does not exist."
2151 schema:
2152 type: "string"
2153 format: "string"
2154 418:
2155 description: "I'm a teapot."
2156 schema:
2157 $ref: "#/definitions/examplepbNumericEnum"
2158 500:
2159 description: "Server error"
2160 schema:
2161 $ref: "#/definitions/examplepbErrorResponse"
2162 default:
2163 description: "An unexpected error response."
2164 schema:
2165 $ref: "#/definitions/runtimeError"
2166 /v2/example/postwithemptybody/{name}:
2167 post:
2168 tags:
2169 - "ABitOfEverythingService"
2170 operationId: "ABitOfEverythingService_PostWithEmptyBody"
2171 parameters:
2172 - name: "name"
2173 in: "path"
2174 required: true
2175 type: "string"
2176 x-exportParamName: "Name"
2177 - in: "body"
2178 name: "body"
2179 required: true
2180 schema:
2181 $ref: "#/definitions/examplepbBody"
2182 x-exportParamName: "Body"
2183 responses:
2184 200:
2185 description: "A successful response."
2186 schema: {}
2187 403:
2188 description: "Returned when the user does not have permission to access\
2189 \ the resource."
2190 schema: {}
2191 404:
2192 description: "Returned when the resource does not exist."
2193 schema:
2194 type: "string"
2195 format: "string"
2196 418:
2197 description: "I'm a teapot."
2198 schema:
2199 $ref: "#/definitions/examplepbNumericEnum"
2200 500:
2201 description: "Server error"
2202 schema:
2203 $ref: "#/definitions/examplepbErrorResponse"
2204 default:
2205 description: "An unexpected error response."
2206 schema:
2207 $ref: "#/definitions/runtimeError"
2208 /v2/example/timeout:
2209 get:
2210 tags:
2211 - "ABitOfEverythingService"
2212 operationId: "ABitOfEverythingService_Timeout"
2213 parameters: []
2214 responses:
2215 200:
2216 description: "A successful response."
2217 schema: {}
2218 403:
2219 description: "Returned when the user does not have permission to access\
2220 \ the resource."
2221 schema: {}
2222 404:
2223 description: "Returned when the resource does not exist."
2224 schema:
2225 type: "string"
2226 format: "string"
2227 418:
2228 description: "I'm a teapot."
2229 schema:
2230 $ref: "#/definitions/examplepbNumericEnum"
2231 500:
2232 description: "Server error"
2233 schema:
2234 $ref: "#/definitions/examplepbErrorResponse"
2235 default:
2236 description: "An unexpected error response."
2237 schema:
2238 $ref: "#/definitions/runtimeError"
2239 /v2/example/withbody/{id}:
2240 post:
2241 tags:
2242 - "ABitOfEverythingService"
2243 operationId: "ABitOfEverythingService_GetMessageWithBody"
2244 parameters:
2245 - name: "id"
2246 in: "path"
2247 required: true
2248 type: "string"
2249 x-exportParamName: "Id"
2250 - in: "body"
2251 name: "body"
2252 required: true
2253 schema:
2254 $ref: "#/definitions/examplepbBody"
2255 x-exportParamName: "Body"
2256 responses:
2257 200:
2258 description: "A successful response."
2259 schema: {}
2260 403:
2261 description: "Returned when the user does not have permission to access\
2262 \ the resource."
2263 schema: {}
2264 404:
2265 description: "Returned when the resource does not exist."
2266 schema:
2267 type: "string"
2268 format: "string"
2269 418:
2270 description: "I'm a teapot."
2271 schema:
2272 $ref: "#/definitions/examplepbNumericEnum"
2273 500:
2274 description: "Server error"
2275 schema:
2276 $ref: "#/definitions/examplepbErrorResponse"
2277 default:
2278 description: "An unexpected error response."
2279 schema:
2280 $ref: "#/definitions/runtimeError"
2281 /v2/{value}:check:
2282 get:
2283 tags:
2284 - "ABitOfEverythingService"
2285 operationId: "ABitOfEverythingService_CheckExternalNestedPathEnum"
2286 parameters:
2287 - name: "value"
2288 in: "path"
2289 required: true
2290 type: "string"
2291 enum:
2292 - "GHI"
2293 - "JKL"
2294 x-exportParamName: "Value"
2295 responses:
2296 200:
2297 description: "A successful response."
2298 schema: {}
2299 403:
2300 description: "Returned when the user does not have permission to access\
2301 \ the resource."
2302 schema: {}
2303 404:
2304 description: "Returned when the resource does not exist."
2305 schema:
2306 type: "string"
2307 format: "string"
2308 418:
2309 description: "I'm a teapot."
2310 schema:
2311 $ref: "#/definitions/examplepbNumericEnum"
2312 500:
2313 description: "Server error"
2314 schema:
2315 $ref: "#/definitions/examplepbErrorResponse"
2316 default:
2317 description: "An unexpected error response."
2318 schema:
2319 $ref: "#/definitions/runtimeError"
2320 /v2a/example/a_bit_of_everything/{abe.uuid}:
2321 patch:
2322 tags:
2323 - "ABitOfEverythingService"
2324 operationId: "ABitOfEverythingService_UpdateV23"
2325 parameters:
2326 - name: "abe.uuid"
2327 in: "path"
2328 required: true
2329 type: "string"
2330 x-exportParamName: "AbeUuid"
2331 - in: "body"
2332 name: "body"
2333 required: true
2334 schema:
2335 $ref: "#/definitions/examplepbUpdateV2Request"
2336 x-exportParamName: "Body"
2337 responses:
2338 200:
2339 description: "A successful response."
2340 schema: {}
2341 403:
2342 description: "Returned when the user does not have permission to access\
2343 \ the resource."
2344 schema: {}
2345 404:
2346 description: "Returned when the resource does not exist."
2347 schema:
2348 type: "string"
2349 format: "string"
2350 418:
2351 description: "I'm a teapot."
2352 schema:
2353 $ref: "#/definitions/examplepbNumericEnum"
2354 500:
2355 description: "Server error"
2356 schema:
2357 $ref: "#/definitions/examplepbErrorResponse"
2358 default:
2359 description: "An unexpected error response."
2360 schema:
2361 $ref: "#/definitions/runtimeError"
2362securityDefinitions:
2363 ApiKeyAuth:
2364 type: "apiKey"
2365 name: "X-API-Key"
2366 in: "header"
2367 x-amazon-apigateway-authorizer:
2368 authorizerResultTtlInSeconds: 60
2369 type: "token"
2370 x-amazon-apigateway-authtype: "oauth2"
2371 BasicAuth:
2372 type: "basic"
2373 OAuth2:
2374 type: "oauth2"
2375 authorizationUrl: "https://example.com/oauth/authorize"
2376 tokenUrl: "https://example.com/oauth/token"
2377 flow: "accessCode"
2378 scopes:
2379 admin: "Grants read and write access to administrative information"
2380 read: "Grants read access"
2381 write: "Grants write access"
2382definitions:
2383 ABitOfEverythingNested:
2384 type: "object"
2385 properties:
2386 name:
2387 type: "string"
2388 description: "name is nested field."
2389 amount:
2390 type: "integer"
2391 format: "int64"
2392 ok:
2393 description: "DeepEnum description."
2394 $ref: "#/definitions/NestedDeepEnum"
2395 description: "Nested is nested type."
2396 example:
2397 ok: "TRUE"
2398 MessagePathEnumNestedPathEnum:
2399 type: "string"
2400 enum:
2401 - "GHI"
2402 - "JKL"
2403 default: "GHI"
2404 NestedDeepEnum:
2405 type: "string"
2406 description: "DeepEnum is one or zero.\n\n - FALSE: FALSE is false.\n - TRUE:\
2407 \ TRUE is true."
2408 enum:
2409 - "FALSE"
2410 - "TRUE"
2411 default: "FALSE"
2412 examplepbABitOfEverything:
2413 type: "object"
2414 required:
2415 - "double_value"
2416 - "int64_value"
2417 - "uuid"
2418 properties:
2419 single_nested:
2420 $ref: "#/definitions/ABitOfEverythingNested"
2421 uuid:
2422 type: "string"
2423 minLength: 1
2424 pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
2425 nested:
2426 type: "array"
2427 items:
2428 $ref: "#/definitions/ABitOfEverythingNested"
2429 float_value:
2430 type: "number"
2431 format: "float"
2432 description: "Float value field"
2433 default: 0.2
2434 double_value:
2435 type: "number"
2436 format: "double"
2437 int64_value:
2438 type: "string"
2439 format: "int64"
2440 uint64_value:
2441 type: "string"
2442 format: "uint64"
2443 int32_value:
2444 type: "integer"
2445 format: "int32"
2446 fixed64_value:
2447 type: "string"
2448 format: "uint64"
2449 fixed32_value:
2450 type: "integer"
2451 format: "int64"
2452 bool_value:
2453 type: "boolean"
2454 string_value:
2455 type: "string"
2456 bytes_value:
2457 type: "string"
2458 format: "byte"
2459 pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
2460 uint32_value:
2461 type: "integer"
2462 format: "int64"
2463 enum_value:
2464 $ref: "#/definitions/examplepbNumericEnum"
2465 path_enum_value:
2466 $ref: "#/definitions/pathenumPathEnum"
2467 nested_path_enum_value:
2468 $ref: "#/definitions/MessagePathEnumNestedPathEnum"
2469 sfixed32_value:
2470 type: "integer"
2471 format: "int32"
2472 sfixed64_value:
2473 type: "string"
2474 format: "int64"
2475 sint32_value:
2476 type: "integer"
2477 format: "int32"
2478 sint64_value:
2479 type: "string"
2480 format: "int64"
2481 repeated_string_value:
2482 type: "array"
2483 items:
2484 type: "string"
2485 oneof_empty:
2486 type: "object"
2487 properties: {}
2488 oneof_string:
2489 type: "string"
2490 map_value:
2491 type: "object"
2492 additionalProperties:
2493 $ref: "#/definitions/examplepbNumericEnum"
2494 mapped_string_value:
2495 type: "object"
2496 additionalProperties:
2497 type: "string"
2498 mapped_nested_value:
2499 type: "object"
2500 additionalProperties:
2501 $ref: "#/definitions/ABitOfEverythingNested"
2502 nonConventionalNameValue:
2503 type: "string"
2504 timestamp_value:
2505 type: "string"
2506 format: "date-time"
2507 repeated_enum_value:
2508 type: "array"
2509 title: "repeated enum value. it is comma-separated in query"
2510 items:
2511 $ref: "#/definitions/examplepbNumericEnum"
2512 repeated_enum_annotation:
2513 type: "array"
2514 description: "Repeated numeric enum description."
2515 title: "Repeated numeric enum title"
2516 items:
2517 $ref: "#/definitions/examplepbNumericEnum"
2518 enum_value_annotation:
2519 description: "Numeric enum description."
2520 title: "Numeric enum title"
2521 $ref: "#/definitions/examplepbNumericEnum"
2522 repeated_string_annotation:
2523 type: "array"
2524 description: "Repeated string description."
2525 title: "Repeated string title"
2526 items:
2527 type: "string"
2528 repeated_nested_annotation:
2529 type: "array"
2530 description: "Repeated nested object description."
2531 title: "Repeated nested object title"
2532 items:
2533 $ref: "#/definitions/ABitOfEverythingNested"
2534 nested_annotation:
2535 description: "Nested object description."
2536 title: "Nested object title"
2537 $ref: "#/definitions/ABitOfEverythingNested"
2538 int64_override_type:
2539 type: "integer"
2540 format: "int64"
2541 externalDocs:
2542 description: "Find out more about ABitOfEverything"
2543 url: "https://github.com/grpc-ecosystem/grpc-gateway"
2544 title: "A bit of everything"
2545 description: "Intentionaly complicated message type to cover many features of\
2546 \ Protobuf."
2547 example:
2548 uuid: "0cf361e1-4b44-483d-a159-54dabdf7e814"
2549 examplepbABitOfEverythingRepeated:
2550 type: "object"
2551 properties:
2552 path_repeated_float_value:
2553 type: "array"
2554 title: "repeated values. they are comma-separated in path"
2555 items:
2556 type: "number"
2557 format: "float"
2558 path_repeated_double_value:
2559 type: "array"
2560 items:
2561 type: "number"
2562 format: "double"
2563 path_repeated_int64_value:
2564 type: "array"
2565 items:
2566 type: "string"
2567 format: "int64"
2568 path_repeated_uint64_value:
2569 type: "array"
2570 items:
2571 type: "string"
2572 format: "uint64"
2573 path_repeated_int32_value:
2574 type: "array"
2575 items:
2576 type: "integer"
2577 format: "int32"
2578 path_repeated_fixed64_value:
2579 type: "array"
2580 items:
2581 type: "string"
2582 format: "uint64"
2583 path_repeated_fixed32_value:
2584 type: "array"
2585 items:
2586 type: "integer"
2587 format: "int64"
2588 path_repeated_bool_value:
2589 type: "array"
2590 items:
2591 type: "boolean"
2592 path_repeated_string_value:
2593 type: "array"
2594 items:
2595 type: "string"
2596 path_repeated_bytes_value:
2597 type: "array"
2598 items:
2599 type: "string"
2600 format: "byte"
2601 pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
2602 path_repeated_uint32_value:
2603 type: "array"
2604 items:
2605 type: "integer"
2606 format: "int64"
2607 path_repeated_enum_value:
2608 type: "array"
2609 items:
2610 $ref: "#/definitions/examplepbNumericEnum"
2611 path_repeated_sfixed32_value:
2612 type: "array"
2613 items:
2614 type: "integer"
2615 format: "int32"
2616 path_repeated_sfixed64_value:
2617 type: "array"
2618 items:
2619 type: "string"
2620 format: "int64"
2621 path_repeated_sint32_value:
2622 type: "array"
2623 items:
2624 type: "integer"
2625 format: "int32"
2626 path_repeated_sint64_value:
2627 type: "array"
2628 items:
2629 type: "string"
2630 format: "int64"
2631 title: "ABitOfEverythingRepeated is used to validate repeated path parameter functionality"
2632 example:
2633 path_repeated_bool_value:
2634 - true
2635 - true
2636 - false
2637 - true
2638 path_repeated_int32_value:
2639 - 1
2640 - 2
2641 - 3
2642 examplepbBody:
2643 type: "object"
2644 properties:
2645 name:
2646 type: "string"
2647 examplepbBook:
2648 type: "object"
2649 properties:
2650 name:
2651 type: "string"
2652 description: "The resource name of the book.\n\nFormat: `publishers/{publisher}/books/{book}`\n\
2653 \nExample: `publishers/1257894000000000000/books/my-book`"
2654 id:
2655 type: "string"
2656 description: "Output only. The book's ID."
2657 readOnly: true
2658 create_time:
2659 type: "string"
2660 format: "date-time"
2661 description: "Output only. Creation time of the book."
2662 readOnly: true
2663 description: "An example resource type from AIP-123 used to test the behavior\
2664 \ described in\nthe CreateBookRequest message.\n\nSee: https://google.aip.dev/123"
2665 example:
2666 create_time: "2000-01-23T04:56:07.000+00:00"
2667 name: "name"
2668 id: "id"
2669 examplepbErrorObject:
2670 type: "object"
2671 properties:
2672 code:
2673 type: "integer"
2674 format: "integer"
2675 description: "Response code"
2676 title: "code"
2677 message:
2678 type: "string"
2679 description: "Response message"
2680 title: "message"
2681 pattern: "^[a-zA-Z0-9]{1, 32}$"
2682 examplepbErrorResponse:
2683 type: "object"
2684 properties:
2685 correlationId:
2686 type: "string"
2687 format: "uuid"
2688 example: "2438ac3c-37eb-4902-adef-ed16b4431030"
2689 description: "Unique event identifier for server requests"
2690 title: "x-correlation-id"
2691 pattern: "^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$"
2692 error:
2693 $ref: "#/definitions/examplepbErrorObject"
2694 examplepbNumericEnum:
2695 type: "string"
2696 description: "NumericEnum is one or zero.\n\n - ZERO: ZERO means 0\n - ONE: ONE\
2697 \ means 1"
2698 enum:
2699 - "ZERO"
2700 - "ONE"
2701 default: "ZERO"
2702 examplepbUpdateV2Request:
2703 type: "object"
2704 properties:
2705 abe:
2706 $ref: "#/definitions/examplepbABitOfEverything"
2707 update_mask:
2708 $ref: "#/definitions/protobufFieldMask"
2709 title: "UpdateV2Request request for update includes the message and the update\
2710 \ mask"
2711 pathenumPathEnum:
2712 type: "string"
2713 enum:
2714 - "ABC"
2715 - "DEF"
2716 default: "ABC"
2717 protobufAny:
2718 type: "object"
2719 properties:
2720 type_url:
2721 type: "string"
2722 description: "A URL/resource name that uniquely identifies the type of the\
2723 \ serialized\nprotocol buffer message. This string must contain at least\n\
2724 one \"/\" character. The last segment of the URL's path must represent\n\
2725 the fully qualified name of the type (as in\n`path/google.protobuf.Duration`).\
2726 \ The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\
2727 \nIn practice, teams usually precompile into the binary all types that they\n\
2728 expect it to use in the context of Any. However, for URLs which use the\n\
2729 scheme `http`, `https`, or no scheme, one can optionally set up a type\n\
2730 server that maps type URLs to message definitions as follows:\n\n* If no\
2731 \ scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must\
2732 \ yield a [google.protobuf.Type][]\n value in binary format, or produce\
2733 \ an error.\n* Applications are allowed to cache lookup results based on\
2734 \ the\n URL, or have them precompiled into a binary to avoid any\n lookup.\
2735 \ Therefore, binary compatibility needs to be preserved\n on changes to\
2736 \ types. (Use versioned type names to manage\n breaking changes.)\n\nNote:\
2737 \ this functionality is not currently available in the official\nprotobuf\
2738 \ release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\
2739 \nSchemes other than `http`, `https` (or the empty scheme) might be\nused\
2740 \ with implementation specific semantics."
2741 value:
2742 type: "string"
2743 format: "byte"
2744 description: "Must be a valid serialized protocol buffer of the above specified\
2745 \ type."
2746 pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
2747 description: "`Any` contains an arbitrary serialized protocol buffer message along\
2748 \ with a\nURL that describes the type of the serialized message.\n\nProtobuf\
2749 \ library provides support to pack/unpack Any values in the form\nof utility\
2750 \ functions or additional generated methods of the Any type.\n\nExample 1: Pack\
2751 \ and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n\
2752 \ ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack\
2753 \ and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n\
2754 \ ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n\
2755 \ }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n\
2756 \ any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n\
2757 \ any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in\
2758 \ Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n\
2759 \ ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo);\
2760 \ err != nil {\n ...\n }\n\nThe pack methods provided by protobuf\
2761 \ library will by default use\n'type.googleapis.com/full.type.name' as the type\
2762 \ URL and the unpack\nmethods only use the fully qualified type name after the\
2763 \ last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\n\
2764 name \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses\
2765 \ the regular\nrepresentation of the deserialized, embedded message, with an\n\
2766 additional field `@type` which contains the type URL. Example:\n\n package\
2767 \ google.profile;\n message Person {\n string first_name = 1;\n \
2768 \ string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\"\
2769 ,\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf\
2770 \ the embedded message type is well-known and has a custom JSON\nrepresentation,\
2771 \ that representation will be embedded adding a field\n`value` which holds the\
2772 \ custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\
2773 \n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n\
2774 \ \"value\": \"1.212s\"\n }"
2775 protobufFieldMask:
2776 type: "object"
2777 properties:
2778 paths:
2779 type: "array"
2780 description: "The set of field mask paths."
2781 items:
2782 type: "string"
2783 title: "`FieldMask` represents a set of symbolic field paths, for example:"
2784 description: "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field\
2785 \ in some root message, `a` and `b`\nfields in the message found in `f`, and\
2786 \ `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify\
2787 \ a subset of fields that should be\nreturned by a get operation or modified\
2788 \ by an update operation.\nField masks also have a custom JSON encoding (see\
2789 \ below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection,\
2790 \ a response message or\nsub-message is filtered by the API to only contain\
2791 \ those fields as\nspecified in the mask. For example, if the mask in the previous\n\
2792 example is applied to a response message as follows:\n\n f {\n a : 22\n\
2793 \ b {\n d : 1\n x : 2\n }\n y : 13\n }\n \
2794 \ z: 8\n\nThe result will not contain specific values for fields x,y and z\n\
2795 (their value will be set to the default, and omitted in proto text\noutput):\n\
2796 \n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated\
2797 \ field is not allowed except at the last position of a\npaths string.\n\nIf\
2798 \ a FieldMask object is not present in a get operation, the\noperation applies\
2799 \ to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote\
2800 \ that a field mask does not necessarily apply to the\ntop-level response message.\
2801 \ In case of a REST get operation, the\nfield mask applies directly to the response,\
2802 \ but in case of a REST\nlist operation, the mask instead applies to each individual\
2803 \ message\nin the returned resource list. In case of a REST custom method,\n\
2804 other definitions may be used. Where the mask applies will be\nclearly documented\
2805 \ together with its declaration in the API. In\nany case, the effect on the\
2806 \ returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks\
2807 \ in Update Operations\n\nA field mask in update operations specifies which\
2808 \ fields of the\ntargeted resource are going to be updated. The API is required\n\
2809 to only change the values of the fields as specified in the mask\nand leave\
2810 \ the others untouched. If a resource is passed in to\ndescribe the updated\
2811 \ values, the API ignores the values of all\nfields not covered by the mask.\n\
2812 \nIf a repeated field is specified for an update operation, new values will\n\
2813 be appended to the existing repeated field in the target resource. Note that\n\
2814 a repeated field is only allowed in the last position of a `paths` string.\n\
2815 \nIf a sub-message is specified in the last position of the field mask for an\n\
2816 update operation, then new value will be merged into the existing sub-message\n\
2817 in the target resource.\n\nFor example, given the target message:\n\n f {\n\
2818 \ b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd\
2819 \ an update message:\n\n f {\n b {\n d: 10\n }\n c:\
2820 \ [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\n\
2821 then the result will be:\n\n f {\n b {\n d: 10\n x: 2\n\
2822 \ }\n c: [1, 2]\n }\n\nAn implementation may provide options to\
2823 \ override this default behavior for\nrepeated and message fields.\n\nIn order\
2824 \ to reset a field's value to the default, the field must\nbe in the mask and\
2825 \ set to the default value in the provided resource.\nHence, in order to reset\
2826 \ all fields of a resource, provide a default\ninstance of the resource and\
2827 \ set all fields in the mask, or do\nnot provide a mask as described below.\n\
2828 \nIf a field mask is not present on update, the operation applies to\nall fields\
2829 \ (as if a field mask of all fields has been specified).\nNote that in the presence\
2830 \ of schema evolution, this may mean that\nfields the client does not know and\
2831 \ has therefore not filled into\nthe request will be reset to their default.\
2832 \ If this is unwanted\nbehavior, a specific service may require a client to\
2833 \ always specify\na field mask, producing an error if not.\n\nAs with get operations,\
2834 \ the location of the resource which\ndescribes the updated values in the request\
2835 \ message depends on the\noperation kind. In any case, the effect of the field\
2836 \ mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP\
2837 \ REST\n\nThe HTTP kind of an update operation which uses a field mask must\n\
2838 be set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must\
2839 \ only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON,\
2840 \ a field mask is encoded as a single string where paths are\nseparated by a\
2841 \ comma. Fields name in each path are converted\nto/from lower-camel naming\
2842 \ conventions.\n\nAs an example, consider the following message declarations:\n\
2843 \n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n\
2844 \ message User {\n string display_name = 1;\n string address =\
2845 \ 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n \
2846 \ mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\
2847 \nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\
2848 \n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs\
2849 \ just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage\
2850 \ {\n oneof test_oneof {\n string name = 4;\n SubMessage\
2851 \ sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n\
2852 \ paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\
2853 \n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be\
2854 \ used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any\
2855 \ API method which has a FieldMask type field in the\nrequest should verify\
2856 \ the included field paths, and return an\n`INVALID_ARGUMENT` error if any path\
2857 \ is unmappable."
2858 runtimeError:
2859 type: "object"
2860 properties:
2861 error:
2862 type: "string"
2863 code:
2864 type: "integer"
2865 format: "int32"
2866 message:
2867 type: "string"
2868 details:
2869 type: "array"
2870 items:
2871 $ref: "#/definitions/protobufAny"
2872 subStringMessage:
2873 type: "object"
2874 properties:
2875 value:
2876 type: "string"
2877externalDocs:
2878 description: "More about gRPC-Gateway"
2879 url: "https://github.com/grpc-ecosystem/grpc-gateway"
2880x-grpc-gateway-baz-list:
2881- "one"
2882- true
2883x-grpc-gateway-foo: "bar"
View as plain text