docs: generate API reference for 2.12.0 (#14185)

2025-12-02 11:56:37 +02:00
1 parent 21f61ec160
commit 9372a17d1f
@@ -268,6 +268,11 @@
 *     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
 */

@@ -653,6 +653,12 @@
 *     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
 * 
 */

@@ -267,6 +267,12 @@
 *     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
 * 
 */

@@ -139,6 +139,10 @@
 *     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).
 * 
 */

@@ -0,0 +1,13 @@
+/**
+ * @schema AdminOrderChangeResponse
+ * type: object
+ * description: The details of the order change.
+ * x-schemaName: AdminOrderChangeResponse
+ * required:
+ *   - order_change
+ * properties:
+ *   order_change:
+ *     $ref: "#/components/schemas/AdminOrderChange"
+ * 
+*/
+
@@ -653,6 +653,12 @@
 *     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
 * 
 */

@@ -13,6 +13,7 @@
 *   - ean
 *   - upc
 *   - thumbnail
+ *   - images
 *   - allow_backorder
 *   - manage_inventory
 *   - hs_code
@@ -147,7 +148,7 @@
 *     type: array
 *     description: The variant's images.
 *     items:
- *       $ref: "#/components/schemas/AdminProductImage"
+ *       $ref: "#/components/schemas/BaseProductImage"
 *   thumbnail:
 *     type: string
 *     title: thumbnail
@@ -67,6 +67,14 @@
 *     type: boolean
 *     title: is_tax_inclusive
 *     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.
 * 
 */

@@ -0,0 +1,13 @@
+/**
+ * @schema AdminUpdateOrderChange
+ * 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).
+ * 
+*/
+
@@ -255,6 +255,12 @@
 *     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
 * 
 */

@@ -31,7 +31,7 @@
 *     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
@@ -11,6 +11,7 @@
 *   - ean
 *   - upc
 *   - thumbnail
+ *   - images
 *   - allow_backorder
 *   - manage_inventory
 *   - hs_code
@@ -136,6 +137,11 @@
 *     type: string
 *     title: thumbnail
 *     description: The variant's thumbnail.
+ *   images:
+ *     type: array
+ *     description: The variant's images.
+ *     items:
+ *       $ref: "#/components/schemas/BaseProductImage"
 * 
 */

@@ -319,6 +319,12 @@
 *     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
 * 
 */

@@ -139,6 +139,10 @@
 *     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).
 * 
 */

@@ -17,6 +17,7 @@
 *   - action
 *   - details
 *   - internal_note
+ *   - ordering
 *   - created_at
 *   - updated_at
 * properties:
@@ -100,6 +101,10 @@
 *     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.
 * 
 */

@@ -253,6 +253,12 @@
 *     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
 * 
 */

@@ -120,6 +120,11 @@
 *     type: string
 *     title: thumbnail
 *     description: The variant's thumbnail.
+ *   images:
+ *     type: array
+ *     description: The variant's images.
+ *     items:
+ *       $ref: "#/components/schemas/BaseProductImage"
 * required:
 *   - options
 *   - length
@@ -135,6 +140,7 @@
 *   - hs_code
 *   - mid_code
 *   - material
+ *   - images
 *   - deleted_at
 *   - manage_inventory
 *   - allow_backorder