[PR #5936/58425d79 backport][3.39] Fix Any serializer type regression breaking Ruby bindings

CHANGES/+fix-any-type.bugfix

@@ -0,0 +1,2 @@
+Fixed the JSONField specification so it doesn't break ruby bindings.
+See context [here](https://github.com/pulp/pulp_rpm/issues/3639).

pulpcore/app/serializers/domain.py

@@ -238,7 +238,7 @@ class GoogleSettingsSerializer(BaseSettingsClass):
 
     bucket_name = serializers.CharField(required=True)
     project_id = serializers.CharField(required=True)
-    # credentials = serializers.JSONField(write_only=True)  # Need better upstream support
+    # credentials = fields.JSONDictField(write_only=True)  # Need better upstream support
     custom_endpoint = serializers.CharField(allow_null=True, default=None)
     location = serializers.CharField(allow_blank=True, default="")
     default_acl = serializers.CharField(allow_null=True, default=None)

pulpcore/app/serializers/exporter.py

@@ -15,6 +15,7 @@
     RelatedField,
     RelatedResourceField,
     RepositoryVersionRelatedField,
+    fields,
 )
 from pulpcore.constants import FS_EXPORT_CHOICES, FS_EXPORT_METHODS
 
@@ -103,7 +104,7 @@ class ExportSerializer(ModelSerializer):
         view_name="None",  # This is a polymorphic field. The serializer does not need a view name.
     )
 
-    params = serializers.JSONField(
+    params = fields.JSONDictField(
         help_text=_("Any additional parameters that were used to create the export."),
         read_only=True,
     )
@@ -118,12 +119,12 @@ class PulpExportSerializer(ExportSerializer):
     Serializer for PulpExports.
     """
 
-    output_file_info = serializers.JSONField(
+    output_file_info = fields.JSONDictField(
         help_text=_("Dictionary of filename: sha256hash entries for export-output-file(s)"),
         read_only=True,
     )
 
-    toc_info = serializers.JSONField(
+    toc_info = fields.JSONDictField(
         help_text=_("Filename and sha256-checksum of table-of-contents for this export"),
         read_only=True,
     )

pulpcore/app/serializers/fields.py

@@ -4,6 +4,8 @@
 from urllib.parse import urljoin
 
 from django.conf import settings
+from drf_spectacular.utils import extend_schema_field
+from drf_spectacular.types import OpenApiTypes
 from rest_framework import serializers
 from rest_framework.fields import empty
 from rest_framework.reverse import reverse
@@ -20,6 +22,15 @@ def relative_path_validator(relative_path):
         )
 
 
+@extend_schema_field(OpenApiTypes.OBJECT)
+class JSONDictField(serializers.JSONField):
+    """A drf JSONField override to force openapi schema to use 'object' type.
+
+    Not strictly correct, but we relied on that for a long time.
+    See: https://github.com/tfranzel/drf-spectacular/issues/1095
+    """
+
+
 class SingleContentArtifactField(RelatedField):
     """
     A serializer field for the '_artifacts' ManyToManyField on the Content model (single-artifact).

pulpcore/app/serializers/importer.py

@@ -12,6 +12,7 @@
     ModelSerializer,
     RelatedField,
     ValidateFieldsMixin,
+    fields,
 )
 
 
@@ -40,7 +41,7 @@ class ImportSerializer(ModelSerializer):
         view_name="tasks-detail",
     )
 
-    params = serializers.JSONField(
+    params = fields.JSONDictField(
         help_text=_("Any parameters that were used to create the import."),
     )
 

pulpcore/app/serializers/task.py

@@ -13,6 +13,7 @@
     RelatedField,
     RelatedResourceField,
     TaskGroupStatusCountField,
+    fields,
 )
 from pulpcore.constants import TASK_STATES
 from pulpcore.app.util import get_domain
@@ -45,7 +46,7 @@ class TaskSerializer(ModelSerializer):
         help_text=_("Timestamp of the when this task stopped execution."), read_only=True
     )
     error = serializers.DictField(
-        child=serializers.JSONField(),
+        child=fields.JSONDictField(),
         help_text=_(
             "A JSON Object of a fatal error encountered during the execution of this task."
         ),