fix: Add the missing alerting header (#24)

* fix: Add the missing alerting header
* feat: Add coverage badge and documentation

Author: ZPascal

.github/workflows/pull-request-checks.yml

@@ -106,7 +106,7 @@ jobs:
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
           git add --force docs
-          git commit -m "Add coverage badge and documentation"
+          git commit -m "docs: Add coverage badge and documentation"
 
       - name: Push changes
         uses: ad-m/github-push-action@master

docs/content/grafana_api/alerting-provisioning.md

@@ -76,14 +76,15 @@ The method includes a functionality to get the alert rule specified by the uid
 #### add\_alert\_rule
 
 ```python
-def add_alert_rule(alert_rule: AlertRule)
+def add_alert_rule(alert_rule: AlertRule, disable_provenance: bool = False)
 ```
 
 The method includes a functionality to create a new alert rule
 
 **Arguments**:
 
 - `alert_rule` _AlertRule_ - Specify the alert rule
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -101,7 +102,9 @@ The method includes a functionality to create a new alert rule
 #### update\_alert\_rule
 
 ```python
-def update_alert_rule(uid: str, alert_rule: AlertRule)
+def update_alert_rule(uid: str,
+                      alert_rule: AlertRule,
+                      disable_provenance: bool = False)
 ```
 
 The method includes a functionality to update an existing alert rule
@@ -110,6 +113,7 @@ The method includes a functionality to update an existing alert rule
 
 - `uid` _str_ - Specify the alert rule uid
 - `alert_rule` _AlertRule_ - Specify the alert rule
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -127,8 +131,11 @@ The method includes a functionality to update an existing alert rule
 #### update\_the\_interval\_of\_a\_alert\_rule\_group
 
 ```python
-def update_the_interval_of_a_alert_rule_group(folder_uid: str, group: str,
-                                              alert_rule_group_interval: int)
+def update_the_interval_of_a_alert_rule_group(
+        folder_uid: str,
+        group: str,
+        alert_rule_group_interval: int,
+        disable_provenance: bool = False)
 ```
 
 The method includes a functionality to update the interval of a alert rule group
@@ -138,6 +145,7 @@ The method includes a functionality to update the interval of a alert rule group
 - `folder_uid` _str_ - Specify the folder uid
 - `group` _str_ - Specify the group
 - `alert_rule_group_interval` _int_ - Specify the alert rule group interval
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -155,14 +163,15 @@ The method includes a functionality to update the interval of a alert rule group
 #### delete\_alert\_rule
 
 ```python
-def delete_alert_rule(uid: str)
+def delete_alert_rule(uid: str, disable_provenance: bool = False)
 ```
 
 The method includes a functionality to delete an alert rule
 
 **Arguments**:
 
 - `uid` _str_ - Specify the alert rule uid
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -198,14 +207,16 @@ The method includes a functionality to get all contact points
 #### add\_contact\_point
 
 ```python
-def add_contact_point(embedded_contact_point: EmbeddedContactPoint)
+def add_contact_point(embedded_contact_point: EmbeddedContactPoint,
+                      disable_provenance: bool = False)
 ```
 
 The method includes a functionality to create a contact point
 
 **Arguments**:
 
 - `embedded_contact_point` _EmbeddedContactPoint_ - Specify the embedded contact point
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -224,7 +235,8 @@ The method includes a functionality to create a contact point
 
 ```python
 def update_contact_point(uid: str,
-                         embedded_contact_point: EmbeddedContactPoint)
+                         embedded_contact_point: EmbeddedContactPoint,
+                         disable_provenance: bool = False)
 ```
 
 The method includes a functionality to update a contact point
@@ -233,6 +245,7 @@ The method includes a functionality to update a contact point
 
 - `uid` _str_ - Specify the uid of the contact point
 - `embedded_contact_point` _EmbeddedContactPoint_ - Specify the embedded contact point
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -294,14 +307,15 @@ The method includes a functionality to get the notification policy tree
 #### add\_notification\_policies
 
 ```python
-def add_notification_policies(route: Route)
+def add_notification_policies(route: Route, disable_provenance: bool = False)
 ```
 
 The method includes a functionality to set the notification policy tree
 
 **Arguments**:
 
 - `route` _Route_ - Specify the alert rule routes
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -363,14 +377,16 @@ The method includes a functionality to get a mute timings specified by the name
 #### add\_mute\_timing
 
 ```python
-def add_mute_timing(mute_time_interval: MuteTimeInterval)
+def add_mute_timing(mute_time_interval: MuteTimeInterval,
+                    disable_provenance: bool = False)
 ```
 
 The method includes a functionality to create a mute timing
 
 **Arguments**:
 
 - `mute_time_interval` _MuteTimeInterval_ - Specify the mute time interval
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -388,7 +404,9 @@ The method includes a functionality to create a mute timing
 #### update\_mute\_timing
 
 ```python
-def update_mute_timing(name: str, mute_time_interval: MuteTimeInterval)
+def update_mute_timing(name: str,
+                       mute_time_interval: MuteTimeInterval,
+                       disable_provenance: bool = False)
 ```
 
 The method includes a functionality to update an existing mute timing
@@ -397,6 +415,7 @@ The method includes a functionality to update an existing mute timing
 
 - `name` _str_ - Specify the mute timing name
 - `mute_time_interval` _MuteTimeInterval_ - Specify the mute time interval
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:
@@ -483,7 +502,9 @@ The method includes a functionality to get a message template specified by the n
 #### create\_or\_update\_message\_template
 
 ```python
-def create_or_update_message_template(name: str, message_template: str)
+def create_or_update_message_template(name: str,
+                                      message_template: str,
+                                      disable_provenance: bool = False)
 ```
 
 The method includes a functionality to create or update a message template
@@ -492,6 +513,7 @@ The method includes a functionality to create or update a message template
 
 - `name` _str_ - Specify the message template name
 - `message_template` _str_ - Specify the message template
+- `disable_provenance` _bool_ - Specify if the provenance header should be set or not (default False)
 
 
 **Raises**:

docs/content/grafana_api/api.md

@@ -36,6 +36,7 @@ def call_the_api(api_call: str,
                  method: RequestsMethods = RequestsMethods.GET,
                  json_complete: str = None,
                  org_id_header: int = None,
+                 disable_provenance_header: bool = False,
                  response_status_code: bool = False) -> any
 ```
 
@@ -46,8 +47,9 @@ The method execute a defined API call against the Grafana endpoints
 - `api_call` _str_ - Specify the API call endpoint
 - `method` _RequestsMethods_ - Specify the used method (default GET)
 - `json_complete` _str_ - Specify the inserted JSON as string
-- `org_id_header` _int_ - Specify the optional organization id for the corresponding API call
-- `response_status_code` _bool_ - Specify if the response should include the original status code
+- `org_id_header` _int_ - Specify the optional organization id as header for the corresponding API call
+- `disable_provenance_header` _bool_ - Specify the optional disable provenance as header for the corresponding API call (default False)
+- `response_status_code` _bool_ - Specify if the response should include the original status code (default False)
 
 
 **Raises**: