public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix developer links and newly discovered spelling errors (#75875)

Browse Source 
* Fix developer links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix newly discovered spelling errors

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Jack Baldry
2023-10-03 13:49:27 +01:00
committed by GitHub
parent 3c7c608b5b
commit 4432c4c75c
14 changed files with 50 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/alerting.md
+10 -2
View File
@@ -27,7 +27,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]({{< relref "../../alerting" >}}) 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][] 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,4 +173,12 @@ Content-Type: application/json
## Pause all alerts
See [Admin API]({{< relref "/docs/grafana/latest/developers/http_api/admin#pause-all-alerts" >}}).
See [Admin API][].
{{% docs/reference %}}
[Admin API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Admin API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Grafana Alerting alerts documentation]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
[Grafana Alerting alerts documentation]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
{{% /docs/reference %}}
docs/sources/developers/http_api/dashboard_public.md
+11 -6
View File
@@ -20,7 +20,7 @@ title: Public Dashboard HTTP 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]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) 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][] for more information.
{{% /admonition %}}
@@ -32,7 +32,7 @@ Creates a new public dashboard.
**Required permissions**
See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation.
See note in the [introduction](#public-dashboard-api) for an explanation.
| Action | Scope |
| ------------------------- | -------------------------------- |
@@ -115,7 +115,7 @@ Content-Length: 107
**Required permissions**
See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation.
See note in the [introduction](#public-dashboard-api) for an explanation.
| Action | Scope |
| ------------------------- | -------------------------------- |
@@ -196,7 +196,7 @@ Will return the public dashboard given the dashboard unique identifier (uid).
**Required permissions**
See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation.
See note in the [introduction](#public-dashboard-api) for an explanation.
| Action | Scope |
| ----------------- | -------------------------------- |
@@ -247,7 +247,7 @@ Will delete the public dashboard given the specified unique identifier (uid).
**Required permissions**
See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation.
See note in the [introduction](#public-dashboard-api) for an explanation.
| Action | Scope |
| ------------------------- | -------------------------------- |
@@ -274,7 +274,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#public-dashboard-api" >}}) for an explanation.
See note in the [introduction](#public-dashboard-api) for an explanation.
| Action | Scope |
| ----------------- | -------------------------------- |
@@ -317,3 +317,8 @@ Content-Type: application/json
"perPage": 2
}
```
{{% docs/reference %}}
[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
{{% /docs/reference %}}
docs/sources/developers/http_api/user.md
+13 -8
View File
@@ -24,7 +24,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]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) 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][] for more information.
## Search Users
@@ -32,7 +32,7 @@ API Tokens can be used with Organization HTTP API to get users of specific organ
**Required permissions**
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
See note in the [introduction](#user-api) for an explanation.
| Action | Scope |
| ---------- | --------------- |
@@ -89,7 +89,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
See note in the [introduction](#user-api) for an explanation.
| Action | Scope |
| ---------- | --------------- |
@@ -152,7 +152,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
See note in the [introduction](#user-api) for an explanation.
| Action | Scope |
| ---------- | --------------- |
@@ -198,7 +198,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
See note in the [introduction](#user-api) for an explanation.
| Action | Scope |
| ---------- | --------------- |
@@ -253,7 +253,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
See note in the [introduction](#user-api) for an explanation.
| Action | Scope |
| ----------- | --------------- |
@@ -292,7 +292,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
See note in the [introduction](#user-api) for an explanation.
| Action | Scope |
| ---------- | --------------- |
@@ -330,7 +330,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#user-api" >}}) for an explanation.
See note in the [introduction](#user-api) for an explanation.
| Action | Scope |
| ---------- | --------------- |
@@ -683,3 +683,8 @@ Content-Type: application/json
"message": "User auth token revoked"
}
```
{{% docs/reference %}}
[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
{{% /docs/reference %}}