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

2025-06-27 11:28:14 +01:00
parent 7307a2bdbe
commit a113d04fb9
161 changed files with 721 additions and 721 deletions
@@ -203,9 +203,9 @@ Content-Type: application/json
 Content-Type: application/json

 ```
-
+
 ## Password for User
-
+
 `PUT /api/admin/users/:id/password`

 Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/<GRAFANA_VERSION>/http_api/admin/#admin-api) for an explanation.
@@ -21,18 +21,18 @@ title: 'Authentication HTTP API '

 The Authentication HTTP API is used to manage API keys.

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 Grafana recommends using service accounts instead of API keys. For more information, refer to [Grafana service account API reference](../serviceaccount/).
-{{% /admonition %}}
+{{< /admonition >}}

 > If you are running Grafana Enterprise, for some endpoints you would need to have relevant permissions. Refer to [Role-based access control permissions](../../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.

 ## List API keys

-{{% admonition type="warning" %}}
+{{< admonition type="warning" >}}
 This endpoint is deprecated.

-{{% /admonition %}}
+{{< /admonition >}}

 `GET /api/auth/keys`

@@ -80,10 +80,10 @@ Content-Type: application/json

 ```http
 HTTP/1.1 410
-Content-Type: application/json
+Content-Type: application/json

 ```
-
+
 ## Delete API Key

 {{< admonition type="warning" >}}
@@ -100,11 +100,11 @@ Content-Type: application/json

 | Action           | Scope      |
 | ---------------- | ---------- |
-| `apikeys:delete` | apikeys:\* |
+| `apikeys:delete` | apikeys:\* |

 **Example Request**:

-```http
+```http
 DELETE /api/auth/keys/3 HTTP/1.1
 Accept: application/json
 Content-Type: application/json
@@ -262,9 +262,9 @@ Status Codes:
 | `dashboards:create` | <ul><li>`folders:*`</li><li>`folders:uid:*`</li></ul> |
 { .no-spacing-list }
 <!-- prettier-ignore-end -->
-
+
 **Example Request**:
-
+
 ```http
 PATCH /api/dashboards/uid/cIBgcSjkk/trash HTTP/1.1
 Accept: application/json
@@ -312,9 +312,9 @@ Status Codes:
 ```

 ## Tags for Dashboard
-
+
 `GET /api/dashboards/tags`
-
+
 Get all tags of dashboards

 **Example Request**:
@@ -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

@@ -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
 ```

 **Example Response**:
-
+
 ```http
-HTTP/1.1 200
+HTTP/1.1 200
 Content-Type: application/json

 ```
@@ -351,9 +351,9 @@ Content-Type: application/json
 Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
 ```

-**Example Response**:
+**Example Response**:

-```http
+```http
 HTTP/1.1 200
 Content-Type: application/json

@@ -440,9 +440,9 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
 ## Check data source health by id

 > **Warning:** This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source health check API](#check-data-source-health).
-
+
 `GET /api/datasources/:datasourceId/health`
-
+
 Makes a call to the health endpoint of data source identified by the given `datasourceId`. This is not mandatory - every plugin author has to <a href="https://grafana.com/tutorials/build-a-data-source-backend-plugin/#add-support-for-health-checks" target="_blank">implement support for health checks</a> in their plugin themselves.

 ### Examples
@@ -519,9 +519,9 @@ Content-Type: application/json
 ```

 ## Fetch data source resources
-
+
 `GET /api/datasources/uid/:uid/resources/*`
-
+
 Makes a call to the resources endpoint of data source identified by the given `uid`.

 ### Examples
@@ -603,17 +603,17 @@ Content-Type: application/json
            ]
          },
          "data": {
-            "values": [
+            "values": [
              [1644488152084, 1644488212084, 1644488272084, 1644488332084, 1644488392084, 1644488452084],
-              [1, 20, 90, 30, 5, 0]
+              [1, 20, 90, 30, 5, 0]
            ]
          }
        }
      ]
    }
-  }
+  }
 }
-```
+```

 #### Status codes

@@ -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**:

@@ -21,9 +21,9 @@ The Group Attribute Sync API allows you to configure [group attribute sync featu

 > **Note:** Available in [Grafana Enterprise](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/introduction/grafana-enterprise) and [Grafana Cloud](https://grafana.com/docs/grafana-cloud/)

-{{% admonition type="note" %}}
+{{< admonition type="note" >}}
 This feature is currently in [private preview](https://grafana.com/docs/release-life-cycle/#private-preview) and behind the `groupAttributeSync` feature toggle. Please contact support to have this feature enabled.
-{{% /admonition %}}
+{{< /admonition >}}

 ## List group mappings

@@ -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**:

@@ -75,9 +75,9 @@ Status codes:
 ## Add license

 {{< admonition type="note" >}}
-Available in Grafana Enterprise v7.4+.
+Available in Grafana Enterprise v7.4+.
 {{< /admonition >}}
-
+
 `POST /api/licensing/token`

 Applies a license to a Grafana instance.
@@ -151,9 +151,9 @@ Status Codes:

 {}
 ```
-
+
 **Example response:**
-
+
 ```http
 HTTP/1.1 200 OK
 Content-Type: application/json
@@ -212,9 +212,9 @@ Status Codes:
 Content-Type: application/json
 Content-Length: 2

-```
+```

-Status codes:
+Status codes:

 - **202** - Accepted, license removed or did not exist.
 - **401** - Unauthorized
@@ -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

@@ -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**:

@@ -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.
 - **403** – Access Denied

 ## Delete SSO Settings
-
+
 `DELETE /api/v1/sso-settings/:provider`

 Deletes an existing SSO Settings entry for a provider.
-
+
 **Required permissions**

 See note in the [introduction](#sso-settings) for an explanation.