mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Browse Dashboards: Update docs to remove reference to General folder (#74528)
* update documentation to remove mention of General folder * update swagger-tags
This commit is contained in:
@@ -343,7 +343,7 @@ providers:
|
|||||||
|
|
||||||
When Grafana starts, it will update/insert all dashboards available in the configured path. Then later on poll that path every **updateIntervalSeconds** and look for updated json files and update/insert those into the database.
|
When Grafana starts, it will update/insert all dashboards available in the configured path. Then later on poll that path every **updateIntervalSeconds** and look for updated json files and update/insert those into the database.
|
||||||
|
|
||||||
> **Note:** Dashboards are provisioned to the General folder if the `folder` option is missing or empty.
|
> **Note:** Dashboards are provisioned to the root level if the `folder` option is missing or empty.
|
||||||
|
|
||||||
#### Making changes to a provisioned dashboard
|
#### Making changes to a provisioned dashboard
|
||||||
|
|
||||||
@@ -413,7 +413,7 @@ providers:
|
|||||||
{{% /admonition %}}
|
{{% /admonition %}}
|
||||||
|
|
||||||
{{% admonition type="note" %}}
|
{{% admonition type="note" %}}
|
||||||
To provision dashboards to the General folder, store them in the root of your `path`.
|
To provision dashboards to the root level, store them in the root of your `path`.
|
||||||
{{% /admonition %}}
|
{{% /admonition %}}
|
||||||
|
|
||||||
## Alerting
|
## Alerting
|
||||||
|
|||||||
@@ -188,6 +188,6 @@ To create a library panel from the **Share Panel** dialog:
|
|||||||
|
|
||||||
1. Click **Library panel**.
|
1. Click **Library panel**.
|
||||||
1. In **Library panel name**, enter the name.
|
1. In **Library panel name**, enter the name.
|
||||||
1. In **Save in folder**, select the folder in which to save the library panel. By default, the General folder is selected.
|
1. In **Save in folder**, select the folder in which to save the library panel. By default, the root level is selected.
|
||||||
1. Click **Create library panel** to save your changes.
|
1. Click **Create library panel** to save your changes.
|
||||||
1. Save the dashboard.
|
1. Save the dashboard.
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ The uid can have a maximum length of 40 characters.
|
|||||||
|
|
||||||
`POST /api/dashboards/db`
|
`POST /api/dashboards/db`
|
||||||
|
|
||||||
Creates a new dashboard or updates an existing dashboard. When updating existing dashboards, if you do not define the `folderId` or the `folderUid` property, then the dashboard(s) are moved to the General folder. (You need to define only one property, not both).
|
Creates a new dashboard or updates an existing dashboard. When updating existing dashboards, if you do not define the `folderId` or the `folderUid` property, then the dashboard(s) are moved to the root level. (You need to define only one property, not both).
|
||||||
|
|
||||||
**Required permissions**
|
**Required permissions**
|
||||||
|
|
||||||
|
|||||||
@@ -28,11 +28,6 @@ The unique identifier (uid) of a folder can be used for uniquely identify folder
|
|||||||
|
|
||||||
The uid can have a maximum length of 40 characters.
|
The uid can have a maximum length of 40 characters.
|
||||||
|
|
||||||
## A note about the General folder
|
|
||||||
|
|
||||||
The General folder (id=0) is special and is not part of the Folder API which means
|
|
||||||
that you cannot use this API for retrieving information about the General folder.
|
|
||||||
|
|
||||||
## Get all folders
|
## Get all folders
|
||||||
|
|
||||||
`GET /api/folders`
|
`GET /api/folders`
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ Query parameters:
|
|||||||
- **limit** – Limit the number of returned results (max is 5000; default is 1000)
|
- **limit** – Limit the number of returned results (max is 5000; default is 1000)
|
||||||
- **page** – Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+.
|
- **page** – Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+.
|
||||||
|
|
||||||
**Example request for retrieving folders and dashboards of the general folder**:
|
**Example request for retrieving folders and dashboards at the root level**:
|
||||||
|
|
||||||
```http
|
```http
|
||||||
GET /api/search?folderIds=0&query=&starred=false HTTP/1.1
|
GET /api/search?folderIds=0&query=&starred=false HTTP/1.1
|
||||||
@@ -48,7 +48,7 @@ Content-Type: application/json
|
|||||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||||
```
|
```
|
||||||
|
|
||||||
**Example response for retrieving folders and dashboards of the general folder**:
|
**Example response for retrieving folders and dashboards at the root level**:
|
||||||
|
|
||||||
```http
|
```http
|
||||||
HTTP/1.1 200
|
HTTP/1.1 200
|
||||||
|
|||||||
@@ -282,7 +282,7 @@ Creates a new library element.
|
|||||||
JSON Body schema:
|
JSON Body schema:
|
||||||
|
|
||||||
- `folderId`: ID of the folder where the library element is stored. It is deprecated since Grafana v9
|
- `folderId`: ID of the folder where the library element is stored. It is deprecated since Grafana v9
|
||||||
- `folderUid`: Optional, the UID of the folder where the library element is stored, empty string when it is General folder
|
- `folderUid`: Optional, the UID of the folder where the library element is stored, empty string when it is at the root level.
|
||||||
- `name`: Optional, the name of the library element.
|
- `name`: Optional, the name of the library element.
|
||||||
- `model`: The JSON model for the library element.
|
- `model`: The JSON model for the library element.
|
||||||
- `kind`: Kind of element to create, Use `1` for library panels or `2` for library variables.
|
- `kind`: Kind of element to create, Use `1` for library panels or `2` for library variables.
|
||||||
@@ -361,7 +361,7 @@ Updates an existing library element identified by uid.
|
|||||||
JSON Body schema:
|
JSON Body schema:
|
||||||
|
|
||||||
- `folderId`: ID of the folder where the library element is stored. It is deprecated since Grafana v9
|
- `folderId`: ID of the folder where the library element is stored. It is deprecated since Grafana v9
|
||||||
- `folderUid`: UID of the folder where the library element is stored, empty string when it is General folder.
|
- `folderUid`: UID of the folder where the library element is stored, empty string when it is at the root level.
|
||||||
- `name`: Name of the library element.
|
- `name`: Name of the library element.
|
||||||
- `model`: The JSON model for the library element.
|
- `model`: The JSON model for the library element.
|
||||||
- `kind`: Kind of element to create. Use `1` for library panels or `2` for library variables.
|
- `kind`: Kind of element to create. Use `1` for library panels or `2` for library variables.
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "folders",
|
"name": "folders",
|
||||||
"description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.\n\nThe General folder (id=0) is special and is not part of the Folder API which means that you cannot use this API for retrieving information about the General folder."
|
"description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "folder_permissions",
|
"name": "folder_permissions",
|
||||||
|
|||||||
@@ -21519,7 +21519,7 @@
|
|||||||
"name": "datasources"
|
"name": "datasources"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.\n\nThe General folder (id=0) is special and is not part of the Folder API which means that you cannot use this API for retrieving information about the General folder.",
|
"description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.",
|
||||||
"name": "folders"
|
"name": "folders"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -22979,7 +22979,7 @@
|
|||||||
"name": "datasources"
|
"name": "datasources"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.\n\nThe General folder (id=0) is special and is not part of the Folder API which means that you cannot use this API for retrieving information about the General folder.",
|
"description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.",
|
||||||
"name": "folders"
|
"name": "folders"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user