[#4396] Added the prefill available attributes functionality

This is based on retrieving the specific objecttype version and based on
the JsonSchema we define the available attributes.

src/openforms/prefill/contrib/objects_api/plugin.py

@@ -10,6 +10,7 @@
 from ...base import BasePlugin
 from ...constants import IdentifierRoles
 from ...registry import register
+from .utils import retrieve_properties
 
 logger = logging.getLogger(__name__)
 
@@ -25,7 +26,8 @@ class ObjectsAPIPrefill(BasePlugin):
  def get_available_attributes(
  reference: dict[str, Any] | None = None,
  ) -> Iterable[tuple[str, str]]:
- pass
+ assert reference is not None
+ return retrieve_properties(reference)
 
  @classmethod
  def get_prefill_values(
@@ -41,3 +43,6 @@ def get_co_sign_values(
  cls, submission: Submission, identifier: str
  ) -> tuple[dict[str, Any], str]:
  pass
+
+ def check_config(self):
+ pass

src/openforms/prefill/contrib/objects_api/utils.py

@@ -0,0 +1,55 @@
+from typing import Any, Iterable
+
+from referencing.jsonschema import ObjectSchema
+
+from openforms.registrations.contrib.objects_api.client import get_objecttypes_client
+
+
+def parse_schema_properties(
+ schema: ObjectSchema, parent_key: str = ""
+) -> list[tuple[str, str]]:
+ properties = []
+
+ if schema["type"] == "object":
+ for prop, prop_schema in schema.get("properties", {}).items():
+ full_key = f"{parent_key}.{prop}" if parent_key else prop
+ prop_type = prop_schema.get("type", "unknown")
+ properties.append((full_key, prop_type))
+ if prop_type == "object" or (
+ prop_type == "array" and "items" in prop_schema
+ ):
+ properties.extend(parse_schema_properties(prop_schema, full_key))
+ elif schema["type"] == "array":
+ items_schema = schema.get("items", {})
+ if isinstance(items_schema, dict):
+ properties.extend(parse_schema_properties(items_schema, f"{parent_key}[]"))
+ elif isinstance(items_schema, list):
+ for i, item_schema in enumerate(items_schema):
+ properties.extend(
+ parse_schema_properties(item_schema, f"{parent_key}[{i}]")
+ )
+ else:
+ properties.append((parent_key, schema["type"]))
+
+ # also remove the props of type object since it's not needed e.g.-> (name, object)
+ # it's the parent prop of the object, we need the real properties and their types
+ return [
+ (prop[0].replace(".", " > "), prop[1])
+ for prop in properties
+ if prop[1] != "object"
+ ]
+
+
+def retrieve_properties(
+ reference: dict[str, Any] | None = None,
+) -> Iterable[tuple[str, str]]:
+ assert reference is not None
+
+ with get_objecttypes_client(reference["objects_api_group"]) as client:
+ json_schema = client.get_objecttype_version(
+ reference["objects_api_objecttype_uuid"],
+ reference["objects_api_objecttype_version"],
+ )["jsonSchema"]
+
+ properties = parse_schema_properties(json_schema)
+ return [(prop[0], f"{prop[0]} ({prop[1]})") for prop in properties]