oncall-engine/engine/apps/api
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
..
serializers Unhide direct paging integration (#2483) 2023-07-13 13:41:31 +08:00
tests augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
throttlers Fix warnings when running backend tests (#2079) 2023-06-06 18:38:00 +00:00
views augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
errors.py Fix backend for resolution notes via mobile app (#2117) 2023-06-07 12:19:16 +00:00
permissions.py continue addressing mypy violations (#2170) 2023-06-27 10:23:08 +00:00
urls.py remove deprecated gitops views (#2530) 2023-07-14 05:13:52 -04:00