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

docs: update dashboard model, new url structure and api changes in what's new in v5

Browse Source
This commit is contained in:
Marcus Efraimsson
2018-02-05 16:40:49 +01:00
parent b2f62ae19c
commit e86fe0b144
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/sources/guides/whats-new-in-v5.md
View File

@ -111,10 +111,17 @@ in sync with dashboards in Grafana's database. The dashboard provisioner has mul
which makes it possible to star them, use one as the home dashboard, set permissions and other features in Grafana that
expects the dashboards to exist in the database. More info in the [dashboard provisioning docs](/administration/provisioning/#dashboards)
# Dashboard model & API
# Dashboard model, new url structure & API changes
We are introducing a new identifier (`uid`) in the dashboard JSON model. The new identifier will be a 9-12 character long unique id.
We are also changing the route for getting dashboards to use this `uid` instead of the slug that the current route and API are using.
We will keep supporting the old route for backward compatibility. This will make it possible to change the title on dashboards without breaking links.
Sharing dashboards between instances becomes much easier since the uid is unique (unique enough). This might seem like a small change,
but we are incredibly excited about it since it will make it much easier to manage, collaborate and navigate between dashboards.
We are introducing a new unique identifier (`uid`) in the dashboard JSON model. It's automatically
generated if not provided when creating a dashboard and will have a length of 9-12 characters.
The unique identifier allows having consistent URL's for accessing dashboards and sharing them
between instances. The new routes and API's for accessing dashboards will use the `uid` instead
of the `slug`. We'll keep supporting the old routes for accessing dashboards for backward
compatibility, but please note that we'll deprecate the old slug-based routes in the future.
This means that changing the title of dashboards will not break any bookmarked links.
Sharing dashboards between instances becomes much easier since the `uid` is unique (unique enough).
This might seem like a small change, but we are incredibly excited about it since it will make it
much easier to manage, collaborate and navigate between dashboards.