oncall-engine/engine/apps/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 World, meet OnCall! 2022-06-03 08:09:47 -06:00
alert_group.py remove deprecated backend code (#2502) 2023-07-12 02:07:45 -04:00
alert_receive_channel.py Unhide direct paging integration (#2483) 2023-07-13 13:41:31 +08:00
alert_receive_channel_template.py Fix resource duplication caused by available_teams_lookup_args (#1593) 2023-03-22 15:43:32 +08:00
alerts.py Add alert detail view (#385) 2022-08-19 14:03:07 +05:00
auth.py Add SLACK_INTEGRATION_MAINTENANCE env var (#1582) 2023-03-21 08:15:35 +00:00
channel_filter.py augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
custom_button.py Fix MultipleObjectsReturned error on webhook endpoints (#1996) 2023-05-23 16:23:06 +00:00
escalation_chain.py Make viewset actions more consistent (#2120) 2023-06-07 12:10:53 +00:00
escalation_policy.py Webhooks 2 Release (#1830) 2023-07-13 13:53:06 -06:00
features.py Webhooks 2 Release (#1830) 2023-07-13 13:53:06 -06:00
integration_heartbeat.py Fix resource duplication caused by available_teams_lookup_args (#1593) 2023-03-22 15:43:32 +08:00
live_setting.py Fix Telegram ratelimit on live setting change (#2100) 2023-06-06 15:18:12 +00:00
on_call_shifts.py Add support to update web schedule rotations in-place (#2102) 2023-06-05 17:24:59 +00:00
organization.py Introduce org uuid (#947) 2022-12-06 22:42:58 +08:00
paging.py Teams redesign (#1528) 2023-03-22 00:57:20 +08:00
preview_template_options.py Fix of templates api behaviour for public and private api (#1408) 2023-03-01 16:32:15 +08:00
public_api_tokens.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
resolution_note.py Fix resource duplication caused by available_teams_lookup_args (#1593) 2023-03-22 15:43:32 +08:00
route_regex_debugger.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
schedule.py fix pagination next and previous links for schedules and integrations GET endpoints (#2467) 2023-07-07 12:24:21 -04:00
slack_channel.py make make test command much more robust + address several more backend test warnings (#2115) 2023-06-07 10:51:58 +00:00
slack_team_settings.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
team.py Fix team update (#1794) 2023-04-19 15:22:14 +00:00
telegram_channels.py Fix insight_logs exceptions (#1757) 2023-04-17 07:16:18 +00:00
user.py make mobile app available to viewers (#1892) 2023-06-13 14:54:52 -04:00
user_group.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user_notification_policy.py Fix duplicate orders for user notification policies (#2278) 2023-06-21 11:13:56 +00:00
webhooks.py Webhooks 2 Release (#1830) 2023-07-13 13:53:06 -06:00