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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

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

@@ -1,5 +1,8 @@
 title: Order
-description: Represents an order
+description: >-
+  An order is a purchase made by a customer. It holds details about payment and
+  fulfillment of the order. An order may also be created from a draft order,
+  which is created by an admin user.
 type: object
 required:
   - billing_address_id
@@ -75,7 +78,8 @@ properties:
     type: string
     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
   cart:
-    description: A cart object. Available if the relation `cart` is expanded.
+    description: The details of the cart associated with the order.
+    x-expandable: cart
     nullable: true
     type: object
   customer_id:
@@ -83,7 +87,8 @@ properties:
     type: string
     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
   customer:
-    description: A customer object. Available if the relation `customer` is expanded.
+    description: The details of the customer associated with the order.
+    x-expandable: customer
     nullable: true
     type: object
   email:
@@ -96,7 +101,8 @@ properties:
     type: string
     example: addr_01G8ZH853YPY9B94857DY91YGW
   billing_address:
-    description: Available if the relation `billing_address` is expanded.
+    description: The details of the billing address associated with the order.
+    x-expandable: billing_address
     nullable: true
     $ref: ./Address.yaml
   shipping_address_id:
@@ -105,15 +111,17 @@ properties:
     type: string
     example: addr_01G8ZH853YPY9B94857DY91YGW
   shipping_address:
-    description: Available if the relation `shipping_address` is expanded.
+    description: The details of the shipping address associated with the order.
+    x-expandable: shipping_address
     nullable: true
     $ref: ./Address.yaml
   region_id:
-    description: The region's ID
+    description: The ID of the region this order was created in.
     type: string
     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
   region:
-    description: A region object. Available if the relation `region` is expanded.
+    description: The details of the region this order was created in.
+    x-expandable: region
     nullable: true
     $ref: ./Region.yaml
   currency_code:
@@ -124,7 +132,8 @@ properties:
       url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
       description: See a list of codes.
   currency:
-    description: Available if the relation `currency` is expanded.
+    description: The details of the currency used in the order.
+    x-expandable: currency
     nullable: true
     $ref: ./Currency.yaml
   tax_rate:
@@ -133,96 +142,85 @@ properties:
     type: number
     example: 0
   discounts:
-    description: >-
-      The discounts used in the order. Available if the relation `discounts` is
-      expanded.
+    description: The details of the discounts applied on the order.
     type: array
+    x-expandable: discounts
     items:
       $ref: ./Discount.yaml
   gift_cards:
-    description: >-
-      The gift cards used in the order. Available if the relation `gift_cards`
-      is expanded.
+    description: The details of the gift card used in the order.
     type: array
+    x-expandable: gift_cards
     items:
       $ref: ./GiftCard.yaml
   shipping_methods:
-    description: >-
-      The shipping methods used in the order. Available if the relation
-      `shipping_methods` is expanded.
+    description: The details of the shipping methods used in the order.
     type: array
+    x-expandable: shipping_methods
     items:
       $ref: ./ShippingMethod.yaml
   payments:
-    description: >-
-      The payments used in the order. Available if the relation `payments` is
-      expanded.
+    description: The details of the payments used in the order.
     type: array
+    x-expandable: payments
     items:
       type: object
   fulfillments:
-    description: >-
-      The fulfillments used in the order. Available if the relation
-      `fulfillments` is expanded.
+    description: The details of the fulfillments created for the order.
     type: array
+    x-expandable: fulfillments
     items:
       type: object
   returns:
-    description: >-
-      The returns associated with the order. Available if the relation `returns`
-      is expanded.
+    description: The details of the returns created for the order.
     type: array
+    x-expandable: returns
     items:
       type: object
   claims:
-    description: >-
-      The claims associated with the order. Available if the relation `claims`
-      is expanded.
+    description: The details of the claims created for the order.
     type: array
+    x-expandable: claims
     items:
       type: object
   refunds:
-    description: >-
-      The refunds associated with the order. Available if the relation `refunds`
-      is expanded.
+    description: The details of the refunds created for the order.
     type: array
+    x-expandable: refunds
     items:
       type: object
   swaps:
-    description: >-
-      The swaps associated with the order. Available if the relation `swaps` is
-      expanded.
+    description: The details of the swaps created for the order.
     type: array
+    x-expandable: swaps
     items:
       type: object
   draft_order_id:
-    description: The ID of the draft order this order is associated with.
+    description: The ID of the draft order this order was created from.
     nullable: true
     type: string
     example: null
   draft_order:
-    description: A draft order object. Available if the relation `draft_order` is expanded.
+    description: The details of the draft order this order was created from.
+    x-expandable: draft_order
     nullable: true
     type: object
   items:
-    description: >-
-      The line items that belong to the order. Available if the relation `items`
-      is expanded.
+    description: The details of the line items that belong to the order.
+    x-expandable: items
     type: array
     items:
       $ref: ./LineItem.yaml
   edits:
-    description: >-
-      Order edits done on the order. Available if the relation `edits` is
-      expanded.
+    description: The details of the order edits done on the order.
     type: array
+    x-expandable: edits
     items:
       type: object
   gift_card_transactions:
-    description: >-
-      The gift card transactions used in the order. Available if the relation
-      `gift_card_transactions` is expanded.
+    description: The gift card transactions made in the order.
     type: array
+    x-expandable: gift_card_transactions
     items:
       $ref: ./GiftCardTransaction.yaml
   canceled_at:
@@ -252,14 +250,13 @@ properties:
     type: string
     example: null
   sales_channel_id:
-    description: The ID of the sales channel this order is associated with.
+    description: The ID of the sales channel this order belongs to.
     nullable: true
     type: string
     example: null
   sales_channel:
-    description: >-
-      A sales channel object. Available if the relation `sales_channel` is
-      expanded.
+    description: The details of the sales channel this order belongs to.
+    x-expandable: sales_channel
     nullable: true
     $ref: ./SalesChannel.yaml
   shipping_total:
@@ -308,9 +305,10 @@ properties:
     example: 0
   returnable_items:
     description: >-
-      The items that are returnable as part of the order, order swaps or order
-      claims
+      The details of the line items that are returnable as part of the order,
+      swaps, or claims
     type: array
+    x-expandable: returnable_items
     items:
       $ref: ./LineItem.yaml
   created_at:
@@ -327,3 +325,7 @@ properties:
     type: object
     example:
       car: white
+    externalDocs:
+      description: Learn about the metadata attribute, and how to delete and update it.
+      url: >-
+        https://docs.medusajs.com/development/entities/overview#metadata-attribute