diff options
author | Rigel Kent <sendmemail@rigelk.eu> | 2021-05-07 09:46:22 +0200 |
---|---|---|
committer | Rigel Kent <sendmemail@rigelk.eu> | 2021-05-07 09:52:36 +0200 |
commit | 52fe9526420b98df78f922ff3680a04ec0f7784e (patch) | |
tree | b668809c2ba4aec5ea6b483aa87bf1b91e66b16a /support/doc/api/openapi.yaml | |
parent | aa7d2da45b478ea834f5484964e5c826d3cc7635 (diff) | |
download | PeerTube-52fe9526420b98df78f922ff3680a04ec0f7784e.tar.gz PeerTube-52fe9526420b98df78f922ff3680a04ec0f7784e.tar.zst PeerTube-52fe9526420b98df78f922ff3680a04ec0f7784e.zip |
relax guarantee on openapi rate limit doc accuracy
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r-- | support/doc/api/openapi.yaml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index e448bc1c9..90e30545f 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -50,7 +50,8 @@ info: | |||
50 | 50 | ||
51 | # Rate limits | 51 | # Rate limits |
52 | 52 | ||
53 | We are rate-limiting all endpoints of PeerTube's API. Here is how it is configured by default: | 53 | We are rate-limiting all endpoints of PeerTube's API. Custom values can be configured |
54 | by administrators: | ||
54 | 55 | ||
55 | | Endpoint | Calls | Time frame | | 56 | | Endpoint | Calls | Time frame | |
56 | |-------------------------|------------------|---------------------------| | 57 | |-------------------------|------------------|---------------------------| |
@@ -62,7 +63,8 @@ info: | |||
62 | Depending on the endpoint, ¹failed requests are not taken into account. A service | 63 | Depending on the endpoint, ¹failed requests are not taken into account. A service |
63 | limit is announced by a `429 Too Many Requests` status code. | 64 | limit is announced by a `429 Too Many Requests` status code. |
64 | 65 | ||
65 | You can get details about how your rate limit is going by reading following headers: | 66 | You can get details about the current state of your rate limit by reading the |
67 | following headers: | ||
66 | 68 | ||
67 | | Header | Description | | 69 | | Header | Description | |
68 | |-------------------------|------------------------------------------------------------| | 70 | |-------------------------|------------------------------------------------------------| |