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

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

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

@@ -2,99 +2,132 @@ title: Order Edit
 description: Order edit keeps track of order items changes.
 type: object
 required:
-  - order_id
-  - order
-  - changes
+  - canceled_at
+  - canceled_by
+  - confirmed_by
+  - confirmed_at
+  - created_at
   - created_by
+  - declined_at
+  - declined_by
+  - declined_reason
+  - id
+  - internal_note
+  - order_id
+  - payment_collection_id
+  - requested_at
+  - requested_by
+  - status
+  - updated_at
 properties:
   id:
-    type: string
     description: The order edit's ID
+    type: string
     example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
   order_id:
-    type: string
     description: The ID of the order that is edited
+    type: string
     example: order_01G2SG30J8C85S4A5CHM2S1NS2
   order:
     description: Available if the relation `order` is expanded.
+    nullable: true
     type: object
   changes:
-    type: array
     description: Available if the relation `changes` is expanded.
+    type: array
     items:
       $ref: ./OrderItemChange.yaml
   internal_note:
     description: An optional note with additional details about the order edit.
+    nullable: true
     type: string
     example: Included two more items B to the order.
   created_by:
-    type: string
     description: The unique identifier of the user or customer who created the order edit.
-  requested_by:
     type: string
+  requested_by:
     description: >-
       The unique identifier of the user or customer who requested the order
       edit.
-  requested_at:
+    nullable: true
     type: string
+  requested_at:
     description: The date with timezone at which the edit was requested.
+    nullable: true
+    type: string
     format: date-time
   confirmed_by:
-    type: string
     description: >-
       The unique identifier of the user or customer who confirmed the order
       edit.
-  confirmed_at:
+    nullable: true
     type: string
+  confirmed_at:
     description: The date with timezone at which the edit was confirmed.
+    nullable: true
+    type: string
     format: date-time
   declined_by:
-    type: string
     description: The unique identifier of the user or customer who declined the order edit.
-  declined_at:
+    nullable: true
     type: string
+  declined_at:
     description: The date with timezone at which the edit was declined.
+    nullable: true
+    type: string
     format: date-time
   declined_reason:
     description: An optional note why  the order edit is declined.
+    nullable: true
     type: string
+  canceled_by:
+    description: >-
+      The unique identifier of the user or customer who cancelled the order
+      edit.
+    nullable: true
+    type: string
+  canceled_at:
+    description: The date with timezone at which the edit was cancelled.
+    nullable: true
+    type: string
+    format: date-time
   subtotal:
-    type: integer
     description: The total of subtotal
+    type: integer
     example: 8000
   discount_total:
-    type: integer
     description: The total of discount
+    type: integer
     example: 800
   shipping_total:
-    type: integer
     description: The total of the shipping amount
+    type: integer
     example: 800
   gift_card_total:
-    type: integer
     description: The total of the gift card amount
+    type: integer
     example: 800
   gift_card_tax_total:
-    type: integer
     description: The total of the gift card tax amount
+    type: integer
     example: 800
   tax_total:
-    type: integer
     description: The total of tax
+    type: integer
     example: 0
   total:
-    type: integer
     description: The total amount of the edited order.
+    type: integer
     example: 8200
   difference_due:
-    type: integer
     description: >-
       The difference between the total amount of the order and total amount of
       edited order.
+    type: integer
     example: 8200
   status:
-    type: string
     description: The status of the order edit.
+    type: string
     enum:
       - confirmed
       - declined
@@ -102,22 +135,24 @@ properties:
       - created
       - canceled
   items:
-    type: array
     description: Available if the relation `items` is expanded.
+    type: array
     items:
       $ref: ./LineItem.yaml
   payment_collection_id:
-    type: string
     description: The ID of the payment collection
+    nullable: true
+    type: string
     example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
   payment_collection:
     description: Available if the relation `payment_collection` is expanded.
+    nullable: true
     $ref: ./PaymentCollection.yaml
   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