forked from tombihoreau/API-Badminton
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
374 lines (358 loc) · 10.5 KB
/
openapi.yaml
File metadata and controls
374 lines (358 loc) · 10.5 KB
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
openapi: 3.0.0
info:
title: API de gestion des terrains et des réservations
description: API pour gérer les terrains, les créneaux horaires et les réservations, avec authentification via JWT.
version: 1.0.0
servers:
- url: http://localhost:3000
description: Serveur local de développement
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Field:
type: object
properties:
id:
type: integer
description: L'identifiant unique du terrain
name:
type: string
description: Le nom du terrain
available:
type: boolean
description: L'indication si le terrain est disponible
reasonUnavailable:
type: string
description: La raison de l'indisponibilité du terrain
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
Slot:
type: object
properties:
id:
type: integer
description: L'identifiant unique du créneau
startTime:
type: string
format: time
description: L'heure de début du créneau
endTime:
type: string
format: time
description: L'heure de fin du créneau
date:
type: string
format: date
description: La date du créneau
isAvailable:
type: boolean
description: L'indication si le créneau est disponible
fieldId:
type: integer
description: L'identifiant du terrain associé au créneau
Reservation:
type: object
properties:
id:
type: integer
description: L'identifiant unique de la réservation
userId:
type: integer
description: L'identifiant de l'utilisateur ayant fait la réservation
slotId:
type: integer
description: L'identifiant du créneau réservé
date:
type: string
format: date
description: La date de la réservation
isCancelled:
type: boolean
description: L'indication si la réservation a été annulée
User:
type: object
properties:
id:
type: integer
description: L'identifiant unique de l'utilisateur
pseudo:
type: string
description: Le pseudo de l'utilisateur
password:
type: string
description: Le mot de passe de l'utilisateur
role:
type: string
description: Le rôle de l'utilisateur
enum: [admin, user]
default: user
security:
- BearerAuth: []
paths:
/login:
post:
summary: Authentifier un utilisateur
description: Authentifie un utilisateur et retourne un token JWT pour les futures requêtes sécurisées.
operationId: loginUser
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
pseudo:
type: string
password:
type: string
responses:
'200':
description: Succès de l'authentification, retourne le token
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
'400':
description: Pseudo ou mot de passe incorrect
'500':
description: Erreur serveur
/register:
post:
summary: Créer un compte utilisateur
description: Crée un nouveau compte utilisateur et retourne un token JWT pour les futures requêtes sécurisées.
operationId: registerUser
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
pseudo:
type: string
password:
type: string
responses:
'201':
description: Inscription réussie, retourne le token
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
'400':
description: Pseudo, mot de passe manquant, ou pseudo déjà pris
'500':
description: Erreur serveur
/fields:
get:
summary: Lister tous les terrains
description: Récupère la liste de tous les terrains disponibles.
operationId: getFields
responses:
'200':
description: Liste des terrains
content:
application/json:
schema:
type: object
properties:
_embedded:
type: object
properties:
fields:
type: array
items:
$ref: '#/components/schemas/Field'
'500':
description: Erreur serveur
/fields/{id}:
get:
summary: Voir les détails d'un terrain
description: Récupère les détails d'un terrain par son ID.
operationId: getFieldById
parameters:
- in: path
name: id
required: true
schema:
type: integer
description: L'identifiant du terrain
responses:
'200':
description: Détails du terrain
content:
application/json:
schema:
$ref: '#/components/schemas/Field'
'404':
description: Terrain non trouvé
'500':
description: Erreur serveur
patch:
summary: Modifier un terrain (Admin)
description: Modifie la disponibilité d'un terrain et la raison de son indisponibilité. Accessible uniquement par un administrateur.
operationId: updateField
parameters:
- in: path
name: id
required: true
schema:
type: integer
description: L'identifiant du terrain à modifier
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
available:
type: boolean
reasonUnavailable:
type: string
responses:
'200':
description: Terrain modifié
content:
application/json:
schema:
$ref: '#/components/schemas/Field'
'403':
description: Accès interdit, seul un administrateur peut modifier
'404':
description: Terrain non trouvé
'500':
description: Erreur serveur
/fields/{id}/slots:
get:
summary: Voir les créneaux disponibles pour un terrain
description: Récupère la liste des créneaux disponibles pour un terrain donné.
operationId: getAvailableSlots
parameters:
- in: path
name: id
required: true
schema:
type: integer
description: L'identifiant du terrain
responses:
'200':
description: Liste des créneaux disponibles
content:
application/json:
schema:
type: object
properties:
_embedded:
type: object
properties:
slots:
type: array
items:
$ref: '#/components/schemas/Slot'
'500':
description: Erreur serveur
/reservations:
post:
summary: Créer une réservation
description: Permet de créer une réservation pour un créneau disponible. La réservation doit être dans la semaine en cours et le terrain doit être disponible.
operationId: createReservation
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
slotId:
type: integer
date:
type: string
format: date
required:
- slotId
- date
responses:
'201':
description: Réservation créée
content:
application/json:
schema:
type: object
properties:
message:
type: string
reservation:
$ref: '#/components/schemas/Reservation'
'400':
description: Erreur dans la création de la réservation
'500':
description: Erreur serveur
/reservations/{id}:
delete:
summary: Annuler une réservation
description: Permet d'annuler une réservation existante.
operationId: cancelReservation
security:
- BearerAuth: []
parameters:
- in: path
name: id
required: true
schema:
type: integer
description: L'identifiant de la réservation à annuler
responses:
'204':
description: Réservation annulée
'404':
description: Réservation non trouvée
'500':
description: Erreur serveur
/users/{userId}/reservations:
get:
summary: Voir les réservations d'un utilisateur
description: Récupère la liste des réservations d'un utilisateur donné.
operationId: getUserReservations
parameters:
- in: path
name: userId
required: true
schema:
type: integer
description: L'identifiant de l'utilisateur
responses:
'200':
description: Liste des réservations de l'utilisateur
content:
application/json:
schema:
type: object
properties:
_embedded:
type: object
properties:
reservations:
type: array
items:
$ref: '#/components/schemas/Reservation'
'404':
description: Utilisateur non trouvé
'500':
description: Erreur serveur