Deprecate UID funcs (#45)

* update deprecation comments, add Uid functions

* remove unncessary log

* update deprecation string

* update test to use Uid

* update godoc comments

Author: tonglil

dashboard.go

@@ -6,9 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"io/ioutil"
-	"log"
 	"net/url"
-	"os"
 )
 
 type DashboardMeta struct {
@@ -48,7 +46,8 @@ type Dashboard struct {
 	Overwrite bool                   `json:"overwrite"`
 }
 
-// Deprecated: use NewDashboard instead
+// SaveDashboard.
+// Deprecated: Use NewDashboard instead.
 func (c *Client) SaveDashboard(model map[string]interface{}, overwrite bool) (*DashboardSaveResponse, error) {
 	wrapper := map[string]interface{}{
 		"dashboard": model,
@@ -137,11 +136,18 @@ func (c *Client) Dashboards() ([]DashboardSearchResponse, error) {
 	return dashboards, err
 }
 
-// Deprecated: Starting from Grafana v5.0. Please update to use DashboardByUID instead.
+func (c *Client) DashboardByUid(uid string) (*Dashboard, error) {
+	return c.dashboard(fmt.Sprintf("/api/dashboards/uid/%s", uid))
+}
+
+// Dashboard will be removed.
+// Deprecated: Starting from Grafana v5.0. Use DashboardByUid instead.
 func (c *Client) Dashboard(slug string) (*Dashboard, error) {
 	return c.dashboard(fmt.Sprintf("/api/dashboards/db/%s", slug))
 }
 
+// DashboardByUID will be removed.
+// Deprecated: Interface typo. Use DashboardByUid instead.
 func (c *Client) DashboardByUID(uid string) (*Dashboard, error) {
 	return c.dashboard(fmt.Sprintf("/api/dashboards/uid/%s", uid))
 }
@@ -168,17 +174,22 @@ func (c *Client) dashboard(path string) (*Dashboard, error) {
 	result := &Dashboard{}
 	err = json.Unmarshal(data, &result)
 	result.Folder = result.Meta.Folder
-	if os.Getenv("GF_LOG") != "" {
-		log.Printf("got back dashboard response  %s", data)
-	}
+
 	return result, err
 }
 
-// Deprecated: Starting from Grafana v5.0. Please update to use DeleteDashboardByUID instead.
+func (c *Client) DeleteDashboardByUid(uid string) error {
+	return c.deleteDashboard(fmt.Sprintf("/api/dashboards/uid/%s", uid))
+}
+
+// DeleteDashboard will be removed.
+// Deprecated: Starting from Grafana v5.0. Use DeleteDashboardByUid instead.
 func (c *Client) DeleteDashboard(slug string) error {
 	return c.deleteDashboard(fmt.Sprintf("/api/dashboards/db/%s", slug))
 }
 
+// DeleteDashboardByUID will be removed.
+// Deprecated: Interface typo. Use DeleteDashboardByUid instead.
 func (c *Client) DeleteDashboardByUID(uid string) error {
 	return c.deleteDashboard(fmt.Sprintf("/api/dashboards/uid/%s", uid))
 }

dashboard_test.go

@@ -89,7 +89,7 @@ func TestDashboardGet(t *testing.T) {
 		t.Errorf("Invalid uid - %s, Expected %s", uid, "cIBgcSjkk")
 	}
 
-	resp, err = client.DashboardByUID("cIBgcSjkk")
+	resp, err = client.DashboardByUid("cIBgcSjkk")
 	if err != nil {
 		t.Error(err)
 	}
@@ -105,7 +105,7 @@ func TestDashboardGet(t *testing.T) {
 			t.Errorf("%d not detected", code)
 		}
 
-		_, err = client.DashboardByUID("cIBgcSjkk")
+		_, err = client.DashboardByUid("cIBgcSjkk")
 		if err == nil {
 			t.Errorf("%d not detected", code)
 		}
@@ -121,7 +121,7 @@ func TestDashboardDelete(t *testing.T) {
 		t.Error(err)
 	}
 
-	err = client.DeleteDashboardByUID("cIBgcSjkk")
+	err = client.DeleteDashboardByUid("cIBgcSjkk")
 	if err != nil {
 		t.Error(err)
 	}
@@ -134,7 +134,7 @@ func TestDashboardDelete(t *testing.T) {
 			t.Errorf("%d not detected", code)
 		}
 
-		err = client.DeleteDashboardByUID("cIBgcSjkk")
+		err = client.DeleteDashboardByUid("cIBgcSjkk")
 		if err == nil {
 			t.Errorf("%d not detected", code)
 		}

datasource.go

@@ -17,15 +17,15 @@ type DataSource struct {
 
 	Database string `json:"database,omitempty"`
 	User     string `json:"user,omitempty"`
-	// Deprecated in favor of secureJsonData.password
+	// Deprecated: Use secureJsonData.password instead.
 	Password string `json:"password,omitempty"`
 
 	OrgId     int64 `json:"orgId,omitempty"`
 	IsDefault bool  `json:"isDefault"`
 
 	BasicAuth     bool   `json:"basicAuth"`
 	BasicAuthUser string `json:"basicAuthUser,omitempty"`
-	// Deprecated in favor of secureJsonData.basicAuthPassword
+	// Deprecated: Use secureJsonData.basicAuthPassword instead.
 	BasicAuthPassword string `json:"basicAuthPassword,omitempty"`
 
 	JSONData       JSONData       `json:"jsonData,omitempty"`