-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
252 lines (249 loc) · 8.91 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
openapi: 3.0.0
info:
title: Task Management API
version: 1.0.0
paths:
/token:
post:
summary: Get an access token
tags:
- Authentication
parameters:
- in: header
name: Authorization
schema:
type: string
required: true
description: Basic Auth header with client_id and client_secret
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- grant_type
properties:
grant_type:
type: string
enum: [client_credentials]
description: Tells the token endpoint to perform the Client Credentials flow
scope:
type: string
description: Space separated string of scopes the client is requesting access to
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
required:
- access_token
- expires_in
- token_type
properties:
access_token:
type: string
description: A newly issued access token for the flow
expires_in:
type: integer
description: The time to live of the access token in seconds
scope:
type: string
description: Space separated string of issued scopes. If not present, the requested scopes were issued. If present, the issued scopes may differ from the requested scopes.
token_type:
$ref: "#/components/schemas/TokenType"
description: Describes how the token can be used. Most commonly bearer token usage.
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/tasks:
post:
summary: Create a new task
tags:
- Tasks
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrUpdateTaskRequest"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
get:
summary: List all tasks
tags:
- Tasks
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Task"
/tasks/{taskId}:
get:
summary: Get a task by ID
tags:
- Tasks
parameters:
- $ref: "#/components/parameters/taskId"
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
put:
summary: Update a task
tags:
- Tasks
parameters:
- $ref: "#/components/parameters/taskId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrUpdateTaskRequest"
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
summary: Delete a task
tags:
- Tasks
parameters:
- $ref: "#/components/parameters/taskId"
responses:
"204":
description: Successful response
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
parameters:
taskId:
in: path
name: taskId
required: true
schema:
type: string
format: uuid
schemas:
Error:
type: object
required:
- message
properties:
message:
type: string
Task:
type: object
required:
- id
- title
- description
- status
- createdAt
- updatedAt
properties:
id:
type: string
format: uuid
x-go-name: ID
title:
type: string
description:
type: string
status:
$ref: "#/components/schemas/TaskStatus"
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
TaskStatus:
type: string
enum: [pending, completed]
TokenType:
type: string
enum: [Bearer]
CreateOrUpdateTaskRequest:
type: object
required:
- title
- description
- status
properties:
title:
type: string
minLength: 1
description:
type: string
minLength: 1
status:
$ref: "#/components/schemas/TaskStatus"
default: pending