-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathtodo-lists.yaml
More file actions
256 lines (256 loc) · 6.28 KB
/
todo-lists.yaml
File metadata and controls
256 lines (256 loc) · 6.28 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
openapi: "3.0.0"
info:
title: Todo Lists Example API
version: '0.0.1'
servers:
- url: '{schema}://{tenant}.todo-lists.example.com'
variables:
schema:
enum:
- http
- https
default: https
tenant:
default: your-slug
- url: 'https://todo-lists.example.com'
paths:
/list:
parameters:
- name: created
in: query
schema:
type: string
format: date-time
- name: statuses
in: query
schema:
$ref: '#/components/schemas/Statuses'
- name: tags
in: query
schema:
type: array
items:
type:
string
get:
operationId: getTodoLists
responses:
200:
description: 'success'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TodoList'
/list/{listId}:
parameters:
- $ref: '#/components/parameters/listId'
get:
operationId: getTodoListById
responses:
200:
description: 'success'
content:
application/json:
schema:
$ref: '#/components/schemas/TodoList'
4XX:
$ref: '../integration-tests-definitions-shared/error-handling.yaml#/components/responses/ClientError'
default:
$ref: '../integration-tests-definitions-shared/error-handling.yaml#/components/responses/ServerError'
put:
operationId: updateTodoListById
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateTodoList'
responses:
200:
description: 'updated'
content:
application/json:
schema:
$ref: '#/components/schemas/TodoList'
4XX:
$ref: '../integration-tests-definitions-shared/error-handling.yaml#/components/responses/ClientError'
default:
$ref: '../integration-tests-definitions-shared/error-handling.yaml#/components/responses/ServerError'
delete:
operationId: deleteTodoListById
responses:
204:
description: 'deleted'
4XX:
$ref: '../integration-tests-definitions-shared/error-handling.yaml#/components/responses/ClientError'
default:
$ref: '../integration-tests-definitions-shared/error-handling.yaml#/components/responses/ServerError'
/list/{listId}/items:
parameters:
- name: listId
in: path
required: true
schema:
type: string
format: uuid
get:
operationId: getTodoListItems
responses:
200:
description: success
content:
application/json:
schema:
type: object
required:
- id
- content
- createdAt
properties:
id:
type: string
format: uuid
content:
type: string
createdAt:
type: string
format: date-time
completedAt:
type: string
format: date-time
5XX:
description: server error
content:
application/json:
schema:
type: object
required:
- message
- code
properties:
message:
type: string
code:
type: string
post:
operationId: createTodoListItem
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
- content
properties:
id:
type: string
format: uuid
content:
type: string
completedAt:
type: string
format: date-time
responses:
204:
description: success
/attachments:
servers:
- url: '{schema}://{tenant}.attachments.example.com'
variables:
schema:
enum:
- http
- https
default: https
tenant:
default: your-slug
- url: 'https://attachments.example.com'
get:
operationId: listAttachments
responses:
200:
description: success
content:
application/json:
schema:
type: array
post:
operationId: uploadAttachment
requestBody:
content:
multipart/form-data:
schema:
additionalProperties: false
properties:
file: {}
responses:
202:
description: accepted
/attachments/{id}:
parameters:
- name: id
in: path
schema:
type: string
put:
operationId: replaceAttachment
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
202:
description: accepted
components:
schemas:
CreateUpdateTodoList:
required:
- name
properties:
name:
type: string
TodoList:
required:
- id
- name
- totalItemCount
- incompleteItemCount
- created
- updated
properties:
id:
type: string
format: uuid
name:
type: string
totalItemCount:
type: number
incompleteItemCount:
type: number
created:
type: string
format: date-time
updated:
type: string
format: date-time
Statuses:
type: array
items:
type: string
enum:
- incomplete
- complete
parameters:
listId:
name: listId
in: path
required: true
schema:
type: string
format: uuid