fix right-hand navigation in API docs (#4546 )

# What this PR does

The right-hand side navigation in the OnCall API public docs
([example](https://grafana.com/docs/oncall/latest/oncall-api-reference/alertgroups/))
doesn’t render as expected vs. what we see in the Grafana API public
docs
([example](https://grafana.com/docs/grafana/latest/developers/http_api/folder/);
2nd screenshot). This PR fixes that ([convo on
Slack](https://raintank-corp.slack.com/archives/C045CTY1QEP/p1718388424649359)).


![Screenshot 2024-06-14 at 14 05
03](https://github.com/grafana/oncall/assets/9406895/0636d9d7-2f58-4c82-91b5-5b4af0dd3524)

![Screenshot 2024-06-14 at 14 06 36
(1)](https://github.com/grafana/oncall/assets/9406895/7a5bc2c8-ccb2-4b53-b982-d7d7596f90e2)

2024-06-17 11:31:35 -04:00

1.5 KiB

Raw Blame History

canonical	title	weight
https://grafana.com/docs/oncall/latest/oncall-api-reference/user_groups/	OnCall user groups HTTP API	1400

OnCall user groups HTTP API

List user groups

curl "{{API_URL}}/api/v1/user_groups/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "GPFAPH7J7BKJB",
      "type": "slack_based",
      "slack": {
        "id": "MEOW_SLACK_ID",
        "name": "Meow Group",
        "handle": "meow_group"
      }
    }
  ],
  "current_page_number": 1,
  "page_size": 50,
  "total_pages": 1
}

Parameter	Unique	Description
`id`	Yes	User Group ID
`type`	No	Slack-defined user groups
`slack`	No	Metadata retrieved from Slack.

HTTP request

GET {{API_URL}}/api/v1/user_groups/

1.5 KiB Raw Blame History

OnCall user groups HTTP API

List user groups

1.5 KiB

Raw Blame History