diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts index 32a7bebf1f..52a42bd073 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -1,8 +1,12 @@ /** * @oas [delete] /store/carts/{id}/line-items/{line_id} * operationId: DeleteCartsIdLineItemsLine_id - * summary: Remove Line Items from Cart - * description: Remove a list of line items from a cart. This doesn't delete the Line Item, only the association between the Line Item and the cart. + * summary: Remove Line Item from Cart + * x-sidebar-summary: Remove Line Item + * description: Remove a line item from a cart. + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#remove-line-item-from-cart + * description: Storefront guide: How to remove line item from cart. * x-authenticated: false * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: line_id * in: path - * description: The cart's line id. + * description: The line item's ID. * required: true * schema: * type: string @@ -49,7 +53,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The deletion's details. * required: * - id * - object @@ -58,21 +62,23 @@ * id: * type: string * title: id - * description: The cart's ID. + * description: The ID of the deleted line item. * object: * type: string * title: object * description: The name of the deleted object. + * default: "line-item" * deleted: * type: boolean * title: deleted - * description: Whether the Cart was deleted. + * description: Whether the item was deleted. * - type: object - * description: SUMMARY + * description: The deletion's details. * properties: * parent: * $ref: "#/components/schemas/StoreCart" - * description: SUMMARY + * description: The cart that the item belonged to. + * description: The deletion's details. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts index 0bd0a80dbd..6bd9623f74 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -2,7 +2,7 @@ * @oas [delete] /store/carts/{id}/promotions * operationId: DeleteCartsIdPromotions * summary: Remove Promotions from Cart - * description: Remove a list of promotions from a cart. This doesn't delete the Promotion, only the association between the Promotion and the cart. + * description: Remove a list of promotions from a cart. * x-authenticated: false * parameters: * - name: id @@ -42,7 +42,7 @@ * application/json: * schema: * type: object - * description: SUMMARY + * description: The cart's details. * required: * - cart * properties: diff --git a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts index 0b66468c59..e616378d47 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -1,13 +1,17 @@ /** * @oas [delete] /store/customers/me/addresses/{address_id} * operationId: DeleteCustomersMeAddressesAddress_id - * summary: Remove Addresses from Customer - * description: Remove a list of addresses from a customer. This doesn't delete the Address, only the association between the Address and the customer. + * summary: Remove Customer's Address + * x-sidebar-summary: Remove Address + * description: Remove an address of the logged-in customer. * x-authenticated: true + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#delete-customer-address + * description: Storefront guide: How to delete a customer's address. * parameters: * - name: address_id * in: path - * description: The customer's address id. + * description: The address's ID. * required: true * schema: * type: string @@ -48,7 +52,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The deletion's details. * required: * - id * - object @@ -57,21 +61,23 @@ * id: * type: string * title: id - * description: The customer's ID. + * description: The address's ID. * object: * type: string * title: object * description: The name of the deleted object. + * default: "address" * deleted: * type: boolean * title: deleted - * description: Whether the Customer was deleted. + * description: Whether the address was deleted. * - type: object - * description: SUMMARY + * description: The deletion's details. * properties: * parent: * $ref: "#/components/schemas/StoreCustomer" - * description: SUMMARY + * description: The details of the customer the address belongs to. + * description: The deletion's details. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections.ts b/www/utils/generated/oas-output/operations/store/get_store_collections.ts index d57ef1af27..2e5444fb4f 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections.ts @@ -2,8 +2,11 @@ * @oas [get] /store/collections * operationId: GetCollections * summary: List Collections - * description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. + * description: Retrieve a list of collections. The collections can be filtered by fields such as `handle`. The collections can also be sorted or paginated. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list + * description: Storefront guide: How to retrieve a list of collections. * parameters: * - name: expand * in: query @@ -49,11 +52,11 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: deleted_at * in: query - * description: The collection's deleted at. + * description: Filter by the collection's deletion date. * required: false * schema: * type: object - * description: The collection's deleted at. + * description: Filter by the collection's deletion date. * properties: * $and: * type: array @@ -285,20 +288,20 @@ * oneOf: * - type: string * title: title - * description: The collection's title. + * description: Filter by a collection's title. * - type: array - * description: The collection's title. + * description: Filter by collection titles. * items: * type: string * title: title - * description: The title's details. + * description: A title. * - name: created_at * in: query - * description: The collection's created at. + * description: Filter by the collection's creation date. * required: false * schema: * type: object - * description: The collection's created at. + * description: Filter by the collection's creation date. * properties: * $and: * type: array @@ -318,11 +321,11 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne @@ -333,19 +336,19 @@ * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: @@ -367,42 +370,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -441,31 +444,31 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -504,32 +507,32 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The values to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - name: updated_at * in: query - * description: The collection's updated at. + * description: Filter by the collection's update date. * required: false * schema: * type: object - * description: The collection's updated at. + * description: Filter by the collection's update date. * properties: * $and: * type: array @@ -549,11 +552,11 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne @@ -564,19 +567,19 @@ * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: @@ -598,42 +601,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -672,31 +675,31 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -735,21 +738,21 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The values to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists @@ -761,21 +764,21 @@ * oneOf: * - type: string * title: handle - * description: The collection's handle. + * description: Filter by a collection's handle. * - type: array - * description: The collection's handle. + * description: Filter by collection handles. * items: * type: string * title: handle - * description: The handle's details. + * description: A handle. * - name: q * in: query - * description: The collection's q. + * description: Search term to filter the collection's searchable properties. * required: false * schema: * type: string * title: q - * description: The collection's q. + * description: Search term to filter the collection's searchable properties. * - name: $and * in: query * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts index e2707cdbbf..7838727758 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts @@ -4,6 +4,9 @@ * summary: Get a Collection * description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve + * description: Storefront guide: How to retrieve a collection. * parameters: * - name: id * in: path diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts index 4c632b864e..749352c80c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts @@ -2,7 +2,7 @@ * @oas [get] /store/currencies * operationId: GetCurrencies * summary: List Currencies - * description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. + * description: Retrieve a list of currencies. The currencies can be filtered by fields such as `code`. The currencies can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -49,12 +49,12 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query - * description: The currency's q. + * description: Search term to filter the currency's searchable properties. * required: false * schema: * type: string * title: q - * description: The currency's q. + * description: Search term to filter the currency's searchable properties. * - name: code * in: query * required: false @@ -62,13 +62,13 @@ * oneOf: * - type: string * title: code - * description: The currency's code. + * description: Filter by a currency code. * - type: array - * description: The currency's code. + * description: Filter by currency codes. * items: * type: string * title: code - * description: The code's details. + * description: A currency code. * - name: $and * in: query * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts index beeb9d384f..cd158dae92 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts @@ -2,7 +2,7 @@ * @oas [get] /store/currencies/{code} * operationId: GetCurrenciesCode * summary: Get a Currency - * description: Retrieve a currency by its ID. You can expand the currency's relations or select the fields that should be returned. + * description: Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: code diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts index 1fb5c5e033..fa576bc92c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts @@ -1,9 +1,13 @@ /** * @oas [get] /store/customers/me * operationId: GetCustomersMe - * summary: List Customers - * description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. + * summary: Get Logged-in Customer + * x-sidebar-summary: Get Customer + * description: Retrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned. * x-authenticated: true + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve + * description: Storefront guide: How to retrieve the logged-in customer. * parameters: * - name: expand * in: query diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index dd0693be1d..873e8c4ac5 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -1,9 +1,13 @@ /** * @oas [get] /store/customers/me/addresses * operationId: GetCustomersMeAddresses - * summary: List Customers - * description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. + * summary: List Customer's Addresses + * x-sidebary-summary: List Addresses + * description: Retrieve the addresses of the logged-in customer. The addresses can be filtered by fields such as `country_code`. The addresses can also be sorted or paginated. * x-authenticated: true + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses + * description: Storefront guide: How to retrieve the logged-in customer's addresses. * parameters: * - name: expand * in: query @@ -49,57 +53,36 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: city * in: query - * description: The customer's city. - * required: false + * description: Filter by the address's city. + * required: true * schema: - * oneOf: - * - type: string - * title: city - * description: The customer's city. - * - type: array - * description: The customer's city. - * items: - * type: string - * title: city - * description: The city's details. - * - name: country_code - * in: query - * description: The customer's country code. - * required: false - * schema: - * oneOf: - * - type: string - * title: country_code - * description: The customer's country code. - * - type: array - * description: The customer's country code. - * items: - * type: string - * title: country_code - * description: The country code's details. + * type: string + * title: city + * description: Filter by the address's city. * - name: postal_code * in: query - * description: The customer's postal code. - * required: false + * description: Filter by the address's postal code. + * required: true * schema: - * oneOf: - * - type: string - * title: postal_code - * description: The customer's postal code. - * - type: array - * description: The customer's postal code. - * items: - * type: string - * title: postal_code - * description: The postal code's details. + * type: string + * title: postal_code + * description: Filter by the address's postal code. + * - name: country_code + * in: query + * description: Filter by the address's country code. + * required: true + * schema: + * type: string + * title: country_code + * description: Filter by the address's country code. * - name: q * in: query - * description: The customer's q. - * required: false + * description: Search term to filter the address's searchable properties. + * required: true * schema: * type: string * title: q - * description: The customer's q. + * description: Search term to filter the address's searchable properties. * security: * - cookie_auth: [] * - jwt_token: [] diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts index 31a6d138a3..9cbd76cd90 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -1,13 +1,14 @@ /** * @oas [get] /store/customers/me/addresses/{address_id} * operationId: GetCustomersMeAddressesAddress_id - * summary: List Addresses - * description: Retrieve a list of addresses in a customer. The addresses can be filtered by fields like FILTER FIELDS. The addresses can also be paginated. + * summary: Get Customer's Address + * x-sidebar-summary: Get Address + * description: Retrieve an address of the logged-in customer. You can expand the address's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: address_id * in: path - * description: The customer's address id. + * description: The address's ID. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts index 1d5f666d3b..36f4869e24 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -1,8 +1,9 @@ /** * @oas [get] /store/orders * operationId: GetOrders - * summary: List Orders - * description: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. + * summary: List Logged-in Customer's Orders + * x-sidebar-summary: List Orders + * description: Retrieve the orders of the logged-in customer. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -54,13 +55,13 @@ * oneOf: * - type: string * title: id - * description: The order's ID. + * description: Filter by an order ID. * - type: array - * description: The order's ID. + * description: Filter by order IDs. * items: * type: string * title: id - * description: The id's ID. + * description: An order ID. * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts index 68d2e17c8a..60e0863aa1 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts @@ -1,8 +1,8 @@ /** * @oas [get] /store/orders/{id} * operationId: GetOrdersId - * summary: Get a Order - * description: Retrieve a order by its ID. You can expand the order's relations or select the fields that should be returned. + * summary: Get an Order + * description: Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts index 790b1ea66d..28ac6dd45d 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts @@ -2,8 +2,11 @@ * @oas [get] /store/payment-providers * operationId: GetPaymentProviders * summary: List Payment Providers - * description: Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated. + * description: Retrieve a list of payment providers. You must provide the `region_id` query parameter to retrieve the payment providers enabled in that region. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment + * description: Storefront guide: How to implement payment during checkout. * parameters: * - name: expand * in: query @@ -49,12 +52,12 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: region_id * in: query - * description: The payment provider's region id. + * description: Filter by a region ID to get the payment providers enabled in that region. * required: true * schema: * type: string * title: region_id - * description: The payment provider's region id. + * description: Filter by a region ID. * x-codeSamples: * - lang: Shell * label: cURL @@ -69,7 +72,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The list of payment providers. * required: * - limit * - offset @@ -78,23 +81,23 @@ * limit: * type: number * title: limit - * description: The payment provider's limit. + * description: The maximum number of items returned. * offset: * type: number * title: offset - * description: The payment provider's offset. + * description: The number of items skipped before retrieving the returned items. * count: * type: number * title: count - * description: The payment provider's count. + * description: The total number of items. * - type: object - * description: SUMMARY + * description: The list of payment providers. * required: * - payment_providers * properties: * payment_providers: * type: array - * description: The payment provider's payment providers. + * description: The list of payment providers. * items: * $ref: "#/components/schemas/StorePaymentProvider" * "400": diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index bc1362477b..c936c0e766 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -4,6 +4,9 @@ * summary: List Product Categories * description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list + * description: Storefront guide: How to retrieve a list of product categories. * parameters: * - name: expand * in: query @@ -49,12 +52,12 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query - * description: The product category's q. + * description: Search term to filter the product category's properties. * required: false * schema: * type: string * title: q - * description: The product category's q. + * description: Search term to filter the product category's properties. * - name: id * in: query * required: false @@ -62,13 +65,13 @@ * oneOf: * - type: string * title: id - * description: The product category's ID. + * description: Filter by a product category's ID. * - type: array - * description: The product category's ID. + * description: Filter by product category IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A product category ID. * - name: description * in: query * required: false @@ -76,13 +79,13 @@ * oneOf: * - type: string * title: description - * description: The product category's description. + * description: Filter by a description. This only matches categories with the exact description. To search by a term or keyword, use the `q` query parameter instead. * - type: array - * description: The product category's description. + * description: Filter by descriptions. This only matches categories that have one of the provided descriptions. To search by a term or keyword, use the `q` query parameter instead. * items: * type: string * title: description - * description: The description's details. + * description: A description. * - name: handle * in: query * required: false @@ -90,13 +93,13 @@ * oneOf: * - type: string * title: handle - * description: The product category's handle. + * description: Filter by a category's handle. * - type: array - * description: The product category's handle. + * description: Filter by category handles. * items: * type: string * title: handle - * description: The handle's details. + * description: A handle. * - name: parent_category_id * in: query * required: false @@ -104,36 +107,36 @@ * oneOf: * - type: string * title: parent_category_id - * description: The product category's parent category id. + * description: The ID of a category to retrieve its child categories. * - type: array - * description: The product category's parent category id. + * description: The ID of categories to retrieve their child categories. * items: * type: string * title: parent_category_id - * description: The parent category id's details. + * description: A product category's ID. * - name: include_ancestors_tree * in: query - * description: The product category's include ancestors tree. + * description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: The product category's include ancestors tree. + * description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. * - name: include_descendants_tree * in: query - * description: The product category's include descendants tree. + * description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: The product category's include descendants tree. + * description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. * - name: created_at * in: query - * description: The product category's created at. + * description: Filter by the category's creation date. * required: false * schema: * type: object - * description: The product category's created at. + * description: Filter by the category's creation date. * properties: * $and: * type: array @@ -153,11 +156,11 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne @@ -168,19 +171,19 @@ * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: @@ -202,42 +205,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -276,31 +279,31 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -339,32 +342,32 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The values to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - name: updated_at * in: query - * description: The product category's updated at. + * description: Filter by the category's update date. * required: false * schema: * type: object - * description: The product category's updated at. + * description: Filter by the category's update date. * properties: * $and: * type: array @@ -384,11 +387,11 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne @@ -399,19 +402,19 @@ * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: @@ -433,42 +436,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -507,31 +510,31 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -570,32 +573,32 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The values to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - name: deleted_at * in: query - * description: The product category's deleted at. + * description: Filter by the category's deletion date. * required: false * schema: * type: object - * description: The product category's deleted at. + * description: Filter by the category's deletion date. * properties: * $and: * type: array @@ -615,11 +618,11 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne @@ -630,19 +633,19 @@ * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: @@ -664,42 +667,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -738,31 +741,31 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -801,21 +804,21 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The values to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists @@ -825,7 +828,7 @@ * required: false * schema: * type: array - * description: The product category's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object * title: $and @@ -845,13 +848,13 @@ * oneOf: * - type: string * title: name - * description: The product category's name. + * description: Filter by a product category name. * - type: array - * description: The product category's name. + * description: Filter by product category names. * items: * type: string * title: name - * description: The name's details. + * description: A product category name. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts index ee0f059aea..bc05f5ad06 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts @@ -4,6 +4,9 @@ * summary: Get a Product Category * description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve + * description: Storefront guide: How to retrieve a product category. * parameters: * - name: id * in: path @@ -31,20 +34,20 @@ * fields. without prefix it will replace the entire default fields. * - name: include_ancestors_tree * in: query - * description: The product category's include ancestors tree. + * description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: The product category's include ancestors tree. + * description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. * - name: include_descendants_tree * in: query - * description: The product category's include descendants tree. + * description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: The product category's include descendants tree. + * description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_products.ts b/www/utils/generated/oas-output/operations/store/get_store_products.ts index 64faa386dd..722def5f4b 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products.ts @@ -4,6 +4,9 @@ * summary: List Products * description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/price + * description: Storefront guide: How to retrieve a product variants' prices. * parameters: * - name: expand * in: query @@ -49,32 +52,32 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: $and * in: query + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * required: false * schema: * type: array - * description: The product's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object - * description: The $and's details. * title: $and * - name: $or * in: query + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * required: false * schema: * type: array - * description: The product's $or. + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * items: * type: object - * description: The $or's details. * title: $or * - name: q * in: query - * description: The product's q. + * description: Search term to filter the product's searchable properties. * required: false * schema: * type: string * title: q - * description: The product's q. + * description: Search term to filter the product's searchable properties. * - name: id * in: query * required: false @@ -82,132 +85,160 @@ * oneOf: * - type: string * title: id - * description: The product's ID. + * description: Filter by a product ID. * - type: array - * description: The product's ID. + * description: Filter by product IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A product ID. * - name: title * in: query - * description: The product's title. + * description: Filter by product titles. * required: false * schema: * oneOf: * - type: string * title: title - * description: The product's title. + * description: Filter by a title. * - type: array - * description: The product's title. + * description: Filter by titles. * items: * type: string * title: title - * description: The title's details. + * description: A title. * - name: handle * in: query - * description: The product's handle. + * description: Filter by product handles. * required: false * schema: * oneOf: * - type: string * title: handle - * description: The product's handle. + * description: Filter by a product handle. * - type: array - * description: The product's handle. + * description: Filter by product handles. * items: * type: string * title: handle - * description: The handle's details. + * description: A product handle. * - name: is_giftcard * in: query - * description: The product's is giftcard. + * description: Whether the product is a gift card. * required: false * schema: * type: boolean * title: is_giftcard - * description: The product's is giftcard. + * description: Whether the product is a gift card. * - name: collection_id * in: query - * description: The product's collection id. + * description: Filter by a collection's ID to retrieve the products in it. * required: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products + * description: Storefront guides: Retrieve a collection's products. * schema: - * description: The product's collection id. + * description: Filter by a collection's ID to retrieve the products in it. * items: * type: string * title: collection_id - * description: The collection id's details. + * description: A collection's ID. + * - name: tag_id + * in: query + * description: Filter by a tag's ID to retrieve the products in it. + * required: false + * schema: + * oneOf: + * - type: string + * title: tag_id + * description: Filter by a product tag's ID. + * - type: array + * description: Filter by product tag IDs. + * items: + * type: string + * title: tag_id + * description: A product tag ID. * - name: type_id * in: query - * description: The product's type id. + * description: Filter by a type's ID to retrieve the products in it. * required: false * schema: - * description: The product's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. + * oneOf: + * - type: string + * title: type_id + * description: Filter by a product type's ID. + * - type: array + * description: Filter by product type IDs. + * items: + * type: string + * title: type_id + * description: A product type ID. * - name: created_at * in: query - * description: The product's created at. + * description: Filter by the product's creation date. * required: false * schema: * type: object - * description: The product's created at. + * description: Filter by the product's creation date. * properties: * $and: * type: array - * description: The created at's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object + * title: $and * $or: * type: array - * description: The created at's $or. + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * items: * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The created at's $in. + * description: Filter by values in this array. * items: * type: string * title: $in + * description: The value to match. * $nin: * type: array - * description: The created at's $nin. + * description: Filter by values not in this array. * items: * type: string * title: $nin + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array - * description: The $not's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object * title: $and * $or: * type: array - * description: The $not's $or. + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * items: * type: object * title: $or @@ -217,42 +248,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -291,145 +322,154 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: * type: string * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: * type: string * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: * type: string * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. * $like: * type: string * title: $like - * description: The created at's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The created at's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The created at's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The created at's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The created at's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: The values to match. * $contains: * type: array - * description: The created at's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: The values to match. * $contained: * type: array - * description: The created at's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: The values to match. * $exists: * type: boolean * title: $exists - * description: The created at's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - name: updated_at * in: query - * description: The product's updated at. + * description: Filter by the product's update date. * required: false * schema: * type: object - * description: The product's updated at. + * description: Filter by the product's update date. * properties: * $and: * type: array - * description: The updated at's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object + * title: $and * $or: * type: array - * description: The updated at's $or. + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * items: * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The updated at's $in. + * description: Filter by values in this array. * items: * type: string * title: $in + * description: The value to match. * $nin: * type: array - * description: The updated at's $nin. + * description: Filter by values not in this array. * items: * type: string * title: $nin + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array - * description: The $not's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object * title: $and * $or: * type: array - * description: The $not's $or. + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * items: * type: object * title: $or @@ -439,42 +479,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -513,145 +553,154 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: * type: string * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: * type: string * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: * type: string * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. * $like: * type: string * title: $like - * description: The updated at's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The updated at's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The updated at's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The updated at's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The updated at's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: The values to match. * $contains: * type: array - * description: The updated at's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: The values to match. * $contained: * type: array - * description: The updated at's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: The values to match. * $exists: * type: boolean * title: $exists - * description: The updated at's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - name: deleted_at * in: query - * description: The product's deleted at. + * description: Filter by the product's date date. * required: false * schema: * type: object - * description: The product's deleted at. + * description: Filter by the product's date date. * properties: * $and: * type: array - * description: The deleted at's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object + * title: $and * $or: * type: array - * description: The deleted at's $or. + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * items: * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: An exact match. * $ne: * type: string * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The deleted at's $in. + * description: Filter by values in this array. * items: * type: string * title: $in + * description: The value to match. * $nin: * type: array - * description: The deleted at's $nin. + * description: Filter by values not in this array. * items: * type: string * title: $nin + * description: The value not to match. * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter. * - type: object * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array - * description: The $not's $and. + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. * items: * type: object * title: $and * $or: * type: array - * description: The $not's $or. + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. * items: * type: object * title: $or @@ -661,42 +710,42 @@ * title: $eq * description: Filter by an exact match. * - type: array - * description: Filter by an exact match. + * description: Filter by multiple exact matches. * items: * type: string * title: $eq - * description: Filter by an exact match. + * description: The value to match. * $ne: * type: string * title: $ne - * description: Filter by values not equal to this parameter. + * description: Filter by values not matching this parameter. * $in: * type: array * description: Filter by values in this array. * items: * type: string * title: $in - * description: Filter by values in this array. + * description: The value to match. * $nin: * type: array * description: Filter by values not in this array. * items: * type: string * title: $nin - * description: Filter by values not in this array. + * description: The value to not match * $not: * oneOf: * - type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching this parameter * - type: object * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching the values of this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt @@ -735,108 +784,123 @@ * items: * type: string * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. + * description: The value to match. * $contains: * type: array * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: Filter arrays that contain some of the values of this parameter. + * description: The values to match. * $contained: * type: array * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: Filter arrays that contain all values of this parameter. + * description: The values to match. * $exists: * type: boolean * title: $exists * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: Filter by values not matching the conditions in this parameter. + * description: Filter by values not matching those in this parameter. * items: * type: string * title: $not - * description: Filter by values not matching the conditions in this parameter. + * description: The values to not match. * $gt: * type: string * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: * type: string * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: * type: string * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: * type: string * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. * $like: * type: string * title: $like - * description: The deleted at's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The deleted at's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The deleted at's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The deleted at's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The deleted at's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: The values to match. * $contains: * type: array - * description: The deleted at's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: The values to match. * $contained: * type: array - * description: The deleted at's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: The values to match. * $exists: * type: boolean * title: $exists - * description: The deleted at's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - name: region_id * in: query - * description: The product's region id. + * description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes. * required: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price + * description: Storefront guide: How to show product variants' prices with taxes. * schema: * type: string * title: region_id - * description: The product's region id. - * - name: currency_code + * description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes. + * - name: country_code * in: query - * description: The product's currency code. + * description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes. * required: false * schema: * type: string - * title: currency_code - * description: The product's currency code. + * title: country_code + * description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes. * - name: province * in: query - * description: The product's province. + * description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. * required: false * schema: * type: string * title: province - * description: The product's province. + * description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. + * - name: cart_id + * in: query + * description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. + * required: false + * schema: + * type: string + * title: cart_id + * description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. * - name: sales_channel_id * in: query * required: false @@ -844,13 +908,13 @@ * oneOf: * - type: string * title: sales_channel_id - * description: The product's sales channel id. + * description: The ID of a sales channel to retrieve products in it. * - type: array - * description: The product's sales channel id. + * description: The IDs of sales channels to retrieve products in them. * items: * type: string * title: sales_channel_id - * description: The sales channel id's details. + * description: A sales channel's ID. * - name: category_id * in: query * required: false @@ -858,27 +922,13 @@ * oneOf: * - type: string * title: category_id - * description: The product's category id. + * description: The ID of a product category to retrieve products in it. * - type: array - * description: The product's category id. + * description: The ID of product categories to retrieve products in them. * items: * type: string * title: category_id - * description: The category id's details. - * - name: tag_id - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: tag_id - * description: The product's tag id. - * - type: array - * description: The product's tag id. - * items: - * type: string - * title: tag_id - * description: The tag id's details. + * description: A product category's ID. * x-codeSamples: * - lang: Shell * label: cURL @@ -893,7 +943,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The paginated list of products. * required: * - limit * - offset @@ -902,23 +952,23 @@ * limit: * type: number * title: limit - * description: The product's limit. + * description: The maximum number of items returned. * offset: * type: number * title: offset - * description: The product's offset. + * description: The number of items skipped before retrieving the returned items. * count: * type: number * title: count - * description: The product's count. + * description: The total number of items. * - type: object - * description: SUMMARY + * description: The paginated list of products. * required: * - products * properties: * products: * type: array - * description: The product's products. + * description: The list of products. * items: * $ref: "#/components/schemas/StoreProduct" * "400": diff --git a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts index 071e2c9d40..65ad7adf2b 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts @@ -4,6 +4,9 @@ * summary: Get a Product * description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/price + * description: Storefront guide: How to retrieve a product variants' prices. * parameters: * - name: id * in: path @@ -31,36 +34,39 @@ * fields. without prefix it will replace the entire default fields. * - name: region_id * in: query - * description: The product's region id. + * description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes. * required: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price + * description: Storefront guide: How to show product variants' prices with taxes. * schema: * type: string * title: region_id - * description: The product's region id. + * description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes. * - name: country_code * in: query - * description: The product's country code. + * description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes. * required: false * schema: * type: string * title: country_code - * description: The product's country code. + * description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes. * - name: province * in: query - * description: The product's province. + * description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. * required: false * schema: * type: string * title: province - * description: The product's province. + * description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. * - name: cart_id * in: query - * description: The product's cart id. + * description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. * required: false * schema: * type: string * title: cart_id - * description: The product's cart id. + * description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions.ts b/www/utils/generated/oas-output/operations/store/get_store_regions.ts index 73b8878860..a48f82d891 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions.ts @@ -4,6 +4,9 @@ * summary: List Regions * description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. * x-authenticated: false + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list + * description: Storefront guide: How to retrieve a list of regions. * parameters: * - name: expand * in: query @@ -49,12 +52,12 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query - * description: The region's q. + * description: Search term to filter the region's searchable properties. * required: false * schema: * type: string * title: q - * description: The region's q. + * description: Search term to filter the region's searchable properties. * - name: id * in: query * required: false @@ -62,422 +65,13 @@ * oneOf: * - type: string * title: id - * description: The region's ID. + * description: Filter by a region's ID. * - type: array - * description: The region's ID. + * description: Filter by region IDs. * items: * type: string * title: id - * description: The id's ID. - * - type: object - * description: The region's ID. - * properties: - * $and: - * type: array - * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * - type: array - * description: Filter by values not equal to this parameter. - * items: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * oneOf: - * - type: string - * title: $in - * description: Filter by values in this array. - * - type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * oneOf: - * - type: string - * title: $nin - * description: Filter by values not in this array. - * - type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $gt: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * $like: - * type: string - * title: $like - * description: Apply a `like` filter. Useful for strings only. - * $re: - * type: string - * title: $re - * description: Apply a regex filter. Useful for strings only. - * $ilike: - * type: string - * title: $ilike - * description: Apply a case-insensitive `like` filter. Useful for strings only. - * $fulltext: - * type: string - * title: $fulltext - * description: Filter to apply on full-text properties. - * $overlap: - * type: array - * description: Filter arrays that have overlapping values with this parameter. - * items: - * type: string - * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $gt: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * $like: - * type: string - * title: $like - * description: Apply a `like` filter. Useful for strings only. - * $re: - * type: string - * title: $re - * description: Apply a regex filter. Useful for strings only. - * $ilike: - * type: string - * title: $ilike - * description: Apply a case-insensitive `like` filter. Useful for strings only. - * $fulltext: - * type: string - * title: $fulltext - * description: Filter to apply on full-text properties. - * $overlap: - * type: array - * description: Filter arrays that have overlapping values with this parameter. - * items: - * type: string - * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * $like: - * type: string - * title: $like - * description: Apply a `like` filter. Useful for strings only. - * $re: - * type: string - * title: $re - * description: Apply a regex filter. Useful for strings only. - * $ilike: - * type: string - * title: $ilike - * description: Apply a case-insensitive `like` filter. Useful for strings only. - * $fulltext: - * type: string - * title: $fulltext - * description: Filter to apply on full-text properties. - * $overlap: - * type: array - * description: Filter arrays that have overlapping values with this parameter. - * items: - * type: string - * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). + * description: A region's ID. * - name: name * in: query * required: false @@ -485,13 +79,27 @@ * oneOf: * - type: string * title: name - * description: The region's name. + * description: Filter by a region name. * - type: array - * description: The region's name. + * description: Filter by region names. * items: * type: string * title: name - * description: The name's details. + * description: A region's name. + * - name: currency_code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: currency_code + * description: Filter by a currency code to retrieve regions that use that code. + * - type: array + * description: Filter by currency codes to retrieve regions that use one of these codes. + * items: + * type: string + * title: currency_code + * description: A currency code. * - name: $and * in: query * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts index 766e9e6073..2787a571d1 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts @@ -2,7 +2,7 @@ * @oas [get] /store/return-reasons * operationId: GetReturnReasons * summary: List Return Reasons - * description: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. + * description: Retrieve a list of return reasons. The return reasons can be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -61,7 +61,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The paginated list of return reasons. * required: * - limit * - offset @@ -70,23 +70,23 @@ * limit: * type: number * title: limit - * description: The return reason's limit. + * description: The maximum number of items returned. * offset: * type: number * title: offset - * description: The return reason's offset. + * description: The number of items skipped before retrieving the returned items. * count: * type: number * title: count - * description: The return reason's count. + * description: The total number of items. * - type: object - * description: SUMMARY + * description: The paginated list of return reasons. * required: * - return_reasons * properties: * return_reasons: * type: array - * description: The return reason's return reasons. + * description: The list of return reasons. * items: * $ref: "#/components/schemas/StoreReturnReason" * "400": diff --git a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts index 5ec51d24d0..193cbfe11a 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts @@ -1,8 +1,15 @@ /** * @oas [get] /store/shipping-options * operationId: GetShippingOptions - * summary: List Shipping Options - * description: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. + * summary: List Shipping Options for Cart + * description: > + * Retrieve a list of shipping options for a cart. The cart's ID is set in the required `cart_id` query parameter. + * + * + * The shipping options also be sorted or paginated. + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping + * description: Storefront guide: How to implement shipping during checkout. * x-authenticated: false * parameters: * - name: fields @@ -41,12 +48,12 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: cart_id * in: query - * description: The shipping option's cart id. + * description: The ID of the cart to retrieve its shipping options. * required: true * schema: * type: string * title: cart_id - * description: The shipping option's cart id. + * description: The ID of the cart to retrieve its shipping options. * - name: $and * in: query * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.