Fix openapi schema for created resources

pulp · Dec 5, 2024 · 5f0146e · 5f0146e
1 parent ed27c95
commit 5f0146e
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/CHANGES/+created_resource_schema.bugfix b/CHANGES/+created_resource_schema.bugfix
@@ -0,0 +1 @@
+Fixed the schema definition for created resources.
diff --git a/pulpcore/app/serializers/base.py b/pulpcore/app/serializers/base.py
@@ -20,6 +20,7 @@
     NestedHyperlinkedIdentityField,
     NestedHyperlinkedRelatedField,
 )
+from drf_spectacular.utils import extend_schema_field
 
 from pulpcore.app.models import (
     Task,
@@ -176,6 +177,7 @@ def to_representation(self, value):
 PKDomainObject = namedtuple("PKDomainObject", ["pk", "pulp_domain"])
 
 
+@extend_schema_field({"anyOf": [{"type": "null"}, {"type": "string", "format": "uri"}]})
 class RelatedResourceField(RelatedField):
     """RelatedResourceField when relating a Resource object models.
 

diff --git a/pulpcore/app/serializers/task.py b/pulpcore/app/serializers/task.py
@@ -17,7 +17,7 @@
 from pulpcore.app.util import reverse
 
 
-class CreatedResourceSerializer(RelatedResourceField):
+class CreatedResourceField(RelatedResourceField):
     class Meta:
         model = models.CreatedResource
         fields = []
@@ -78,7 +78,7 @@ class TaskSerializer(ModelSerializer):
         view_name="task-groups-detail",
     )
     progress_reports = ProgressReportSerializer(many=True, read_only=True)
-    created_resources = CreatedResourceSerializer(
+    created_resources = CreatedResourceField(
         help_text=_("Resources created by this task."),
         many=True,
         read_only=True,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fixed the schema definition for created resources.