oncall-engine/docs
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
..
img Merge dev to main (#73) 2022-06-14 09:54:41 -06:00
sources augment API response pagination attributes (#2471) 2023-07-14 11:19:40 -04:00
.markdownlint.json Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
docs.mk Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
make-docs Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00
Makefile Use centralized make-docs script from Writers' Toolkit (#1742) 2023-04-24 08:52:43 +00:00
README.md Mobile app docs updates (#2026) 2023-05-29 14:52:42 +00:00
variables.mk Update all links to use docs/reference style (#2456) 2023-07-13 14:38:35 +00:00

Grafana Cloud Documentation

Source for documentation at https://grafana.com/docs/oncall/

Preview the website

Run make docs. This launches a preview of the website with the current grafana docs at http://localhost:3002/docs/oncall/latest/ which will refresh automatically when changes are made to content in the sources directory. Make sure Docker is running.

Image support

See the documentation in writers toolkit about how to store images