chore(docs): Generated API Reference (#3262)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

docs/api/admin/components/schemas/Swap.yaml

@@ -9,13 +9,26 @@ description: >-
   difference.
 type: object
 required:
+  - allow_backorder
+  - canceled_at
+  - cart_id
+  - confirmed_at
+  - created_at
+  - deleted_at
+  - difference_due
   - fulfillment_status
-  - payment_status
+  - id
+  - idempotency_key
+  - metadata
+  - no_notification
   - order_id
+  - payment_status
+  - shipping_address_id
+  - updated_at
 properties:
   id:
-    type: string
     description: The swap's ID
+    type: string
     example: swap_01F0YET86Y9G92D3YDR9Y6V676
   fulfillment_status:
     description: The status of the Fulfillment of the Swap.
@@ -24,6 +37,7 @@ properties:
       - not_fulfilled
       - fulfilled
       - shipped
+      - partially_shipped
       - canceled
       - requires_action
     example: not_fulfilled
@@ -49,6 +63,7 @@ properties:
     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
   order:
     description: An order object. Available if the relation `order` is expanded.
+    nullable: true
     type: object
   additional_items:
     description: >-
@@ -61,6 +76,7 @@ properties:
     description: >-
       A return order object. The Return that is issued for the return part of
       the Swap. Available if the relation `return_order` is expanded.
+    nullable: true
     type: object
   fulfillments:
     description: >-
@@ -74,22 +90,26 @@ properties:
       The Payment authorized when the Swap requires an additional amount to be
       charged from the Customer. Available if the relation `payment` is
       expanded.
+    nullable: true
     type: object
   difference_due:
     description: >-
       The difference that is paid or refunded as a result of the Swap. May be
       negative when the amount paid for the returned items exceed the total of
       the new Products.
+    nullable: true
     type: integer
     example: 0
   shipping_address_id:
     description: >-
       The Address to send the new Line Items to - in most cases this will be the
       same as the shipping address on the Order.
+    nullable: true
     type: string
     example: addr_01G8ZH853YPY9B94857DY91YGW
   shipping_address:
     description: Available if the relation `shipping_address` is expanded.
+    nullable: true
     $ref: ./Address.yaml
   shipping_methods:
     description: >-
@@ -100,50 +120,58 @@ properties:
       $ref: ./ShippingMethod.yaml
   cart_id:
     description: The id of the Cart that the Customer will use to confirm the Swap.
+    nullable: true
     type: string
     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
   cart:
     description: A cart object. Available if the relation `cart` is expanded.
+    nullable: true
     type: object
+  confirmed_at:
+    description: The date with timezone at which the Swap was confirmed by the Customer.
+    nullable: true
+    type: string
+    format: date-time
+  canceled_at:
+    description: The date with timezone at which the Swap was canceled.
+    nullable: true
+    type: string
+    format: date-time
+  no_notification:
+    description: If set to true, no notification will be sent related to this swap
+    nullable: true
+    type: boolean
+    example: false
   allow_backorder:
     description: If true, swaps can be completed with items out of stock
     type: boolean
     default: false
   idempotency_key:
-    type: string
     description: >-
       Randomly generated key used to continue the completion of the swap in case
       of failure.
+    nullable: true
+    type: string
     externalDocs:
       url: >-
         https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
       description: Learn more how to use the idempotency key.
-  confirmed_at:
-    description: The date with timezone at which the Swap was confirmed by the Customer.
-    type: string
-    format: date-time
-  canceled_at:
-    description: The date with timezone at which the Swap was canceled.
-    type: string
-    format: date-time
-  no_notification:
-    description: If set to true, no notification will be sent related to this swap
-    type: boolean
-    example: false
   created_at:
-    type: string
     description: The date with timezone at which the resource was created.
+    type: string
     format: date-time
   updated_at:
-    type: string
     description: The date with timezone at which the resource was updated.
+    type: string
     format: date-time
   deleted_at:
-    type: string
     description: The date with timezone at which the resource was deleted.
+    nullable: true
+    type: string
     format: date-time
   metadata:
-    type: object
     description: An optional key-value map with additional details
+    nullable: true
+    type: object
     example:
       car: white