-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
358 lines (341 loc) · 8.1 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
openapi: 3.0.0
info:
title: Task Manager API
version: 1.0.0
description: API documentation for the Task Manager application
servers:
- url: http://localhost:8008/api
description: Local development server
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
schemas:
User:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
email_verified_at:
type: string
format: date-time
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
Task:
type: object
properties:
id:
type: integer
user_id:
type: integer
parent_id:
type: integer
status:
type: string
enum: [todo, done]
priority:
type: string
enum: [low, midlow, mid, midhigh, high]
title:
type: string
description:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
completed_at:
type: string
format: date-time
paths:
/register:
post:
summary: Register a new user
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
responses:
201:
description: User registered successfully
content:
application/json:
schema:
$ref: '#/components/schemas/User'
400:
description: Bad request
/login:
post:
summary: Login a user
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
password:
type: string
responses:
200:
description: User logged in successfully
content:
application/json:
schema:
type: object
properties:
token:
type: string
401:
description: Unauthorized
/logout:
post:
summary: Logout the authenticated user
security:
- bearerAuth: []
responses:
200:
description: User logged out successfully
401:
description: Unauthorized
/auth-user:
get:
summary: Get authenticated user details
security:
- bearerAuth: []
responses:
200:
description: Authenticated user details
content:
application/json:
schema:
$ref: '#/components/schemas/User'
401:
description: Unauthorized
/tasks:
get:
summary: Get a list of tasks for the authenticated user
security:
- bearerAuth: []
responses:
200:
description: List of tasks
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
401:
description: Unauthorized
post:
summary: Create a new task
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
responses:
201:
description: Task created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
400:
description: Bad request
401:
description: Unauthorized
/tasks/filtered:
get:
summary: Get a filtered list of tasks
security:
- bearerAuth: []
parameters:
- in: query
name: status
schema:
type: string
enum: [pending, completed]
description: Filter tasks by status
- in: query
name: priority
schema:
type: string
enum: [low, midlow, mid, midhigh, high]
description: Filter tasks by priority
responses:
200:
description: Filtered list of tasks
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
401:
description: Unauthorized
/tasks/sorted:
get:
summary: Get a sorted list of tasks
security:
- bearerAuth: []
parameters:
- in: query
name: priority
schema:
type: string
enum: [asc, desc]
description: Sort tasks by priority
responses:
200:
description: Sorted list of tasks
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
401:
description: Unauthorized
/tasks/{task}:
get:
summary: Get task details
security:
- bearerAuth: []
parameters:
- in: path
name: task
required: true
schema:
type: integer
responses:
200:
description: Task details
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
401:
description: Unauthorized
403:
description: Forbidden
patch:
summary: Update a task
security:
- bearerAuth: []
parameters:
- in: path
name: task
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
responses:
200:
description: Task updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
400:
description: Bad request
401:
description: Unauthorized
403:
description: Forbidden
delete:
summary: Delete a task
security:
- bearerAuth: []
parameters:
- in: path
name: task
required: true
schema:
type: integer
responses:
200:
description: Task deleted successfully
401:
description: Unauthorized
403:
description: Forbidden
/tasks/done/{task}:
patch:
summary: Mark a task as done
security:
- bearerAuth: []
parameters:
- in: path
name: task
required: true
schema:
type: integer
responses:
200:
description: Task marked as done successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
400:
description: Bad request
401:
description: Unauthorized
403:
description: Forbidden
/tasks/tree/{task}:
get:
summary: Get task tree for a specific task
security:
- bearerAuth: []
parameters:
- in: path
name: task
required: true
schema:
type: integer
responses:
200:
description: Task tree details
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
401:
description: Unauthorized
403:
description: Forbidden