Fix add_annotation to also accept dashboard_uid argument

Author: amotl

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## unreleased
 
 * Add support for service accounts. Thanks, @einar-lanfranco and @feerbau.
+* Fix `add_annotation` to also accept `dashboard_uid` argument. Thanks, @IBUMBLEBEE.
 
 
 ## 3.10.0 (2023-10-30)

grafana_client/elements/annotations.py

@@ -78,6 +78,7 @@ def get_annotation(
     def add_annotation(
         self,
         dashboard_id=None,
+        dashboard_uid=None,
         panel_id=None,
         time_from=None,
         time_to=None,
@@ -88,6 +89,7 @@ def add_annotation(
         https://grafana.com/docs/grafana/latest/http_api/annotations/#create-annotation
 
         :param dashboard_id:
+        :param dashboard_uid:
         :param panel_id
         :param time_from:
         :param time_to:
@@ -98,13 +100,16 @@ def add_annotation(
 
         annotations_path = "/annotations"
         payload = {
-            "dashboardId": dashboard_id,
             "panelId": panel_id,
             "time": time_from,
             "timeEnd": time_to,
             "tags": tags,
             "text": text,
         }
+        if dashboard_id is not None:
+            payload["dashboardId"] = dashboard_id
+        if dashboard_uid is not None:
+            payload["dashboardUID"] = dashboard_uid
 
         r = self.client.POST(annotations_path, json=payload)
 

test/elements/test_annotations.py

@@ -131,7 +131,7 @@ def test_delete_annotations_by_id_bad_input(self, m):
             self.grafana.annotations.delete_annotations_by_id(annotations_id=None)
 
     @requests_mock.Mocker()
-    def test_add_annotation(self, m):
+    def test_add_annotation_no_dashboard(self, m):
         m.post(
             "http://localhost/api/annotations",
             json={"endId": 80, "id": 79, "message": "Annotation added"},
@@ -143,6 +143,28 @@ def test_add_annotation(self, m):
         self.assertEqual(annotation["id"], 79)
         self.assertEqual(annotation["message"], "Annotation added")
 
+    @requests_mock.Mocker()
+    def test_add_annotation_dashboard_id(self, m):
+        m.post(
+            "http://localhost/api/annotations",
+            json={"dashboardId": 42},
+        )
+        annotation = self.grafana.annotations.add_annotation(
+            dashboard_id=42, time_from=1563183710618, time_to=1563185212275, tags=["tags-test"], text="Test"
+        )
+        self.assertEqual(annotation["dashboardId"], 42)
+
+    @requests_mock.Mocker()
+    def test_add_annotation_dashboard_uid(self, m):
+        m.post(
+            "http://localhost/api/annotations",
+            json={"dashboardUID": "jcIIG-07z"},
+        )
+        annotation = self.grafana.annotations.add_annotation(
+            dashboard_uid="jcIIG-07z", time_from=1563183710618, time_to=1563185212275, tags=["tags-test"], text="Test"
+        )
+        self.assertEqual(annotation["dashboardUID"], "jcIIG-07z")
+
     @requests_mock.Mocker()
     def test_update_annotation(self, m):
         m.put(