chore(docs): Updated API Reference (automated) (#12461)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-05-13 13:43:58 +00:00
parent 5c36bafc1d
commit c6c660c4d3
135 changed files with 2202 additions and 545 deletions
@@ -26,6 +26,11 @@
 *     description: The list of claims.
 *     items:
 *       $ref: "#/components/schemas/AdminClaim"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of product collections.
 *     items:
 *       $ref: "#/components/schemas/AdminCollection"
+ *   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
 * 
 */

@@ -1,22 +0,0 @@
-/**
- * @schema AdminCreateCollection
- * type: object
- * description: the product collection's details.
- * x-schemaName: AdminCreateCollection
- * required:
- *   - title
- * properties:
- *   title:
- *     type: string
- *     title: title
- *     description: The collection's title.
- *   handle:
- *     type: string
- *     title: handle
- *     description: The collection's handle.
- *   metadata:
- *     type: object
- *     description: The collection's metadata, used to store custom key-value pairs.
- * 
-*/
-
@@ -61,7 +61,7 @@
 *         type: string
 *         title: province
 *         description: The delivery address's ISO 3166-2 province code. Must be lower-case.
- *         example: "us-ca"
+ *         example: us-ca
 *         externalDocs:
 *           url: https://en.wikipedia.org/wiki/ISO_3166-2
 *           description: Learn more about ISO 3166-2
@@ -15,7 +15,7 @@
 *     type: string
 *     title: province_code
 *     description: The tax region's ISO 3166-2 province code. Must be lower-case.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -55,6 +55,10 @@
 *   metadata:
 *     type: object
 *     description: The tax region's metadata, used to store custom key-value pairs.
+ *   provider_id:
+ *     type: string
+ *     title: provider_id
+ *     description: The ID of the tax provider used to calculate the tax rate in this tax region.
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of currencies.
 *     items:
 *       $ref: "#/components/schemas/AdminCurrency"
+ *   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
 * 
 */

@@ -76,7 +76,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of draft orders.
 *     items:
 *       $ref: "#/components/schemas/AdminDraftOrder"
+ *   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
 * 
 */

@@ -61,7 +61,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of fulfillment providers.
 *     items:
 *       $ref: "#/components/schemas/AdminFulfillmentProvider"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of fulfillment options.
 *     items:
 *       $ref: "#/components/schemas/AdminFulfillmentProviderOption"
+ *   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
 * 
 */

@@ -34,7 +34,7 @@
 *     type: string
 *     title: province_code
 *     description: The geo zone's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of notifications.
 *     items:
 *       $ref: "#/components/schemas/AdminNotification"
+ *   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
 * 
 */

@@ -56,7 +56,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of price lists.
 *     items:
 *       $ref: "#/components/schemas/AdminPriceList"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of price preferences.
 *     items:
 *       $ref: "#/components/schemas/AdminPricePreference"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of product categories.
 *     items:
 *       $ref: "#/components/schemas/AdminProductCategory"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of product tags.
 *     items:
 *       $ref: "#/components/schemas/AdminProductTag"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of product types.
 *     items:
 *       $ref: "#/components/schemas/AdminProductType"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of return reasons.
 *     items:
 *       $ref: "#/components/schemas/AdminReturnReason"
+ *   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
 * 
 */

@@ -41,7 +41,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of stock locations.
 *     items:
 *       $ref: "#/components/schemas/AdminStockLocation"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of stores.
 *     items:
 *       $ref: "#/components/schemas/AdminStore"
+ *   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
 * 
 */

@@ -0,0 +1,21 @@
+/**
+ * @schema AdminTaxProvider
+ * type: object
+ * description: The tax provider's details.
+ * x-schemaName: AdminTaxProvider
+ * required:
+ *   - id
+ *   - is_enabled
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The tax provider's ID.
+ *     example: tp_taxjar_taxjar
+ *   is_enabled:
+ *     type: boolean
+ *     title: is_enabled
+ *     description: Whether the tax provider is enabled in the Medusa application.
+ * 
+*/
+
@@ -30,7 +30,7 @@
 *     type: string
 *     title: province_code
 *     description: The tax region's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -1,20 +0,0 @@
-/**
- * @schema AdminUpdateCollection
- * type: object
- * description: The details to update in a collection.
- * x-schemaName: AdminUpdateCollection
- * properties:
- *   title:
- *     type: string
- *     title: title
- *     description: The collection's title.
- *   handle:
- *     type: string
- *     title: handle
- *     description: The collection's handle.
- *   metadata:
- *     type: object
- *     description: The collection's metadata, can hold custom key-value pairs.
- * 
-*/
-
@@ -50,7 +50,7 @@
 *         type: string
 *         title: province
 *         description: The shipping address's ISO 3166-2 province code. Must be lower-case.
- *         example: "us-ca"
+ *         example: us-ca
 *         externalDocs:
 *           url: https://en.wikipedia.org/wiki/ISO_3166-2
 *           description: Learn more about ISO 3166-2
@@ -102,7 +102,7 @@
 *         type: string
 *         title: province
 *         description: The billing address's ISO 3166-2 province code. Must be lower-case.
- *         example: "us-ca"
+ *         example: us-ca
 *         externalDocs:
 *           url: https://en.wikipedia.org/wiki/ISO_3166-2
 *           description: Learn more about ISO 3166-2
@@ -50,7 +50,7 @@
 *         type: string
 *         title: province
 *         description: The address's ISO 3166-2 province code. Must be lower-case.
- *         example: "us-ca"
+ *         example: us-ca
 *         externalDocs:
 *           url: https://en.wikipedia.org/wiki/ISO_3166-2
 *           description: Learn more about ISO 3166-2
@@ -102,7 +102,7 @@
 *         type: string
 *         title: province
 *         description: The address's ISO 3166-2 province code. Must be lower-case.
- *         example: "us-ca"
+ *         example: us-ca
 *         externalDocs:
 *           url: https://en.wikipedia.org/wiki/ISO_3166-2
 *           description: Learn more about ISO 3166-2
@@ -48,7 +48,7 @@
 *         type: string
 *         title: province
 *         description: The address's ISO 3166-2 province code. Must be lower-case.
- *         example: "us-ca"
+ *         example: us-ca
 *         externalDocs:
 *           url: https://en.wikipedia.org/wiki/ISO_3166-2
 *           description: Learn more about ISO 3166-2
@@ -8,13 +8,17 @@
 *     type: string
 *     title: province_code
 *     description: The tax region's ISO 3166-2 province code. Must be lower-case.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
 *   metadata:
 *     type: object
 *     description: The tax region's metadata, can hold custom key-value pairs.
+ *   provider_id:
+ *     type: string
+ *     title: provider_id
+ *     description: The ID of the tax provider to use when calculating taxes for this tax region.
 * 
 */

@@ -40,7 +40,7 @@
 *     type: string
 *     title: province
 *     description: The address's ISO 3166-2 province code. Must be lower-case.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of users.
 *     items:
 *       $ref: "#/components/schemas/AdminUser"
+ *   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
 * 
 */

@@ -54,7 +54,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "US-CA"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -53,7 +53,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -53,7 +53,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of currencies.
 *     items:
 *       $ref: "#/components/schemas/StoreCurrency"
+ *   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
 * 
 */

@@ -76,7 +76,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of addresses.
 *     items:
 *       $ref: "#/components/schemas/StoreCustomerAddress"
+ *   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
 * 
 */

@@ -56,7 +56,7 @@
 *     type: string
 *     title: province
 *     description: The address's lower-case ISO 3166-2 province code.
- *     example: "us-ca"
+ *     example: us-ca
 *     externalDocs:
 *       url: https://en.wikipedia.org/wiki/ISO_3166-2
 *       description: Learn more about ISO 3166-2
@@ -26,6 +26,11 @@
 *     description: The list of product categories.
 *     items:
 *       $ref: "#/components/schemas/StoreProductCategory"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of product tags.
 *     items:
 *       $ref: "#/components/schemas/StoreProductTag"
+ *   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
 * 
 */

@@ -26,6 +26,11 @@
 *     description: The list of product types.
 *     items:
 *       $ref: "#/components/schemas/StoreProductType"
+ *   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
 * 
 */

@@ -12,56 +12,61 @@
 *   - canceled_at
 *   - received_at
 * properties:
- *   id:
- *     type: string
- *     title: id
- *     description: The return's ID.
- *   order_id:
- *     type: string
- *     title: order_id
- *     description: The ID of the order this return is created for.
- *   status:
- *     type: string
- *     title: status
- *     description: The return's status.
- *   exchange_id:
- *     type: string
- *     title: exchange_id
- *     description: The ID of the associated exchange.
- *   location_id:
- *     type: string
- *     title: location_id
- *     description: The ID of the location the items are returned to.
- *   claim_id:
- *     type: string
- *     title: claim_id
- *     description: The ID of the associated claim.
- *   display_id:
- *     type: number
- *     title: display_id
- *     description: The return's display ID.
- *   refund_amount:
- *     type: number
- *     title: refund_amount
- *     description: The return's refunded amount.
 *   items:
 *     type: array
 *     description: The return's items.
 *     items:
 *       $ref: "#/components/schemas/StoreReturnItem"
- *   received_at:
+ *   status:
 *     type: string
- *     title: received_at
- *     description: The date the return was received.
+ *     description: The return's status.
+ *     enum:
+ *       - received
+ *       - canceled
+ *       - requested
+ *       - open
+ *       - partially_received
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The return's ID.
+ *   display_id:
+ *     type: number
+ *     title: display_id
+ *     description: The return's display ID.
 *   created_at:
 *     type: string
 *     format: date-time
 *     title: created_at
 *     description: The date the return was created.
+ *   order_id:
+ *     type: string
+ *     title: order_id
+ *     description: The ID of the order this return belongs to.
+ *   location_id:
+ *     type: string
+ *     title: location_id
+ *     description: The ID of the location the return items are being returned to.
 *   canceled_at:
 *     type: string
 *     title: canceled_at
- *     description: The date the return was updated.
+ *     description: The date the return was canceled.
+ *   exchange_id:
+ *     type: string
+ *     title: exchange_id
+ *     description: The ID of the associated exchange.
+ *   claim_id:
+ *     type: string
+ *     title: claim_id
+ *     description: The ID of the associated claim.
+ *   refund_amount:
+ *     type: number
+ *     title: refund_amount
+ *     description: The amount to be refunded.
+ *   received_at:
+ *     type: string
+ *     title: received_at
+ *     description: The date the return items were received.
 * 
 */

@@ -3,6 +3,13 @@
 * type: object
 * description: The return item's details.
 * x-schemaName: StoreReturnItem
+ * required:
+ *   - id
+ *   - quantity
+ *   - received_quantity
+ *   - damaged_quantity
+ *   - item_id
+ *   - return_id
 * properties:
 *   id:
 *     type: string
@@ -39,13 +46,6 @@
 *   metadata:
 *     type: object
 *     description: The item's metadata, can hold custom key-value pairs.
- * required:
- *   - id
- *   - quantity
- *   - received_quantity
- *   - damaged_quantity
- *   - item_id
- *   - return_id
 * 
 */