-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
353 lines (337 loc) · 9.22 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
openapi: 3.0.3
info:
title: projectU REST API
description: A REST API for the application projectU
version: 1.0.0
servers:
- url: http://localhost:8080
description: Development Server
paths:
/projects:
get:
tags:
- project
summary: Get all projects
description: Returns a list containing every project.
operationId: getAllProjects
responses:
'200':
description: A list containing every project is returned successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Project'
post:
tags:
- project
summary: Create new project
description: >
Creates a new project.
A unique ID for the project is automatically generated.
operationId: createProject
requestBody:
description: Project containing at least the required attributes
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
responses:
'201':
description: A new project was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
/projects/{id}:
get:
tags:
- project
summary: Get project by ID
description: Returns a project with a specific ID.
operationId: getProjectById
parameters:
- name: id
in: path
description: ID of project to return
required: true
schema:
type: string
format: uuid
responses:
'200':
description: A project with the specified ID is returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'404':
description: A project with the specified ID was not found.
put:
tags:
- project
summary: Update project
description: >
Updates a project with a specific ID.
If no project with the specified ID was found,
a new project with the specified ID will be created.
operationId: updateProject
parameters:
- name: id
in: path
description: ID of project to be updated
required: true
schema:
type: string
format: uuid
requestBody:
description: Project containing data
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
responses:
'200':
description: A project with the specified ID was updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'201':
description: A project with the specified ID was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
delete:
tags:
- project
summary: Delete project by ID
description: Deletes a project with a specific ID.
operationId: deleteProject
parameters:
- name: id
in: path
description: Project ID to delete
required: true
schema:
type: string
format: uuid
responses:
'204':
description: A project with the specified ID was deleted successfully.
'404':
description: A project with the specified ID was not found.
/projects/{id}/tasks:
post:
tags:
- project
summary: Create new task
description: >
Creates a new task.
A unique ID for the task is automatically generated.
operationId: createTask
parameters:
- name: id
in: path
description: ID of the project of the task
required: true
schema:
type: string
format: uuid
requestBody:
description: Task containing at least the required attributes
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
responses:
'201':
description: A new task was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'404':
description: A project with the specified ID was not found.
/tasks/{id}:
get:
tags:
- task
summary: Get task by ID
description: Returns a task with a specific ID.
operationId: getTaskById
parameters:
- name: id
in: path
description: ID of task to return
required: true
schema:
type: string
format: uuid
responses:
'200':
description: A task with the specified ID is returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'404':
description: A task with the specified ID was not found.
put:
tags:
- task
summary: Update task
description: Updates a task with a specific ID.
operationId: updateTask
parameters:
- name: id
in: path
description: ID of task to be updated
required: true
schema:
type: string
format: uuid
requestBody:
description: Task containing data
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
responses:
'200':
description: A task with the specified ID was updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'404':
description: A task with the specified ID was not found.
delete:
tags:
- task
summary: Delete task by ID
description: Deletes a task with a specific ID.
operationId: deleteTask
parameters:
- name: id
in: path
description: Task ID to delete
required: true
schema:
type: string
format: uuid
responses:
'200':
description: The task of the project was deleted successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'404':
description: A task with the specified ID was not found.
components:
schemas:
Project:
type: object
required:
- title
- state
- complexity
properties:
id:
type: string
format: uuid
title:
type: string
description:
type: string
tasks:
type: array
items:
$ref: '#/components/schemas/Task'
state:
$ref: '#/components/schemas/State'
complexity:
$ref: '#/components/schemas/Complexity'
estimatedDurationInHours:
type: integer
expectedResult:
type: string
actualResult:
type: string
createdAt:
type: integer
format: int64
startedAt:
type: string
finishedAt:
type: string
example:
id: 2ebeba4e-67a0-44f9-baed-2ebf6c903648
title: Learn to design an API
description: A project for learning and applying REST API practises
tasks:
- id: 1adfb959-5152-4cd7-abae-00ea07fa6056
title: Learn OpenApi
description: A task for learning the OpenApi specification
done: false
estimatedDurationInHours: 12
result: More knowledge about OpenApi
state: IN_PROGRESS
complexity: EASY
estimatedDurationInHours: 23
expectedResult: Learning something.
actualResult: Learned a lot!
createdAt: 1649693507720
startedAt: 1649693507720
finishedAt: 1649693507720
Task:
type: object
required:
- title
- done
properties:
id:
type: string
format: uuid
title:
type: string
description:
type: string
done:
type: boolean
estimatedDurationInHours:
type: integer
result:
type: string
example:
id: 1adfb959-5152-4cd7-abae-00ea07fa6056
title: Learn OpenApi
description: A task for learning the OpenApi specification
done: false
estimatedDurationInHours: 12
result: More knowledge about OpenApi
State:
type: string
enum:
- INITIATED
- IN_PROGRESS
- HALTED
- FINISHED
Complexity:
type: string
enum:
- EASY
- MEDIUM
- DIFFICULT
tags:
- name: project
description: An operation including projects
- name: task
description: An operation including tasks