oncall-engine/docs/sources/oncall-api-reference
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
..
_index.md Fix docs, change team to organization in ratelimits, as previously te… (#2135) 2023-06-08 13:47:13 +00:00
alertgroups.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
alerts.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
escalation_chains.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
escalation_policies.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
integrations.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
on_call_shifts.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
outgoing_webhooks.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
personal_notification_rules.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
resolution_notes.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
routes.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
schedules.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
slack_channels.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
user_groups.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
users.md augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00