mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2025-11-30 16:23:34 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

[feature] Make rate limit requests amount configurable (#966)

Browse source 
* update rate limit documentation

* regenerate landingpage config helpers

* make rate limit rate configurable
This commit is contained in:
tobi 2022-11-06 10:47:48 +01:00 • committed by GitHub
commit 4d66fb9603
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 128 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/api/swagger.md
View file

@ -1,16 +1,5 @@
# API Documentation
## Rate limit
To prevent abuse of the API an IP-based HTTP rate limit is in place, a maximum of 1000 requests in a 5 minutes time window are allowed, every response will include the current status of the rate limit with the following headers:
- `x-ratelimit-limit` maximum number of requests allowed per time period (fixed)
- `x-ratelimit-remaining` number of remaining requests that can still be performed
- `x-ratelimit-reset` unix timestamp when the rate limit will reset
In case the rate limit is exceeded an HTTP 429 error is returned to the caller.
GoToSocial uses [go-swagger](https://github.com/go-swagger/go-swagger) to generate a V2 [OpenAPI specification](https://swagger.io/specification/v2/) document from code annotations.
The resulting API documentation is rendered below, for quick reference.