Merge pull request DataDog#663 from DataDog/samantha/api_dash_read_only

technovangelist · technovangelist · commit e3d56aad13a9 · 2016-03-21T13:51:06.000-04:00
[api] document dashboard read_only parameter
diff --git a/code_snippets/api-dashboard-create.py b/code_snippets/api-dashboard-create.py
@@ -26,4 +26,6 @@
     "default": "host:my-host"
 }]
 
-api.Timeboard.create(title=title, description=description, graphs=graphs, template_variables=template_variables)
+read_only = True
+
+api.Timeboard.create(title=title, description=description, graphs=graphs, template_variables=template_variables, read_only=read_only)
diff --git a/code_snippets/api-dashboard-create.rb b/code_snippets/api-dashboard-create.rb
@@ -24,5 +24,6 @@
 	"prefix" => "host",
 	"default" => "host:my-host"
 }]
+read_only=true
 
-dog.create_dashboard(title, description, graphs, template_variables)
+dog.create_dashboard(title, description, graphs, template_variables, read_only)
diff --git a/code_snippets/api-dashboard-create.sh b/code_snippets/api-dashboard-create.sh
@@ -19,6 +19,7 @@ curl  -X POST -H "Content-type: application/json" \
           "name": "host1",
           "prefix": "host",
           "default": "host:my-host"
-      }]
+      }],
+      "read_only": "True"
     }' \
 "https://app.datadoghq.com/api/v1/dash?api_key=${api_key}&application_key=${app_key}"
diff --git a/code_snippets/api-dashboard-update.py b/code_snippets/api-dashboard-update.py
@@ -24,5 +24,6 @@
 	"prefix": "host",
 	"default": "host:my-host"
 }]
+read_only = True
 
-api.Timeboard.update(4952, title=title, description=description, graphs=graphs, template_variables=template_variables)
+api.Timeboard.update(4952, title=title, description=description, graphs=graphs, template_variables=template_variables, read_only=read_only)
diff --git a/code_snippets/api-dashboard-update.rb b/code_snippets/api-dashboard-update.rb
@@ -23,6 +23,7 @@
 	"name" => "host1",
 	"prefix" => "host",
 	"default" => "host:my-host"
-}]
+}],
+read_only = true
 
-dog.update_dashboard(dash_id, title, description, graphs, template_variables)
+dog.update_dashboard(dash_id, title, description, graphs, template_variables, read_only)
diff --git a/code_snippets/results/result.api-dashboard-create.py b/code_snippets/results/result.api-dashboard-create.py
@@ -1,6 +1,7 @@
 {'dash': {'description': 'An informative timeboard.',
   'created': '2015-12-17T21:29:40.890824+00:00',
   'modified': '2015-12-17T21:29:40.890824+00:00',
+  'read_only': 'True',
   'graphs': [{'definition': {'events': [],
      'requests': [{'q': 'avg:system.mem.free{*}'}],
      'viz': 'timeseries'},
diff --git a/code_snippets/results/result.api-dashboard-create.rb b/code_snippets/results/result.api-dashboard-create.rb
@@ -12,4 +12,5 @@
   "url"=>"/dash/dash/2552",
   "resource"=>"/api/v1/dash/2552",
   "created"=>"2015-12-17T21:29:40.890824+00:00",
-  "modified"=>"2015-12-17T21:29:40.890824+00:00"}]
+  "modified"=>"2015-12-17T21:29:40.890824+00:00",
+  "read_only"=>true}]
diff --git a/code_snippets/results/result.api-dashboard-create.sh b/code_snippets/results/result.api-dashboard-create.sh
@@ -21,4 +21,5 @@
     "url": "/dash/dash/2532",
     "created": "2015-12-17T23:06:06.703087+00:00",
     "modified": "2015-12-17T23:06:06.726234+00:00",
+    "read_only": "true"
 }
diff --git a/code_snippets/results/result.api-dashboard-get-all.py b/code_snippets/results/result.api-dashboard-get-all.py
@@ -9,5 +9,6 @@
   'resource': '/api/v1/dash/2552',
   'title': 'My First Metrics',
   'created': '2015-12-17T21:29:40.890824+00:00',
-  'modified': '2015-12-17T21:39:20.770834+00:00'}
+  'modified': '2015-12-17T21:39:20.770834+00:00',
+  'read_only': True}
 ]
diff --git a/code_snippets/results/result.api-dashboard-get-all.rb b/code_snippets/results/result.api-dashboard-get-all.rb
@@ -11,5 +11,6 @@
      "id"=>"2552",
      "description"=>"And they are marvelous.",
      "created"=>"2015-12-17T20:09:33.890824+00:00",
-     "modified"=>"2015-12-17T20:19:22.770834+00:00"}
+     "modified"=>"2015-12-17T20:19:22.770834+00:00",
+     "read_only"=>true}
     ]}]
diff --git a/code_snippets/results/result.api-dashboard-get-all.sh b/code_snippets/results/result.api-dashboard-get-all.sh
@@ -6,15 +6,17 @@
             "resource": "/api/v1/dash/2473",
             "title": "My Dashboard",
             "created": "2015-12-12T23:06:06.703087+00:00",
-            "modified": "2015-12-12T23:12:26.726234+00:00"
+            "modified": "2015-12-12T23:12:26.726234+00:00",
+            "read_only": "true"
         },
-                {
+        {
             "description": "This has all the new hotness.",
             "id": "2551",
             "resource": "/api/v1/dash/2551",
             "title": "New and Improved Dashboard",
             "created": "2015-12-17T23:06:06.703087+00:00",
-            "modified": "2015-12-17T23:12:26.726234+00:00"
+            "modified": "2015-12-17T23:12:26.726234+00:00",
+            "read_only": "true"
         }
     ]
 }
diff --git a/code_snippets/results/result.api-dashboard-get.py b/code_snippets/results/result.api-dashboard-get.py
@@ -1,6 +1,7 @@
 {'dash': {'description': 'A new and improved timeboard!',
   'created': '2015-12-17T21:29:40.890824+00:00',
   'modified': '2015-12-17T21:39:20.770834+00:00',
+  'read_only': True,
   'graphs': [{'definition': {'events': [],
      'requests': [{'q': 'avg:system.mem.free{*} by {host}'}],
      'viz': 'timeseries'},
diff --git a/code_snippets/results/result.api-dashboard-get.rb b/code_snippets/results/result.api-dashboard-get.rb
@@ -12,4 +12,5 @@
   "url"=>"/dash/dash/2542",
   "resource"=>"/api/v1/dash/2542",
   "created"=>"2015-12-17T21:29:40.890824+00:00",
-  "modified"=>"2015-12-17T21:39:20.770834+00:00"}]
+  "modified"=>"2015-12-17T21:39:20.770834+00:00",
+  "read_only"=>true}]
diff --git a/code_snippets/results/result.api-dashboard-get.sh b/code_snippets/results/result.api-dashboard-get.sh
@@ -21,5 +21,6 @@
     "resource": "/api/v1/dash/2473",
     "url": "/dash/dash/2473",
     "created": "2015-12-17T23:06:06.703087+00:00",
-    "modified": "2015-12-17T23:12:26.726234+00:00"
+    "modified": "2015-12-17T23:12:26.726234+00:00",
+    "read_only": "true"
 }
diff --git a/code_snippets/results/result.api-dashboard-update.py b/code_snippets/results/result.api-dashboard-update.py
@@ -1,6 +1,7 @@
 {'dash': {'description': 'A new and improved timeboard!',
   'created': '2015-12-17T21:29:40.890824+00:00',
   'modified': '2015-12-17T21:39:20.770834+00:00',
+  'read_only': True,
   'graphs': [{'definition': {'events': [],
      'requests': [{'q': 'avg:system.mem.free{*} by {host}'}],
      'viz': 'timeseries'},
diff --git a/code_snippets/results/result.api-dashboard-update.rb b/code_snippets/results/result.api-dashboard-update.rb
@@ -12,4 +12,5 @@
   "url"=>"/dash/dash/2551",
   "resource"=>"/api/v1/dash/2551",
   "created"=>"2015-12-17T21:29:40.890824+00:00",
-  "modified"=>"2015-12-17T21:39:20.770834+00:00"}]
+  "modified"=>"2015-12-17T21:39:20.770834+00:00",
+  "read_only"=>true}]
diff --git a/code_snippets/results/result.api-dashboard-update.sh b/code_snippets/results/result.api-dashboard-update.sh
@@ -20,5 +20,6 @@
     "resource": "/api/v1/dash/2532",
     "url": "/dash/dash/2532",
     "created": "2015-12-17T23:06:06.703087+00:00",
-    "modified": "2015-12-17T23:12:26.726234+00:00"
+    "modified": "2015-12-17T23:12:26.726234+00:00",
+    "read_only": "false"
 }
diff --git a/code_snippets/results/result.api-screenboard-create.py b/code_snippets/results/result.api-screenboard-create.py
@@ -1,6 +1,7 @@
 {'description': 'An informative screenboard.',
  'created': '2015-12-17T21:29:40.890824+00:00',
  'modified': '2015-12-17T21:29:40.890824+00:00',
+ 'read_only': False,
  'widgets': [{'height': 20,
    'type': 'image',
    'url': 'https://path/to/image.jpg',
diff --git a/code_snippets/results/result.api-screenboard-create.rb b/code_snippets/results/result.api-screenboard-create.rb
@@ -11,4 +11,5 @@
      "x"=>32,
      "type"=>"image"}],
   "created"=>"2015-12-17T21:29:40.890824+00:00",
-  "modified"=>"2015-12-17T21:29:40.890824+00:00"}]
+  "modified"=>"2015-12-17T21:29:40.890824+00:00",
+  "read_only"=>false}]
diff --git a/code_snippets/results/result.api-screenboard-create.sh b/code_snippets/results/result.api-screenboard-create.sh
@@ -14,5 +14,6 @@
     ],
     "width": 1024,
     "created": "2015-12-17T23:06:06.703087+00:00",
-    "modified": "2015-12-17T23:06:06.705087+00:00"
+    "modified": "2015-12-17T23:06:06.705087+00:00",
+    "read_only": "false"
 }
diff --git a/code_snippets/results/result.api-screenboard-delete.py b/code_snippets/results/result.api-screenboard-delete.py
@@ -10,4 +10,5 @@
    'name': 'host1',
    'prefix': 'host'}],
  'title': 'My Screenboard',
- 'width': 1024}
+ 'width': 1024,
+ 'read_only': False}
diff --git a/code_snippets/results/result.api-screenboard-get-all.py b/code_snippets/results/result.api-screenboard-get-all.py
@@ -3,11 +3,13 @@
   'resource': '/api/v1/screen/2551',
   'title': 'New and Improved Screenboard',
   'created': '2015-12-17T21:29:40.890824+00:00',
-  'modified': '2015-12-17T21:39:20.770834+00:00'},
+  'modified': '2015-12-17T21:39:20.770834+00:00',
+  'read_only': False},
  {'description': 'And they are marvelous.',
   'id': '2552',
   'resource': '/api/v1/screen/2552',
   'title': 'My First Metrics',
   'created': '2015-12-17T21:29:40.890824+00:00',
-  'modified': '2015-12-17T21:39:20.770834+00:00'}
+  'modified': '2015-12-17T21:39:20.770834+00:00',
+  'read_only': False}
 ]
diff --git a/code_snippets/results/result.api-screenboard-get-all.rb b/code_snippets/results/result.api-screenboard-get-all.rb
@@ -4,12 +4,14 @@
          "resource"=>"/api/v1/screen/6334",
          "id"=>6334,
          "modified"=>"2015-12-17T20:00:25.051176+00:00",
-         "title"=>"dogapi test"},
+         "title"=>"dogapi test",
+         "read_only"=>false},
         {"created"=>"2015-12-17T20:00:25.868731+00:00",
          "resource"=>"/api/v1/screen/2",
          "id"=>2,
          "modified"=>"2015-12-17T20:00:25.868752+00:00",
-         "title"=>"Database Screen Board"}
+         "title"=>"Database Screen Board",
+         "read_only"=>false}
         ]
     }
 ]
diff --git a/code_snippets/results/result.api-screenboard-get-all.sh b/code_snippets/results/result.api-screenboard-get-all.sh
@@ -3,11 +3,13 @@
   'resource': '/api/v1/screen/2551',
   'title': 'New and Improved Screenboard',
   'created': '2015-12-17T23:06:06.703087+00:00',
-  'modified': '2015-12-17T23:12:26.726234+00:00'}
+  'modified': '2015-12-17T23:12:26.726234+00:00',
+  'read_only': 'false'}
  {'description': 'And they are marvelous.',
   'id': '2552',
   'resource': '/api/v1/screen/2552',
   'title': 'My First Metrics',
   'created': '2015-12-17T23:06:06.703087+00:00',
-  'modified': '2015-12-17T23:12:26.726234+00:00'}
+  'modified': '2015-12-17T23:12:26.726234+00:00',
+  'read_only': 'false'}
 ]
diff --git a/code_snippets/results/result.api-screenboard-get.py b/code_snippets/results/result.api-screenboard-get.py
@@ -1,6 +1,7 @@
 {'description': 'An informative screenboard.',
  'created': '2015-12-17T21:29:40.890824+00:00',
  'modified': '2015-12-17T21:39:20.770834+00:00',
+ 'read_only': False,
  'graphs': [{'height': 20,
    'type': 'image',
    'url': 'https://path/to/image.jpg',
diff --git a/code_snippets/results/result.api-screenboard-get.rb b/code_snippets/results/result.api-screenboard-get.rb
@@ -11,4 +11,5 @@
      "x"=>32,
      "type"=>"image"}],
   "created"=>"2015-12-17T21:29:40.890824+00:00",
-  "modified"=>"2015-12-17T21:39:20.770834+00:00"}]
+  "modified"=>"2015-12-17T21:39:20.770834+00:00",
+  "read_only"=>false}]
diff --git a/code_snippets/results/result.api-screenboard-get.sh b/code_snippets/results/result.api-screenboard-get.sh
@@ -14,5 +14,6 @@
     ],
     "width": 1024,
     "created": "2015-12-17T23:06:06.703087+00:00",
-    "modified": "2015-12-17T23:12:26.726234+00:00"
+    "modified": "2015-12-17T23:12:26.726234+00:00",
+    "read_only": "false"
 }
diff --git a/content/api/index.html b/content/api/index.html
@@ -1053,6 +1053,7 @@ <h5>Arguments</h5>
                <div>The default value for the template variable on dashboard load</div>
              </li>
            </ul>
+           <%= argument("read_only", "The read-only status of the timeboard.", :default => "False") %>
            </ul>
       </div>
       <%= right_side_div %>
@@ -1122,6 +1123,7 @@ <h5>Arguments</h5>
                <div>The default value for the template variable on dashboard load</div>
              </li>
            </ul>
+           <%= argument("read_only", "The read-only status of the timeboard.", :default => "False") %>
            </ul>
       </div>
       <%= right_side_div %>
@@ -1228,6 +1230,7 @@ <h5>Arguments</h5>
           <%= argument("template_variables", "A list of template variables for using Dashboard templating.", :default => "None") %>
           <%= argument("width", "Screenboard width in pixels", :default => "None") %>
           <%= argument("height", "Height in pixels.", :default => "None") %>
+          <%= argument("read_only", "The read-only status of the screenboard.", :default => "False") %>
         </ul>
       </div>
       <%= right_side_div %>

Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,5 @@`
`21`	`21`	`"url": "/dash/dash/2532",`
`22`	`22`	`"created": "2015-12-17T23:06:06.703087+00:00",`
`23`	`23`	`"modified": "2015-12-17T23:06:06.726234+00:00",`
	`24`	`+ "read_only": "true"`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,6 @@`
`9`	`9`	`'resource': '/api/v1/dash/2552',`
`10`	`10`	`'title': 'My First Metrics',`
`11`	`11`	`'created': '2015-12-17T21:29:40.890824+00:00',`
`12`		`- 'modified': '2015-12-17T21:39:20.770834+00:00'}`
	`12`	`+ 'modified': '2015-12-17T21:39:20.770834+00:00',`
	`13`	`+ 'read_only': True}`
`13`	`14`	`]`