[#3688] Add a config check and a placeholder client

src/openforms/contrib/objects_api/clients/__init__.py

@@ -1,3 +1,3 @@
-from .objects import ObjectsClient
+from .objects import ObjectsClient, ObjecttypesClient
 
-__all__ = ["ObjectsClient"]
+__all__ = ["ObjectsClient", "ObjecttypesClient"]

src/openforms/contrib/objects_api/clients/objects.py

@@ -9,3 +9,7 @@ def create_object(self, object_data: dict) -> dict:
         response.raise_for_status()
 
         return response.json()
+
+
+class ObjecttypesClient(NLXClient):
+    pass

src/openforms/registrations/contrib/objects_api/checks.py

@@ -4,13 +4,23 @@
 
 from openforms.plugins.exceptions import InvalidPluginConfiguration
 
-from .client import NoServiceConfigured, get_documents_client, get_objects_client
+from .client import (
+    NoServiceConfigured,
+    get_documents_client,
+    get_objects_client,
+    get_objecttypes_client,
+)
 from .models import ObjectsAPIConfig
 
 
 def check_objects_service():
     with get_objects_client() as client:
-        client.get("objects")
+        client.get("objects", params={"pageSize": 1})
+
+
+def check_objecttypes_service():
+    with get_objecttypes_client() as client:
+        client.get("objecttypes", params={"pageSize": 1})
 
 
 def check_documents_service():
@@ -22,6 +32,7 @@ def check_config():
     # First, check that the necessary services are configured correctly.
     services = (
         (check_objects_service, "objects_service"),
+        (check_objecttypes_service, "objecttypes_service"),
         (check_documents_service, "drc_service"),
     )
 

src/openforms/registrations/contrib/objects_api/client.py

@@ -10,9 +10,8 @@
 """
 
 from zgw_consumers.client import build_client
-from zgw_consumers.nlx import NLXClient
 
-from openforms.contrib.objects_api.clients import ObjectsClient
+from openforms.contrib.objects_api.clients import ObjectsClient, ObjecttypesClient
 from openforms.contrib.zgw.clients import DocumentenClient
 
 from .models import ObjectsAPIConfig
@@ -22,14 +21,22 @@ class NoServiceConfigured(RuntimeError):
     pass
 
 
-def get_objects_client() -> NLXClient:
+def get_objects_client() -> ObjectsClient:
     config = ObjectsAPIConfig.get_solo()
     assert isinstance(config, ObjectsAPIConfig)
     if not (service := config.objects_service):
         raise NoServiceConfigured("No Objects API service configured!")
     return build_client(service, client_factory=ObjectsClient)
 
 
+def get_objecttypes_client() -> ObjecttypesClient:
+    config = ObjectsAPIConfig.get_solo()
+    assert isinstance(config, ObjectsAPIConfig)
+    if not (service := config.objecttypes_service):
+        raise NoServiceConfigured("No Objects API service configured!")
+    return build_client(service, client_factory=ObjecttypesClient)
+
+
 def get_documents_client() -> DocumentenClient:
     config = ObjectsAPIConfig.get_solo()
     assert isinstance(config, ObjectsAPIConfig)

src/openforms/registrations/contrib/objects_api/tests/test_config_checks.py

@@ -23,6 +23,9 @@ def setUp(self):
             objects_service=ServiceFactory.build(
                 api_root="https://objects.example.com/api/v1/",
             ),
+            objecttypes_service=ServiceFactory.build(
+                api_root="https://objecttypes.example.com/api/v1/",
+            ),
             drc_service=ServiceFactory.build(
                 api_root="https://documents.example.com/api/v1/",
                 api_type=APITypes.drc,
@@ -41,7 +44,11 @@ def setUp(self):
 
     def _mockForValidServiceConfiguration(self, m: requests_mock.Mocker) -> None:
         m.get(
-            "https://objects.example.com/api/v1/objects",
+            "https://objects.example.com/api/v1/objects?pageSize=1",
+            json={"results": []},
+        )
+        m.get(
+            "https://objecttypes.example.com/api/v1/objecttypes?pageSize=1",
             json={"results": []},
         )
         m.get(
@@ -59,7 +66,7 @@ def test_no_objects_service_configured(self):
     @requests_mock.Mocker()
     def test_objects_service_misconfigured(self, m):
         m.get(
-            "https://objects.example.com/api/v1/objects",
+            "https://objects.example.com/api/v1/objects?pageSize=1",
             exc=requests.ConnectionError,
         )
         plugin = ObjectsAPIRegistration(PLUGIN_IDENTIFIER)
@@ -71,7 +78,11 @@ def test_objects_service_misconfigured(self, m):
     def test_no_documents_service_configured(self, m):
         self.config.drc_service = None
         m.get(
-            "https://objects.example.com/api/v1/objects",
+            "https://objects.example.com/api/v1/objects?pageSize=1",
+            json={"results": []},
+        )
+        m.get(
+            "https://objecttypes.example.com/api/v1/objecttypes?pageSize=1",
             json={"results": []},
         )
         plugin = ObjectsAPIRegistration(PLUGIN_IDENTIFIER)

src/openforms/registrations/contrib/objects_api/tests/test_models.py

@@ -2,8 +2,7 @@
 from django.test import TestCase
 
 from zgw_consumers.constants import APITypes
-
-from zgw_consumers_ext.tests.factories import ServiceFactory
+from zgw_consumers.test.factories import ServiceFactory
 
 from ..models import ObjectsAPIConfig