-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
446 lines (423 loc) · 10.9 KB
/
openapi.yaml
File metadata and controls
446 lines (423 loc) · 10.9 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
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
openapi: 3.0.3
info:
title: Task Management API
description: RESTful API for task management system implemented in 33 languages
version: 1.0.0
contact:
name: David Christian Liedle
email: david.liedle@gmail.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: http://localhost:8080/api/v1
description: Local development server
- url: https://api.example.com/v1
description: Production server
paths:
/tasks:
get:
summary: List all tasks
operationId: listTasks
tags:
- Tasks
parameters:
- name: page_size
in: query
description: Maximum number of tasks to return
schema:
type: integer
default: 20
maximum: 100
- name: page_token
in: query
description: Page token for pagination
schema:
type: string
- name: status
in: query
description: Filter by task status
schema:
$ref: '#/components/schemas/TaskStatus'
- name: assigned_to
in: query
description: Filter by assigned user
schema:
type: string
- name: tags
in: query
description: Filter by tags (comma-separated)
schema:
type: string
- name: sort_order
in: query
description: Sort order for results
schema:
$ref: '#/components/schemas/SortOrder'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/Task'
next_page_token:
type: string
total_count:
type: integer
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
post:
summary: Create a new task
operationId: createTask
tags:
- Tasks
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskRequest'
responses:
'201':
description: Task created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
headers:
Location:
description: URL of the created task
schema:
type: string
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'500':
$ref: '#/components/responses/InternalServerError'
/tasks/{taskId}:
get:
summary: Get a task by ID
operationId: getTask
tags:
- Tasks
parameters:
- name: taskId
in: path
required: true
description: Task ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
put:
summary: Update a task
operationId: updateTask
tags:
- Tasks
parameters:
- name: taskId
in: path
required: true
description: Task ID
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskRequest'
responses:
'200':
description: Task updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: Delete a task
operationId: deleteTask
tags:
- Tasks
parameters:
- name: taskId
in: path
required: true
description: Task ID
schema:
type: string
responses:
'204':
description: Task deleted successfully
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/tasks/{taskId}/status:
patch:
summary: Update task status
operationId: updateTaskStatus
tags:
- Tasks
parameters:
- name: taskId
in: path
required: true
description: Task ID
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
$ref: '#/components/schemas/TaskStatus'
responses:
'200':
description: Status updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'500':
$ref: '#/components/responses/InternalServerError'
components:
schemas:
Task:
type: object
required:
- id
- title
- status
- priority
- created_at
- updated_at
properties:
id:
type: string
format: uuid
description: Unique identifier for the task
title:
type: string
minLength: 1
maxLength: 200
description: Title of the task
description:
type: string
maxLength: 2000
description: Detailed description of the task
status:
$ref: '#/components/schemas/TaskStatus'
priority:
$ref: '#/components/schemas/TaskPriority'
tags:
type: array
items:
type: string
description: Tags associated with the task
created_by:
type: string
description: User who created the task
assigned_to:
type: string
description: User currently assigned to the task
created_at:
type: string
format: date-time
description: When the task was created
updated_at:
type: string
format: date-time
description: When the task was last updated
due_date:
type: string
format: date-time
description: When the task is due
completed_at:
type: string
format: date-time
description: When the task was completed
TaskStatus:
type: string
enum:
- pending
- in_progress
- completed
- cancelled
- on_hold
description: Current status of the task
TaskPriority:
type: string
enum:
- low
- medium
- high
- critical
description: Priority level of the task
SortOrder:
type: string
enum:
- created_at_asc
- created_at_desc
- due_date_asc
- due_date_desc
- priority_asc
- priority_desc
description: Sort order for task listing
CreateTaskRequest:
type: object
required:
- title
- priority
properties:
title:
type: string
minLength: 1
maxLength: 200
description:
type: string
maxLength: 2000
priority:
$ref: '#/components/schemas/TaskPriority'
tags:
type: array
items:
type: string
assigned_to:
type: string
due_date:
type: string
format: date-time
UpdateTaskRequest:
type: object
properties:
title:
type: string
minLength: 1
maxLength: 200
description:
type: string
maxLength: 2000
status:
$ref: '#/components/schemas/TaskStatus'
priority:
$ref: '#/components/schemas/TaskPriority'
tags:
type: array
items:
type: string
assigned_to:
type: string
due_date:
type: string
format: date-time
Error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Error code
message:
type: string
description: Error message
details:
type: object
description: Additional error details
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
UnprocessableEntity:
description: Unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalServerError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: Tasks
description: Task management operations