-
-
Notifications
You must be signed in to change notification settings - Fork 34
/
example.documentation.yaml
607 lines (607 loc) · 17.3 KB
/
example.documentation.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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
openapi: 3.1.0
info:
title: Example API
version: 21.1.0
paths:
/v1/user/retrieve:
get:
operationId: GetV1UserRetrieve
summary: Retrieves the user.
description: Example user retrieval endpoint.
tags:
- users
parameters:
- name: id
in: query
required: true
description: a numeric string containing the id of the user
schema:
type: string
pattern: \d+
description: a numeric string containing the id of the user
responses:
"200":
description: GET /v1/user/retrieve Positive response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: success
data:
type: object
properties:
id:
type: integer
format: int64
minimum: 0
maximum: 9007199254740991
name:
type: string
features:
type: array
items:
type: object
properties:
title:
type: string
features:
$ref: "#/components/schemas/Schema1"
required:
- title
- features
required:
- id
- name
- features
required:
- status
- data
"400":
description: GET /v1/user/retrieve Negative response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: error
error:
type: object
properties:
message:
type: string
required:
- message
required:
- status
- error
examples:
example1:
value:
status: error
error:
message: Sample error message
/v1/user/{id}/remove:
delete:
operationId: DeleteV1UserIdRemove
tags:
- users
parameters:
- name: id
in: path
required: true
description: numeric string
schema:
type: string
pattern: \d+
description: numeric string
responses:
"204":
description: DELETE /v1/user/:id/remove Positive response
"404":
description: DELETE /v1/user/:id/remove Negative response
/v1/user/{id}:
patch:
operationId: PatchV1UserId
summary: Changes the user record. Example user update endp…
description: Changes the user record. Example user update endpoint.
tags:
- users
parameters:
- name: id
in: path
required: true
description: PATCH /v1/user/:id Parameter
schema:
type: string
examples:
example1:
value: "12"
requestBody:
description: PATCH /v1/user/:id Request body
content:
application/json:
schema:
type: object
properties:
key:
type: string
minLength: 1
name:
type: string
minLength: 1
birthday:
description: YYYY-MM-DDTHH:mm:ss.sssZ
type: string
format: date-time
pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$
externalDocs:
url: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
required:
- key
- name
- birthday
examples:
example1:
value:
key: 1234-5678-90
name: John Doe
birthday: 1963-04-21
security:
- APIKEY_1: []
APIKEY_2: []
responses:
"200":
description: PATCH /v1/user/:id Positive response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: success
data:
type: object
properties:
name:
type: string
createdAt:
description: YYYY-MM-DDTHH:mm:ss.sssZ
type: string
format: date-time
externalDocs:
url: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
required:
- name
- createdAt
examples:
- name: John Doe
createdAt: 2021-12-31T00:00:00.000Z
required:
- status
- data
examples:
example1:
value:
status: success
data:
name: John Doe
createdAt: 2021-12-31T00:00:00.000Z
"400":
description: PATCH /v1/user/:id Negative response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: error
error:
type: object
properties:
message:
type: string
required:
- message
required:
- status
- error
examples:
example1:
value:
status: error
error:
message: Sample error message
/v1/user/create:
post:
operationId: PostV1UserCreate
tags:
- users
requestBody:
description: POST /v1/user/create Request body
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
required:
- name
responses:
"201":
description: POST /v1/user/create Positive response 201
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: created
data:
type: object
properties:
id:
type: integer
format: int64
exclusiveMinimum: 0
maximum: 9007199254740991
required:
- id
required:
- status
- data
"202":
description: POST /v1/user/create Positive response 202
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: created
data:
type: object
properties:
id:
type: integer
format: int64
exclusiveMinimum: 0
maximum: 9007199254740991
required:
- id
required:
- status
- data
"400":
description: POST /v1/user/create Negative response 400
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: error
reason:
type: string
required:
- status
- reason
"409":
description: POST /v1/user/create Negative response 409
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: exists
id:
type: integer
format: int64
minimum: -9007199254740991
maximum: 9007199254740991
required:
- status
- id
"500":
description: POST /v1/user/create Negative response 500
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: error
reason:
type: string
required:
- status
- reason
/v1/user/list:
get:
operationId: GetV1UserList
tags:
- users
responses:
"200":
description: GET /v1/user/list Positive response
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
required:
- name
examples:
example1:
value:
- name: Hunter Schafer
- name: Laverne Cox
- name: Patti Harrison
"400":
description: GET /v1/user/list Negative response
content:
application/json:
schema:
type: string
examples:
example1:
value: Sample error message
/v1/avatar/send:
get:
operationId: GetV1AvatarSend
summary: Sends a file content.
tags:
- files
- users
parameters:
- name: userId
in: query
required: true
description: GET /v1/avatar/send Parameter
schema:
type: string
pattern: \d+
responses:
"200":
description: GET /v1/avatar/send Positive response
content:
image/svg+xml:
schema:
type: string
"400":
description: GET /v1/avatar/send Negative response
content:
text/plain:
schema:
type: string
/v1/avatar/stream:
get:
operationId: GetV1AvatarStream
summary: Streams a file content.
tags:
- users
- files
parameters:
- name: userId
in: query
required: true
description: GET /v1/avatar/stream Parameter
schema:
type: string
pattern: \d+
responses:
"200":
description: GET /v1/avatar/stream Positive response
content:
image/*:
schema:
type: string
format: binary
"400":
description: GET /v1/avatar/stream Negative response
content:
text/plain:
schema:
type: string
/v1/avatar/upload:
post:
operationId: PostV1AvatarUpload
summary: Handles a file upload.
description: Handles a file upload.
tags:
- files
requestBody:
description: POST /v1/avatar/upload Request body
content:
multipart/form-data:
schema:
type: object
properties:
avatar:
type: string
format: binary
required:
- avatar
responses:
"200":
description: POST /v1/avatar/upload Positive response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: success
data:
type: object
properties:
name:
type: string
size:
type: integer
format: int64
minimum: 0
maximum: 9007199254740991
mime:
type: string
hash:
type: string
otherInputs:
type: object
additionalProperties:
format: any
required:
- name
- size
- mime
- hash
- otherInputs
required:
- status
- data
"400":
description: POST /v1/avatar/upload Negative response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: error
error:
type: object
properties:
message:
type: string
required:
- message
required:
- status
- error
examples:
example1:
value:
status: error
error:
message: Sample error message
/v1/avatar/raw:
post:
operationId: PostV1AvatarRaw
tags:
- files
requestBody:
description: POST /v1/avatar/raw Request body
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
"200":
description: POST /v1/avatar/raw Positive response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: success
data:
type: object
properties:
length:
type: integer
format: int64
minimum: 0
maximum: 9007199254740991
required:
- length
required:
- status
- data
"400":
description: POST /v1/avatar/raw Negative response
content:
application/json:
schema:
type: object
properties:
status:
type: string
const: error
error:
type: object
properties:
message:
type: string
required:
- message
required:
- status
- error
examples:
example1:
value:
status: error
error:
message: Sample error message
components:
schemas:
Schema1:
type: array
items:
type: object
properties:
title:
type: string
features:
$ref: "#/components/schemas/Schema1"
required:
- title
- features
responses: {}
parameters: {}
examples: {}
requestBodies: {}
headers: {}
securitySchemes:
APIKEY_1:
type: apiKey
in: query
name: key
x-in-actual: body
description: key MUST be supplied within the request body instead of query
APIKEY_2:
type: apiKey
in: header
name: token
links: {}
callbacks: {}
tags:
- name: users
description: Everything about the users
- name: files
description: Everything about the files processing
servers:
- url: https://example.com