docs: generate API reference for 2.12.3 (#14341)

2025-12-17 18:19:46 +02:00
parent c0ec54fc15
commit 52e965f411
134 changed files with 7706 additions and 12 deletions
@@ -50,6 +50,11 @@
 *     externalDocs:
 *       url: https://docs.medusajs.com/api/admin#manage-metadata
 *       description: Learn how to manage metadata
+ *   translations:
+ *     type: array
+ *     description: The collection's translations.
+ *     items:
+ *       $ref: "#/components/schemas/AdminTranslation"
 * 
 */

@@ -0,0 +1,15 @@
+/**
+ * @schema AdminExportOrderResponse
+ * type: object
+ * description: The details of the order export.
+ * x-schemaName: AdminExportOrderResponse
+ * required:
+ *   - transaction_id
+ * properties:
+ *   transaction_id:
+ *     type: string
+ *     title: transaction_id
+ *     description: The ID of the workflow execution's transaction. Use it to check the status of the export by sending a GET request to `/admin/workflows-executions/export-orders/:transaction-id`
+ * 
+*/
+
@@ -0,0 +1,36 @@
+/**
+ * @schema AdminPriceListPriceListResponse
+ * type: object
+ * description: The list of prices.
+ * x-schemaName: AdminPriceListPriceListResponse
+ * required:
+ *   - limit
+ *   - offset
+ *   - count
+ *   - prices
+ * properties:
+ *   limit:
+ *     type: number
+ *     title: limit
+ *     description: The maximum number of prices returned.
+ *   offset:
+ *     type: number
+ *     title: offset
+ *     description: The number of items skipped before retrieving the prices.
+ *   count:
+ *     type: number
+ *     title: count
+ *     description: The total number of prices.
+ *   estimate_count:
+ *     type: number
+ *     title: estimate_count
+ *     description: The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.
+ *     x-featureFlag: index_engine
+ *   prices:
+ *     type: array
+ *     description: The list of prices.
+ *     items:
+ *       $ref: "#/components/schemas/AdminPrice"
+ * 
+*/
+
@@ -173,6 +173,11 @@
 *     description: The date the product was deleted.
 *   shipping_profile:
 *     $ref: "#/components/schemas/AdminShippingProfile"
+ *   translations:
+ *     type: array
+ *     description: The product's translations.
+ *     items:
+ *       $ref: "#/components/schemas/AdminTranslation"
 * 
 */

@@ -38,6 +38,11 @@
 *     externalDocs:
 *       url: https://docs.medusajs.com/api/admin#manage-metadata
 *       description: Learn how to manage metadata
+ *   translations:
+ *     type: array
+ *     description: The tag's translations.
+ *     items:
+ *       $ref: "#/components/schemas/AdminTranslation"
 * 
 */

@@ -38,6 +38,11 @@
 *     externalDocs:
 *       url: https://docs.medusajs.com/api/admin#manage-metadata
 *       description: Learn how to manage metadata
+ *   translations:
+ *     type: array
+ *     description: The type's translations.
+ *     items:
+ *       $ref: "#/components/schemas/AdminTranslation"
 * 
 */

@@ -153,6 +153,11 @@
 *     type: string
 *     title: thumbnail
 *     description: The variant's thumbnail.
+ *   translations:
+ *     type: array
+ *     description: The variant's translations.
+ *     items:
+ *       $ref: "#/components/schemas/AdminTranslation"
 * 
 */

@@ -10,7 +10,9 @@
 *     type: object
 *     description: Key-value pairs of translatable fields for different entities. Each key is an entity type, and the value is an array of fields that can be translated for that entity.
 *     example:
- *       product: ["title", "description"]
+ *       product:
+ *         - title
+ *         - description
 * 
 */

@@ -29,8 +29,7 @@
 *       properties:
 *         by_locale:
 *           type: object
- *           description: The translation statistics of an entity type broken down by locale. The key is the locale code in BCP 47 format, and
- *             the value is an object containing the statistics for that locale.
+ *           description: The translation statistics of an entity type broken down by locale. The key is the locale code in BCP 47 format, and the value is an object containing the statistics for that locale.
 *           example:
 *             fr-FR:
 *               expected: 150