-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
304 lines (295 loc) · 8.29 KB
/
swagger.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
openapi: "3.0.3"
info:
description: "This is a small API to retrieve a daily message. e.g. for an iOS shortcut or widget"
version: "1.0.1"
title: "Daily Message"
contact:
name: "Thorsten Rösler"
email: "[email protected]"
servers:
- url: "https://caa28cc3-9e18-43d5-a5b8-930c98ca35bc.id.repl.co"
description: "The replit.com URL"
paths:
/daily-message:
get:
description: "Receive a daily message"
tags:
- "daily-message"
summary: "Returns the daily message"
operationId: "getDailyMessage"
responses:
"200":
description: "You receive your daily message"
content:
application/json:
schema:
$ref: '#/components/schemas/GetResponseScheme'
"401":
$ref: '#/components/responses/401'
"403":
$ref: '#/components/responses/403'
"404":
$ref: '#/components/responses/404'
"429":
$ref: '#/components/responses/429'
"500":
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/404'
security:
- userToken: []
/manage/{key}:
get:
tags:
- "manage"
summary: "Get a message by its key"
description: "Returns the message that belongs to the provided key"
operationId: "getMessageById"
parameters:
- in: "path"
name: "key"
description: "Key of the message to return"
required: true
schema:
type: "string"
pattern: "^[a-zA-Z\_]+$"
maxLength: 32
responses:
"200":
description: "You receive the message for the requested key"
content:
application/json:
schema:
$ref: '#/components/schemas/GetResponseScheme'
"401":
$ref: '#/components/responses/401'
"403":
$ref: '#/components/responses/403'
"404":
$ref: '#/components/responses/404'
"422":
$ref: '#/components/responses/422'
"429":
$ref: '#/components/responses/429'
"500":
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/404'
security:
- userToken: []
post:
tags:
- "manage"
summary: "Add a new Message"
description: "Adds a message to the database. If it starts with the defined prefix (default: daily_) it will be used for daily-message"
operationId: "addMessage"
parameters:
- in: "path"
name: "key"
description: "Key of the message to add"
required: true
schema:
type: "string"
pattern: "^[a-zA-Z\_]+$"
maxLength: 32
requestBody:
description: "The Message to set"
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ValueScheme'
responses:
"200":
description: "You receive the message for the requested key"
content:
application/json:
schema:
$ref: '#/components/schemas/EditResponseScheme'
"401":
$ref: '#/components/responses/401'
"403":
$ref: '#/components/responses/403'
"404":
$ref: '#/components/responses/404'
"422":
$ref: '#/components/responses/422'
"429":
$ref: '#/components/responses/429'
"500":
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/404'
security:
- adminToken: []
delete:
tags:
- "manage"
summary: "Deletes a message"
description: "Deletes the message that belongs to the provided key if present"
operationId: "deleteMessage"
parameters:
- in: "path"
name: "key"
description: "Key of the message to return"
required: true
schema:
type: "string"
pattern: "^[a-zA-Z\_]+$"
maxLength: 32
responses:
"200":
description: "You receive the message for the requested key"
content:
application/json:
schema:
$ref: '#/components/schemas/EditResponseScheme'
"401":
$ref: '#/components/responses/401'
"403":
$ref: '#/components/responses/403'
"404":
$ref: '#/components/responses/404'
"422":
$ref: '#/components/responses/422'
"429":
$ref: '#/components/responses/429'
"500":
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/404'
security:
- adminToken: []
components:
securitySchemes:
adminToken:
type: "apiKey"
name: "authorization"
description: "The ADMIN_TOKEN for all admin actions"
in: "header"
userToken:
type: "apiKey"
name: "authorization"
description: "The USER_TOKEN for all user actions"
in: "header"
schemas:
EditResponseScheme:
type: object
required:
- message
properties:
message:
type: string
description: "A success message"
example: "Your key was successfully added or deleted"
maxLength: 64
pattern: "^[a-zA-Z \_.]+$"
GetResponseScheme:
type: object
required:
- message
properties:
message:
type: string
description: "The message Text"
example: "My inspirational quote to brighten your day"
maxLength: 1024
pattern: "^[a-zA-Z0-9 !.?()']+$"
ValueScheme:
type: object
required:
- value
properties:
value:
type: string
description: "The message Text"
example: "My inspirational quote to brighten your day"
maxLength: 1024
pattern: "^[a-zA-Z0-9 !.?()']+$"
Error:
type: object
required:
- status
- message
properties:
code:
type: integer
description: "The status code of the error"
example: 401
minimum: 200
maximum: 599
format: int32
message:
type: string
description: 'The cause of the Error.'
ValidationError:
type: object
required:
- value
- msg
- param
- location
properties:
value:
type: string
description: "The invalid Value"
maxLength: 32
msg:
type: string
format: string
description: 'The Error message.'
maxLength: 2048
param:
type: string
description: "The invalid parameter"
example: "key"
maxLength: 64
location:
type: "string"
description: "Where the invalid Parameter is located"
maxLength: 16
responses:
"401":
description: "Invalid Authorization Token"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: "Forbidden: The rewuest requires Admin access"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: "Not Found"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
"422":
description: "Unprocessable Entity: The Key was not in the right format"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ValidationError'
"429":
description: "To Many Requests"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: "Authorization isn't configured properly"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
tags:
- name: "daily-message"
description: "Endpoints for the normal user."
- name: "manage"
description: "All management Endpoints for the asmin users"
externalDocs:
description: "README.md on GitHub project"
url: "https://github.com/Thorsten1/daily_message#readme"