-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
576 lines (576 loc) · 21.8 KB
/
swagger.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
openapi: 3.0.0
info:
title: MoviePool API
description: RESTful API for movie lovers that want to be able to access information about different movies
version: 1.0.0
tags:
- name: Homepage
description: Homepage
- name: Sign up / Log in
description: Everything about sign up / log in
- name: Users
description: Everything about Users
- name: Movies
description: Everything about Movies
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
paths:
/:
get:
tags:
- Homepage
summary: Get Homepage
description: GET request to get the homepage.
responses:
'200':
description: Successful fetch of resource
/signup:
post:
tags:
- Sign up / Log in
summary: Allow a user to sign up
description: POST request to sign up as a new user. This can be done by anyone.
security:
- bearerAuth: []
requestBody:
description: User data that needs to be send to sign up as a new user.
required: true
content:
application/json:
schema:
type: object
properties:
userName:
type: string
example: Jane Doe
password:
type: string
example: testpassword1234
email:
type: string
example: [email protected]
birthDate:
type: integer
example: YYYY-MM-DD
responses:
'201':
description: User successfully created
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 12345abcde67fg890h1i2jk3
userName:
type: string
example: Jane Doe
password:
type: string
example: $3c$10$OJL7mdTq69czPIYlV/c09OzUR.kV5tBCTUmxCxy/ysxg1TSS.bIcp
email:
type: string
example: [email protected]
birthDate:
type: integer
example: YYYY-MM-DD
favoriteMovies:
type: array
items:
properties:
'400':
description: User already exists
/login:
post:
tags:
- Sign up / Log in
summary: Allow a user to log in
description: POST request to log in as an already existing user. This can only be done by a registered user. JSON Web Token is created when logging in with user name and password.
security:
- basicAuth: []
requestBody:
description: User data that needs to be send to log in as a registered user.
required: true
content:
application/json:
schema:
type: object
properties:
userName:
type: string
example: Jane Doe
password:
type: string
example: testpassword1234
responses:
'200':
description: Successful fetch of resource
content:
application/json:
schema:
type: object
properties:
user:
type: object
properties:
userName:
type: string
example: Jane Doe
email:
type: string
example: [email protected]
favoriteMovies:
type: array
items:
properties:
token:
type: string
example: a long string of characters, representing passport json web token with HS256 encoding
'400':
description: Bad request due to invalid input
/users:
get:
tags:
- Users
summary: Get all users
description: GET request to get all users. This can only be done by a logged in user.
security:
- bearerAuth: []
responses:
'200':
description: Successful fetch of resource
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 12345abcde67fg890h1i2jk3
userName:
type: string
example: Jane Doe
password:
type: string
example: $3c$10$OJL7mdTq69czPIYlV/c09OzUR.kV5tBCTUmxCxy/ysxg1TSS.bIcp
email:
type: string
example: [email protected]
birthDate:
type: integer
example: YYYY-MM-DD
favoriteMovies:
type: array
items:
properties:
0:
type: string
example: 12345abcde67fg890h1i2jk3
1:
type: string
example: 12345abcde67fg890h1i2jk3
'500':
description: Internal Server Error
/users/{userName}:
get:
tags:
- Users
summary: Get a user by user name
description: GET request to get a user by user name. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: userName
in: path
description: The user name
required: true
schema:
type: string
responses:
'200':
description: Successful fetch of resource
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 12345abcde67fg890h1i2jk3
userName:
type: string
example: Jane Doe
password:
type: string
example: $3c$10$OJL7mdTq69czPIYlV/c09OzUR.kV5tBCTUmxCxy/ysxg1TSS.bIcp
email:
type: string
example: [email protected]
birthDate:
type: integer
example: YYYY-MM-DD
favoriteMovies:
type: array
items:
properties:
0:
type: string
example: 12345abcde67fg890h1i2jk3
1:
type: string
example: 12345abcde67fg890h1i2jk3
'500':
description: Internal Server Error
put:
tags:
- Users
summary: Update user data by user name
description: PUT request to update user data by user name. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: userName
in: path
description: The user name
required: true
schema:
type: string
responses:
'201':
description: User successfully updated
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 12345abcde67fg890h1i2jk3
userName:
type: string
example: Jane Doe
password:
type: string
example: $3c$10$OJL7mdTq69czPIYlV/c09OzUR.kV5tBCTUmxCxy/ysxg1TSS.bIcp
email:
type: string
example: [email protected]
'500':
description: Internal Server Error
delete:
tags:
- Users
summary: Delete a user by user name
description: DELETE request to delete a user by user name. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: userName
in: path
description: The user name
required: true
schema:
type: string
responses:
'200':
description: User has been deleted.
'400':
description: User was not found.
'500':
description: Internal Server Error
/users/{userName}/movies/{movieid}:
post:
tags:
- Users
summary: Add a movie to user's favorite movies list by movie id
description: POST request to add a movie to user's favorite movies list. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: userName
in: path
description: The name of a user with a favorite movies list
required: true
schema:
type: string
- name: movieid
in: path
description: The movie id of the movie that has been added to a user's favorite movies list
required: true
schema:
type: string
responses:
'201':
description: Movie added successfully, User object updated
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: ObjectId('12345abcde67fg890h1i2jk3')
userName:
type: string
example: Jane Doe
password:
type: string
example: $3c$10$OJL7mdTq69czPIYlV/c09OzUR.kV5tBCTUmxCxy/ysxg1TSS.bIcp
email:
type: string
example: [email protected]
birthDate:
type: integer
example: YYYY-MM-DD
favoriteMovies:
type: array
items:
properties:
0:
type: string
example: ObjectId('12345abcde67fg890h1i2jk3')
1:
type: string
example: ObjectId('12345abcde67fg890h1i2jk3')
2:
type: string
example: ObjectId('12345abcde67fg890h1i2jk3')
'500':
description: Internal Server Error
delete:
tags:
- Users
summary: Delete a movie off of user's favorite movies list by movie id
description: DELETE request to delete a movie off of a user's favorite movies list. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: userName
in: path
description: The name of a user with a favorite movies list.
required: true
schema:
type: string
- name: movieid
in: path
description: Movie id of the movie that has been deleted off of a user's favorite movies list
required: true
schema:
type: string
responses:
'201':
description: Movie deleted successfully, User object updated
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 12345abcde67fg890h1i2jk3
userName:
type: string
example: Jane Doe
password:
type: string
example: $3c$10$OJL7mdTq69czPIYlV/c09OzUR.kV5tBCTUmxCxy/ysxg1TSS.bIcp
email:
type: string
example: [email protected]
birthDate:
type: integer
example: YYYY-MM-DD
favoriteMovies:
type: array
items:
properties:
'500':
description: Internal Server Error
/movies:
get:
tags:
- Movies
summary: Get all movies
description: GET request to get all movies. This can only be done by a logged in user.
security:
- bearerAuth: []
responses:
'200':
description: Successful fetch of resource
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 640f2e4353ffdd1f54db45da
title:
type: string
example: Terminator
description:
type: string
example: A human soldier is sent from 2029 to 1984 to stop an almost indestructible cyborg killing machine, sent from the same year, which has been programmed to execute a young woman whose unborn son is the key to humanity's future salvation.
genre:
type: object
properties:
genreName:
type: string
example: Sci-Fi
description:
type: string
example: Science fiction (sometimes shortened to sf or sci-fi) is a genre of speculative fiction, which typically deals with imaginative and futuristic concepts such as advanced science and technology, space exploration, time travel, parallel universes, and extraterrestrial life.
director:
type: object
properties:
directorName:
type: string
example: James Cameron
bio:
type: string
example: James Francis Cameron is a Canadian filmmaker. A major figure in the post-New Hollywood era, he is considered one of the industry's most innovative filmmakers, regularly pushing the boundaries of cinematic capability with his use of novel technologies. He first gained recognition for writing and directing The Terminator (1984) and found further success with Aliens (1986), The Abyss (1989), Terminator 2, Judgment Day (1991), and the action comedy True Lies (1994). He wrote and directed Titanic (1997), Avatar (2009) and its sequels, with Titanic earning him Academy Awards for Best Picture, Best Director and Best Film Editing. A recipient of various other industry accolades, two of his films have been selected for preservation in the National Film Registry by the Library of Congress.
birthDate:
type: integer
example: YYYY-MM-DD
imagePath:
type: string
example: https://xl.movieposterdb.com/22_11/1991/301928/xl_the-terminator-movie-poster_c32bbde4.jpg
featured:
type: boolean
example: true
'500':
description: Internal Server Error
/movies/{title}:
get:
tags:
- Movies
summary: Get a specific movie by title
description: GET request to get a specific movie by title. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: title
in: path
description: The movie title
required: true
schema:
type: string
responses:
'200':
description: Successful fetch of resource
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 640f2e4353ffdd1f54db45da
title:
type: string
example: Terminator
description:
type: string
example: A human soldier is sent from 2029 to 1984 to stop an almost indestructible cyborg killing machine, sent from the same year, which has been programmed to execute a young woman whose unborn son is the key to humanity's future salvation.
genre:
type: object
properties:
genreName:
type: string
example: Sci-Fi
description:
type: string
example: Science fiction (sometimes shortened to sf or sci-fi) is a genre of speculative fiction, which typically deals with imaginative and futuristic concepts such as advanced science and technology, space exploration, time travel, parallel universes, and extraterrestrial life.
director:
type: object
properties:
directorName:
type: string
example: James Cameron
bio:
type: string
example: James Francis Cameron is a Canadian filmmaker. A major figure in the post-New Hollywood era, he is considered one of the industry's most innovative filmmakers, regularly pushing the boundaries of cinematic capability with his use of novel technologies. He first gained recognition for writing and directing The Terminator (1984) and found further success with Aliens (1986), The Abyss (1989), Terminator 2, Judgment Day (1991), and the action comedy True Lies (1994). He wrote and directed Titanic (1997), Avatar (2009) and its sequels, with Titanic earning him Academy Awards for Best Picture, Best Director and Best Film Editing. A recipient of various other industry accolades, two of his films have been selected for preservation in the National Film Registry by the Library of Congress.
birthDate:
type: integer
example: YYYY-MM-DD
imagePath:
type: string
example: https://xl.movieposterdb.com/22_11/1991/301928/xl_the-terminator-movie-poster_c32bbde4.jpg
fetured:
type: boolean
example: true
'500':
description: Internal Server Error
/movies/genres/{genreName}:
get:
tags:
- Movies
summary: Get a specific movie genre by movie genre name
description: GET request to get a specific movie genre by genre name. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: genreName
in: path
description: The genre name
required: true
schema:
type: string
responses:
'200':
description: Successful fetch of resource
content:
application/json:
schema:
type: object
properties:
genreName:
type: string
example: Sci-Fi
description:
type: string
example: Science fiction (sometimes shortened to sf or sci-fi) is a genre of speculative fiction, which typically deals with imaginative and futuristic concepts such as advanced science and technology, space exploration, time travel, parallel universes, and extraterrestrial life.
'500':
description: Internal Server Error
/movies/directors/{directorName}:
get:
tags:
- Movies
summary: Get a specific director by director name
description: Get a specific director by director name. This can only be done by a logged in user.
security:
- bearerAuth: []
parameters:
- name: directorName
in: path
description: The director name
required: true
schema:
type: string
responses:
'200':
description: Successful fetch of resource
content:
application/json:
schema:
type: object
properties:
directorName:
type: string
example: James Cameron
bio:
type: string
example: James Francis Cameron is a Canadian filmmaker. A major figure in the post-New Hollywood era, he is considered one of the industry's most innovative filmmakers, regularly pushing the boundaries of cinematic capability with his use of novel technologies. He first gained recognition for writing and directing The Terminator (1984) and found further success with Aliens (1986), The Abyss (1989), Terminator 2, Judgment Day (1991), and the action comedy True Lies (1994). He wrote and directed Titanic (1997), Avatar (2009) and its sequels, with Titanic earning him Academy Awards for Best Picture, Best Director and Best Film Editing. A recipient of various other industry accolades, two of his films have been selected for preservation in the National Film Registry by the Library of Congress.
birthDate:
type: integer
example: YYYY-MM-DD
'500':
description: Internal Server Error