From 52fe9526420b98df78f922ff3680a04ec0f7784e Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Fri, 7 May 2021 09:46:22 +0200 Subject: relax guarantee on openapi rate limit doc accuracy --- support/doc/api/openapi.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'support') 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: # Rate limits - We are rate-limiting all endpoints of PeerTube's API. Here is how it is configured by default: + We are rate-limiting all endpoints of PeerTube's API. Custom values can be configured + by administrators: | Endpoint | Calls | Time frame | |-------------------------|------------------|---------------------------| @@ -62,7 +63,8 @@ info: Depending on the endpoint, ¹failed requests are not taken into account. A service limit is announced by a `429 Too Many Requests` status code. - You can get details about how your rate limit is going by reading following headers: + You can get details about the current state of your rate limit by reading the + following headers: | Header | Description | |-------------------------|------------------------------------------------------------| -- cgit v1.2.3