From c40b6d12281c2ddb8f674ed890c6c0cb8e7bd3d1 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Mon, 3 Jun 2024 13:26:36 +0100 Subject: [PATCH] [v10.4.x] [docs/sources/developers] Replace docs/reference shortcode with ref URIs (#88076) --- docs/sources/developers/http_api/alerting.md | 23 +++++++++++-------- .../developers/http_api/dashboard_public.md | 13 ++++++----- docs/sources/developers/http_api/user.md | 13 ++++++----- 3 files changed, 27 insertions(+), 22 deletions(-) diff --git a/docs/sources/developers/http_api/alerting.md b/docs/sources/developers/http_api/alerting.md index ceece602a88..1edd1a6b93f 100644 --- a/docs/sources/developers/http_api/alerting.md +++ b/docs/sources/developers/http_api/alerting.md @@ -15,6 +15,17 @@ labels: - enterprise - oss title: Legacy Alerting API +refs: + admin-api: + - pattern: /docs/grafana/ + destination: /docs/grafana//developers/http_api/admin/#pause-all-alerts + - pattern: /docs/grafana/ + destination: /docs/grafana//developers/http_api/admin/#pause-all-alerts + grafana-alerting-alerts-documentation: + - pattern: /docs/grafana/ + destination: /docs/grafana//alerting/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana//alerting/ --- # Legacy Alerting API @@ -27,7 +38,7 @@ This topic is relevant for the [legacy dashboard alerts](/docs/grafana/v8.5/aler If you are using Grafana Alerting, refer to [Alerting provisioning API]({{< relref "./alerting_provisioning" >}}) -You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation][] for details on how to create and manage new alerts. +You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation](ref:grafana-alerting-alerts-documentation) for details on how to create and manage new alerts. You can use the Alerting API to get information about legacy dashboard alerts and their states but this API cannot be used to modify the alert. To create new alerts or modify them you need to update the dashboard JSON that contains the alerts. @@ -173,12 +184,4 @@ Content-Type: application/json ## Pause all alerts -See [Admin API][]. - -{{% docs/reference %}} -[Admin API]: "/docs/grafana/ -> /docs/grafana//developers/http_api/admin#pause-all-alerts" -[Admin API]: "/docs/grafana/ -> /docs/grafana//developers/http_api/admin#pause-all-alerts" - -[Grafana Alerting alerts documentation]: "/docs/grafana/ -> /docs/grafana//alerting" -[Grafana Alerting alerts documentation]: "/docs/grafana-cloud/ -> /docs/grafana//alerting" -{{% /docs/reference %}} +See [Admin API](ref:admin-api). diff --git a/docs/sources/developers/http_api/dashboard_public.md b/docs/sources/developers/http_api/dashboard_public.md index d0f1980c6b0..1604022fd66 100644 --- a/docs/sources/developers/http_api/dashboard_public.md +++ b/docs/sources/developers/http_api/dashboard_public.md @@ -14,13 +14,19 @@ labels: - enterprise - oss title: Public Dashboard HTTP API +refs: + role-based-access-control-permissions: + - pattern: /docs/grafana/ + destination: /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes/ --- # Public Dashboard API {{% admonition type="note" %}} -If you're running Grafana Enterprise, you'll need to have specific permissions for some endpoints. Refer to [Role-based access control permissions][] for more information. +If you're running Grafana Enterprise, you'll need to have specific permissions for some endpoints. Refer to [Role-based access control permissions](ref:role-based-access-control-permissions) for more information. {{% /admonition %}} @@ -319,8 +325,3 @@ Content-Type: application/json "perPage": 2 } ``` - -{{% docs/reference %}} -[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" -[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" -{{% /docs/reference %}} diff --git a/docs/sources/developers/http_api/user.md b/docs/sources/developers/http_api/user.md index 37c64bffa24..428c12c3472 100644 --- a/docs/sources/developers/http_api/user.md +++ b/docs/sources/developers/http_api/user.md @@ -14,6 +14,12 @@ labels: - enterprise - oss title: User HTTP API +refs: + role-based-access-control-permissions: + - pattern: /docs/grafana/ + destination: /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes/ --- # User API @@ -24,7 +30,7 @@ user must have the Grafana Admin role. API Tokens can be used with Organization HTTP API to get users of specific organization. -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions][] for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](ref:role-based-access-control-permissions) for more information. ## Search Users @@ -683,8 +689,3 @@ Content-Type: application/json "message": "User auth token revoked" } ``` - -{{% docs/reference %}} -[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" -[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana//administration/roles-and-permissions/access-control/custom-role-actions-scopes" -{{% /docs/reference %}}