feat(kuma-cp) pagination in the API #673
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
tharun208
suggested changes
Apr 10, 2020
lobkovilya
reviewed
Apr 14, 2020
lobkovilya
reviewed
Apr 14, 2020
| @@ -29,6 +32,24 @@ func (a *ApiServer) Address() string { | |||
| return a.server.Addr | |||
| } | |||
|
|
|||
| func init() { | |||
| // turn off escape & character so the link in "next" fields for resources is user friendly | |||
There was a problem hiding this comment.
Does it turn off escaping for all api-server responses?
There was a problem hiding this comment.
Yes, you cannot differentiate it.
There was a problem hiding this comment.
Marco decided that we should not escape it for better UX
jakubdyszkiewicz
force-pushed
the
feat/pagination
branch
from
1c8726b
to
d2921ec
Compare
lobkovilya
approved these changes
Apr 17, 2020
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.
Summary
Adds pagination functionality.
You can now query API with
sizequery param to have a list with given numbers of items.The default page size is 100. Page size limit is 1000, so we won't load all entities in the memory (at least here, we do it in other places, but that's out of scope of this PR).
Returned response contains
nextfield next toitemswith link to fetch next page of the items.Offset in Postgres and Memory is just a number, but on K8S is a continue token
Dataplane overview is tricky endpoint, because we retrieve dataplanes and dataplane insights and then we merge it. Additionaly we have filters that we do in memory (because at the time of creating those, there was no option to do the filtering on K8S API). This makes pagination hard to do, so for now we provide pagination to it only if there are no filters.
Support for kumactl pagination comes in another PR, because I don't want to makes huge conflicts with this PR https://github.com/Kong/kuma/pull/667