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

2.6 KiB

Raw Blame History

canonical	title	weight
https://grafana.com/docs/oncall/latest/oncall-api-reference/users/	Grafana OnCall users HTTP API	1500

Grafana OnCall users HTTP API

Get a user

This endpoint retrieves the user object.

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

The above command returns JSON structured in the following way:

{
  "id": "U4DNY931HHJS5",
  "email": "public-api-demo-user-1@grafana.com",
  "slack": [
    {
      "user_id": "UALEXSLACKDJPK",
      "team_id": "TALEXSLACKDJPK"
    }
  ],
  "username": "alex",
  "role": "admin",
  "timezone": "UTC",
  "teams": []
}

HTTP request

GET {{API_URL}}/api/v1/users/<USER_ID>/

Use {{API_URL}}/api/v1/users/current to retrieve the current user.

Parameter	Unique	Description
`id`	Yes/org	User ID
`email`	Yes/org	User e-mail
`slack`	Yes/org	List of user IDs from connected Slack. User linking key is e-mail.
`username`	Yes/org	User username
`role`	No	One of: `user`, `observer`, `admin`.
`timezone`	No	timezone of the user one of time zones.
`teams`	No	List of team IDs the user belongs to

List Users

curl "{{API_URL}}/api/v1/users/" \
  --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": "U4DNY931HHJS5",
      "email": "public-api-demo-user-1@grafana.com",
      "slack": [
        {
          "user_id": "UALEXSLACKDJPK",
          "team_id": "TALEXSLACKDJPK"
        }
      ],
      "username": "alex",
      "role": "admin",
      "timezone": "UTC",
      "teams": ["TAAM1K1NNEHAG"]
    }
  ],
  "current_page_number": 1,
  "page_size": 100,
  "total_pages": 1
}

This endpoint retrieves all users.

The following available filter parameter should be provided as a GET argument:

username (Exact match)

HTTP request

GET {{API_URL}}/api/v1/users/

2.6 KiB Raw Blame History

Grafana OnCall users HTTP API

Get a user

List Users

2.6 KiB

Raw Blame History