augment API response pagination attributes #2471
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
joeyorlando
commented
Jul 7, 2023
There was a problem hiding this comment.
main change for the backend
joeyorlando
commented
Jul 10, 2023
| @@ -527,8 +527,8 @@ def heartbeat_module(self): | |||
| return getattr(heartbeat, self.INTEGRATIONS_TO_REVERSE_URL_MAP[self.integration], None) | |||
|
|
|||
| # Demo alerts | |||
| def send_demo_alert(self, force_route_id=None, payload=None): | |||
There was a problem hiding this comment.
force_route_id seemed to only be passed in when this method was called from ChannelFilter. send_demo_alert (which was already deprecated and is now removed in this PR)
joeyorlando
commented
Jul 10, 2023
Comment on lines
-65
to
+71
| def get_paginated_response_with_matched_users_count(self, data, matched_users_count): | ||
| return Response( | ||
| OrderedDict( | ||
| [ | ||
| ("count", self.page.paginator.count), | ||
| ("matched_users_count", matched_users_count), | ||
| ("next", self.get_next_link()), | ||
| ("previous", self.get_previous_link()), | ||
| ("results", data), | ||
| ] | ||
| ) | ||
| ) | ||
| return self.get_paginated_response(data, len(cloud_identities)) |
There was a problem hiding this comment.
HundredPageSizePaginator inherits from PathPrefixedPagePagination and therefore all of these attributes, except for matched_users_count would be set. matched_users_count is being set above in the new CloudUsersPagination paginator class.
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 this PR does
This PR:
With the new paginated API response schema, the web UI will no longer need to:
ITEMS_PER_PAGEfor each table(these two things ☝️ will be done in #2476)
For
GET /api/internal/v1/alertgroupsthe response will now look like this:{ "next": <url> | None, "previous": <url> | None, "results": [], ++ "page_size": <int> }For all other paginated API responses, the response will now look like:
{ "count": <int>, "next": <url> | None, "previous": <url> | None, "results": [], ++ "page_size": <int>, ++ "current_page_number": <int>, ++ "total_pages": <int> }TODO
Checklist
pr:no public docsPR label added if not required)CHANGELOG.mdupdated (orpr:no changelogPR label added if not required)