docs: document the API rate limits and the page ceiling - #51
Open
anoziere wants to merge 4 commits into
Open
Conversation
10 tasks
This file contains hidden or 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
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.
Documents the API rate limits added by thelia/thelia#3883. The two settings that decide whether they work at all, trusted proxies and a shared cache, are the ones a shop otherwise discovers after it starts refusing its own customers.
New page
api/rate-limiting.md,sidebar_position: 8:429,Retry-Afterin seconds, and the same body every time, with a note on why the body says nothing about which cap was reached or whether the identifier names an accountTHELIA_API_RATE_LIMIT_*variables with their defaults, what each is counted per, and which endpoints each coverscache.appat Redis or Memcached holds itapi/endpoints/_category_.jsonmoves from position 8 to 9 so the new page sits after Filters & Pagination.Updated pages
api/filters.mddocumenteditemsPerPagewith a default and no maximum, which is no longer true. The pagination table now carries the ceiling, and a new section explains it, shows thathydra:totalItemsstill reports the real size of the collection, and gives the two ways to change it (API Platform defaults, or per operation).api/authentication.mdgains a short rate limiting section before its next steps, so someone reading about the login endpoints is told that failed attempts are counted and that the proxy configuration matters.Versioning
Every change is applied to
docs/and toversioned_docs/version-3.0/, which stay identical.Companion to thelia/thelia#3883, which adds the limits themselves.