[#3732] Fix API documentation after drf-spectacular upgrade

Author: Viicos

src/openapi.yaml

@@ -6333,6 +6333,8 @@ components:
           title: Appointment time
           description: Date and time of the appointment
         contactDetails:
+          type: object
+          additionalProperties: {}
           description: Additional contact detail field values.
         privacyPolicyAccepted:
           type: boolean
@@ -6348,7 +6350,6 @@ components:
             the endpoint contains a token which invalidates on state changes and after
             one day.
       required:
-      - contactDetails
       - date
       - datetime
       - location
@@ -6923,6 +6924,8 @@ components:
           - $ref: '#/components/schemas/PaymentBackendEnum'
           - $ref: '#/components/schemas/BlankEnum'
         paymentBackendOptions:
+          type: object
+          additionalProperties: {}
           nullable: true
         paymentOptions:
           type: array
@@ -7138,6 +7141,8 @@ components:
       type: object
       properties:
         data:
+          type: object
+          additionalProperties: {}
           title: form data
           description: The Form.io submission data object. This will be merged with
             the full form submission data, including data from other steps, to evaluate
@@ -7165,6 +7170,8 @@ components:
           pattern: ^[-a-zA-Z0-9_]+$
           deprecated: true
         configuration:
+          allOf:
+          - $ref: '#/components/schemas/FormDefinitionConfiguration'
           title: Form.io configuration
           description: The form definition as Form.io JSON schema
         loginRequired:
@@ -7183,6 +7190,22 @@ components:
       - configuration
       - name
       - url
+    FormDefinitionConfiguration:
+      type: object
+      properties:
+        type:
+          $ref: '#/components/schemas/FormDefinitionConfigurationTypeEnum'
+        components:
+          type: array
+          items: {}
+      required:
+      - components
+      - type
+    FormDefinitionConfigurationTypeEnum:
+      enum:
+      - form
+      type: string
+      description: '* `form` - form'
     FormDefinitionDetail:
       type: object
       properties:
@@ -7206,6 +7229,8 @@ components:
           pattern: ^[-a-zA-Z0-9_]+$
           deprecated: true
         configuration:
+          allOf:
+          - $ref: '#/components/schemas/FormDefinitionConfiguration'
           title: Form.io configuration
           description: The form definition as Form.io JSON schema
         loginRequired:
@@ -7597,11 +7622,14 @@ components:
           title: Registration backend
           maxLength: 100
         options:
-          title: Registration backend options
+          type: object
+          additionalProperties: {}
+          title: registration backend options
       required:
       - backend
       - key
       - name
+      - options
     FormStep:
       type: object
       properties:
@@ -7617,6 +7645,8 @@ components:
           maxLength: 100
           pattern: ^[-a-zA-Z0-9_]+$
         configuration:
+          allOf:
+          - $ref: '#/components/schemas/FormDefinitionConfiguration'
           readOnly: true
         formDefinition:
           type: string
@@ -8131,6 +8161,8 @@ components:
       type: object
       properties:
         value:
+          type: object
+          additionalProperties: {}
           title: service_fetch_configuration
       required:
       - value
@@ -8460,6 +8492,8 @@ components:
           - $ref: '#/components/schemas/PaymentBackendEnum'
           - $ref: '#/components/schemas/BlankEnum'
         paymentBackendOptions:
+          type: object
+          additionalProperties: {}
           nullable: true
         paymentOptions:
           type: array
@@ -8652,6 +8686,8 @@ components:
           pattern: ^[-a-zA-Z0-9_]+$
           deprecated: true
         configuration:
+          allOf:
+          - $ref: '#/components/schemas/FormDefinitionConfiguration'
           title: Form.io configuration
           description: The form definition as Form.io JSON schema
         loginRequired:
@@ -8681,6 +8717,8 @@ components:
           maxLength: 100
           pattern: ^[-a-zA-Z0-9_]+$
         configuration:
+          allOf:
+          - $ref: '#/components/schemas/FormDefinitionConfiguration'
           readOnly: true
         formDefinition:
           type: string
@@ -8773,6 +8811,8 @@ components:
           type: string
           description: The human-readable name for a plugin.
         schema:
+          type: object
+          additionalProperties: {}
           title: JSON schema
           description: The generated JSON schema for the plugin options.
       required:
@@ -8901,6 +8941,8 @@ components:
           type: string
           description: The human-readable name for a plugin.
         schema:
+          type: object
+          additionalProperties: {}
           title: JSON schema
           description: The generated JSON schema for the plugin options.
       required:
@@ -8978,10 +9020,17 @@ components:
             * `GET` - GET
             * `POST` - POST
         headers:
+          type: object
+          additionalProperties: {}
           title: HTTP request headers
           description: Additions and overrides for the HTTP request headers as defined
             in the Service.
         queryParams:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
           title: HTTP query string
         body:
           nullable: true
@@ -9139,6 +9188,8 @@ components:
         value:
           description: Raw value of the component.
         component:
+          type: object
+          additionalProperties: {}
           description: Configuration of the component.
       required:
       - component
@@ -9242,6 +9293,8 @@ components:
           - $ref: '#/components/schemas/ContextAwareFormStep'
           readOnly: true
         data:
+          type: object
+          additionalProperties: {}
           nullable: true
         isApplicable:
           type: boolean

src/openforms/appointments/api/serializers.py

@@ -168,6 +168,11 @@ class AppointmentSerializer(serializers.HyperlinkedModelSerializer):
             "one day."
         ),
     )
+    contact_details = serializers.DictField(
+        label=_("contact details"),
+        help_text=_("Additional contact detail field values."),
+        required=False,
+    )
 
     _status_url: str  # set by the view
 

src/openforms/forms/api/serializers/form.py

@@ -57,6 +57,8 @@ class FormLiteralsSerializer(serializers.Serializer):
 
 
 class FormRegistrationBackendSerializer(serializers.ModelSerializer):
+    options = serializers.DictField(label=_("registration backend options"))
+
     class Meta:
         model = FormRegistrationBackend
         fields = [
@@ -161,6 +163,11 @@ class FormSerializer(PublicFieldsSerializerMixin, serializers.ModelSerializer):
         required=False,
         default="",
     )
+    payment_backend_options = serializers.DictField(
+        label=_("payment backend options"),
+        required=False,
+        allow_null=True,
+    )
     payment_options = PaymentOptionsReadOnlyField()
 
     appointment_options = AppointmentOptionsSerializer(

src/openforms/forms/api/serializers/form_definition.py

@@ -58,6 +58,13 @@ def get_admin_url(self, obj: Form) -> str:
         return request.build_absolute_uri(admin_url)
 
 
+class FormDefinitionConfigurationSerializer(serializers.Serializer):
+    type = serializers.ChoiceField(
+        choices=["form"],
+    )
+    components = serializers.ListField()
+
+
 @extend_schema_serializer(deprecate_fields=["slug"])
 class FormDefinitionSerializer(
     PublicFieldsSerializerMixin, serializers.HyperlinkedModelSerializer
@@ -66,6 +73,10 @@ class FormDefinitionSerializer(
     component_translations = ComponentTranslationsSerializer(
         required=False, allow_null=True
     )
+    configuration = FormDefinitionConfigurationSerializer(
+        label=_("Form.io configuration"),
+        help_text=_("The form definition as Form.io JSON schema"),
+    )
 
     class Meta:
         model = FormDefinition

src/openforms/forms/api/serializers/form_step.py

@@ -13,6 +13,7 @@
 from ...validators import validate_no_duplicate_keys_across_steps
 from ..validators import FormStepIsApplicableIfFirstValidator
 from .button_text import ButtonTextSerializer
+from .form_definition import FormDefinitionConfigurationSerializer
 
 
 class FormStepLiteralsSerializer(serializers.Serializer):
@@ -68,7 +69,7 @@ class FormStepSerializer(
     PublicFieldsSerializerMixin, serializers.HyperlinkedModelSerializer
 ):
     index = serializers.IntegerField(source="order")
-    configuration = serializers.JSONField(
+    configuration = FormDefinitionConfigurationSerializer(
         source="form_definition.configuration", read_only=True
     )
     login_required = serializers.BooleanField(

src/openforms/forms/api/serializers/logic/action_serializers.py

@@ -67,7 +67,7 @@ class LogicValueActionSerializer(serializers.Serializer):
 
 
 class LogicFetchActionSerializer(serializers.Serializer):
-    value = serializers.JSONField(
+    value = serializers.DictField(
         label=_("service_fetch_configuration"),
     )
 

src/openforms/payments/api/serializers.py

@@ -13,7 +13,7 @@ class PaymentPluginSerializer(PluginBaseSerializer):
     """
 
     # add the configuration form options
-    schema = serializers.JSONField(
+    schema = serializers.DictField(
         source="configuration_options.display_as_jsonschema",
         label=_("JSON schema"),
         help_text=_("The generated JSON schema for the plugin options."),

src/openforms/registrations/api/serializers.py

@@ -10,7 +10,7 @@
 
 
 class RegistrationPluginSerializer(PluginBaseSerializer):
-    schema = serializers.JSONField(
+    schema = serializers.DictField(
         source="configuration_options.display_as_jsonschema",
         label=_("JSON schema"),
         help_text=_("The generated JSON schema for the plugin options."),

src/openforms/submissions/api/serializers.py

@@ -211,7 +211,7 @@ def get_configuration(self, instance) -> dict:
 class SubmissionStepSerializer(NestedHyperlinkedModelSerializer):
     form_step = ContextAwareFormStepSerializer(read_only=True)
     slug = serializers.SlugField(source="form_step.slug", read_only=True)
-    data = serializers.JSONField(
+    data = serializers.DictField(
         label=_("data"),
         required=False,
         allow_null=True,
@@ -261,7 +261,7 @@ def validate_data(self, data: dict):
 
 
 class FormDataSerializer(serializers.Serializer):
-    data = serializers.JSONField(
+    data = serializers.DictField(
         label=_("form data"),
         required=False,
         help_text=_(
@@ -469,7 +469,7 @@ class SubmissionComponentSummarySerializer(serializers.Serializer):
         help_text=_("Raw value of the component."),
         required=True,
     )
-    component = serializers.JSONField(
+    component = serializers.DictField(
         help_text=_("Configuration of the component."),
         required=True,
     )

src/openforms/variables/api/serializers.py

@@ -1,3 +1,5 @@
+from django.utils.translation import gettext_lazy as _
+
 from rest_framework import serializers
 
 from openforms.api.validators import ModelValidator
@@ -7,6 +9,19 @@
 
 
 class ServiceFetchConfigurationSerializer(serializers.HyperlinkedModelSerializer):
+    headers = serializers.DictField(
+        label=_("HTTP request headers"),
+        help_text=_(
+            "Additions and overrides for the HTTP request headers as defined in the Service."
+        ),
+        required=False,
+    )
+    query_params = serializers.DictField(
+        child=serializers.ListField(child=serializers.CharField()),
+        label=_("HTTP query string"),
+        required=False,
+    )
+
     def to_internal_value(self, data):
         value = super().to_internal_value(data)
         # add id for the bulk update of form_variables