add message to dashboard creation (#306)

* add message to dashboard creation

* fix tab spacing

* Update client library and generate docs

* Ignore message in import test

Co-authored-by: Justin Mai <[email protected]>
Co-authored-by: Julien Duchesne <[email protected]>

Author: justinTM

docs/resources/dashboard.md

@@ -33,6 +33,7 @@ resource "grafana_dashboard" "metrics" {
 
 - **folder** (Number) The id of the folder to save the dashboard in.
 - **id** (String) The ID of this resource.
+- **message** (String) Set a commit message for the version history.
 - **overwrite** (Boolean) Set to true if you want to overwrite existing dashboard with newer version, same dashboard title in folder or same dashboard uid.
 
 ### Read-Only

examples/resources/grafana_dashboard/_acc_basic.tf

@@ -11,4 +11,5 @@ resource "grafana_dashboard" "test" {
   "version": 34
 }
 EOD
+  message     = "inital commit."
 }

go.mod

@@ -3,7 +3,7 @@ module github.com/grafana/terraform-provider-grafana
 go 1.16
 
 require (
-	github.com/grafana/grafana-api-golang-client v0.1.0
+	github.com/grafana/grafana-api-golang-client v0.1.1
 	github.com/grafana/synthetic-monitoring-agent v0.3.3
 	github.com/grafana/synthetic-monitoring-api-go-client v0.3.0
 	github.com/hashicorp/go-cleanhttp v0.5.2

go.sum

@@ -452,8 +452,8 @@ github.com/gorilla/context v1.1.1/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51
 github.com/gorilla/mux v1.6.2/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs=
 github.com/gorilla/mux v1.7.3/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs=
 github.com/gorilla/websocket v0.0.0-20170926233335-4201258b820c/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
-github.com/grafana/grafana-api-golang-client v0.1.0 h1:z2PL/r+HjnaXEakVT9n5v/43vVYvl0rXty/KpGmAsoE=
-github.com/grafana/grafana-api-golang-client v0.1.0/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
+github.com/grafana/grafana-api-golang-client v0.1.1 h1:qS/i3dxITGyDRqYuBLk679SjpSwPQ3VZyxuTsKq1Bas=
+github.com/grafana/grafana-api-golang-client v0.1.1/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
 github.com/grafana/synthetic-monitoring-agent v0.3.0/go.mod h1:P8WTBnw3SIZW5Nm5obOlSKvD887IxAfbrJkSnoZyIlA=
 github.com/grafana/synthetic-monitoring-agent v0.3.3 h1:/MM1vm/BwnbwQ2/aEwKbEpf01O4O3GhrcOofY4A0V9Q=
 github.com/grafana/synthetic-monitoring-agent v0.3.3/go.mod h1:qyo27gOTdj8K/dKkd+/SJ0M0zlnCV7t9nwVK+iLkVrk=

grafana/resource_dashboard.go

@@ -74,6 +74,11 @@ Manages Grafana dashboards.
 				Optional:    true,
 				Description: "Set to true if you want to overwrite existing dashboard with newer version, same dashboard title in folder or same dashboard uid.",
 			},
+			"message": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "Set a commit message for the version history.",
+			},
 		},
 		SchemaVersion: 1,
 		StateUpgraders: []schema.StateUpgrader{
@@ -255,6 +260,7 @@ func makeDashboard(d *schema.ResourceData) gapi.Dashboard {
 	dashboard := gapi.Dashboard{
 		Folder:    int64(d.Get("folder").(int)),
 		Overwrite: d.Get("overwrite").(bool),
+		Message:   d.Get("message").(string),
 	}
 	configJSON := d.Get("config_json").(string)
 	dashboardJSON, err := unmarshalDashboardConfigJSON(configJSON)

grafana/resource_dashboard_test.go

@@ -62,9 +62,10 @@ func TestAccDashboard_basic(t *testing.T) {
 			},
 			{
 				// Importing matches the state of the previous step.
-				ResourceName:      "grafana_dashboard.test",
-				ImportState:       true,
-				ImportStateVerify: true,
+				ResourceName:            "grafana_dashboard.test",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"message"},
 			},
 		},
 	})