review comments

Author: pmajali

linode_api4/groups/__init__.py

@@ -10,7 +10,7 @@
 from .lke import *
 from .lke_tier import *
 from .longview import *
-from .monitor_service import *
+from .monitor import *
 from .networking import *
 from .nodebalancer import *
 from .object_storage import *

linode_api4/groups/monitor_service.py renamed to linode_api4/groups/monitor.py

@@ -21,15 +21,15 @@ class MonitorGroup(Group):
     """
 
     def dashboards(
-        self, service_type: Optional[str] = None, *filters
+        self, *filters, service_type: Optional[str] = None
     ) -> PaginatedList:
         """
         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.dashboards()
+            dashboards = client.monitor_serv.dashboards()
             dashboard = client.load(MonitorDashboard, 1)
-            dashboards_by_service = client.monitor_service.dashboards(service_type="dbaas")
+            dashboards_by_service = client.monitor.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`.
 
@@ -59,12 +59,12 @@ def dashboards(
         )
 
     def services(
-        self, service_type: Optional[str] = None, *filters
+        self, *filters, service_type: Optional[str] = None
     ) -> list[MonitorService]:
         """
         Lists services supported by ACLP.
-            supported_services = client.monitor_service.services()
-            service_details = client.monitor_service.services(service_type="dbaas")
+            supported_services = client.monitor.services()
+            service_details = client.monitor.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`.
 
@@ -97,7 +97,7 @@ def metric_definitions(
         """
         Returns metrics for a specific service type.
 
-            metrics = client.monitor_service.list_metric_definitions(service_type="dbaas")
+            metrics = client.monitor.list_metric_definitions(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-information
@@ -122,7 +122,7 @@ def create_token(
     ) -> MonitorServiceToken:
         """
         Returns a JWE Token for a specific service type.
-            token = client.monitor_service.create_token(service_type="dbaas", entity_ids=[1234])
+            token = client.monitor.create_token(service_type="dbaas", entity_ids=[1234])
 
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 

linode_api4/linode_client.py

@@ -202,7 +202,7 @@ def __init__(
         #: Access methods related to VM placement - See :any:`PlacementAPIGroup` for more information.
         self.placement = PlacementAPIGroup(self)
 
-        self.monitor_service = MonitorGroup(self)
+        self.monitor = MonitorGroup(self)
 
     @property
     def _user_agent(self):

linode_api4/objects/__init__.py

@@ -21,4 +21,4 @@
 from .vpc import *
 from .beta import *
 from .placement import *
-from .monitor_service import *
+from .monitor import *

linode_api4/objects/monitor_service.py renamed to linode_api4/objects/monitor.py

@@ -151,19 +151,16 @@ class MonitorDashboard(Base):
     }
 
 
-class MonitorService(Base):
+@dataclass
+class MonitorService(JSONObject):
     """
     Represents a single service type.
     API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services
 
     """
 
-    api_endpoint = "/monitor/services/{service_type}"
-    id_attribute = "service_type"
-    properties = {
-        "service_type": Property(ServiceType, identifier=True),
-        "label": Property(),
-    }
+    service_type: ServiceType = ""
+    label: str = ""
 
 
 @dataclass

test/integration/models/monitor/test_monitor.py

@@ -18,7 +18,7 @@
 # List all dashboards
 def test_get_all_dashboards(test_linode_client):
     client = test_linode_client
-    dashboards = client.monitor_service.dashboards()
+    dashboards = client.monitor.dashboards()
     assert isinstance(dashboards[0], MonitorDashboard)
 
     dashboard_get = dashboards[0]
@@ -30,30 +30,28 @@ 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(
-        service_type=get_service_type
-    )
+    dashboards_by_svc = client.monitor.dashboards(service_type=get_service_type)
     assert isinstance(dashboards_by_svc[0], MonitorDashboard)
     assert dashboards_by_svc[0].service_type == get_service_type
 
 
 # List supported services
 def test_get_supported_services(test_linode_client):
     client = test_linode_client
-    supported_services = client.monitor_service.services()
+    supported_services = client.monitor.services()
     assert isinstance(supported_services[0], MonitorService)
 
     get_supported_service = supported_services[0].service_type
 
     # Get details for a particular service
-    service_details = client.monitor_service.services(
+    service_details = client.monitor.services(
         service_type=get_supported_service
     )
     assert isinstance(service_details[0], MonitorService)
     assert service_details[0].service_type == get_supported_service
 
     # Get Metric definition details for that particular service
-    metric_definitions = client.monitor_service.metric_definitions(
+    metric_definitions = client.monitor.metric_definitions(
         service_type=get_supported_service
     )
     assert isinstance(metric_definitions[0], MonitorMetricsDefinition)
@@ -103,7 +101,7 @@ def test_my_db_functionality(test_linode_client, test_create_and_test_db):
     entity_id = test_create_and_test_db.id
 
     # create token for the particular service
-    token = client.monitor_service.create_token(
+    token = client.monitor.create_token(
         service_type="dbaas", entity_ids=[entity_id]
     )
     assert isinstance(token, MonitorServiceToken)

test/unit/objects/monitor_service_test.py renamed to test/unit/objects/monitor.py

@@ -13,7 +13,7 @@ def test_supported_services(self):
         """
         Test the services supported by monitor
         """
-        service = self.client.monitor_service.services()
+        service = self.client.monitor.services()
         self.assertEqual(len(service), 1)
         self.assertEqual(service[0].label, "Databases")
         self.assertEqual(service[0].service_type, "dbaas")
@@ -43,9 +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(
-            service_type="dbaas"
-        )
+        dashboards = self.client.monitor.dashboards(service_type="dbaas")
         self.assertEqual(dashboards[0].type, "standard")
         self.assertEqual(
             dashboards[0].created, datetime.datetime(2024, 10, 10, 5, 1, 58)
@@ -66,7 +64,7 @@ def test_dashboard_by_service_type(self):
         self.assertEqual(dashboards[0].widgets[0].y_label, "cpu_usage")
 
     def test_get_all_dashboards(self):
-        dashboards = self.client.monitor_service.dashboards()
+        dashboards = self.client.monitor.dashboards()
         self.assertEqual(dashboards[0].type, "standard")
         self.assertEqual(
             dashboards[0].created, datetime.datetime(2024, 10, 10, 5, 1, 58)
@@ -87,15 +85,13 @@ 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.services(service_type="dbaas")
+        data = self.client.monitor.services(service_type="dbaas")
         self.assertEqual(data[0].label, "Databases")
         self.assertEqual(data[0].service_type, "dbaas")
 
     def test_metric_definitions(self):
 
-        metrics = self.client.monitor_service.metric_definitions(
-            service_type="dbaas"
-        )
+        metrics = self.client.monitor.metric_definitions(service_type="dbaas")
         self.assertEqual(
             metrics[0].available_aggregate_functions,
             ["max", "avg", "min", "sum"],
@@ -115,7 +111,7 @@ def test_metric_definitions(self):
     def test_create_token(self):
 
         with self.mock_post("/monitor/services/dbaas/token") as m:
-            self.client.monitor_service.create_token(
+            self.client.monitor.create_token(
                 service_type="dbaas", entity_ids=[189690, 188020]
             )
             self.assertEqual(m.return_dct["token"], "abcdefhjigkfghh")