feat: Add datasource caching functionality (#30)

* feat: Add datasource caching functionality

* docs: Add coverage badge and documentation

---------

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

Author: ZPascal

README.md

@@ -10,9 +10,6 @@ The main feature that is implemented inside this library:
 
 In general my focus inside this project is to implement and deliver old and new features from the Grafana API, to document all features and functionality clear and to increase the overall test coverage of the project.
 
-## Features on the roadmap
-- [ ] [Query and resource caching API](https://grafana.com/docs/grafana/latest/developers/http_api/query_and_resource_caching/) Planned for CW 26/27
-
 ## Currently, supported features
 
 ### Dashboard
@@ -63,6 +60,13 @@ In general my focus inside this project is to implement and deliver old and new
 - Add datasource permissions
 - Delete datasource permissions
 
+### Datasource query and resource caching
+- Get datasource cache by uid
+- Enable datasource cache by uid
+- Disable datasource cache by uid
+- Update datasource cache by uid
+- Clean all datasource caches
+
 ### Legacy Alerting
 - Get alerts
 - Get alerts by dashboard ids

docs/content/grafana_api/datasource.md

@@ -18,6 +18,12 @@
     * [get\_datasource\_permissions](#datasource.Datasource.get_datasource_permissions)
     * [add\_datasource\_permissions](#datasource.Datasource.add_datasource_permissions)
     * [delete\_datasource\_permissions](#datasource.Datasource.delete_datasource_permissions)
+  * [DatasourceQueryResourceCaching](#datasource.DatasourceQueryResourceCaching)
+    * [get\_datasource\_cache](#datasource.DatasourceQueryResourceCaching.get_datasource_cache)
+    * [enable\_datasource\_cache](#datasource.DatasourceQueryResourceCaching.enable_datasource_cache)
+    * [disable\_datasource\_cache](#datasource.DatasourceQueryResourceCaching.disable_datasource_cache)
+    * [clean\_datasource\_cache](#datasource.DatasourceQueryResourceCaching.clean_datasource_cache)
+    * [update\_datasource\_cache](#datasource.DatasourceQueryResourceCaching.update_datasource_cache)
 
 <a id="datasource"></a>
 
@@ -504,3 +510,171 @@ The method includes a functionality to delete datasource permission specified by
 
   None
 
+<a id="datasource.DatasourceQueryResourceCaching"></a>
+
+## DatasourceQueryResourceCaching Objects
+
+```python
+class DatasourceQueryResourceCaching()
+```
+
+The class includes all necessary methods to access the Grafana datasource query and resource caching API endpoints. It's required that the API token got the corresponding datasource access rights. Please check the used methods docstring for the necessary access rights. The functionality is a Grafana ENTERPRISE feature
+
+HINT: Note Grafana Enterprise API need required permissions if fine-grained access control is enabled
+
+**Arguments**:
+
+- `grafana_api_model` _APIModel_ - Inject a Grafana API model object that includes all necessary values and information
+  
+
+**Attributes**:
+
+- `grafana_api_model` _APIModel_ - This is where we store the grafana_api_model
+
+<a id="datasource.DatasourceQueryResourceCaching.get_datasource_cache"></a>
+
+#### get\_datasource\_cache
+
+```python
+def get_datasource_cache(uid: str) -> dict
+```
+
+The method includes a functionality to get the datasource cache config specified by the datasource uid
+
+**Arguments**:
+
+- `uid` _str_ - Specify the uid of the datasource
+  
+  Required Permissions:
+- `Action` - datasources.caching:write
+- `Scope` - datasources:*
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns a datasource
+
+<a id="datasource.DatasourceQueryResourceCaching.enable_datasource_cache"></a>
+
+#### enable\_datasource\_cache
+
+```python
+def enable_datasource_cache(uid: str) -> dict
+```
+
+The method includes a functionality to enable the datasource cache specified by the datasource uid
+
+**Arguments**:
+
+- `uid` _str_ - Specify the uid of the datasource
+  
+  Required Permissions:
+- `Action` - datasources.caching:read
+- `Scope` - datasources:*
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns a datasource
+
+<a id="datasource.DatasourceQueryResourceCaching.disable_datasource_cache"></a>
+
+#### disable\_datasource\_cache
+
+```python
+def disable_datasource_cache(uid: str) -> dict
+```
+
+The method includes a functionality to disable the datasource cache specified by the datasource uid
+
+**Arguments**:
+
+- `uid` _str_ - Specify the uid of the datasource
+  
+  Required Permissions:
+- `Action` - datasources.caching:write
+- `Scope` - datasources:*
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns a datasource
+
+<a id="datasource.DatasourceQueryResourceCaching.clean_datasource_cache"></a>
+
+#### clean\_datasource\_cache
+
+```python
+def clean_datasource_cache(uid: str) -> dict
+```
+
+The method includes a functionality to clean the datasource cache of all data sources with caching enabled. The uid of the datasource will only be used to return the configuration for that data source
+
+**Arguments**:
+
+- `uid` _str_ - Specify the uid of the datasource
+  
+  Required Permissions:
+- `Action` - datasources.caching:write
+- `Scope` - datasources:*
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns a datasource
+
+<a id="datasource.DatasourceQueryResourceCaching.update_datasource_cache"></a>
+
+#### update\_datasource\_cache
+
+```python
+def update_datasource_cache(uid: str,
+                            datasource_cache: DatasourceCache) -> dict
+```
+
+The method includes a functionality to update the datasource cache specified by the datasource uid
+
+**Arguments**:
+
+- `uid` _str_ - Specify the uid of the datasource
+- `datasource_cache` _DatasourceCache_ - Specif the datasource cache object
+  
+  Required Permissions:
+- `Action` - datasources.caching:write
+- `Scope` - datasources:*
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns a datasource
+

docs/content/grafana_api/model.md

@@ -35,6 +35,7 @@
   * [GlobalUser](#model.GlobalUser)
   * [RolePermission](#model.RolePermission)
   * [CustomRole](#model.CustomRole)
+  * [DatasourceCache](#model.DatasourceCache)
 
 <a id="model"></a>
 
@@ -683,3 +684,23 @@ The class includes all necessary variables to generate a custom role object
 - `hidden` _bool_ - Specify whether the role is hidden or not.  If set to True, then the role does not show in the role picker. It will not be listed by API endpoints unless explicitly specified (default False)
 - `permissions` _list_ - Specify the optional permissions of the role as a list of the RolePermission objects (default None)
 
+<a id="model.DatasourceCache"></a>
+
+## DatasourceCache Objects
+
+```python
+@dataclass
+class DatasourceCache()
+```
+
+The class includes all necessary variables to generate a datasource cache object
+
+**Arguments**:
+
+- `datasource_id` _int_ - Specify the datasource id
+- `datasource_uid` _str_ - Specify the datasource uid
+- `enabled` _bool_ - Specify if caching should be enabled for the datasource
+- `use_default_ttl` _bool_ - Specify if the configured default TTL (Time-To-Live) should be used for both query and resource caching, instead of the user-specified values
+- `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
+