/
openapi_json.yaml
517 lines (516 loc) · 18.5 KB
/
openapi_json.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: Messaging API
version: 1.2.3
servers:
- url: https://foo.googleapi.com
paths:
/v1/messages:
get:
tags:
- Messaging
operationId: Messaging_ListMessages
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleProtobufValue'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/messages/{messageId}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
- name: stringType
in: query
schema:
type: string
- name: recursiveType.parentId
in: query
schema:
type: integer
format: int32
- name: recursiveType.child.childId
in: query
schema:
type: integer
format: int32
- name: recursiveType.child.parent.parentId
in: query
schema:
type: integer
format: int32
- name: recursiveType.child.parent.child.childId
in: query
schema:
type: integer
format: int32
- name: embeddedType.messageId
in: query
schema:
type: string
- name: subType.messageId
in: query
schema:
type: string
- name: subType.subSubMessage.messageId
in: query
schema:
type: string
- name: subType.subSubMessage.integers
in: query
schema:
type: array
items:
type: integer
format: int32
- name: repeatedType
in: query
schema:
type: array
items:
type: string
- name: valueType
in: query
description: Description of value
schema:
$ref: '#/components/schemas/GoogleProtobufValue'
- name: repeatedValueType
in: query
description: Description of repeated value
schema:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufValue'
- name: boolValueType
in: query
schema:
type: boolean
- name: bytesValueType
in: query
schema:
type: string
format: bytes
- name: int32ValueType
in: query
schema:
type: integer
format: int32
- name: uint32ValueType
in: query
schema:
type: integer
format: uint32
- name: stringValueType
in: query
schema:
type: string
- name: int64ValueType
in: query
schema:
type: string
- name: uint64ValueType
in: query
schema:
type: string
- name: floatValueType
in: query
schema:
type: number
format: float
- name: doubleValueType
in: query
schema:
type: number
format: double
- name: timestampType
in: query
schema:
type: string
format: date-time
- name: durationType
in: query
schema:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: string
description: Represents a a duration between -315,576,000,000s and 315,576,000,000s (around 10000 years). Precision is in nanoseconds. 1 nanosecond is represented as 0.000000001s
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- Messaging
operationId: Messaging_CreateMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
patch:
tags:
- Messaging
operationId: Messaging_UpdateMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
- name: stringType
in: query
schema:
type: string
- name: recursiveType.parentId
in: query
schema:
type: integer
format: int32
- name: recursiveType.child.childId
in: query
schema:
type: integer
format: int32
- name: recursiveType.child.parent.parentId
in: query
schema:
type: integer
format: int32
- name: recursiveType.child.parent.child.childId
in: query
schema:
type: integer
format: int32
- name: embeddedType.messageId
in: query
schema:
type: string
- name: subType.messageId
in: query
schema:
type: string
- name: subType.subSubMessage.messageId
in: query
schema:
type: string
- name: subType.subSubMessage.integers
in: query
schema:
type: array
items:
type: integer
format: int32
- name: repeatedType
in: query
schema:
type: array
items:
type: string
- name: valueType
in: query
description: Description of value
schema:
$ref: '#/components/schemas/GoogleProtobufValue'
- name: repeatedValueType
in: query
description: Description of repeated value
schema:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufValue'
- name: boolValueType
in: query
schema:
type: boolean
- name: bytesValueType
in: query
schema:
type: string
format: bytes
- name: int32ValueType
in: query
schema:
type: integer
format: int32
- name: uint32ValueType
in: query
schema:
type: integer
format: uint32
- name: stringValueType
in: query
schema:
type: string
- name: int64ValueType
in: query
schema:
type: string
- name: uint64ValueType
in: query
schema:
type: string
- name: floatValueType
in: query
schema:
type: number
format: float
- name: doubleValueType
in: query
schema:
type: number
format: double
- name: timestampType
in: query
schema:
type: string
format: date-time
- name: durationType
in: query
schema:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: string
description: Represents a a duration between -315,576,000,000s and 315,576,000,000s (around 10000 years). Precision is in nanoseconds. 1 nanosecond is represented as 0.000000001s
requestBody:
content:
application/json:
schema:
type: object
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/messages:csv:
get:
tags:
- Messaging
description: |-
OpenAPI does not allow requestBody in GET operations.
But it should not convert it to query params either.
operationId: Messaging_ListMessagesCSV
responses:
"200":
description: OK
content:
'*/*': {}
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- Messaging
operationId: Messaging_CreateMessagesFromCSV
requestBody:
content:
application/json:
schema:
type: string
required: true
responses:
"200":
description: OK
content:
'*/*': {}
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
GoogleProtobufValue:
description: Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
Message:
type: object
properties:
messageId:
type: string
stringType:
type: string
recursiveType:
$ref: '#/components/schemas/RecursiveParent'
embeddedType:
$ref: '#/components/schemas/Message_EmbMessage'
subType:
$ref: '#/components/schemas/SubMessage'
repeatedType:
type: array
items:
type: string
repeatedSubType:
type: array
items:
$ref: '#/components/schemas/SubMessage'
repeatedRecursiveType:
type: array
items:
$ref: '#/components/schemas/RecursiveParent'
mapType:
type: object
additionalProperties:
type: string
body:
type: object
media:
type: array
items:
type: object
valueType:
allOf:
- $ref: '#/components/schemas/GoogleProtobufValue'
description: Description of value
repeatedValueType:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufValue'
description: Description of repeated value
boolValueType:
type: boolean
bytesValueType:
type: string
format: bytes
int32ValueType:
type: integer
format: int32
uint32ValueType:
type: integer
format: uint32
stringValueType:
type: string
int64ValueType:
type: string
uint64ValueType:
type: string
floatValueType:
type: number
format: float
doubleValueType:
type: number
format: double
timestampType:
type: string
format: date-time
durationType:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: string
Message_EmbMessage:
type: object
properties:
messageId:
type: string
RecursiveChild:
type: object
properties:
childId:
type: integer
format: int32
parent:
$ref: '#/components/schemas/RecursiveParent'
RecursiveParent:
type: object
properties:
parentId:
type: integer
format: int32
child:
$ref: '#/components/schemas/RecursiveChild'
Status:
type: object
properties:
code:
type: integer
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
SubMessage:
type: object
properties:
messageId:
type: string
subSubMessage:
$ref: '#/components/schemas/SubSubMessage'
SubSubMessage:
type: object
properties:
messageId:
type: string
integers:
type: array
items:
type: integer
format: int32
tags:
- name: Messaging