From e86fe0b1444bb0ec33a952be1f14c81dacc4bcad Mon Sep 17 00:00:00 2001 From: Marcus Efraimsson Date: Mon, 5 Feb 2018 16:40:49 +0100 Subject: [PATCH] docs: update dashboard model, new url structure and api changes in what's new in v5 --- docs/sources/guides/whats-new-in-v5.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/sources/guides/whats-new-in-v5.md b/docs/sources/guides/whats-new-in-v5.md index 0cda207d650..6c70682d3f6 100644 --- a/docs/sources/guides/whats-new-in-v5.md +++ b/docs/sources/guides/whats-new-in-v5.md @@ -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.