generated from RustLangES/cfworker-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
378 lines (365 loc) · 11.6 KB
/
openapi.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
openapi: 3.0.3
info:
title: Q-rs
description: Endpoints para q-rs.
version: 1.0.0
tags:
- name: Authentication
description: Endpoints relacionados con el inicio y cierre de sesión.
- name: Links
description: Endpoints relacionados con creación y manejo de enlaces.
paths:
/login:
post:
tags:
- Authentication
summary: Iniciar sesión
description: Permite autenticar al usuario mediante email y contraseña. Si se requiere MFA, se indica en la respuesta.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
password:
type: string
example: securepassword
mfa:
type: integer
nullable: true
example: null
responses:
'204':
description: Completado. La sesión fue iniciada correctamente y se estableció una cookie de sesión.
'401':
description: Credenciales inválidas. El correo o contraseña no coinciden con un usuario registrado.
'400':
description: Se requiere autenticación 2FA.
/logout:
get:
tags:
- Authentication
summary: Cerrar sesión
description: Permite al usuario cerrar su sesión activa.
responses:
'204':
description: Sesión cerrada correctamente.
'401':
description: No hay una sesión activa.
/signup:
post:
tags:
- Authentication
summary: Crear cuenta
description: Permite a un usuario registrarse proporcionando un nombre de usuario, correo electrónico y contraseña.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
example: new_user
email:
type: string
example: [email protected]
password:
type: string
example: securepassword
responses:
'204':
description: Usuario creado exitosamente.
'403':
description: El usuario ya existe.
'400':
description: El cuerpo de la solicitud no contiene todos los campos requeridos.
/links:
get:
tags:
- Links
summary: Obtener enlaces.
description: Permite Obtener todos los enlaces creads por el usuario.
responses:
'200':
description: Links recuperados exitosamente.
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 2382
slug:
type: string
example: abcdef
content:
oneOf:
- type: array
example:
- https://rustlang.org
- https://rustlang-es.org
- type: string
example: https://rustlang-es.org
created_at:
type: integer
example: 1732289376
modified_at:
type: integer
nullable: true
example: 1732289376
campaign:
type: string
nullable: true
example: event2025
tags:
type: array
nullable: true
items:
type: string
example:
- events
- "2025"
- upcoming
'401':
description: No hay una sesión activa
put:
tags:
- Links
summary: Crea un nuevo enlace.
description: Permite crear un nuevo enlace con un slug aleatorio.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
content:
oneOf:
- type: string
format: string
description: Un único enlace.
example: https://rustlang-es.org
- type: array
items:
type: string
format: string
description: Una lista de enlaces.
example:
- https://rustlang.org
- https://rustlang-es.org
tags:
type: array
items:
type: string
format: string
description: array of tag names
nullable: true
example:
- tag1
- tag2
campaign:
type: string
description: campaign name
nullable: true
example: event2025
responses:
'200':
description: Link creado exitosamente.
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Link created
slug:
type: string
example: abcdef
created_at:
type: integer
example: 1732289376
'401':
description: No hay una sesión activa
/links/{slug}:
parameters:
- name: slug
in: path
required: true
description: El identificador único del enlace.
schema:
type: string
get:
tags:
- Links
summary: Obtener links
description: Permite Obtener todos los enlaces creads por el usuario.
responses:
'200':
description: Link creado exitosamente.
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 2382
content:
oneOf:
- type: array
example:
- https://rustlang.org
- https://rustlang-es.org
- type: string
example: https://rustlang-es.org
created_at:
type: integer
example: 1732289376
modified_at:
type: integer
nullable: true
example: 1732289376
campaign:
type: string
nullable: true
example: event2025
tags:
type: array
nullable: true
items:
type: string
example:
- events
- "2025"
- upcoming
'401':
description: No hay una sesión activa.
'403':
description: El enlace no pertenece al usuario actual.
'404':
description: El enlace no existe.
post:
tags:
- Links
summary: Crear enlace con slug personalizado.
description: Permite crear enlaces con un slug personalizado.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
content:
oneOf:
- type: string
format: string
description: Un único enlace.
example: https://rustlang-es.org
- type: array
items:
type: string
format: string
description: Una lista de enlaces.
example:
- https://rustlang.org
- https://rustlang-es.org
tags:
type: array
items:
type: string
format: string
description: array of tag names
nullable: true
example:
- tag1
- tag2
campaign:
type: string
description: campaign name
nullable: true
example: event2025
responses:
'201':
description: Enlace creado
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Link created
slug:
type: string
example: abcdef
created_at:
type: integer
example: 1732289376
'401':
description: No hay una sesión activa.
'409':
description: Ya existe.
patch:
tags:
- Links
summary: Edita un enlace
description: Permite modificar un enlace
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
content:
oneOf:
- type: string
format: string
description: Un único enlace.
nullable: true
example: https://rustlang-es.org
- type: array
items:
type: string
format: string
description: Una lista de enlaces.
nullable: true
example:
- https://rustlang.org
- https://rustlang-es.org
tags:
type: array
items:
type: string
format: string
description: array of tag names
nullable: true
example:
- tag1
- tag2
campaign:
type: string
description: campaign name
nullable: true
example: event2025
responses:
'204':
description: Modificado.
'401':
description: No hay una sesión activa.
'403':
description: El enlace no pertenece al usuario actual.
'404':
description: El enlace no existe.