-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
729 lines (726 loc) · 21.7 KB
/
openapi.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
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
# yaml-language-server: $schema=https://github.com/OAI/OpenAPI-Specification/raw/main/schemas/v3.0/schema.json
openapi: 3.0.3
info:
title: My REST API template
description: >
A collections of my REST API template for different language. This template
follows the [JSON:API](https://jsonapi.org/) specification, unless there is
a specific endpoint specification.
contact:
name: Ahmad Husen
url: https://husen.id
email: [email protected]
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.1.0
paths:
/auth/login:
post:
tags:
- "auth"
summary: Log in to the site.
description: >
This endpoint follow Bearer Token Usage specification
[[RFC 6750]](https://tools.ietf.org/html/rfc6750).
operationId: logIn
requestBody:
content:
"application/json":
schema:
type: object
properties:
username:
type: string
password:
type: string
required:
- "username"
- "password"
example:
username: [email protected]
password: abogoboga
responses:
"200":
$ref: "#/components/responses/BearerAuth"
"400":
description: Invalid request body.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/Error"
- example:
links:
self: "/auth/login"
errors:
- status: 400
title: Bad Request
description: The username is required.
source:
pointer: "/data/attributes/username"
- status: 400
title: Bad Request
description: The password is required.
source:
pointer: "/data/attributes/password"
"401":
description: Invalid credentials.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/Error"
- example:
links:
self: "/auth/login"
errors:
- status: 401
title: Unauthorized
description: These credentials do not match our records.
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/auth/login"
security:
- {}
/auth/profile:
get:
tags:
- "auth"
summary: Get current logged in user.
operationId: getProfile
responses:
"200":
description: "Return current logged in user."
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/SingleUserResponseData"
- example:
links:
self: "/auth/profile"
"400":
$ref: "#/components/responses/InvalidRequest"
"401":
$ref: "#/components/responses/InvalidToken"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/auth/profile"
/auth/refresh:
get:
tags:
- "auth"
summary: Refresh access and refresh token.
description: >
Currently not working automatically due limitation of Swagger UI.
operationId: refresh
responses:
"200":
$ref: "#/components/responses/BearerAuth"
"400":
$ref: "#/components/responses/InvalidRequest"
"401":
$ref: "#/components/responses/InvalidToken"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/auth/logout"
security:
- cookieAuth: []
/auth/logout:
post:
tags:
- "auth"
summary: Log out current user.
description: >
Currently not working automatically due limitation of Swagger UI.
operationId: logOut
responses:
"204":
description: "User log out successfully."
"400":
$ref: "#/components/responses/InvalidRequest"
"401":
$ref: "#/components/responses/InvalidToken"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/auth/logout"
security:
- cookieAuth: []
/user:
post:
tags:
- "user"
summary: Create an user.
operationId: create
requestBody:
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/UserRequestData"
- example:
links:
self: "/user"
responses:
"201":
description: Return created user.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/SingleUserResponseData"
- example:
links:
self: "/user"
"400":
description: Invalid request body
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/UserRequestError"
- example:
links:
self: "/user"
"401":
$ref: "#/components/responses/InvalidToken"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/user"
get:
tags:
- "user"
summary: Get all users.
operationId: findAll
responses:
"200":
description: Return all users.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/AllUserResponseData"
- example:
links:
self: "/user"
"400":
$ref: "#/components/responses/InvalidRequest"
"401":
$ref: "#/components/responses/InvalidToken"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/user"
/user/{id}:
get:
tags:
- "user"
summary: Get an user.
operationId: findOne
parameters:
- name: id
description: This parameter must be a valid UUID v4.
in: path
required: true
schema:
type: string
responses:
"200":
description: Return an user.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/SingleUserResponseData"
- example:
links:
self: "/user/{id}"
"400":
description: Invalid id parameter.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InvalidIdParameter"
- example:
links:
self: "/user/{id}"
"401":
$ref: "#/components/responses/InvalidToken"
"404":
$ref: "#/components/responses/UserNotFound"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/user/{id}"
patch:
tags:
- "user"
summary: Update an user.
operationId: update
parameters:
- name: id
in: path
description: This parameter must be a valid UUID v4.
required: true
schema:
type: string
requestBody:
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/UserRequestData"
- example:
links:
self: "/user/{id}"
responses:
"200":
description: Return an user.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/SingleUserResponseData"
- example:
links:
self: "/user/{id}"
"400":
description: Invalid id parameter or request body.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InvalidIdParameter"
- $ref: "#/components/schemas/UserError"
- example:
links:
self: "/user/{id}"
"401":
$ref: "#/components/responses/InvalidToken"
"404":
$ref: "#/components/responses/UserNotFound"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/user/{id}"
delete:
tags:
- "user"
summary: Delete an user.
operationId: remove
parameters:
- name: id
in: path
description: This parameter must be a valid UUID v4.
required: true
schema:
type: string
responses:
"204":
description: User has been deleted successfully.
"400":
description: Invalid id parameter.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InvalidIdParameter"
- example:
links:
self: "/user/{id}"
"401":
$ref: "#/components/responses/InvalidToken"
"404":
$ref: "#/components/responses/UserNotFound"
"500":
description: Internal server error.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/InternalServerError"
- example:
links:
self: "/user/{id}"
components:
schemas:
JsonApi:
type: object
properties:
jsonapi:
type: object
properties:
version:
type: string
links:
type: object
properties:
self:
type: string
example:
jsonapi:
version: "1.0"
Data:
type: object
properties:
id:
type: string
type:
type: string
Error:
allOf:
- $ref: "#/components/schemas/JsonApi"
- type: object
properties:
errors:
type: array
items:
type: object
properties:
status:
type: number
default: 400
title:
type: string
detail:
type: string
source:
type: object
properties:
pointer:
type: string
parameter:
type: string
required:
- "status"
- "title"
InternalServerError:
allOf:
- $ref: "#/components/schemas/Error"
- example:
errors:
- status: 500
title: Internal Server Error
description: Something went wrong.
InvalidIdParameter:
allOf:
- $ref: "#/components/schemas/Error"
- example:
errors:
- status: 400
title: Bad Request
detail: Validation failed (uuid v4 is expected).
source:
parameter: id
BearerAuthError:
type: object
properties:
error:
type: string
error_description:
type: string
User:
type: object
properties:
name:
type: string
nickname:
type: string
email:
type: string
password:
type: string
writeOnly: true
password_confirmation:
type: string
writeOnly: true
photo:
type: string
writeOnly: true
avatar:
type: string
readOnly: true
created_at:
type: string
readOnly: true
updated_at:
type: string
readOnly: true
required:
- "name"
- "email"
- "password"
- "password_confirmation"
example:
name: John Doe
nickname: John
email: [email protected]
password: abogoboga
password_confirmation: abogoboga
photo: <your-photo-path>
avatar: <your-s3-url-here>
UserData:
allOf:
- $ref: "#/components/schemas/Data"
- properties:
attributes:
$ref: "#/components/schemas/User"
SingleUserResponseData:
allOf:
- $ref: "#/components/schemas/JsonApi"
- properties:
data:
$ref: "#/components/schemas/UserData"
- example:
data:
id: <your-uuid-v4-here>
type: users
attributes:
name: John Doe
nickname: John
email: [email protected]
avatar: <your-s3-url-here>
created_at: Date
updated_at: Date
AllUserResponseData:
allOf:
- $ref: "#/components/schemas/JsonApi"
- properties:
data:
type: array
items:
$ref: "#/components/schemas/UserData"
- example:
data:
- id: <your-uuid-v4-here>
type: users
attributes:
name: John Doe
nickname: John
email: [email protected]
avatar: <your-s3-url-here>
created_at: Date
updated_at: Date
UserRequestData:
allOf:
- $ref: "#/components/schemas/JsonApi"
- properties:
data:
$ref: "#/components/schemas/UserData"
- example:
data:
id: <your-uuid-v4-here>
type: users
attributes:
name: John Doe
nickname: John
email: [email protected]
password: abogoboga
password_confirmation: abogoboga
photo: <your-photo-path>
UserError:
allOf:
- $ref: "#/components/schemas/Error"
- example:
errors:
- status: 400
title: Bad Request
detail: The email must be a valid email address.
source:
pointer: "/data/attributes/email"
- status: 400
title: Bad Request
detail: The email has already been taken.
source:
pointer: "/data/attributes/email"
- status: 400
title: Bad Request
detail: The password must be at least 8 characters.
source:
pointer: "/data/attributes/password"
- status: 400
title: Bad Request
detail: The password_confirmation must be at least 8 characters.
source:
pointer: "/data/attributes/password_confirmation"
- status: 400
title: Bad Request
detail: The password_confirmation and password must match.
source:
pointer: "/data/attributes/password_confirmation"
UserRequestError:
allOf:
- $ref: "#/components/schemas/UserError"
- example:
errors:
- status: 400
title: Bad Request
detail: The name is required.
source:
pointer: "/data/attributes/name"
- status: 400
title: Bad Request
detail: The email is required.
source:
pointer: "/data/attributes/email"
- status: 400
title: Bad Request
detail: The password is required.
source:
pointer: "/data/attributes/password"
- status: 400
title: Bad Request
detail: The password_confirmation is required.
source:
pointer: "/data/attributes/password_confirmation"
UserNotFound:
allOf:
- $ref: "#/components/schemas/Error"
- example:
errors:
- status: 404
title: Not Found
detail: The user is not found.
source:
parameter: id
responses:
InvalidRequest:
description: The token is missing or malformed.
headers:
"WWW-Authenticate":
$ref: "#/components/headers/bearerAuthError"
content:
"application/json":
schema:
allOf:
- $ref: "#/components/schemas/BearerAuthError"
- example:
error: invalid_request
error_description: The token is missing or malformed.
InvalidToken:
description: The token is revoked or expired.
headers:
"WWW-Authenticate":
$ref: "#/components/headers/bearerAuthError"
content:
"application/json":
schema:
allOf:
- $ref: "#/components/schemas/BearerAuthError"
- example:
error: invalid_token
error_description: The token has been revoked or expired.
BearerAuth:
description: >
Valid credentials, with a response format that follows
[RFC6750](https://datatracker.ietf.org/doc/html/rfc6750#section-4).
content:
"application/json":
schema:
type: object
properties:
access_token:
type: string
token_type:
type: string
default: Bearer
expires_in:
type: integer
refresh_token:
type: string
example:
access_token: <your-access-token-here>
token_type: Bearer
expires_in: 3600
refresh_token: <your-refresh-token-here>
UserNotFound:
description: User not found, usually caused by invalid id parameter.
content:
"application/vnd.api+json":
schema:
allOf:
- $ref: "#/components/schemas/Error"
- example:
links:
self: "/user/{id}"
errors:
- status: 404
title: Not Found
detail: The user is not found.
source:
parameter: id
headers:
bearerAuthError:
description: >
HTTP authentication methods ("challenges") that might be used.
schema:
type: string
example: Bearer realm="Access to the site"
securitySchemes:
bearerAuth:
description: JWT based access token authentication
type: http
scheme: bearer
bearerFormat: JWT
cookieAuth:
description: JWT based refresh token authentication
type: apiKey
in: cookie
name: refresh-token
security:
- bearerAuth: []