-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
479 lines (477 loc) · 11.9 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
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
openapi: 3.0.3
security: []
info:
title: Projects and tasks application
contact:
email: [email protected]
version: 1.0.0
servers:
- url: http://localhost:3000
tags:
- name: project
- name: task
- name: tag
paths:
/projects:
get:
tags:
- project
summary: Get a list of all projects
operationId: getProjects
responses:
"200":
description: List of projects
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/project"
post:
tags:
- project
summary: Create a new project
operationId: createProject
requestBody:
description: New project
content:
application/json:
schema:
$ref: "#/components/schemas/project"
responses:
"201":
description: Project created
headers:
Location:
schema:
type: string
description: URI of the created project
"400":
description: Invalid request format
/projects/{projId}:
get:
tags:
- project
summary: Find project by ID
operationId: getProjectById
parameters:
- $ref: "#/components/parameters/projectId"
responses:
"200":
description: Project details
content:
application/json:
schema:
$ref: "#/components/schemas/project"
"400":
description: Invalid ID
"404":
description: Project not found
put:
tags:
- project
summary: Update an existing project
operationId: updateProject
parameters:
- $ref: "#/components/parameters/projectId"
requestBody:
description: Project with updated data
content:
application/json:
schema:
$ref: "#/components/schemas/project"
responses:
"204":
description: Project updated
"400":
description: Invalid ID
"404":
description: Project not found
delete:
tags:
- project
summary: Delete an existing project
description: This operation will also delete all assigned tasks
operationId: deleteProject
parameters:
- $ref: "#/components/parameters/projectId"
responses:
"204":
description: Project deleted
"400":
description: Invalid ID
"404":
description: Project not found
/projects/{projId}/tasks:
get:
tags:
- task
summary: Get a list of all tasks from one project
operationId: getProjectTasks
parameters:
- $ref: "#/components/parameters/projectId"
- $ref: "#/components/parameters/limit"
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/tag"
- $ref: "#/components/parameters/taskDescription"
- $ref: "#/components/parameters/taskState"
responses:
"303":
description: Found elsewhere
post:
tags:
- task
summary: Create a new task for project
operationId: createProjectTask
parameters:
- $ref: "#/components/parameters/projectId"
requestBody:
description: New task
content:
application/json:
schema:
$ref: "#/components/schemas/task"
responses:
"201":
description: Task created
headers:
Location:
schema:
type: string
description: URI of the created task
"400":
description: Invalid request format
/projects/{projId}/tasks/{taskId}:
get:
tags:
- task
summary: Find task from project by ID
operationId: getProjectTaskById
parameters:
- $ref: "#/components/parameters/projectId"
- $ref: "#/components/parameters/taskId"
responses:
"200":
description: Task details
content:
application/json:
schema:
$ref: "#/components/schemas/task"
"400":
description: Invalid ID
"404":
description: Task not found
put:
tags:
- task
summary: Update an existing task from project
operationId: updateProjectTask
parameters:
- $ref: "#/components/parameters/projectId"
- $ref: "#/components/parameters/taskId"
requestBody:
description: Task with updated data
content:
application/json:
schema:
$ref: "#/components/schemas/task"
responses:
"204":
description: Task updated
"400":
description: Invalid ID
"404":
description: Task not found
delete:
tags:
- task
summary: Delete an existing task
operationId: deleteProjectTask
parameters:
- $ref: "#/components/parameters/projectId"
- $ref: "#/components/parameters/taskId"
responses:
"204":
description: Task deleted
"400":
description: Invalid ID
"404":
description: Task not found
#------------------------------------------
/tasks:
get:
tags:
- task
summary: Get a list of all tasks
operationId: getAllTasks
parameters:
- $ref: "#/components/parameters/limit"
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/tag"
- $ref: "#/components/parameters/taskDescription"
- $ref: "#/components/parameters/taskState"
- $ref: "#/components/parameters/project"
responses:
"200":
description: List of tasks
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/task"
/tasks/{taskId}/tags:
put:
tags:
- tag
summary: Add an existing tag to a task
operationId: addTaskTag
parameters:
- $ref: "#/components/parameters/taskId"
requestBody:
description: Tag to be added
content:
application/json:
schema:
$ref: "#/components/schemas/tag"
responses:
"204":
description: Tag added
"400":
description: Invalid ID
"404":
description: Not found
delete:
tags:
- tag
summary: Remove a tag from a task
operationId: deleteTaskTag
parameters:
- $ref: "#/components/parameters/taskId"
- name: tag
in: query
required: true
description: Name of the tag we want to remove from task
schema:
type: string
responses:
"204":
description: Tag added
"400":
description: Invalid ID
"404":
description: Not found
# -------------------------------------------------
/tags:
get:
tags:
- tag
summary: Get a list of all tags
operationId: getTags
responses:
"200":
description: List of tags
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/tag"
post:
tags:
- tag
summary: Create a new tag
operationId: createTag
requestBody:
description: New tag
content:
application/json:
schema:
$ref: "#/components/schemas/tag"
responses:
"201":
description: Tag created
headers:
Location:
schema:
type: string
description: URI of the created tag
"400":
description: Invalid request format
/tags/{tagId}:
get:
tags:
- tag
summary: Find tag by ID
operationId: getTagById
parameters:
- $ref: "#/components/parameters/tagId"
responses:
"200":
description: Tag details
content:
application/json:
schema:
$ref: "#/components/schemas/tag"
"400":
description: Invalid ID
"404":
description: Tag not found
put:
tags:
- tag
summary: Update an existing tag
operationId: updateTag
parameters:
- $ref: "#/components/parameters/tagId"
requestBody:
description: Tag with updated data
content:
application/json:
schema:
$ref: "#/components/schemas/tag"
responses:
"204":
description: Tag updated
"400":
description: Invalid ID
"404":
description: Tag not found
delete:
tags:
- tag
summary: Delete an existing tag
description: This operation will also delete all references from tasks
operationId: deleteTag
parameters:
- $ref: "#/components/parameters/tagId"
responses:
"204":
description: Tag deleted
"400":
description: Invalid ID
"404":
description: Tag not found
components:
parameters:
projectId:
name: projId
in: path
required: true
description: ID of the requested project
schema:
type: integer
taskId:
name: taskId
in: path
required: true
description: ID of the requested task
schema:
type: integer
tagId:
name: tagId
in: path
required: true
description: ID of the requested tag
schema:
type: integer
project:
name: proj
in: query
description: ID of project we are searching
schema:
type: integer
limit:
name: limit
in: query
description: Number of results we want to obtain
schema:
type: integer
page:
name: page
in: query
description: Used in conjunction with limit parameter. If you use it and don't specify a limit, paging is ignored. Use it for pagination based on the limit parameter
schema:
type: integer
tag:
name: tag
in: query
description: Filters tasks containing specified tag. Name of the tag is used
schema:
type: string
taskDescription:
name: desc
in: query
description: Filters tasks containing specified description
schema:
type: string
taskState:
name: state
in: query
description: State of the task
schema:
type: string
enum:
- new
- in progress
- done
schemas:
project:
type: object
required:
- name
- description
- dateStart
- dateEnd
additionalProperties: false
properties:
projId:
type: integer
readOnly: true
name:
type: string
description:
type: string
dateStart:
type: string
format: date
dateEnd:
type: string
format: date
task:
type: object
required:
- description
- state
additionalProperties: false
properties:
taskId:
type: integer
readOnly: true
description:
type: string
state:
type: string
enum:
- new
- in progress
- done
projId:
type: integer
readOnly: true
tags:
type: array
readOnly: true
items:
$ref: "#/components/schemas/tag"
tag:
type: object
required:
- name
additionalProperties: false
properties:
tagId:
type: integer
readOnly: true
name:
type: string