Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update web UI to read page_size/total_pages pagination parameters from API response, rather than manually calculate these #2476

Closed
joeyorlando opened this issue Jul 10, 2023 · 3 comments
Closed

Update web UI to read page_size/total_pages pagination parameters from API response, rather than manually calculate these #2476

joeyorlando opened this issue Jul 10, 2023 · 3 comments
Labels
feature request New feature or request more info needed

Comments

@joeyorlando
Copy link
Contributor

What would you like to see!

Right now, for paginated data in the UI, we manually set ITEMS_PER_PAGE. Once #2471 is merged, it will introduce new pagination related attributes to the API response that will allow the UI to:

  • no longer need to hardcode this value
  • no longer need to manually calculate "total pages"

Product Area

Other

Anything else to add?

No response
@joeyorlando joeyorlando added the feature request New feature or request label Jul 10, 2023
@github-actions
Copy link
Contributor

The current version of Grafana OnCall, at the time this issue was opened, is v1.3.7. If your issue pertains to an older version of Grafana OnCall, please be sure to list it in the PR description. Thank you 😄!

@joeyorlando joeyorlando mentioned this issue Jul 10, 2023
Merged
4 tasks
joeyorlando added a commit that referenced this issue Jul 14, 2023
@joeyorlando
augment API response pagination attributes (#2471)
767c535 
# What this PR does

This PR:
- adds a few attributes to paginated API responses
- removes channel filter "send demo alert" internal API endpoint + tests
(this endpoint was marked as deprecated + not consumed by the web UI)

With the new paginated API response schema, the web UI will no longer
need to:
- hardcode `ITEMS_PER_PAGE` for each table
- manually calculate total number of pages

(these two things ☝️ will be done in
#2476)

For `GET /api/internal/v1/alertgroups` the response will now look like
this:
```diff
{
    "next": <url> | None,
    "previous": <url> | None,
    "results": [],
++  "page_size": <int>
}
```

For all other paginated API responses, the response will now look like:
```diff
{
    "count": <int>,
    "next": <url> | None,
    "previous": <url> | None,
    "results": [],
++  "page_size": <int>,
++  "current_page_number": <int>,
++  "total_pages": <int>
}
```

## TODO
- [x] update public API docs to include these new attributes

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
@joeyorlando
Copy link
Contributor Author

backend changes for this have already been released:
Screenshot 2023-07-17 at 13 14 48

there is already a WIP PR that implements this

@joeyorlando joeyorlando linked a pull request Jul 17, 2023 that will close this issue
pagination cleanup - frontend changes #2474
Closed
@joeyorlando
Copy link
Contributor Author

closing as completed in #3205

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature request New feature or request more info needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

pagination cleanup - frontend changes grafana/oncall
1 participant
@joeyorlando