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

remove feature toggle + add libraryPaneldefinition (#34488)

Browse Source 
* remove feature toggle + add libraryPaneldefinition

* update doc

* update comments

* Apply suggestions from code review

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* fix typo

* remove post trim

* update api doc

* solve comments and retrigger the test

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
ying-jeanne
2021-05-27 17:14:58 +08:00
committed by GitHub
parent dbef103fb9
commit c59a2e1bcf
8 changed files with 109 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
docs/sources/http_api/dashboard.md
View File

@ -440,6 +440,100 @@ Content-Type: application/json
## Dashboard Search
See [Folder/Dashboard Search API]({{< relref "folder_dashboard_search.md" >}}).
## Remove default values in dashboard
`POST /api/dashboards/trim`
Will remove default values from input dashboard JSON.
**Example Request for trimming dashboard JSON**:
```http
POST /api/dashboards/uid/trim HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"meta": {
"isStarred": false,
"url": "/d/cIBgcSjkk/production-overview",
"folderId": 2,
"folderUid": "l3KqBxCMz",
"slug": "production-overview"
},
"dashboard": {
"id": 112,
"panels": [
{
"datasource": null,
"description": "",
"gridPos": {
"h": 9,
"w": 12,
"x": 0,
"y": 0
},
"id": 2,
"options": {
"feedUrl": "https://grafana.com/blog/news.xml",
"showImage": true
},
"pluginVersion": "8.1.0-pre",
"title": "Panel Title",
"type": "news"
}
],
"title": "test dashboard",
"uid": "9lzdzI3Mz",
"version": 2
}
}
```
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
{
"meta": {
"folderId": 2,
"folderUid": "l3KqBxCMz",
"isStarred": false,
"slug": "production-overview",
"url": "/d/cIBgcSjkk/production-overview"
},
"dashboard": {
"id": 112,
"panels": [
{
"gridPos": {},
"id": 2,
"options": {
"feedUrl": "https://grafana.com/blog/news.xml",
"showImage": true
},
"pluginVersion": "8.1.0-pre",
"title": "Panel Title",
"type": "news"
}
],
"title": "test dashboard",
"uid": "9lzdzI3Mz",
"version": 2
}
}
```
Status Codes:
- **200** – Trimmed
- **400** – Errors (invalid json, missing or invalid fields, etc)
- **401** – Unauthorized
- **403** – Access denied
## Deprecated resources
Please note that these resource have been deprecated and will be removed in a future release.