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

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

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

@@ -1,6 +1,4 @@
 type: object
-required:
-  - prices
 properties:
   title:
     description: The title to identify the Product Variant by.

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

@@ -10,6 +10,8 @@ x-expanded-relations:
     - variants
     - variants.options
     - variants.prices
+  totals:
+    - variants.purchasable
 required:
   - products
   - count

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

@@ -5,6 +5,8 @@ x-expanded-relations:
     - options
     - prices
     - product
+  totals:
+    - purchasable
 required:
   - variants
   - count

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

@@ -130,7 +130,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   context:
     description: The context of the cart which can include info like IP or user agent.

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

@@ -141,5 +141,5 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.

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

@@ -1,10 +0,0 @@
-title: Product with decorated variants
-type: object
-allOf:
-  - $ref: ./Product.yaml
-  - type: object
-    properties:
-      variants:
-        type: array
-        items:
-          $ref: ./DecoratedVariant.yaml

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

@@ -1,9 +0,0 @@
-title: Decorated Product Variant
-type: object
-allOf:
-  - $ref: ./PricedVariant.yaml
-  - type: object
-    properties:
-      purchasable:
-        type: boolean
-        description: Boolean indicating if variant is purchasable.

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

@@ -71,7 +71,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -126,7 +126,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -26,7 +26,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: Date which the idempotency key was locked.

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

@@ -245,7 +245,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   external_id:
     description: The ID of an external order.

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

@@ -102,7 +102,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -82,7 +82,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   amount:
     description: The amount that the Payment Session has been authorized for.

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

@@ -189,3 +189,13 @@ properties:
     type: object
     example:
       car: white
+  purchasable:
+    description: |
+      Only used with the inventory modules.
+      A boolean value indicating whether the Product Variant is purchasable.
+      A variant is purchasable if:
+        - inventory is not managed
+        - it has no inventory items
+        - it is in stock
+        - it is backorderable.
+    type: boolean

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

@@ -67,7 +67,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -103,7 +103,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   received_at:
     description: The date with timezone at which the return was received.

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

@@ -154,7 +154,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -44,7 +44,7 @@ properties:
     type: string
     externalDocs:
       url: >-
-        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.