Implement Objects API sets

src/openapi.yaml

@@ -3802,6 +3802,12 @@ paths:
         registration backend and ZGW APIs services.
       summary: List available InformatieObjectTypen
       parameters:
+      - in: query
+        name: objects_api_group
+        schema:
+          type: integer
+        description: The primary key of the Objects API group to use. The informatieobjecttypen
+          from the Catalogi API in this group will be returned.
       - in: query
         name: registration_backend
         schema:
@@ -3824,6 +3830,7 @@ paths:
           * `objects_api` - Objects API registration
           * `microsoft-graph` - Microsoft Graph (OneDrive/SharePoint)
           * `camunda` - Camunda
+        required: true
       - in: query
         name: zgw_api_group
         schema:
@@ -3919,6 +3926,12 @@ paths:
         List the available Objecttypes.
 
         Note that the response data is essentially proxied from the configured Objecttypes API.
+      parameters:
+      - in: query
+        name: objects_api_group
+        schema:
+          type: string
+        description: Which Objects API group to use.
       tags:
       - registration
       security:
@@ -3949,6 +3962,11 @@ paths:
 
         Note that the response data is essentially proxied from the configured Objecttypes API.
       parameters:
+      - in: query
+        name: objects_api_group
+        schema:
+          type: string
+        description: Which Objects API group to use.
       - in: path
         name: submission_uuid
         schema:
@@ -9919,6 +9937,9 @@ components:
     TargetPathsInput:
       type: object
       properties:
+        objectsApiGroup:
+          type: integer
+          description: Which Objects API group to use.
         objecttypeUrl:
           type: string
           format: uri
@@ -9931,6 +9952,7 @@ components:
           additionalProperties: {}
           description: The JSON Schema of the form variable.
       required:
+      - objectsApiGroup
       - objecttypeUrl
       - objecttypeVersion
       - variableJsonSchema

src/openforms/fixtures/admin_index_unlisted.json

@@ -20,6 +20,7 @@
     "qmatic.QmaticConfig",
     "registrations_email.EmailConfig",
     "registrations_microsoft_graph.MSGraphRegistrationConfig",
+    "registrations_objects_api.ObjectsAPIGroupConfig",
     "registrations_objects_api.ObjectsAPIConfig",
     "stuf.StufService",
     "stuf_bg.StufBGConfig",

src/openforms/forms/migrations/0100_add_default_objects_api_group.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.2.11 on 2024-06-19 13:09
+
+from django.db import migrations
+
+from django.db.migrations.state import StateApps
+from django.db.backends.base.schema import BaseDatabaseSchemaEditor
+
+
+def add_default_objects_api_group(
+    apps: StateApps, schema_editor: BaseDatabaseSchemaEditor
+) -> None:
+    FormRegistrationBackend = apps.get_model("forms", "FormRegistrationBackend")
+    ObjectsAPIGroupConfig = apps.get_model(
+        "registrations_objects_api", "ObjectsAPIGroupConfig"
+    )
+
+    objects_api_group_config = ObjectsAPIGroupConfig.objects.order_by("pk").first()
+    if objects_api_group_config is None:
+        # Because this migration runs after registrations_objects_api/0017_move_singleton_data,
+        # Having no Objects API Group means we had no solo config in the first place, thus
+        # it is safe to assume no Objects API registration backend was set up.
+        return
+
+    for registration_backend in FormRegistrationBackend.objects.filter(
+        backend="objects_api"
+    ):
+        registration_backend.options.setdefault(
+            "objects_api_group", objects_api_group_config.pk
+        )
+        registration_backend.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("forms", "0099_auto_20240613_0654"),
+        ("registrations_objects_api", "0017_move_singleton_data"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            add_default_objects_api_group,
+            migrations.RunPython.noop,
+        ),
+    ]

src/openforms/forms/tests/test_migrations.py

@@ -1,3 +1,5 @@
+from django.db.migrations.state import StateApps
+
 from zgw_consumers.constants import APITypes, AuthTypes
 
 from openforms.utils.tests.test_migrations import TestMigrations
@@ -447,3 +449,39 @@ def test_conditionals_are_fixed(self):
             isinstance(fixed_components[6]["components"][0]["conditional"]["eq"], bool)
         )
         self.assertTrue(fixed_components[6]["components"][0]["conditional"]["eq"])
+
+
+class AddDefaultObjectsAPIGroupMigrationTests(TestMigrations):
+    app = "forms"
+    migrate_from = "0099_auto_20240613_0654"
+    migrate_to = "0100_add_default_objects_api_group"
+
+    def setUpBeforeMigration(self, apps: StateApps) -> None:
+        Form = apps.get_model("forms", "Form")
+        FormRegistrationBackend = apps.get_model("forms", "FormRegistrationBackend")
+        ObjectsAPIGroupConfig = apps.get_model(
+            "registrations_objects_api", "ObjectsAPIGroupConfig"
+        )
+
+        form = Form.objects.create(name="test form")
+        ObjectsAPIGroupConfig.objects.create(name="Objects API Group")
+
+        FormRegistrationBackend.objects.create(
+            form=form,
+            name="Objects API backend",
+            key="backend",
+            backend="objects_api",
+        )
+
+    def test_sets_default_objects_api_group(self) -> None:
+        FormRegistrationBackend = self.apps.get_model(
+            "forms", "FormRegistrationBackend"
+        )
+        ObjectsAPIGroupConfig = self.apps.get_model(
+            "registrations_objects_api", "ObjectsAPIGroupConfig"
+        )
+
+        backend = FormRegistrationBackend.objects.get()
+        self.assertEqual(
+            backend.options["objects_api_group"], ObjectsAPIGroupConfig.objects.get().pk
+        )

src/openforms/js/compiled-lang/en.json

@@ -2539,6 +2539,12 @@
       "value": "Form variable"
     }
   ],
+  "RELMCa": [
+    {
+      "type": 0,
+      "value": "Which Objects API group to use."
+    }
+  ],
   "RN628y": [
     {
       "type": 0,
@@ -4545,6 +4551,12 @@
       "value": "House number"
     }
   ],
+  "mgs/Xe": [
+    {
+      "type": 0,
+      "value": "Objects API group"
+    }
+  ],
   "mpzdoT": [
     {
       "type": 0,

src/openforms/js/compiled-lang/nl.json

@@ -2539,6 +2539,12 @@
       "value": "Form variable"
     }
   ],
+  "RELMCa": [
+    {
+      "type": 0,
+      "value": "Which Objects API group to use."
+    }
+  ],
   "RN628y": [
     {
       "type": 0,
@@ -4550,6 +4556,12 @@
       "value": "Huisnummer"
     }
   ],
+  "mgs/Xe": [
+    {
+      "type": 0,
+      "value": "Objects API group"
+    }
+  ],
   "mpzdoT": [
     {
       "type": 0,

src/openforms/js/components/admin/form_design/registrations/objectsapi/LegacyConfigFields.js

@@ -1,18 +1,20 @@
 import PropTypes from 'prop-types';
-import React, {useContext} from 'react';
+import React, {useContext, useEffect} from 'react';
 import {useIntl} from 'react-intl';
 
 import {CustomFieldTemplate} from 'components/admin/RJSFWrapper';
 import {Checkbox, NumberInput, TextArea, TextInput} from 'components/admin/forms/Inputs';
+import Select from 'components/admin/forms/Select';
 import {ValidationErrorContext} from 'components/admin/forms/ValidationErrors';
 
-import {getErrorMarkup, getFieldErrors} from './utils';
+import {getChoicesFromSchema, getErrorMarkup, getFieldErrors} from './utils';
 
-const LegacyConfigFields = ({index, name, formData, onChange}) => {
+const LegacyConfigFields = ({index, name, schema, formData, onChange}) => {
   const intl = useIntl();
   const validationErrors = useContext(ValidationErrorContext);
 
   const {
+    objectsApiGroup = '',
     objecttype = '',
     objecttypeVersion = '',
     productaanvraagType = '',
@@ -30,8 +32,43 @@ const LegacyConfigFields = ({index, name, formData, onChange}) => {
     return rawErrors ? getErrorMarkup(rawErrors) : null;
   };
 
+  useEffect(() => {
+    if (schema.properties.objectsApiGroup.enum.length === 1 && objectsApiGroup === '') {
+      onChange({
+        target: {name: 'objectsApiGroup', value: schema.properties.objectsApiGroup.enum[0]},
+      });
+    }
+  }, []);
+
   return (
     <>
+      <CustomFieldTemplate
+        id="root_objectsApiGroup"
+        label={intl.formatMessage({
+          defaultMessage: 'Objects API group',
+          description: 'Objects API group',
+        })}
+        rawDescription={intl.formatMessage({
+          description: 'Objects API group selection',
+          defaultMessage: 'Which Objects API group to use.',
+        })}
+        rawErrors={getFieldErrors(name, index, validationErrors, 'objectsApiGroup')}
+        errors={buildErrorsComponent('objectsApiGroup')}
+        displayLabel
+        required
+      >
+        <Select
+          id="root_objectsApiGroup"
+          name="objectsApiGroup"
+          choices={getChoicesFromSchema(
+            schema.properties.objectsApiGroup.enum,
+            schema.properties.objectsApiGroup.enumNames
+          )}
+          value={objectsApiGroup}
+          onChange={onChange}
+          allowBlank
+        />
+      </CustomFieldTemplate>
       <CustomFieldTemplate
         id="root_objecttype"
         label={intl.formatMessage({
@@ -269,7 +306,9 @@ const LegacyConfigFields = ({index, name, formData, onChange}) => {
 LegacyConfigFields.propTypes = {
   index: PropTypes.number,
   name: PropTypes.string,
+  schema: PropTypes.any,
   formData: PropTypes.shape({
+    objectsApiGroup: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
     version: PropTypes.number,
     objecttype: PropTypes.string,
     objecttypeVersion: PropTypes.string,

src/openforms/js/components/admin/form_design/registrations/objectsapi/ObjectTypeSelect.js

@@ -18,7 +18,7 @@ const ObjectTypeSelect = ({availableObjectTypesState, objecttype, onChange}) =>
   // synchronize the UI state back to the form state)
   useEffect(() => {
     // do nothing if no options have been loaded
-    if (loading) return;
+    if (loading || !availableObjecttypes.length) return;
 
     // check if a valid option is selected, if this is the case -> do nothing
     const isOptionPresent = availableObjecttypes.find(ot => ot.url === objecttype);

src/openforms/js/components/admin/form_design/registrations/objectsapi/ObjectTypeVersionSelect.js

@@ -15,6 +15,7 @@ const getObjecttypeVersionsEndpoint = objecttype => {
 };
 
 const ObjectTypeVersionSelect = ({
+  objectsApiGroup,
   availableObjecttypes = [],
   selectedObjecttype,
   selectedVersion,
@@ -27,17 +28,19 @@ const ObjectTypeVersionSelect = ({
     value: availableVersions = [],
     error,
   } = useAsync(async () => {
+    if (!objectsApiGroup) return [];
     const objecttype = availableObjecttypes.find(ot => ot.url === selectedObjecttype);
     // no match -> no versions to retrieve;
     if (!objecttype) return [];
 
-    const response = await get(getObjecttypeVersionsEndpoint(objecttype));
+    const params = {objects_api_group: objectsApiGroup};
+    const response = await get(getObjecttypeVersionsEndpoint(objecttype), params);
     if (!response.ok) {
       throw new Error('Loading available object types failed');
     }
     const versions = response.data;
     return versions.sort((v1, v2) => v2.version - v1.version);
-  }, [selectedObjecttype, objecttypeUrls]);
+  }, [selectedObjecttype, objecttypeUrls, objectsApiGroup]);
 
   const choices =
     loading || error
@@ -76,6 +79,7 @@ const ObjectTypeVersionSelect = ({
 };
 
 ObjectTypeVersionSelect.propTypes = {
+  objectsApiGroup: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   availableObjecttypes: PropTypes.array,
   selectedObjecttype: PropTypes.string.isRequired,
   selectedVersion: PropTypes.string.isRequired,

src/openforms/js/components/admin/form_design/registrations/objectsapi/ObjectsApiOptionsFormFields.js

@@ -99,6 +99,7 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
             <LegacyConfigFields
               index={index}
               name={name}
+              schema={schema}
               formData={formData}
               onChange={onFieldChange}
             />
@@ -111,6 +112,7 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
             <V2ConfigFields
               index={index}
               name={name}
+              schema={schema}
               formData={formData}
               onChange={onFieldChange}
             />
@@ -126,6 +128,7 @@ ObjectsApiOptionsFormFields.propTypes = {
   name: PropTypes.string,
   schema: PropTypes.any,
   formData: PropTypes.shape({
+    objectsApiGroup: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
     version: PropTypes.number,
     objecttype: PropTypes.string,
     objecttypeVersion: PropTypes.string,