oncall-engine/docs/sources
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
..
escalation-chains-and-routes Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
get-started Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
insights-and-metrics Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
integrations Outgoing webhooks 2 documentation (#1844) 2023-07-13 14:39:20 -06:00
jinja2-templating Refactor docs for the new integrations page (#2290) 2023-06-27 09:57:27 +08:00
migration-from-other-tools Docs restructure (#1703) 2023-05-24 14:11:21 +03:00
mobile-app Remove absolute aliases as it can cause unexpected redirects in future versions (#1793) 2023-06-05 09:03:38 +00:00
notify Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
on-call-schedules Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
oncall-api-reference augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
open-source add index on started_at column in alert groups (#2516) 2023-07-13 05:22:59 -04:00
outgoing-webhooks Outgoing webhooks 2 documentation (#1844) 2023-07-13 14:39:20 -06:00
user-and-team-management Remove absolute aliases as it can cause unexpected redirects in future versions (#1793) 2023-06-05 09:03:38 +00:00
_index.md adjust frontmatter weight and add menu title (#2484) 2023-07-10 16:54:28 +00:00