oncall-engine/engine/common/api_helpers
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
custom_fields.py Add is_default fields to templates, remove WritableSerialiserMethodFi… (#1759) 2023-04-18 04:44:51 +00:00
custom_rate_scoped_throttler.py Add ratelimit for phone number verification (#1354) 2023-02-21 16:47:52 +08:00
exceptions.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
filters.py Teams redesign (#1528) 2023-03-22 00:57:20 +08:00
mixins.py continue addressing mypy violations (#2170) 2023-06-27 10:23:08 +00:00
optional_slash_router.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
paginators.py augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
serializers.py Make viewset actions more consistent (#2120) 2023-06-07 12:10:53 +00:00
utils.py add user (full) avatar to schedule filter events internal API endpoint (#2459) 2023-07-06 15:43:04 -04:00