diff options
| author |  Mia Heidenstedt <i5heu@i5h.eu> | 2022-10-31 13:20:39 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2022-10-31 13:20:39 +0100 |
| commit | c0a2d702a320269884b88d7a55f016a5c15a2145 (patch) | |
| tree | 7c65378013aa21d721cfd742800f576778c51a40 /docs/api | |
| parent | [bugfix] Fix imports for helpers.gen.go (#924) (diff) | |
| download | gotosocial-c0a2d702a320269884b88d7a55f016a5c15a2145.tar.xz | |
[docs] Update swagger.md (#933)
See https://github.com/superseriousbusiness/gotosocial/blob/main/internal/api/security/security.go
```go
s.AttachMiddleware(m.RateLimit(RateLimitOptions{
// accept a maximum of 1000 requests in 5 minutes window
Period: 5 * time.Minute,
Limit: 1000,
}))
```
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/api/swagger.md b/docs/api/swagger.md index 5368e8720..fac2ba009 100644 --- a/docs/api/swagger.md +++ b/docs/api/swagger.md @@ -2,7 +2,7 @@ ## Rate limit -To prevent abuse of the API an IP-based HTTP rate limit is in place, a maximum of 300 requests in a 5 minutes time window are allowed, every response will include the current status of the rate limit with the following headers: +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 |