diff options
| author |  tobi <31960611+tsmethurst@users.noreply.github.com> | 2022-11-06 10:47:48 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2022-11-06 09:47:48 +0000 |
| commit | 4d66fb9603ada9b04f642576bbc541189876a3f3 (patch) | |
| tree | 7f9b4f3a5ab95b20eb1ad4ceaf2e6779c1e02630 /docs/api/swagger.md | |
| parent | [bugfix] Check `media-description-min-chars` on submission of new status (#960) (diff) | |
| download | gotosocial-4d66fb9603ada9b04f642576bbc541189876a3f3.tar.xz | |
[feature] Make rate limit requests amount configurable (#966)
* update rate limit documentation
* regenerate landingpage config helpers
* make rate limit rate configurable
Diffstat (limited to 'docs/api/swagger.md')
| -rw-r--r-- | docs/api/swagger.md | 11 |
1 files changed, 0 insertions, 11 deletions
diff --git a/docs/api/swagger.md b/docs/api/swagger.md index fac2ba009..50191f18d 100644 --- a/docs/api/swagger.md +++ b/docs/api/swagger.md @@ -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. |