feat: Add team sync and public dashboard support (#52)

* feat: Add team sync support
* feat: Add public dashboard support
* feat: Add new unit and integration tests
* docs: Add the documentation
* feat: Adjust the GH action

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ZPascal

.github/workflows/integrationtest.yml

@@ -40,6 +40,9 @@ jobs:
           GRAFANA_PASSWORD: ${{ secrets.GRAFANA_PASSWORD }}
           HTTP2: "False"
 
+      - name: Wait 20 seconds
+        run: sleep 20
+
       - name: Execute the integrationtests (http2)
         run: python3 -m unittest discover tests/integrationtest
         env:

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

@@ -109,6 +109,7 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: ${{ github.head_ref }}
+          atomic: false
 
   pr-documentation:
     runs-on: ubuntu-latest

README.md

@@ -13,10 +13,6 @@ The core features that are implemented inside this library:
 
 In general, my focus on this project is to implement and deliver old and new features from the Grafana API, to document all features and functionality clear,ly and to increase the overall test coverage of the project.
 
-## TODO
-- [ ] [Team Sync](https://grafana.com/docs/grafana/latest/developers/http_api/team_sync/)
-- [ ] [Public Dashboard](https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_public/)
-
 ## Currently, supported features
 
 ### Dashboard
@@ -33,6 +29,11 @@ In general, my focus on this project is to implement and deliver old and new fea
 - Restore a dashboard version of a specific dashboard
 - Restore a dashboard version of a specific dashboard by uid
 - Compare two dashboard versions and extract the diff between booth dashboards
+- Get public dashboards
+- Get public dashboard by uid
+- Create public dashboard
+- Update public dashboard
+- Delete public dashboard
 
 ### Folder
 - Get folder id by dashboard path
@@ -202,6 +203,9 @@ In general, my focus on this project is to implement and deliver old and new fea
 - Delete team member
 - Get team preferences
 - Update team preferences
+- Get external team groups
+- Add external team group
+- Delete external team group
 
 ### Legacy Playlist
 - Search playlist

docs/content/grafana_api/dashboard.md

@@ -19,6 +19,11 @@
     * [restore\_dashboard\_version](#dashboard.Dashboard.restore_dashboard_version)
     * [restore\_dashboard\_version\_by\_uid](#dashboard.Dashboard.restore_dashboard_version_by_uid)
     * [calculate\_dashboard\_diff](#dashboard.Dashboard.calculate_dashboard_diff)
+    * [get\_public\_dashboards](#dashboard.Dashboard.get_public_dashboards)
+    * [get\_public\_dashboard\_by\_uid](#dashboard.Dashboard.get_public_dashboard_by_uid)
+    * [create\_public\_dashboard](#dashboard.Dashboard.create_public_dashboard)
+    * [update\_public\_dashboard](#dashboard.Dashboard.update_public_dashboard)
+    * [delete\_public\_dashboard](#dashboard.Dashboard.delete_public_dashboard)
 
 <a id="dashboard"></a>
 
@@ -476,3 +481,162 @@ The method includes a functionality to calculate the diff of specified versions
 
 - `api_call` _str_ - Returns the difference of the two specified dashboards
 
+<a id="dashboard.Dashboard.get_public_dashboards"></a>
+
+#### get\_public\_dashboards
+
+```python
+def get_public_dashboards(per_page: int = None, page: int = None) -> dict
+```
+
+The method includes a functionality to get all public available dashboards
+
+Required Permissions:
+Action: dashboards:read
+Scope: dashboards:uid:<dashboard UID>
+
+**Arguments**:
+
+- `per_page` _int_ - Specify the value per page size
+- `page` _int_ - Specify the page
+  
+
+**Raises**:
+
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns all public available dashboards
+
+<a id="dashboard.Dashboard.get_public_dashboard_by_uid"></a>
+
+#### get\_public\_dashboard\_by\_uid
+
+```python
+def get_public_dashboard_by_uid(dashboard_uid: str) -> dict
+```
+
+The method includes a functionality to get a public available dashboard specified by dashboard_uid
+
+Required Permissions:
+Action: dashboards:read
+Scope: dashboards:uid:<dashboard UID>
+
+**Arguments**:
+
+- `dashboard_uid` _str_ - Specify the dashboard_uid
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns the corresponding public available dashboard
+
+<a id="dashboard.Dashboard.create_public_dashboard"></a>
+
+#### create\_public\_dashboard
+
+```python
+def create_public_dashboard(
+    dashboard_uid: str, public_dashboard: PublicDashboard = PublicDashboard()
+) -> dict
+```
+
+The method includes a functionality to create a public available dashboard
+
+Required Permissions:
+Action: dashboards.public:write
+Scope: dashboards:uid:<dashboard UID>
+
+**Arguments**:
+
+- `dashboard_uid` _str_ - Specify the dashboard_uid
+- `public_dashboard` _PublicDashboard_ - Specify the optional public dashboard object
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns the corresponding public available dashboard
+
+<a id="dashboard.Dashboard.update_public_dashboard"></a>
+
+#### update\_public\_dashboard
+
+```python
+def update_public_dashboard(dashboard_uid: str,
+                            public_dashboard_uid: str,
+                            time_selection_enabled: bool = None,
+                            is_enabled: bool = None,
+                            annotations_enabled: bool = None,
+                            share: str = None) -> dict
+```
+
+The method includes a functionality to update a public available dashboard
+
+Required Permissions:
+Action: dashboards.public:write
+Scope: dashboards:uid:<dashboard UID>
+
+**Arguments**:
+
+- `dashboard_uid` _str_ - Specify the dashboard_uid
+- `public_dashboard_uid` _str_ - Specify the public_dashboard_uid
+- `time_selection_enabled` _bool_ - Specify the optional enablement of the time picker inside the public dashboard (default None)
+- `is_enabled` _bool_ - Specify the optional enablement of the public dashboard (default None)
+- `annotations_enabled` _bool_ - Specify the optional enablement of the annotations inside the public dashboard (default None)
+- `share` _str_ - Specify the optional share mode of the public dashboard (default None)
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns the corresponding public available dashboard
+
+<a id="dashboard.Dashboard.delete_public_dashboard"></a>
+
+#### delete\_public\_dashboard
+
+```python
+def delete_public_dashboard(dashboard_uid: str, public_dashboard_uid: str)
+```
+
+The method includes a functionality to delete a public available dashboard
+
+Required Permissions:
+Action: dashboards.public:write
+Scope: dashboards:uid:<dashboard UID>
+
+**Arguments**:
+
+- `dashboard_uid` _str_ - Specify the dashboard_uid
+- `public_dashboard_uid` _str_ - Specify the public_dashboard_uid
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+  None
+

docs/content/grafana_api/model.md

@@ -36,6 +36,7 @@
   * [RolePermission](#model.RolePermission)
   * [CustomRole](#model.CustomRole)
   * [DatasourceCache](#model.DatasourceCache)
+  * [PublicDashboard](#model.PublicDashboard)
 
 <a id="model"></a>
 
@@ -705,3 +706,23 @@ The class includes all necessary variables to generate a datasource cache object
 - `ttl_queries_ms` _int_ - Specify the TTL to use for query caching, in milliseconds
 - `ttl_resources_ms` _int_ - Specify the TTL to use for resource caching, in milliseconds
 
+<a id="model.PublicDashboard"></a>
+
+## PublicDashboard Objects
+
+```python
+@dataclass
+class PublicDashboard()
+```
+
+The class includes all necessary variables to generate a public dashboard object
+
+**Arguments**:
+
+- `uid` _str_ - Specify the optional unique identifier when creating a public dashboard. If it’s none, it will generate a new uid (default None)
+- `access_token` _str_ - Specify the optional unique access token. If it’s none, it will generate a new access token (default None)
+- `time_selection_enabled` _bool_ - Specify the optional enablement of the time picker inside the public dashboard (default False)
+- `is_enabled` _bool_ - Specify the optional enablement of the public dashboard (default False)
+- `annotations_enabled` _bool_ - Specify the optional enablement of the annotations inside the public dashboard (default False)
+- `share` _str_ - Specify the optional share mode of the public dashboard (default public)
+

docs/content/grafana_api/team.md

@@ -12,6 +12,9 @@
     * [delete\_team\_member](#team.Team.delete_team_member)
     * [get\_team\_preferences](#team.Team.get_team_preferences)
     * [update\_team\_preferences](#team.Team.update_team_preferences)
+    * [get\_external\_groups](#team.Team.get_external_groups)
+    * [add\_external\_group](#team.Team.add_external_group)
+    * [remove\_external\_group](#team.Team.remove_external_group)
 
 <a id="team"></a>
 
@@ -25,7 +28,7 @@
 class Team()
 ```
 
-The class includes all necessary methods to access the Grafana team API endpoints. Be aware that all functionalities inside the class only working with the corresponding access rights, please check the following page for details: https://grafana.com/docs/grafana/latest/http_api/team/`team`-api
+The class includes all necessary methods to access the Grafana team API endpoints. Be aware that all functionalities inside the class only working with the corresponding access rights, please check the following page for details: https://grafana.com/docs/grafana/latest/http_api/team/`team`-api & https://grafana.com/docs/grafana/latest/developers/http_api/team_sync/`team`-sync-api
 
 HINT: Note Grafana Enterprise API need required permissions if fine-grained access control is enabled
 
@@ -339,6 +342,95 @@ Scope: teams:*
 - `Exception` - Unspecified error by executing the API call
 
 
+**Returns**:
+
+  None
+
+<a id="team.Team.get_external_groups"></a>
+
+#### get\_external\_groups
+
+```python
+def get_external_groups(id: int) -> list
+```
+
+The method includes a functionality to get the team groups specified by the team_id. The functionality is a Grafana ENTERPRISE feature
+
+Required Permissions:
+Action: teams.permissions:read
+Scope: teams:*
+
+**Arguments**:
+
+- `id` _int_ - Specify the team id
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _list_ - Returns the organization team groups
+
+<a id="team.Team.add_external_group"></a>
+
+#### add\_external\_group
+
+```python
+def add_external_group(id: int, team_group: str)
+```
+
+The method includes a functionality to add a group to the team specified by the team_id and the team_group. The functionality is a Grafana ENTERPRISE feature
+
+Required Permissions:
+Action: teams.permissions:write
+Scope: teams:*
+
+**Arguments**:
+
+- `id` _int_ - Specify the team id
+- `team_group` _str_ - Specify the team group
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+  None
+
+<a id="team.Team.remove_external_group"></a>
+
+#### remove\_external\_group
+
+```python
+def remove_external_group(id: int, team_group: str)
+```
+
+The method includes a functionality to remove a group from a team specified by the team_id and the team_group. The functionality is a Grafana ENTERPRISE feature
+
+Required Permissions:
+Action: teams.permissions:write
+Scope: teams:*
+
+**Arguments**:
+
+- `id` _int_ - Specify the team id
+- `team_group` _str_ - Specify the team group
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
 **Returns**:
 
   None

docs/content/index.md

@@ -18,6 +18,10 @@ The following list describes the currently supported features of the Grafana API
 - [x] [Alerting Notification Channels HTTP API](https://grafana.com/docs/grafana/latest/http_api/alerting_notification_channels/) 
 - [x] [Annotations HTTP API](https://grafana.com/docs/grafana/latest/http_api/annotations/)
 - [x] [Authentication HTTP API](https://grafana.com/docs/grafana/latest/http_api/auth/)
+- [x] [Dashboard](https://grafana.com/docs/grafana/latest/developers/http_api/dashboard/)
+- [x] [Dashboard Permissions](https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_permissions/)
+- [x] [Dashboard Versions](https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_versions/)
+- [x] [Public Dashboard](https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_public/)
 - [x] [Data source HTTP API](https://grafana.com/docs/grafana/latest/http_api/data_source/)
 - [x] [Datasource query and resource caching](https://grafana.com/docs/grafana/latest/developers/http_api/query_and_resource_caching/)
 - [x] [Datasource Permissions HTTP API](https://grafana.com/docs/grafana/latest/http_api/datasource_permissions/)
@@ -37,6 +41,7 @@ The following list describes the currently supported features of the Grafana API
 - [x] [Reporting API](https://grafana.com/docs/grafana/latest/http_api/reporting/)
 - [x] [Short URL HTTP API](https://grafana.com/docs/grafana/latest/http_api/short_url/)
 - [x] [Team HTTP API](https://grafana.com/docs/grafana/latest/http_api/team/)
+- [x] [Team Sync](https://grafana.com/docs/grafana/latest/developers/http_api/team_sync/)
 - [x] [User HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/)
 - [x] [Service Account HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/)
 - [x] [RBAC HTTP API](https://grafana.com/docs/grafana/latest/http_api/access_control/)