Browse Source

relax guarantee on openapi rate limit doc accuracy

tags/v3.2.0-rc.1
Rigel Kent 1 year ago
parent
commit
52fe952642
No known key found for this signature in database GPG Key ID: 5E53E96A494E452F
1 changed files with 4 additions and 2 deletions
  1. +4
    -2
      support/doc/api/openapi.yaml

+ 4
- 2
support/doc/api/openapi.yaml View File

@@ -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 |
|-------------------------|------------------------------------------------------------|


Loading…
Cancel
Save