Add FolderID to SetDashboard api request (#67)

* Add FolderID to SetDashboard api request

Signed-off-by: Masudur Rahman <[email protected]>

* Update dashboard api

Signed-off-by: Masudur Rahman <[email protected]>

* Update rest-dashboard.go


Signed-off-by: Masudur Rahman <[email protected]>

Author: masudur-rahman

cmd/import-dashboards/main.go

@@ -66,7 +66,11 @@ func main() {
 				continue
 			}
 			c.DeleteDashboard(board.UpdateSlug())
-			_, err := c.SetDashboard(board, false)
+			params := sdk.SetDashboardParams{
+				FolderID:  sdk.DefaultFolderId,
+				Overwrite: false,
+			}
+			_, err := c.SetDashboard(board, params)
 			if err != nil {
 				log.Printf("error on importing dashboard %s", board.Title)
 				continue

rest-dashboard.go

@@ -30,6 +30,10 @@ import (
 	"github.com/pkg/errors"
 )
 
+// DefaultFolderId is the id of the general folder
+// that is pre-created and cannot be removed.
+const DefaultFolderId = 0
+
 // BoardProperties keeps metadata of a dashboard.
 type BoardProperties struct {
 	IsStarred  bool      `json:"isStarred,omitempty"`
@@ -193,6 +197,13 @@ func (r *Client) SearchDashboards(query string, starred bool, tags ...string) ([
 	return boards, err
 }
 
+// SetDashboardParams contains the extra parameteres
+// that affects where and how the dashboard will be stored
+type SetDashboardParams struct {
+	FolderID  int
+	Overwrite bool
+}
+
 // SetDashboard updates existing dashboard or creates a new one.
 // Set dasboard ID to nil to create a new dashboard.
 // Set overwrite to true if you want to overwrite existing dashboard with
@@ -201,11 +212,12 @@ func (r *Client) SearchDashboards(query string, starred bool, tags ...string) ([
 // may be only loaded with HTTP API but not created or updated.
 //
 // Reflects POST /api/dashboards/db API call.
-func (r *Client) SetDashboard(board Board, overwrite bool) (StatusMessage, error) {
+func (r *Client) SetDashboard(board Board, params SetDashboardParams) (StatusMessage, error) {
 	var (
 		isBoardFromDB bool
 		newBoard      struct {
 			Dashboard Board `json:"dashboard"`
+			FolderID  int   `json:"folderId"`
 			Overwrite bool  `json:"overwrite"`
 		}
 		raw  []byte
@@ -217,8 +229,9 @@ func (r *Client) SetDashboard(board Board, overwrite bool) (StatusMessage, error
 		return StatusMessage{}, errors.New("only database dashboard (with 'db/' prefix in a slug) can be set")
 	}
 	newBoard.Dashboard = board
-	newBoard.Overwrite = overwrite
-	if !overwrite {
+	newBoard.FolderID = params.FolderID
+	newBoard.Overwrite = params.Overwrite
+	if !params.Overwrite {
 		newBoard.Dashboard.ID = 0
 	}
 	if raw, err = json.Marshal(newBoard); err != nil {

rest-dashboard_integration_test.go

@@ -26,7 +26,11 @@ func Test_Dashboard_CRUD(t *testing.T) {
 	}
 
 	client.DeleteDashboard(board.UpdateSlug())
-	if _, err = client.SetDashboard(board, false); err != nil {
+	params := sdk.SetDashboardParams{
+		FolderID:  sdk.DefaultFolderId,
+		Overwrite: false,
+	}
+	if _, err = client.SetDashboard(board, params); err != nil {
 		t.Fatal(err)
 	}