-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
205 lines (202 loc) · 4.72 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
openapi: 3.0.3
info:
title: "TODO List Example API"
version: 1.0.0
servers:
- url: http:localhost:8080
paths:
/tasks:
get:
operationId: getTasksPage
summary: Get all tasks
parameters:
- in: query
name: page
schema:
type: integer
default: 0
minimum: 0
- in: query
name: pageSize
schema:
type: integer
default: 10
maximum: 20
minimum: 1
responses:
200:
description: Tasks Page
content:
application/json:
schema:
$ref: "#/components/schemas/TasksPage"
401:
$ref: "#/components/responses/401"
post:
operationId: createNewTask
summary: Create new task
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
responses:
200:
description: successful response
content:
application/json:
schema:
$ref: "#/components/schemas/Identifiable"
401:
$ref: "#/components/responses/401"
/tasks/{id}:
get:
operationId: getTaskByID
summary: Get task by ID
parameters:
- in: path
name: id
required: true
schema:
$ref: "#/components/schemas/Id"
responses:
200:
description: The requested task
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
400:
$ref: "#/components/responses/400"
401:
$ref: "#/components/responses/401"
404:
$ref: "#/components/responses/404"
delete:
operationId: deleteTaskByID
summary: Delete task by ID
parameters:
- in: path
required: true
name: id
schema:
$ref: "#/components/schemas/Id"
responses:
204:
description: Deleted successfully
400:
$ref: "#/components/responses/400"
401:
$ref: "#/components/responses/401"
410:
$ref: "#/components/responses/410"
put:
operationId: updateTaskByID
summary: Update task by ID
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
parameters:
- in: path
required: true
name: id
schema:
$ref: "#/components/schemas/Id"
responses:
204:
description: Updated successfully
400:
$ref: "#/components/responses/400"
401:
$ref: "#/components/responses/401"
404:
$ref: "#/components/responses/404"
components:
schemas:
Id:
type: string
format: uuid
minLength: 36
maxLength: 36
nullable: false
Identifiable:
type: object
additionalProperties: true
properties:
id:
$ref: "#/components/schemas/Id"
Task:
type: object
additionalProperties: true
required:
- summary
- description
properties:
summary:
type: string
description:
type: string
status:
type: string
default: open
enum:
- open
- in progress
- closed
Page:
type: object
additionalProperties: true
properties:
page:
type: integer
pageSize:
type: integer
isLast:
type: boolean
TasksPage:
type: object
allOf:
- type: object
additionalProperties: true
properties:
results:
type: array
items:
allOf:
- $ref: "#/components/schemas/Identifiable"
- $ref: "#/components/schemas/Task"
- $ref: '#/components/schemas/Page'
HttpError:
type: object
properties:
error:
type: string
reason:
type: string
responses:
400:
description: bad request
content:
application/json:
schema:
$ref: "#/components/schemas/HttpError"
401:
description: unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HttpError"
404:
description: not found
content:
application/json:
schema:
$ref: "#/components/schemas/HttpError"
410:
description: gone
content:
application/json:
schema:
$ref: "#/components/schemas/HttpError"