Update API documentation to mention pagination #11115
Merged
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
youkoulayley
added
area/documentation
status/2-needs-review
kind/bug/fix
kevinpollet
force-pushed
the
feature/docs_api_pagination_6917
branch
from
63764af
to
c0bfc03
Compare
kevinpollet
changed the title
Pagination can be controlled using the `page` and `per_page` HTTP Query parameters.
kevinpollet
force-pushed
the
feature/docs_api_pagination_6917
branch
from
c0bfc03
to
3737155
Compare
|
Thanks all! Happy to contribute to Traefik! |
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.
What does this PR do?
This PR updates API documentation to mention pagination, and how to control the pagination.
Motivation
I had a Traefik deployment that had over 100 HTTP routers, and was perplexed as to why some were missing in my API queries. I eventually came across #6917 , and thought documentation updates would be helpful to others.
More
Additional Notes
I built the documentation locally according to Method 1, and looked at it on my local workstation to see if my change looked ok. I then used
make docsto clean and verify the docs.