-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
462 lines (429 loc) · 10.9 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
openapi: 3.0.0
info:
title: MEN REST API
description: MongoDB ExpressJS NodeJS REST API
version: 1.0.0
servers:
- url: http://localhost:4000/api/
description: Localhost development server
- url: https://nba-stats-deploy-nodejs.herokuapp.com/api
description: Heroku remote server
tags:
- name: "User"
- name: "Team"
- name: "Player"
name: "News"
components:
securitySchemes:
ApiKeyAuth: # arbitrary name for the security scheme
type: apiKey
in: header # can be "header", "query" or "cookie"
name: auth-token
schemas:
User:
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
date:
type: string
News:
type: object
properties:
title:
type: string
url:
type: string
image:
type: string
Team:
type: object
properties:
name:
type: string
full_name:
type: string
location:
type: string
stadium:
type: string
wins:
type: number
losses:
type: number
logo:
type: string
Player:
type: object
properties:
first_name:
type: string
last_name:
type: string
team:
type: string
position:
type: string
height_cm:
type: number
paths:
/user/register:
post:
tags:
- "User"
summary: Register a new User
description: Register a new User in the database
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/User"
responses:
201:
description: User created succesfully
content:
application/json:
schema:
type: object
properties:
error:
type: string
_id:
type: string
/user/login:
post:
tags:
- "User"
summary: Login a User
description: Login a User in order to get JWT token (auth-token)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
password:
type: string
responses:
200:
description: User logged in succesfully
content:
application/json:
schema:
type: object
properties:
error:
type: string
data:
type: string
/teams:
get:
tags:
- "Team"
summary: Retrieves a list of teams
description: Retrieves a list of teams as JSON objects.
responses:
200:
description: A list of teams JSON objects in an array.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Team"
post:
tags:
- "Team"
summary: Create a new Team
description: Create a new Team
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Team"
responses:
201:
description: Team created succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Team"
/teams/{id}:
get:
tags:
- "Team"
summary: Specific Team
description: Retrieves a specific Team based on it id.
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
responses:
200:
description: A Team in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Team"
404:
description: 404 error message player id was not found
content:
application/json:
schema:
properties:
error:
type: string
put:
tags:
- "Team"
summary: Updates a specific Team
description: Updates a specific Team based on it id
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Team"
responses:
201:
description: Team updated succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Team"
404:
description: Team id succesfully
content:
application/json:
schema:
properties:
error:
type: string
delete:
tags:
- "Team"
summary: Deletes a specific Team
description: Deletes a specific Team based on it id
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
responses:
201:
description: Team deleted succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Team"
404:
description: 404 error message team id was not found.
content:
application/json:
schema:
properties:
error:
type: string
/players:
get:
tags:
- "Player"
summary: Retrieves a list of players
description: Retrieves a list of players as JSON objects.
responses:
200:
description: A list of players JSON objects in an array.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Player"
post:
tags:
- "Player"
summary: Create a new Player
description: Create a new Player
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Player"
responses:
201:
description: Player created succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Player"
/players/{id}:
get:
tags:
- "Player"
summary: Specific Player
description: Retrieves a specific Player based on it id.
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
responses:
200:
description: A Player in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Player"
404:
description: 404 error message player id was not found.
content:
application/json:
schema:
properties:
error:
type: string
put:
tags:
- "Player"
summary: Updates a specific Player
description: Updates a specific Player based on it id
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Player"
responses:
201:
description: Player updated succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Player"
404:
description: 404 error message player id was not found.
content:
application/json:
schema:
properties:
error:
type: string
delete:
tags:
- "Player"
summary: Deletes a specific Player
description: Deletes a specific Player based on it id
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
responses:
201:
description: Player deleted succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Player"
404:
description: 404 error message player id was not found.
content:
application/json:
schema:
properties:
error:
type: string
/players/team/{team}:
get:
tags:
- "Player"
summary: Specific team roster
description: Retrieves a specific team roster based on it id. Team names e.g. Suns, Heat, Lakers, Grizzlies
parameters:
- in: path
name: team
required: true
description: Team name
schema:
type: string
responses:
200:
description: A Player in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Player"
404:
description: 404 error message team name was not found.
content:
application/json:
schema:
properties:
error:
type: string
/news:
get:
tags:
- "News"
summary: Retrieves a list of sports news
description: Retrieves a list of news as JSON objects.
responses:
200:
description: A list of news JSON objects in an array.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/News"