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

Fix all the old usage of admonition syntax (#107017)

Browse Source
This commit is contained in:
Jack Baldry
2025-06-24 09:23:29 +01:00
committed by GitHub
parent 623302d055
commit ff2ac27301
142 changed files with 543 additions and 543 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/admin.md
+2 -2
View File
@@ -203,9 +203,9 @@ Content-Type: application/json
`PUT /api/admin/settings`
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Available in Grafana Enterprise v8.0+.
{{% /admonition %}}
{{< /admonition >}}
Updates / removes and reloads database settings. You must provide either `updates`, `removals` or both.
docs/sources/developers/http_api/dashboard_public.md
+2 -2
View File
@@ -24,11 +24,11 @@ refs:
# Shared Dashboards API
{{% admonition type="note" %}}
{{< 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](ref:role-based-access-control-permissions) for more information.
{{% /admonition %}}
{{< /admonition >}}
## Create a shared dashboard
docs/sources/developers/http_api/data_source.md
+20 -20
View File
@@ -25,9 +25,9 @@ title: Data source HTTP API
`GET /api/datasources`
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
This API currently doesn't handle pagination. The default maximum number of data sources returned is 5000. You can change this value in the default.ini file.
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**
@@ -84,9 +84,9 @@ Content-Type: application/json
`GET /api/datasources/:datasourceId`
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [API for getting a single data source by UID](#get-a-single-data-source-by-uid) or to the [API for getting a single data source by its name](#get-a-single-data-source-by-name).
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**
@@ -351,9 +351,9 @@ Content-Type: application/json
}
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
By defining `password` and `basicAuthPassword` under `secureJsonData` Grafana encrypts them securely as an encrypted blob in the database. The response then lists the encrypted fields under `secureJsonFields`.
{{% /admonition %}}
{{< /admonition >}}
**Example Graphite Request with basic auth enabled**:
@@ -440,9 +440,9 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
`PUT /api/datasources/:datasourceId`
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source update API](#update-an-existing-data-source).
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**
@@ -519,9 +519,9 @@ Content-Type: application/json
}
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Similar to [creating a data source](#create-a-data-source), `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response.
{{% /admonition %}}
{{< /admonition >}}
## Update an existing data source
@@ -603,17 +603,17 @@ Content-Type: application/json
}
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Similar to [creating a data source](#create-a-data-source), `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response.
{{% /admonition %}}
{{< /admonition >}}
## Delete an existing data source by id
`DELETE /api/datasources/:datasourceId`
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [API for deleting an existing data source by UID](#delete-an-existing-data-source-by-uid) or to the [API for deleting an existing data source by its name](#delete-an-existing-data-source-by-name)
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**
@@ -715,9 +715,9 @@ Content-Type: application/json
## Data source proxy calls by id
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source API for proxying requests](#data-source-proxy-calls).
{{% /admonition %}}
{{< /admonition >}}
`GET /api/datasources/proxy/:datasourceId/*`
@@ -791,9 +791,9 @@ Content-Type: application/json
## Fetch data source resources by id
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source resources API](#fetch-data-source-resources).
{{% /admonition %}}
{{< /admonition >}}
`GET /api/datasources/:datasourceId/resources/*`
@@ -893,9 +893,9 @@ Queries a data source having a backend implementation.
`POST /api/ds/query`
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Grafana's built-in data sources usually have a backend implementation.
{{% /admonition %}}
{{< /admonition >}}
**Example request for the Test data source**:
docs/sources/developers/http_api/library_element.md
+2 -2
View File
@@ -441,9 +441,9 @@ Status Codes:
Deletes an existing library element as specified by the UID. This operation cannot be reverted.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
You cannot delete a library element that is connected. This operation cannot be reverted.
{{% /admonition %}}
{{< /admonition >}}
**Example Request**:
docs/sources/developers/http_api/licensing.md
+6 -6
View File
@@ -75,9 +75,9 @@ Status codes:
## Add license
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Available in Grafana Enterprise v7.4+.
{{% /admonition %}}
{{< /admonition >}}
`POST /api/licensing/token`
@@ -151,9 +151,9 @@ Status Codes:
## Manually force license refresh
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Available in Grafana Enterprise v7.4+.
{{% /admonition %}}
{{< /admonition >}}
`POST /api/licensing/token/renew`
@@ -212,9 +212,9 @@ Status Codes:
## Remove license from database
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Available in Grafana Enterprise v7.4+.
{{% /admonition %}}
{{< /admonition >}}
`DELETE /api/licensing/token`
docs/sources/developers/http_api/query_and_resource_caching.md
+2 -2
View File
@@ -23,9 +23,9 @@ title: Query and Resource Caching HTTP API
# Query and resource caching API
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
{{% /admonition %}}
{{< /admonition >}}
## Enable caching for a data source
docs/sources/developers/http_api/snapshot.md
+2 -2
View File
@@ -69,9 +69,9 @@ JSON Body schema:
- **key** - Optional. Define the unique key. Required if **external** is `true`.
- **deleteKey** - Optional. Unique key used to delete the snapshot. It is different from the **key** so that only the creator can delete the snapshot. Required if **external** is `true`.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
When creating a snapshot using the API, you have to provide the full dashboard payload including the snapshot data. This endpoint is designed for the Grafana UI.
{{% /admonition %}}
{{< /admonition >}}
**Example Response**:
docs/sources/developers/http_api/sso-settings.md
+4 -4
View File
@@ -22,9 +22,9 @@ title: SSO Settings API
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Available since Grafana 11. SAML support is in public preview behind the `ssoSettingsSAML` feature flag.
{{% /admonition %}}
{{< /admonition >}}
The API can be used to create, update, delete, get, and list SSO Settings for OAuth2 and SAML.
@@ -167,11 +167,11 @@ Grafana verifies whether the given settings are allowed and valid.
If they are, then Grafana stores the settings in the database and reloads
Grafana services with no need to restart the instance.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you run Grafana in high availability mode, configuration changes
may not get applied to all Grafana instances immediately. You may need
to wait a few minutes for the configuration to propagate to all Grafana instances.
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**