|
|
@@ -3,10 +3,10 @@
|
|
|
<br><br><br>
|
|
|
|
|
|
## [Planned for future releases]
|
|
|
-- Allow definition of max requests per minute per each client ([issue #37](https://github.com/Sv443/JokeAPI/issues/37))
|
|
|
-- Add positive flags and a "?whitelistFlags" param ([issue #127](https://github.com/Sv443/JokeAPI/issues/127))
|
|
|
-- Add Unit Tests ([issue #121](https://github.com/Sv443/JokeAPI/issues/121))
|
|
|
-- Serve docs with nginx to speed up page load times ([issue #118](https://github.com/Sv443/JokeAPI/issues/118))
|
|
|
+- Allow definition of max requests per minute per each client ([issue #37](https://github.com/Sv443-Network/JokeAPI/issues/37))
|
|
|
+- Add positive flags and a "?whitelistFlags" param ([issue #127](https://github.com/Sv443-Network/JokeAPI/issues/127))
|
|
|
+- Add Unit Tests ([issue #121](https://github.com/Sv443-Network/JokeAPI/issues/121))
|
|
|
+- Serve docs with nginx to speed up page load times ([issue #118](https://github.com/Sv443-Network/JokeAPI/issues/118))
|
|
|
|
|
|
|
|
|
<br><br><br>
|
|
|
@@ -19,22 +19,22 @@
|
|
|
|
|
|
## [2.3.2] - Joke update
|
|
|
- Added new jokes
|
|
|
-- Rewrote the submission script to make it much more streamlined ([issue #340](https://github.com/Sv443/JokeAPI/issues/340))
|
|
|
+- Rewrote the submission script to make it much more streamlined ([issue #340](https://github.com/Sv443-Network/JokeAPI/issues/340))
|
|
|
- Rewrote the add-joke script so it's easier for me to use
|
|
|
- Added a new info script to make working with JokeAPI easier for me
|
|
|
-- Added a global CLI interface ([issue #344](https://github.com/Sv443/JokeAPI/issues/344))
|
|
|
-- API now adjusts environment-dependent settings automatically ([issue #343](https://github.com/Sv443/JokeAPI/issues/343))
|
|
|
+- Added a global CLI interface ([issue #344](https://github.com/Sv443-Network/JokeAPI/issues/344))
|
|
|
+- API now adjusts environment-dependent settings automatically ([issue #343](https://github.com/Sv443-Network/JokeAPI/issues/343))
|
|
|
|
|
|
|
|
|
<br><br><br>
|
|
|
|
|
|
-## [2.3.1] - The Safe Mode Hotfix, because bugs exist for some reason ([pull request #214](https://github.com/Sv443/JokeAPI/pull/214))
|
|
|
-- Fixed bug "API Error 500 - Cannot read property 'msBeforeNext' of null" ([issue #212](https://github.com/Sv443/JokeAPI/issues/212))
|
|
|
-- Fixed bug where API responded with Error 106 when using format=txt on endpoint /joke ([issue #218](https://github.com/Sv443/JokeAPI/issues/218))
|
|
|
-- Re-flagged joke 79 ([issue #220](https://github.com/Sv443/JokeAPI/issues/220))
|
|
|
-- API now automatically adds modification date <meta> tag to the docs ([issue #223](https://github.com/Sv443/JokeAPI/issues/223))
|
|
|
-- /info endpoint now gives the number of safe jokes per language ([issue #224](https://github.com/Sv443/JokeAPI/issues/224))
|
|
|
-- Added dependent jonathanbossenger/devdadjokes ([issue #225](https://github.com/Sv443/JokeAPI/issues/225))
|
|
|
+## [2.3.1] - The Safe Mode Hotfix, because bugs exist for some reason ([pull request #214](https://github.com/Sv443-Network/JokeAPI/pull/214))
|
|
|
+- Fixed bug "API Error 500 - Cannot read property 'msBeforeNext' of null" ([issue #212](https://github.com/Sv443-Network/JokeAPI/issues/212))
|
|
|
+- Fixed bug where API responded with Error 106 when using format=txt on endpoint /joke ([issue #218](https://github.com/Sv443-Network/JokeAPI/issues/218))
|
|
|
+- Re-flagged joke 79 ([issue #220](https://github.com/Sv443-Network/JokeAPI/issues/220))
|
|
|
+- API now automatically adds modification date <meta> tag to the docs ([issue #223](https://github.com/Sv443-Network/JokeAPI/issues/223))
|
|
|
+- /info endpoint now gives the number of safe jokes per language ([issue #224](https://github.com/Sv443-Network/JokeAPI/issues/224))
|
|
|
+- Added dependent jonathanbossenger/devdadjokes ([issue #225](https://github.com/Sv443-Network/JokeAPI/issues/225))
|
|
|
- Added translations to joke submission parser
|
|
|
- Made static content not indexable by web crawlers
|
|
|
|
|
|
@@ -46,7 +46,7 @@
|
|
|
- Version 2 of the API should be called @ https://v2.jokeapi.dev/ but can also be called with the old domain and https://jokeapi.dev/
|
|
|
- The stage version is @ https://stage.jokeapi.dev/
|
|
|
- Version 3 will be available @ https://v3.jokeapi.dev/
|
|
|
-- Implemented safe mode ([issue #196](https://github.com/Sv443/JokeAPI/issues/196))
|
|
|
+- Implemented safe mode ([issue #196](https://github.com/Sv443-Network/JokeAPI/issues/196))
|
|
|
- Added contributors to the documentation
|
|
|
- Added the blacklist flag "explicit" to filter out jokes containing explicit language
|
|
|
- Improved the documentation a little bit again
|
|
|
@@ -55,10 +55,10 @@
|
|
|
- Endpoint "/info"
|
|
|
- Endpoint "/langcode/{LANGUAGE}"
|
|
|
- Parameter "safe-mode" on Endpoint "/joke/{CATEGORY}"
|
|
|
-- Added a URL parameter to dry-run the /submit endpoint ([issue #187](https://github.com/Sv443/JokeAPI/issues/187))
|
|
|
-- API now tells clients how many requests they have left by providing some headers ([issue #188](https://github.com/Sv443/JokeAPI/issues/188))
|
|
|
-- Added changelog generation in Markdown format (thanks to Sahithyan Kandathasan / [issue #191](https://github.com/Sv443/JokeAPI/issues/191))
|
|
|
-- Changelog link in docs now redirects to the markdown file on GitHub ([issue #192](https://github.com/Sv443/JokeAPI/issues/192))
|
|
|
+- Added a URL parameter to dry-run the /submit endpoint ([issue #187](https://github.com/Sv443-Network/JokeAPI/issues/187))
|
|
|
+- API now tells clients how many requests they have left by providing some headers ([issue #188](https://github.com/Sv443-Network/JokeAPI/issues/188))
|
|
|
+- Added changelog generation in Markdown format (thanks to Sahithyan Kandathasan / [issue #191](https://github.com/Sv443-Network/JokeAPI/issues/191))
|
|
|
+- Changelog link in docs now redirects to the markdown file on GitHub ([issue #192](https://github.com/Sv443-Network/JokeAPI/issues/192))
|
|
|
- Added a few category aliases
|
|
|
- Miscellaneous for Misc
|
|
|
- Coding for Programming
|
|
|
@@ -66,10 +66,10 @@
|
|
|
- Halloween for Spooky
|
|
|
- Renamed category "Miscellaneous" to "Misc" but kept old name "Miscellaneous" as an alias
|
|
|
- Added two new wrapper libraries
|
|
|
- - sv443-joke-api for Node.js / TS ([issue #190](https://github.com/Sv443/JokeAPI/issues/190))
|
|
|
- - jokeapi-go for Golang ([issue #193](https://github.com/Sv443/JokeAPI/issues/193))
|
|
|
-- Updated C# code example in the docs ([issue #207](https://github.com/Sv443/JokeAPI/issues/207))
|
|
|
-- Increased Rate Limiting budgets ([issue #208](https://github.com/Sv443/JokeAPI/issues/208))
|
|
|
+ - sv443-joke-api for Node.js / TS ([issue #190](https://github.com/Sv443-Network/JokeAPI/issues/190))
|
|
|
+ - jokeapi-go for Golang ([issue #193](https://github.com/Sv443-Network/JokeAPI/issues/193))
|
|
|
+- Updated C# code example in the docs ([issue #207](https://github.com/Sv443-Network/JokeAPI/issues/207))
|
|
|
+- Increased Rate Limiting budgets ([issue #208](https://github.com/Sv443-Network/JokeAPI/issues/208))
|
|
|
- When using GET: from 60 to 120
|
|
|
- When using POST: from 3 to 5
|
|
|
|
|
|
@@ -77,20 +77,20 @@
|
|
|
<br><br><br>
|
|
|
|
|
|
## [2.2.2] - The Seasonal Update
|
|
|
-- Added some new seasonal categories ([issue #180](https://github.com/Sv443/JokeAPI/issues/180))
|
|
|
+- Added some new seasonal categories ([issue #180](https://github.com/Sv443-Network/JokeAPI/issues/180))
|
|
|
- Spooky (Halloween)
|
|
|
- Christmas (thanks for the suggestion Dan)
|
|
|
-- Added dependent ToastIT-dev/PoshBot.Joker ([issue #173](https://github.com/Sv443/JokeAPI/issues/173))
|
|
|
+- Added dependent ToastIT-dev/PoshBot.Joker ([issue #173](https://github.com/Sv443-Network/JokeAPI/issues/173))
|
|
|
- Added a bunch of joke submissions
|
|
|
-- Reliability improvements in the documentation ([issue #181](https://github.com/Sv443/JokeAPI/issues/181))
|
|
|
+- Reliability improvements in the documentation ([issue #181](https://github.com/Sv443-Network/JokeAPI/issues/181))
|
|
|
- Added POST as a method to submit data to the API since it makes more sense than PUT (maybe deprecating that some time)
|
|
|
|
|
|
|
|
|
<br><br><br>
|
|
|
|
|
|
## [2.2.1] - Version 2.2 Hotfix
|
|
|
-- Added the Czech translation ([pull request #137](https://github.com/Sv443/JokeAPI/pull/137)) - provided by @ThatCopy (https://github.com/ThatCopy) - thanks :)
|
|
|
-- Added a missing conversion mapping when using format `txt` and the `amount` parameter on endpoint `/joke` ([issue #138](https://github.com/Sv443/JokeAPI/issues/138))
|
|
|
+- Added the Czech translation ([pull request #137](https://github.com/Sv443-Network/JokeAPI/pull/137)) - provided by @ThatCopy (https://github.com/ThatCopy) - thanks :)
|
|
|
+- Added a missing conversion mapping when using format `txt` and the `amount` parameter on endpoint `/joke` ([issue #138](https://github.com/Sv443-Network/JokeAPI/issues/138))
|
|
|
- Fixed wrong URLs in the documentation's JavaScript
|
|
|
- Fixed crash when a client asks for a translation that doesn't exist
|
|
|
- Slightly improved the documentation
|
|
|
@@ -100,30 +100,30 @@
|
|
|
<br><br><br>
|
|
|
|
|
|
## [2.2.0] - The Pun Update
|
|
|
-- Added joke category "Pun" ([issue #105](https://github.com/Sv443/JokeAPI/issues/105))
|
|
|
-- Added "?amount" parameter to joke endpoint so multiple jokes can be fetched at once ([issue #126](https://github.com/Sv443/JokeAPI/issues/126))
|
|
|
-- Added support for jokes and error messages of different languages ([issue #75](https://github.com/Sv443/JokeAPI/issues/75))
|
|
|
+- Added joke category "Pun" ([issue #105](https://github.com/Sv443-Network/JokeAPI/issues/105))
|
|
|
+- Added "?amount" parameter to joke endpoint so multiple jokes can be fetched at once ([issue #126](https://github.com/Sv443-Network/JokeAPI/issues/126))
|
|
|
+- Added support for jokes and error messages of different languages ([issue #75](https://github.com/Sv443-Network/JokeAPI/issues/75))
|
|
|
- /langcode/{LANGUAGE} endpoint
|
|
|
- /languages endpoint
|
|
|
- "?lang=code" URL parameter
|
|
|
-- Fixed ID caching (again, sigh) ([issue #80](https://github.com/Sv443/JokeAPI/issues/80))
|
|
|
-- Added pm2 custom metrics ([issue #91](https://github.com/Sv443/JokeAPI/issues/91))
|
|
|
-- Fixed HTTP 403 errors ([issue #96](https://github.com/Sv443/JokeAPI/issues/96))
|
|
|
-- Remade the URL parser using a package ([issue #97](https://github.com/Sv443/JokeAPI/issues/97))
|
|
|
-- Daemonized the API token refreshing ([issue #102](https://github.com/Sv443/JokeAPI/issues/102))
|
|
|
-- Rate limiting joke submissions more harshly now ([issue #104](https://github.com/Sv443/JokeAPI/issues/104))
|
|
|
-- Fixed error where the end of the payload were cut off, thus invalidating JSON ([issue #119](https://github.com/Sv443/JokeAPI/issues/119))
|
|
|
-- Joke submission property order is now enforced, improving uniformity ([issue #120](https://github.com/Sv443/JokeAPI/issues/120))
|
|
|
-- Joke submissions are now validated to make sure they don't contain fancy Unicode chars ([issue #123](https://github.com/Sv443/JokeAPI/issues/123))
|
|
|
+- Fixed ID caching (again, sigh) ([issue #80](https://github.com/Sv443-Network/JokeAPI/issues/80))
|
|
|
+- Added pm2 custom metrics ([issue #91](https://github.com/Sv443-Network/JokeAPI/issues/91))
|
|
|
+- Fixed HTTP 403 errors ([issue #96](https://github.com/Sv443-Network/JokeAPI/issues/96))
|
|
|
+- Remade the URL parser using a package ([issue #97](https://github.com/Sv443-Network/JokeAPI/issues/97))
|
|
|
+- Daemonized the API token refreshing ([issue #102](https://github.com/Sv443-Network/JokeAPI/issues/102))
|
|
|
+- Rate limiting joke submissions more harshly now ([issue #104](https://github.com/Sv443-Network/JokeAPI/issues/104))
|
|
|
+- Fixed error where the end of the payload were cut off, thus invalidating JSON ([issue #119](https://github.com/Sv443-Network/JokeAPI/issues/119))
|
|
|
+- Joke submission property order is now enforced, improving uniformity ([issue #120](https://github.com/Sv443-Network/JokeAPI/issues/120))
|
|
|
+- Joke submissions are now validated to make sure they don't contain fancy Unicode chars ([issue #123](https://github.com/Sv443-Network/JokeAPI/issues/123))
|
|
|
|
|
|
|
|
|
<br><br><br>
|
|
|
|
|
|
## [2.1.5] - 2020 Q3 general patch #2
|
|
|
-- Ditched my botched rate limiting package for a "commercial" one ([issue #113](https://github.com/Sv443/JokeAPI/issues/113))
|
|
|
-- Added API token section to documentation ([issue #114](https://github.com/Sv443/JokeAPI/issues/114))
|
|
|
-- Client now receives a "Token-Valid" header with the value 0 or 1 depending on token validity ([issue #115](https://github.com/Sv443/JokeAPI/issues/115))
|
|
|
-- Renamed "X-Auth-Token" header to "Authorization" so requests don't get blocked by Cloudflare ([issue #117](https://github.com/Sv443/JokeAPI/issues/117))
|
|
|
+- Ditched my botched rate limiting package for a "commercial" one ([issue #113](https://github.com/Sv443-Network/JokeAPI/issues/113))
|
|
|
+- Added API token section to documentation ([issue #114](https://github.com/Sv443-Network/JokeAPI/issues/114))
|
|
|
+- Client now receives a "Token-Valid" header with the value 0 or 1 depending on token validity ([issue #115](https://github.com/Sv443-Network/JokeAPI/issues/115))
|
|
|
+- Renamed "X-Auth-Token" header to "Authorization" so requests don't get blocked by Cloudflare ([issue #117](https://github.com/Sv443-Network/JokeAPI/issues/117))
|
|
|
- Cleaned up a lot of code
|
|
|
|
|
|
|
|
|
@@ -136,9 +136,9 @@
|
|
|
<br><br><br>
|
|
|
|
|
|
## [2.1.3] - 2020 Q2 general patch #1
|
|
|
-- Added option to disable all console output but error messages ([issue #72](https://github.com/Sv443/JokeAPI/issues/72))
|
|
|
-- The content of jokes in the joke submission form is now correctly escaped and can no longer mess up the page ([issue #68](https://github.com/Sv443/JokeAPI/issues/68))
|
|
|
-- Fixed crash when parsing a malformatted URI ([issue #69](https://github.com/Sv443/JokeAPI/issues/69) (nice))
|
|
|
+- Added option to disable all console output but error messages ([issue #72](https://github.com/Sv443-Network/JokeAPI/issues/72))
|
|
|
+- The content of jokes in the joke submission form is now correctly escaped and can no longer mess up the page ([issue #68](https://github.com/Sv443-Network/JokeAPI/issues/68))
|
|
|
+- Fixed crash when parsing a malformatted URI ([issue #69](https://github.com/Sv443-Network/JokeAPI/issues/69) (nice))
|
|
|
- Re-flagged some jokes
|
|
|
- Updated dependencies
|
|
|
|
|
|
@@ -156,7 +156,7 @@
|
|
|
<br><br><br>
|
|
|
|
|
|
## [2.1.1] - Auth update hotfix
|
|
|
-- Fixed incorrect error cause when using an out-of-range ID range parameter (see [issue #54](https://github.com/Sv443/JokeAPI/issues/54))
|
|
|
+- Fixed incorrect error cause when using an out-of-range ID range parameter (see [issue #54](https://github.com/Sv443-Network/JokeAPI/issues/54))
|
|
|
- Added submission form (https://v2.jokeapi.dev/#submit)
|
|
|
|
|
|
|
|
|
@@ -165,7 +165,7 @@
|
|
|
## [2.1.0] - The auth update
|
|
|
- Added an authorization header to make whitelisting possible without needing to have a static IP
|
|
|
- Added the script "npm run add-token [amount]" to add one or more tokens
|
|
|
-- Improved the documentation (see [issue #52](https://github.com/Sv443/JokeAPI/issues/52))
|
|
|
+- Improved the documentation (see [issue #52](https://github.com/Sv443-Network/JokeAPI/issues/52))
|
|
|
- Fixed a few bugs in the documentation
|
|
|
|
|
|
|
|
|
@@ -229,7 +229,7 @@ ery small improvements to the console window
|
|
|
<br><br><br>
|
|
|
|
|
|
## [1.1.0]
|
|
|
-- switched to ReadStreams instead of just loading the entire file to RAM to massively improve request performance (more details in [issue #2](https://github.com/Sv443/JokeAPI/issues/2))
|
|
|
+- switched to ReadStreams instead of just loading the entire file to RAM to massively improve request performance (more details in [issue #2](https://github.com/Sv443-Network/JokeAPI/issues/2))
|
|
|
- this basically means it transmits the data over time, instead of loading it all to RAM and sending it at once
|
|
|
dded rate limiting to counter DoS attacks (yes I've been getting some of those *sigh*)
|
|
|
|
Sv443