-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiRoutesDoc.yaml
575 lines (557 loc) · 16.9 KB
/
apiRoutesDoc.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
openapi: 3.0.0
servers:
- description: API Simpsons Trivia Flyio server
url: https://simpsons-trivia.fly.dev/api/v1
- description: API Simpsons Trivia localhost
url: http://localhost:3001/api/v1
info:
description: API para el juego de trivia de Los Simpson
version: "1.3"
title: Simpsons Trivia API
contact:
email: tomas.saintromain@gmail.com
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
tags:
- name: Public
description: Endpoints públicos que no requieren autenticación
- name: Game
description: Endpoints relacionados con el juego de trivia
- name: Authentication
description: Gestión de usuarios y sesiones
- name: Session
description: Manejo de sesiones anónimas y autenticadas
- name: Admin
description: Endpoints protegidos solo para administradores
paths:
/healthcheck:
get:
tags:
- Public
summary: Verificar estado de la API
description: Verifica si la API está funcionando correctamente
responses:
'200':
description: Estado de la API
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
timestamp:
type: string
format: date-time
/session-status:
get:
tags:
- Session
summary: Obtener estado de la sesión actual
description: Verifica el estado de la sesión y tiempo restante para usuarios anónimos
responses:
'200':
description: Estado de la sesión actual
content:
application/json:
schema:
type: object
properties:
status:
type: string
data:
type: object
properties:
isAnonymous:
type: boolean
timeRemaining:
type: integer
shouldWarn:
type: boolean
sessionExpires:
type: string
format: date-time
/quote/random:
get:
tags:
- Game
summary: Obtener pregunta aleatoria
description: Retorna una frase aleatoria con 4 opciones de personajes (1 correcta y 3 incorrectas)
responses:
'200':
description: Pregunta aleatoria con opciones
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
id:
type: integer
description: ID único de la frase
example: 102
quote:
type: string
description: Frase del personaje
example: "A darle átomos!"
options:
type: array
description: Lista de personajes posibles con sus IDs
items:
type: object
properties:
id:
type: integer
description: ID único del personaje
name:
type: string
description: Nombre del personaje
example:
[
{ id: 3, name: "Helen Lovejoy" },
{ id: 1, name: "Bart Simpson" },
{ id: 35, name: "Hombre Radioactivo" },
{ id: 2, name: "Homero Simpson" }
]
/quotes/{id}/answer:
post:
tags:
- Game
summary: Enviar respuesta a una pregunta
description: Verifica si la respuesta es correcta y actualiza el puntaje
parameters:
- in: path
name: id
required: true
schema:
type: integer
description: ID de la pregunta
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
answer:
type: integer
description: Nombre del personaje seleccionado
time:
type: integer
description: Tiempo de respuesta
required:
- answer
responses:
'200':
description: Resultado de la respuesta
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
result:
type: object
properties:
correct:
type: boolean
score:
type: integer
time:
type: integer
message:
type: string
/quotes/bycharacter/{characterId}:
get:
tags:
- Game
summary: Obtener frases por personaje
description: Retorna todas las frases de un personaje específico
parameters:
- in: path
name: characterId
required: true
schema:
type: integer
description: ID del personaje
responses:
'200':
description: Frases del personaje
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: array
items:
type: object
properties:
id:
type: integer
quote:
type: string
character:
type: string
/characters:
get:
tags:
- Game
summary: Obtener lista de personajes
description: Retorna la lista de todos los personajes disponibles
responses:
'200':
description: Lista de personajes
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
/login:
post:
tags:
- Authentication
summary: Iniciar sesión
description: Autenticación de usuario registrado
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
responses:
'200':
description: Login exitoso
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
user:
type: object
properties:
id:
type: string
email:
type: string
username:
type: string
/register:
post:
tags:
- Authentication
summary: Registrar nuevo usuario
description: Crear una nueva cuenta de usuario
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
username:
type: string
password:
type: string
responses:
'200':
description: Registro exitoso
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
/logout:
post:
tags:
- Authentication
summary: Cerrar sesión
description: Finaliza la sesión actual del usuario
responses:
'200':
description: Logout exitoso
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
/users:
get:
tags:
- Admin
summary: Obtener lista de usuarios
description: Retorna la lista de todos los usuarios registrados
security:
- bearerAuth: []
responses:
'200':
description: Lista de usuarios
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: array
items:
type: object
properties:
id:
type: string
email:
type: string
username:
type: string
role:
type: string
/scores:
get:
tags:
- Admin
summary: Obtener puntajes de usuarios
description: Retorna los puntajes de todos los usuarios
security:
- bearerAuth: []
responses:
'200':
description: Lista de puntajes
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: array
items:
type: object
properties:
user_id:
type: string
username:
type: string
score:
type: integer
last_played:
type: string
format: date-time
/users/{userId}/role:
patch:
tags:
- Admin
summary: Cambiar rol de un usuario
description: Modifica el rol de un usuario específico
security:
- bearerAuth: []
parameters:
- in: path
name: userId
required: true
schema:
type: string
description: ID del usuario
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
role:
type: string
description: Nuevo rol del usuario
example: "admin"
responses:
'200':
description: Rol actualizado exitosamente
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: "Rol actualizado correctamente"
/user/stats:
get:
tags:
- Authentication
summary: Obtener estadísticas del usuario
description: Retorna las estadísticas del usuario autenticado, incluyendo puntajes y respuestas.
security:
- bearerAuth: []
responses:
'200':
description: Estadísticas del usuario
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
currentScore:
type: integer
description: Puntaje actual del usuario
highestScore:
type: integer
description: Mejor puntaje del usuario
lastScore:
type: integer
description: Último puntaje del usuario
answerTime:
type: integer
description: Tiempo promedio de respuesta en milisegundos
correctAnswers:
type: integer
description: Número de respuestas correctas
incorrectAnswers:
type: integer
description: Número de respuestas incorrectas
totalQuestions:
type: integer
description: Total de preguntas respondidas
accuracy:
type: string
description: Precisión en porcentaje
/user/data:
get:
tags:
- Authentication
summary: Obtener datos del usuario
description: Retorna la información del usuario autenticado, incluyendo nombre de usuario, etiqueta, email, y más.
security:
- bearerAuth: []
responses:
'200':
description: Datos del usuario
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
id:
type: string
description: ID del usuario
username:
type: string
description: Nombre de usuario
user_tag:
type: string
description: Etiqueta del usuario
email:
type: string
description: Correo electrónico del usuario
image_url:
type: string
description: URL de la imagen del usuario (puede ser nulo)
supabase_user_id:
type: string
description: ID del usuario en Supabase
role:
type: string
description: Rol del usuario
created_at:
type: string
format: date-time
description: Fecha de creación de la cuenta
/gameover:
post:
tags:
- Game
summary: Finalizar el juego y resetear puntaje
description: Resetea el puntaje del usuario y devuelve el estado del juego.
security:
- bearerAuth: []
responses:
'200':
description: Juego finalizado exitosamente
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
description: Mensaje de confirmación
data:
type: object
properties:
previousScore:
type: integer
description: Puntaje anterior antes del reset
highestScore:
type: integer
description: Mejor puntaje del usuario
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
QuoteResponse:
type: object
properties:
success:
type: boolean