docs: generate API reference for 2.12.0 (#14185)

2025-12-02 11:56:37 +02:00
parent 21f61ec160
commit 9372a17d1f
71 changed files with 6310 additions and 19 deletions
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml
@@ -272,3 +272,10 @@ properties:
    type: number
    title: shipping_discount_total
    description: The total discount amount applied on the draft order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the draft order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml
@@ -677,3 +677,10 @@ properties:
    type: number
    title: shipping_discount_total
    description: The total discount amount applied on the draft order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the draft order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml
@@ -265,3 +265,10 @@ properties:
    type: number
    title: shipping_discount_total
    description: The total discount amount applied on the order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml
@@ -139,3 +139,9 @@ properties:
    format: date-time
    title: updated_at
    description: The date the order change was updated.
+  carry_over_promotions:
+    type: boolean
+    title: carry_over_promotions
+    description: >-
+      Whether promotions from the original order should be carried over to the
+      order change (specifically, exchanges).
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeResponse.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeResponse.yaml
@@ -0,0 +1,8 @@
+type: object
+description: The details of the order change.
+x-schemaName: AdminOrderChangeResponse
+required:
+  - order_change
+properties:
+  order_change:
+    $ref: ./AdminOrderChange.yaml
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml
@@ -679,3 +679,10 @@ properties:
    type: number
    title: shipping_discount_total
    description: The total discount amount applied on the order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml
@@ -11,6 +11,7 @@ required:
  - ean
  - upc
  - thumbnail
+  - images
  - allow_backorder
  - manage_inventory
  - hs_code
@@ -149,7 +150,7 @@ properties:
    type: array
    description: The variant's images.
    items:
-      $ref: ./AdminProductImage.yaml
+      $ref: ./BaseProductImage.yaml
  thumbnail:
    type: string
    title: thumbnail
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml
@@ -69,3 +69,11 @@ properties:
    description: >-
      Whether the promotion is tax inclusive. If enabled, the promotion is
      applied after tax is calculated.
+  limit:
+    type: number
+    title: limit
+    description: The limit of times the promotion can be used.
+  used:
+    type: number
+    title: used
+    description: The number of times the promotion has been used.
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrderChange.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrderChange.yaml
@@ -0,0 +1,10 @@
+type: object
+description: The data to update in the order change.
+x-schemaName: AdminUpdateOrderChange
+properties:
+  carry_over_promotions:
+    type: boolean
+    title: carry_over_promotions
+    description: >-
+      Whether promotions from the original order should be carried over to the
+      order change (specifically, exchanges).
--- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml
@@ -253,3 +253,10 @@ properties:
    type: number
    title: shipping_discount_total
    description: The total discount amount applied on the order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
--- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml
@@ -29,7 +29,7 @@ properties:
    type: object
    description: The image's metadata, can hold custom key-value pairs.
    externalDocs:
-      url: https://docs.medusajs.com/api/store#manage-metadata
+      url: https://docs.medusajs.com/api/admin#manage-metadata
      description: Learn how to manage metadata
  rank:
    type: number
--- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml
@@ -9,6 +9,7 @@ required:
  - ean
  - upc
  - thumbnail
+  - images
  - allow_backorder
  - manage_inventory
  - hs_code
@@ -138,3 +139,8 @@ properties:
    type: string
    title: thumbnail
    description: The variant's thumbnail.
+  images:
+    type: array
+    description: The variant's images.
+    items:
+      $ref: ./BaseProductImage.yaml
--- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml
@@ -321,3 +321,10 @@ properties:
    type: number
    title: shipping_discount_total
    description: The total discount amount applied on the order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
--- a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml
@@ -139,3 +139,9 @@ properties:
    format: date-time
    title: updated_at
    description: The date the order change was updated.
+  carry_over_promotions:
+    type: boolean
+    title: carry_over_promotions
+    description: >-
+      Whether promotions from the original order should be carried over to the
+      order change (specifically, exchanges).
--- a/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml
@@ -15,6 +15,7 @@ required:
  - action
  - details
  - internal_note
+  - ordering
  - created_at
  - updated_at
 properties:
@@ -98,3 +99,7 @@ properties:
    format: date-time
    title: updated_at
    description: The date the action was updated.
+  ordering:
+    type: number
+    title: ordering
+    description: The action's ordering among other actions in the same order change.
--- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml
@@ -251,3 +251,10 @@ properties:
    type: number
    title: shipping_discount_total
    description: The total discount amount applied on the order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
--- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml
@@ -124,6 +124,11 @@ properties:
    type: string
    title: thumbnail
    description: The variant's thumbnail.
+  images:
+    type: array
+    description: The variant's images.
+    items:
+      $ref: ./BaseProductImage.yaml
 required:
  - options
  - length
@@ -139,6 +144,7 @@ required:
  - hs_code
  - mid_code
  - material
+  - images
  - deleted_at
  - manage_inventory
  - allow_backorder