docs(api): update api description #13429
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move the API description string to a separate variable to improve code readability. Add content to the (Open)API description summarized from general sections of the REST API documentation.
walpox
commented
Jan 5, 2025
| Rate limiting can be adjusted in the `settings.py` file; see [Throttling in Django REST framework documentation](https://www.django-rest-framework.org/api-guide/throttling/) | ||
| for more details on how to configure it. | ||
|
|
||
| In the Docker container, this can be configured with the [WEBLATE_API_RATELIMIT_ANON]({get_doc_url(page='admin/install/docker', anchor='envvar-WEBLATE_API_RATELIMIT_ANON')}) and the [WEBLATE_API_RATELIMIT_USER]({get_doc_url(page='admin/install/docker', anchor='envvar-WEBLATE_API_RATELIMIT_USER')}) environment variables. |
There was a problem hiding this comment.
The anchors for the URLs of both Docker variables actually use the underscore character, but the get_doc_url function replaces them with hyphens -.
nijel
reviewed
Jan 8, 2025
| Weblate's REST API is based on [Django REST framework](https://www.django-rest-framework.org). | ||
| You can interact with it on the `/api/` URL path by using the [Weblate Client]({get_doc_url(page='wlc')}) or any third-party REST client of your choice. | ||
|
|
||
| ## Authentication |
There was a problem hiding this comment.
This is already covered in OpenAPI, it could be definitely improved, but better to have it in standard location than in text:
| requests per day. On the other hand, authenticated requests are rate limited | ||
| to 5000 requests per hour by default. | ||
|
|
||
| ## API rate limiting |
There was a problem hiding this comment.
This is already partly documented in response headers via add_middleware_headers:
nijel
reviewed
Jan 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Checklist
Other information
The rationale behind this change is to help the OpenAPI document stand on its own.
Relates to #12584