oncall-engine/engine/apps/public_api/views
Joey Orlando 767c5352fa
augment API response pagination attributes (#2471)
# 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
https://github.com/grafana/oncall/issues/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)
2023-07-14 11:19:40 -04:00
..
__init__.py First touch on grafana cloud notifications 2022-06-03 19:47:25 +04:00
action.py make make test command much more robust + address several more backend test warnings (#2115) 2023-06-07 10:51:58 +00:00
alerts.py Fix alerts order in public api (#2402) 2023-06-29 12:52:30 +00:00
escalation_chains.py make make test command much more robust + address several more backend test warnings (#2115) 2023-06-07 10:51:58 +00:00
escalation_policies.py Insight logs (#348) 2022-08-24 12:04:44 +05:00
incidents.py Revert count query in alert groups internal api endpoint (#1285) 2023-02-03 20:01:46 +08:00
info.py Add info throttler 2022-06-08 18:25:58 +04:00
integrations.py Unhide direct paging integration (#2483) 2023-07-13 13:41:31 +08:00
maintaiable_object_mixin.py Make viewset actions more consistent (#2120) 2023-06-07 12:10:53 +00:00
on_call_shifts.py Insight logs (#348) 2022-08-24 12:04:44 +05:00
organizations.py Remove demo token related code/logic 2022-06-09 09:16:10 -03:00
personal_notifications.py Remove auto-recreating logic for UserNotificationPolicy (#414) 2022-08-26 13:46:50 +05:00
phone_notifications.py Phone provider refactoring (#1713) 2023-05-24 06:27:48 +00:00
resolution_notes.py Resolution notes endpoint docs (#2404) 2023-06-29 14:08:21 +00:00
routes.py Insight logs (#348) 2022-08-24 12:04:44 +05:00
schedules.py augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
slack_channels.py make make test command much more robust + address several more backend test warnings (#2115) 2023-06-07 10:51:58 +00:00
teams.py make make test command much more robust + address several more backend test warnings (#2115) 2023-06-07 10:51:58 +00:00
user_groups.py make make test command much more robust + address several more backend test warnings (#2115) 2023-06-07 10:51:58 +00:00
users.py Make viewset actions more consistent (#2120) 2023-06-07 12:10:53 +00:00