Add missing argument dashboard_uid to get_annotation method

Author: nikita-b

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## unreleased
 
+* Add missing argument `dashboard_uid` to `get_annotation` method.
+  Thanks, @nikita-b.
+
 
 ## 3.5.0 (2022-12-07)
 

grafana_client/elements/annotations.py

@@ -12,6 +12,7 @@ def get_annotation(
         time_to=None,
         alert_id=None,
         dashboard_id=None,
+        dashboard_uid=None,
         panel_id=None,
         user_id=None,
         ann_type=None,
@@ -25,6 +26,7 @@ def get_annotation(
         :param time_to:
         :param alert_id:
         :param dashboard_id:
+        :param dashboard_uid:
         :param panel_id:
         :param user_id:
         :param ann_type: Annotation type. On of alert|annotation
@@ -47,6 +49,9 @@ def get_annotation(
         if dashboard_id:
             params.append("dashboardId=%s" % dashboard_id)
 
+        if dashboard_uid:
+            params.append("dashboardUID=%s" % dashboard_uid)
+
         if panel_id:
             params.append("panelId=%s" % panel_id)
 

test/elements/test_annotations.py

@@ -19,13 +19,14 @@ def setUp(self):
     def test_annotations(self, m):
         m.get(
             "http://localhost/api/annotations?from=1563183710618&to=1563185212275"
-            "&alertId=11&dashboardId=111&panelId=22&userId=42&type=alert&tags=tags-test&limit=1",
+            "&alertId=11&dashboardId=111&dashboardUID=v1Mm5FPVz&panelId=22&userId=42&type=alert&tags=tags-test&limit=1",
             json=[
                 {
                     "id": 80,
                     "alertId": 11,
                     "alertName": "",
                     "dashboardId": 111,
+                    "dashboardUID": "v1Mm5FPVz",
                     "panelId": 22,
                     "userId": 42,
                     "type": "alert",
@@ -48,6 +49,7 @@ def test_annotations(self, m):
             time_to=1563185212275,
             alert_id=11,
             dashboard_id=111,
+            dashboard_uid="v1Mm5FPVz",
             panel_id=22,
             user_id=42,
             ann_type="alert",
@@ -56,6 +58,7 @@ def test_annotations(self, m):
         )
         self.assertEqual(annotations[0]["text"], "Annotation Description")
         self.assertEqual(annotations[0]["alertId"], 11)
+        self.assertEqual(annotations[0]["dashboardUID"], "v1Mm5FPVz")
         self.assertEqual(annotations[0]["dashboardId"], 111)
         self.assertEqual(annotations[0]["panelId"], 22)
         self.assertEqual(annotations[0]["userId"], 42)