opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-31 18:32:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Browse Dashboards: Update docs to remove reference to General folder (#74528)

Browse Source 
* update documentation to remove mention of General folder

* update swagger-tags
This commit is contained in:
Ashley Harrison
2023-09-08 03:57:16 +01:00
committed by GitHub
parent 0df3647367
commit a7425f875e
9 changed files with 11 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/developers/http_api/dashboard.md
View File

@ -35,7 +35,7 @@ The uid can have a maximum length of 40 characters.
`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**

5
docs/sources/developers/http_api/folder.md
View File

@ -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.
## 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 /api/folders`

4
docs/sources/developers/http_api/folder_dashboard_search.md
View File

@ -39,7 +39,7 @@ Query parameters:
- **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+.
**Example request for retrieving folders and dashboards of the general folder**:
**Example request for retrieving folders and dashboards at the root level**:
```http
GET /api/search?folderIds=0&query=&starred=false HTTP/1.1
@ -48,7 +48,7 @@ Content-Type: application/json
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/1.1 200

4
docs/sources/developers/http_api/library_element.md
View File

@ -282,7 +282,7 @@ Creates a new library element.
JSON Body schema:
- `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.
- `model`: The JSON model for the library element.
- `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:
- `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.
- `model`: The JSON model for the library element.
- `kind`: Kind of element to create. Use `1` for library panels or `2` for library variables.