PR comments

Author: pmajali

linode_api4/groups/monitor_service.py

@@ -1,3 +1,8 @@
+from typing import Optional
+
+from linode_api4 import (
+    PaginatedList,
+)
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
 from linode_api4.objects import (
@@ -15,100 +20,75 @@ class MonitorGroup(Group):
     This group contains all features beneath the `/monitor` group in the API v4.
     """
 
-    def dashboards(self, *filters) -> list[MonitorDashboard]:
+    def dashboards(
+        self, service_type: Optional[str] = None, *filters
+    ) -> PaginatedList:
         """
-        Returns a list of dashboards.
+        Returns a list of dashboards. If `service_type` is provided, it fetches dashboards
+        for the specific service type. If None, it fetches all dashboards.
 
-            dashboards = client.monitor_service.list_monitor_dashboards()
+            dashboards = client.monitor_service.dashboards()
             dashboard = client.load(MonitorDashboard, 1)
+            dashboards_by_service = client.monitor_service.dashboards(service_type="dbaas")
 
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
-        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-dashboards-all
+        API Documentation:
+        - All Dashboards: https://techdocs.akamai.com/linode-api/reference/get-dashboards-all
+        - Dashboards by Service: https://techdocs.akamai.com/linode-api/reference/get-dashboards
 
+        :param service_type: The service type to get dashboards for.
+        :type service_type: Optional[str]
         :param filters: Any number of filters to apply to this query.
                         See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                         for more details on filtering.
 
         :returns: A list of Dashboards.
         :rtype: PaginatedList of Dashboard
         """
-
-        return self.client._get_and_filter(MonitorDashboard, *filters)
-
-    def dashboards_by_service(
-        self, service_type: str, *filters
-    ) -> list[MonitorDashboard]:
-        """
-        Returns a list of dashboards for a particular service.
-
-            dashboard_by_service = client.monitor_service.list_dashboards_by_service(service_type="dbaas")
-
-        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
-
-        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-dashboards
-
-        :param service_type: The service type to get dashboards for.
-        :type service_type: str
-        :param filters: Any number of filters to apply to this query.
-                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
-                        for more details on filtering.
-
-        :returns: Dashboards filtered by Service Type.
-        :rtype: PaginatedList of the Dashboards
-        """
+        endpoint = (
+            f"/monitor/services/{service_type}/dashboards"
+            if service_type
+            else "/monitor/dashboards"
+        )
 
         return self.client._get_and_filter(
             MonitorDashboard,
             *filters,
-            endpoint=f"/monitor/services/{service_type}/dashboards",
+            endpoint=endpoint,
         )
 
-    def services(self, *filters) -> list[MonitorService]:
-        """
-        Returns a list of services supported by ACLP.
-
-            supported_services = client.monitor_service.list_supported_services()
-
-        .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
-
-        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services
-
-        :param filters: Any number of filters to apply to this query.
-                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
-                        for more details on filtering.
-
-        :returns: A list of Supported Services
-        :rtype: PaginatedList of Services
-        """
-
-        return self.client._get_and_filter(MonitorService, *filters)
-
-    def service_by_type(
-        self, service_type: str, *filters
+    def services(
+        self, service_type: Optional[str] = None, *filters
     ) -> list[MonitorService]:
         """
-        Lists monitor services by a given service_type
-
-            service_details = client.monitor_service.list_service_by_type(service_type="dbaas")
+        Lists services supported by ACLP.
+            supported_services = client.monitor_service.services()
+            service_details = client.monitor_service.services(service_type="dbaas")
 
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services-for-service-type
 
         :param service_type: The service type to get details for.
-        :type service_type: str
+        :type service_type: Optional[str]
         :param filters: Any number of filters to apply to this query.
                         See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                         for more details on filtering.
 
         :returns: Lists monitor services by a given service_type
         :rtype: PaginatedList of the Services
         """
+        endpoint = (
+            f"/monitor/services/{service_type}"
+            if service_type
+            else "/monitor/services"
+        )
         return self.client._get_and_filter(
             MonitorService,
             *filters,
-            endpoint=f"/monitor/services/{service_type}",
+            endpoint=endpoint,
         )
 
     def metric_definitions(

test/integration/models/monitor/test_monitor.py

@@ -30,7 +30,7 @@ def test_get_all_dashboards(test_linode_client):
     assert dashboard_by_id.id == 1
 
     # #Fetch Dashboard by service_type
-    dashboards_by_svc = client.monitor_service.dashboards_by_service(
+    dashboards_by_svc = client.monitor_service.dashboards(
         service_type=get_service_type
     )
     assert isinstance(dashboards_by_svc[0], MonitorDashboard)
@@ -46,7 +46,7 @@ def test_get_supported_services(test_linode_client):
     get_supported_service = supported_services[0].service_type
 
     # Get details for a particular service
-    service_details = client.monitor_service.service_by_type(
+    service_details = client.monitor_service.services(
         service_type=get_supported_service
     )
     assert isinstance(service_details[0], MonitorService)

test/unit/objects/monitor_service_test.py

@@ -43,7 +43,7 @@ def test_dashboard_by_ID(self):
         self.assertEqual(dashboard.widgets[0].y_label, "cpu_usage")
 
     def test_dashboard_by_service_type(self):
-        dashboards = self.client.monitor_service.dashboards_by_service(
+        dashboards = self.client.monitor_service.dashboards(
             service_type="dbaas"
         )
         self.assertEqual(dashboards[0].type, "standard")
@@ -87,9 +87,7 @@ def test_get_all_dashboards(self):
         self.assertEqual(dashboards[0].widgets[0].y_label, "cpu_usage")
 
     def test_specific_service_details(self):
-        data = self.client.monitor_service.service_by_type(
-            service_type="dbaas"
-        )
+        data = self.client.monitor_service.services(service_type="dbaas")
         self.assertEqual(data[0].label, "Databases")
         self.assertEqual(data[0].service_type, "dbaas")