This repository was archived by the owner on Oct 14, 2022. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.json
457 lines (457 loc) · 14.1 KB
/
openapi.json
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
{
"openapi" : "3.0.0",
"info" : {
"title" : "Christmas Countdown",
"description" : "## Welcome\n\nThe Christmas Countdown API provides an easy way of getting the time left until Christmas, along with some other fun things like Christmas jokes.\n\n## Rate limits\n\nEndpoint rate limits for unidentified requests are defined per-category and act on the requester's IP address.\n\n|Category |Limit|Period |\n|-----------|-----|--------|\n|`countdown`|`10` |1 minute|\n|`other` |`100`|1 minute|\n\n**If you you need a higher limit, please [contact me](https://eartharoid.me/contact).**",
"termsOfService" : "https://docs.christmascountdown.live/api#terms-of-use",
"contact" : {
"name" : "Isaac",
"url" : "https://go.eartharoid.me/discord",
"email" : "[email protected]"
},
"license" : {
"name" : "MIT",
"url" : "https://choosealicense.com/licenses/mit"
},
"version" : "pine"
},
"servers" : [ {
"url" : "https://api.christmascountdown.live/pine",
"description" : "Production API server"
}, {
"url" : "http://localhost:{port}/pine",
"description" : "Local development API server",
"variables" : {
"port" : {
"default" : "8080"
}
}
} ],
"paths" : {
"/timeleft" : {
"get" : {
"tags" : [ "countdown" ],
"summary" : "Get the time left in sleeps/days etc, combined into one response",
"description" : "The same as `/timeleft/{period}` but all `period`s are combined.",
"parameters" : [ {
"name" : "timezone",
"in" : "query",
"description" : "The timezone",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"default" : "UTC"
}
} ],
"responses" : {
"200" : {
"description" : "The time left until Christmas",
"headers" : {
"X-Rate-Limit-Limit" : {
"description" : "The number of allowed requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Remaining" : {
"description" : "The number of remaining requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Reset" : {
"description" : "The number of seconds left in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/timeleft-combined"
},
"example" : {
"months" : 1,
"weeks" : 5,
"sleeps" : 37,
"days" : 36,
"hours" : 870,
"minutes" : 51840,
"seconds" : 3110400
}
}
}
}
}
}
},
"/timeleft/total" : {
"get" : {
"tags" : [ "countdown" ],
"summary" : "Get the combined total time left until Christmas",
"parameters" : [ {
"name" : "timezone",
"in" : "query",
"description" : "The timezone",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"default" : "UTC"
}
} ],
"responses" : {
"200" : {
"description" : "The total time left until Christmas",
"headers" : {
"X-Rate-Limit-Limit" : {
"description" : "The number of allowed requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Remaining" : {
"description" : "The number of remaining requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Reset" : {
"description" : "The number of seconds left in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/total-timeleft"
},
"example" : {
"days" : 36,
"hours" : 2,
"minutes" : 48,
"seconds" : 59
}
}
}
}
}
}
},
"/timeleft/{period}" : {
"get" : {
"tags" : [ "countdown" ],
"summary" : "Get the time left in sleeps/days etc",
"parameters" : [ {
"name" : "period",
"in" : "path",
"description" : "days/sleeps etc",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"enum" : [ "months", "weeks", "sleeps", "days", "hours", "minutes", "seconds" ]
}
}, {
"name" : "timezone",
"in" : "query",
"description" : "The timezone",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"default" : "UTC"
}
} ],
"responses" : {
"200" : {
"description" : "The time left until Christmas",
"headers" : {
"X-Rate-Limit-Limit" : {
"description" : "The number of allowed requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Remaining" : {
"description" : "The number of remaining requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Reset" : {
"description" : "The number of seconds left in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/timeleft-period"
},
"example" : {
"sleeps" : 37
}
}
}
}
}
}
},
"/weekday" : {
"get" : {
"tags" : [ "countdown" ],
"summary" : "Get the day of the week that Christmas Day is on",
"description" : "The day is a number between 0 and 6, starting with **0 as Sunday**.\n\nYou need to convert this number to a day name yourself, either:\n1. using a simple array\n ```js\n const days = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];\n console.log(days[6]); // => \"Saturday\"\n ```\n2. using built-in methods\n ```js\n const i18n = new Intl.DateTimeFormat('en-GB', { weekday: 'long' });\n console.log(i18n.format(6)); // => \"Saturday\"\n ```",
"parameters" : [ {
"name" : "timezone",
"in" : "query",
"description" : "The timezone",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"default" : "UTC"
}
} ],
"responses" : {
"200" : {
"description" : "The day number (0-6) **starting with Sunday**",
"headers" : {
"X-Rate-Limit-Limit" : {
"description" : "The number of allowed requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Remaining" : {
"description" : "The number of remaining requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Reset" : {
"description" : "The number of seconds left in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/weekday"
},
"example" : 6
}
}
}
}
}
},
"/joke" : {
"get" : {
"tags" : [ "other" ],
"summary" : "Get a Christmas joke",
"description" : "Returns a joke object (question and answer).",
"responses" : {
"200" : {
"description" : "A joke",
"headers" : {
"X-Rate-Limit-Limit" : {
"description" : "The number of allowed requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Remaining" : {
"description" : "The number of remaining requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Reset" : {
"description" : "The number of seconds left in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/joke"
},
"example" : {
"question" : "How much did Santa pay for his sleigh?",
"answer" : "Nothing – it was on the house."
}
}
}
}
}
}
},
"/jokes" : {
"get" : {
"tags" : [ "other" ],
"summary" : "Get all available Christmas jokes",
"description" : "Returns an array of joke objects.",
"responses" : {
"200" : {
"description" : "Jokes",
"headers" : {
"X-Rate-Limit-Limit" : {
"description" : "The number of allowed requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Remaining" : {
"description" : "The number of remaining requests in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
},
"X-Rate-Limit-Reset" : {
"description" : "The number of seconds left in the current period",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jokes"
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"timeleft-combined" : {
"type" : "object",
"properties" : {
"months" : {
"type" : "number"
},
"weeks" : {
"type" : "number"
},
"sleeps" : {
"type" : "number"
},
"days" : {
"type" : "number"
},
"hours" : {
"type" : "number"
},
"minutes" : {
"type" : "number"
},
"seconds" : {
"type" : "number"
}
}
},
"total-timeleft" : {
"type" : "object",
"properties" : {
"days" : {
"type" : "number"
},
"hours" : {
"type" : "number"
},
"minutes" : {
"type" : "number"
},
"seconds" : {
"type" : "number"
}
}
},
"timeleft-period" : {
"type" : "object",
"properties" : {
"{period=string}" : {
"type" : "number"
}
}
},
"weekday" : {
"type" : "number"
},
"joke" : {
"type" : "object",
"properties" : {
"question" : {
"type" : "string"
},
"answer" : {
"type" : "string"
}
}
},
"jokes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/joke"
}
}
}
}
}