forked from anthonybudd/Express-ts-API-Template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OpenApiSpec.yml
532 lines (521 loc) · 13.8 KB
/
OpenApiSpec.yml
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
openapi: 3.0.0
servers:
- url: 'https://localhost:8888/api/v1/'
info:
description: >-
This is the public JSON REST API for the Express API Template.
version: 1.0.0
title: Express API Template
license:
name: Apache-2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
externalDocs:
description: Find out more about Express API Template
url: 'https://github.com/anthonybudd/express-api-template'
tags:
- name: DevOps
description: DevOps utility routes
- name: Auth
description: Auth routes
- name: Groups
description: Group routes
- name: Users
description: User routes
paths:
###############################################
## DevOps
'/_healthcheck':
get:
tags:
- DevOps
summary: "Returns {status: 'ok'} if has auth"
responses:
'200':
description: " {status: 'ok'}"
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: 'ok'
###############################################
## Auth
'/auth/login':
post:
tags:
- Auth
summary: Login
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
example: user@example.com
password:
type: string
example: password
responses:
'200':
description: "{accessToken}"
content:
application/json:
schema:
type: object
properties:
accessToken:
type: string
example: your_access_token
'/auth/sign-up':
post:
tags:
- Auth
summary: Sign-up
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
- firstName
- tos
properties:
email:
type: string
example: user@example.com
password:
type: string
example: password
firstName:
type: string
example: John
tos:
type: boolean
example: true
responses:
'200':
description: "{accessToken}"
content:
application/json:
schema:
type: object
properties:
accessToken:
type: string
example: your_access_token
'/auth/verify-email/{emailVerificationKey}':
get:
tags:
- Auth
summary: Verify Email
parameters:
- name: emailVerificationKey
in: path
required: true
schema:
type: string
responses:
'200':
description: "{success: true}"
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'/auth/forgot':
post:
tags:
- Auth
summary: Forgot Password
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
properties:
email:
type: string
example: user@example.com
responses:
200:
description: "{success: true}"
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'/auth/get-user-by-reset-key/{passwordResetKey}':
get:
tags:
- Auth
summary: Get User for Password Reset
parameters:
- name: passwordResetKey
in: path
required: true
schema:
type: string
responses:
200:
description: "{id, email}"
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: "user_id"
email:
type: string
example: user@example.com
'/auth/reset':
post:
tags:
- Auth
summary: Reset Password
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
- passwordResetKey
properties:
email:
type: string
example: user@example.com
password:
type: string
example: "new_password"
passwordResetKey:
type: string
example: "reset_key"
responses:
200:
description: "{accessToken}"
content:
application/json:
schema:
type: object
properties:
accessToken:
type: string
example: "your_access_token"
'/auth/get-user-by-invite-key/{inviteKey}':
get:
tags:
- Auth
summary: Get User for Invite
parameters:
- name: inviteKey
in: path
required: true
schema:
type: string
responses:
200:
description: "{id, email}"
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: "user_id"
email:
type: string
example: user@example.com
'/auth/invite':
post:
tags:
- Auth
summary: Complete User Invite
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- inviteKey
- email
- password
properties:
inviteKey:
type: string
example: "invite_key"
email:
type: string
example: user@example.com
password:
type: string
example: "new_password"
responses:
200:
description: "{accessToken}"
content:
application/json:
schema:
type: object
properties:
accessToken:
type: string
example: "your_access_token"
'/auth/_authcheck':
get:
tags:
- Auth
summary: Check Authentication Status
responses:
200:
description: "{auth: true}"
content:
application/json:
schema:
type: object
properties:
auth:
type: boolean
example: true
###############################################
## Groups
'/groups/{groupID}':
get:
tags:
- Groups
summary: Get Group by ID
parameters:
- name: groupID
in: path
required: true
schema:
type: string
responses:
200:
description: "Returns group information"
content:
application/json:
schema:
type: object
# Replace {Group} with your actual Group model definition
properties:
email:
type: string
description: The email address of the user to invite
example: user@example.com
post:
tags:
- Groups
summary: Invite User to Group
parameters:
- name: groupID
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: The email address of the user to invite
example: user@example.com
responses:
200:
description: "Returns invited user ID and group ID"
content:
application/json:
schema:
type: object
properties:
UserID:
type: string
description: The ID of the invited user
example: "user_id"
GroupID:
type: string
description: The ID of the group
example: "group_id"
'/groups/{groupID}/users/invite':
post:
tags:
- Groups
summary: Invite User to Group
parameters:
- name: groupID
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: The email address of the user to invite
example: user@example.com
responses:
200:
description: "Returns invited user ID and group ID"
content:
application/json:
schema:
type: object
properties:
UserID:
type: string
description: The ID of the invited user
example: "user_id"
GroupID:
type: string
description: The ID of the group
example: "group_id"
'/groups/{groupID}/users/{userID}':
delete:
tags:
- Groups
summary: Remove User from Group
parameters:
- name: groupID
in: path
required: true
schema:
type: string
- name: userID
in: path
required: true
schema:
type: string
responses:
200:
description: "Returns the ID of the removed user"
content:
application/json:
schema:
type: object
properties:
UserID:
type: string
description: The ID of the removed user
example: "user_id"
###############################################
## User
'/user':
get:
tags:
- Users
summary: Get the current user
responses:
200:
description: "Returns the current user"
content:
application/json:
schema:
type: object
# Replace {Group} with your actual Group model definition
properties:
email:
type: string
description: The email address of the user to invite
example: user@example.com
post:
tags:
- Users
summary: Update the current user
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: The email address of the user to invite
example: user@example.com
responses:
200:
description: "Returns invited user ID and group ID"
content:
application/json:
schema:
type: object
properties:
UserID:
type: string
description: The ID of the invited user
example: "user_id"
GroupID:
type: string
description: The ID of the group
example: "group_id"
'/user/update-password':
post:
tags:
- Users
summary: Update password
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: The email address of the user to invite
example: user@example.com
responses:
200:
description: "Returns invited user ID and group ID"
content:
application/json:
schema:
type: object
properties:
UserID:
type: string
description: The ID of the invited user
example: "user_id"
GroupID:
type: string
description: The ID of the group
example: "group_id"
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer