fix: schema for update order response

Author: alicecoordinator

api/oas_schemas.py

@@ -2,9 +2,14 @@
 
 from decouple import config
 from django.conf import settings
-from drf_spectacular.utils import OpenApiExample, OpenApiParameter
+from drf_spectacular.utils import (
+    OpenApiExample,
+    OpenApiParameter,
+    PolymorphicProxySerializer,
+)
 
 from api.serializers import (
+    CancelledOrderResponseSerializer,
     InfoSerializer,
     ListOrderSerializer,
     OrderDetailSerializer,
@@ -353,7 +358,15 @@ class OrderViewSchema:
             ),
         ],
         "responses": {
-            200: OrderDetailSerializer,
+            200: PolymorphicProxySerializer(
+                component_name="UpdateOrderResponse",
+                serializers=[
+                    CancelledOrderResponseSerializer,
+                    OrderDetailSerializer,
+                ],
+                resource_type_field_name=None,
+                many=False,
+            ),
             400: {
                 "type": "object",
                 "properties": {

api/serializers.py

@@ -500,6 +500,13 @@ class Meta:
         )
 
 
+# Only used in oas_schemas
+class CancelledOrderResponseSerializer(serializers.Serializer):
+    id = serializers.IntegerField(help_text="Order id")
+    status = serializers.IntegerField(help_text="Order status")
+    bad_request = serializers.CharField(help_text="Reason for the failure")
+
+
 class ListNotificationSerializer(serializers.ModelSerializer):
     status = serializers.SerializerMethodField(
         help_text="The `status` of the order when the notification was trigered",

docs/assets/schemas/api-latest.yaml

@@ -619,7 +619,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OrderDetail'
+                $ref: '#/components/schemas/UpdateOrderResponse'
           description: ''
         '400':
           content:
@@ -1032,6 +1032,22 @@ components:
     BlankEnum:
       enum:
       - ''
+    CancelledOrderResponse:
+      type: object
+      properties:
+        id:
+          type: integer
+          description: Order id
+        status:
+          type: integer
+          description: Order status
+        bad_request:
+          type: string
+          description: Reason for the failure
+      required:
+      - bad_request
+      - id
+      - status
     Chat:
       type: object
       properties:
@@ -2117,6 +2133,10 @@ components:
           - $ref: '#/components/schemas/NullEnum'
       required:
       - action
+    UpdateOrderResponse:
+      oneOf:
+      - $ref: '#/components/schemas/CancelledOrderResponse'
+      - $ref: '#/components/schemas/OrderDetail'
     Version:
       type: object
       properties: