Sfoglia il codice sorgente

docs: update changelog

Sv443 4 mesi fa
parent
commit
8cc61a18e2
1 ha cambiato i file con 8 aggiunte e 4 eliminazioni
  1. 8 4
      CHANGELOG.md

+ 8 - 4
CHANGELOG.md

@@ -1,12 +1,16 @@
 ### v2.0.0
+geniURL v2's public instance now requires using the base path `api.sv443.net/geniurl/v2/`  
+All requests to `api.sv443.net/geniurl/` will use the old version which will be deprecated soon.
+
 **Features:**
-- Added `?redirect` parameter for automatic HTTP redirection instead of returning a JSON response ([#22](https://github.com/Sv443/geniURL/issues/22))
+- TODO: Added `?redirect` parameter for automatic HTTP redirection instead of returning a JSON response ([#22](https://github.com/Sv443/geniURL/issues/22))
 
 **Changes:**
+- **Breaking:** If no results are found, the API now responds with code 200 and `"error": false` instead of responding with code 400 and `"error": true`. The `"message"` prop was also removed.
+  - If no results are found when using the `/search/top` route, the above still applies, but the `top` prop will also be set to `null` and `all` will be an empty array in JSON or `<all/>` in XML
 - **Breaking:** Removed fuzzy filtering and `?disableFuzzy` and `?threshold` parameters altogether (to maybe be added back in the future as an opt-in feature) ([#24](https://github.com/Sv443/geniURL/issues/24))
-- geniURL v2's public instance now requires using the base path `api.sv443.net/geniurl/v2/`. All other requests will be redirected to the old version which will be deprecated soon.
-- Reduced ratelimit budget from 25 requests every 30 seconds to 20 requests
-- IP addresses are now hashed before being stored in the ratelimit cache in memory
+- Reduced rate limit budget by 5, from 25 requests in 30 seconds to 20 requests in 30 seconds
+- IP addresses are now hashed before being stored in the rate limiter cache in memory
 
 <br>