From 2189ff2dc8e907e32dd0ba0e5265826950f5e0f3 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 9 Sep 2024 16:54:14 +0300 Subject: [PATCH] chore: fix build errors in OAS (#9059) Fix errors stopping OAS from building --- .../operations/admin/post_auth_token_refresh.ts | 3 ++- ...lete_store_carts_[id]_line-items_[line_id].ts | 2 +- ..._store_customers_me_addresses_[address_id].ts | 2 +- .../operations/store/get_store_collections.ts | 2 +- .../store/get_store_collections_[id].ts | 2 +- .../operations/store/get_store_customers_me.ts | 2 +- .../store/get_store_customers_me_addresses.ts | 2 +- .../store/get_store_payment-providers.ts | 2 +- .../store/get_store_product-categories.ts | 2 +- .../store/get_store_product-categories_[id].ts | 2 +- .../operations/store/get_store_products.ts | 14 +++++++------- .../operations/store/get_store_products_[id].ts | 8 ++++---- .../operations/store/get_store_regions.ts | 16 +--------------- .../store/get_store_shipping-options.ts | 2 +- .../operations/store/post_auth_token_refresh.ts | 3 ++- .../store/post_store_carts_[id]_complete.ts | 2 +- .../store/post_store_carts_[id]_line-items.ts | 2 +- ...post_store_carts_[id]_line-items_[line_id].ts | 2 +- .../post_store_carts_[id]_shipping-methods.ts | 2 +- .../operations/store/post_store_customers.ts | 2 +- .../operations/store/post_store_customers_me.ts | 2 +- .../store/post_store_customers_me_addresses.ts | 2 +- ..._store_customers_me_addresses_[address_id].ts | 2 +- .../store/post_store_payment-collections.ts | 2 +- ..._payment-collections_[id]_payment-sessions.ts | 2 +- 25 files changed, 36 insertions(+), 48 deletions(-) diff --git a/www/utils/generated/oas-output/operations/admin/post_auth_token_refresh.ts b/www/utils/generated/oas-output/operations/admin/post_auth_token_refresh.ts index 85050ee5c1..2a8a2d8540 100644 --- a/www/utils/generated/oas-output/operations/admin/post_auth_token_refresh.ts +++ b/www/utils/generated/oas-output/operations/admin/post_auth_token_refresh.ts @@ -10,7 +10,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/auth/token/refresh' \ + * source: |- + * curl -X POST '{backend_url}/auth/token/refresh' \ * -H 'Authorization: Bearer {token}' * tags: * - Auth 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 52a42bd073..6d822e5951 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 @@ -6,7 +6,7 @@ * 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. + * description: "Storefront guide: How to remove line item from cart." * x-authenticated: false * parameters: * - name: id 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 e616378d47..280860faac 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 @@ -7,7 +7,7 @@ * 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. + * description: "Storefront guide: How to delete a customer's address." * parameters: * - name: address_id * in: path 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 2e5444fb4f..5235646be4 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 @@ -6,7 +6,7 @@ * 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. + * description: "Storefront guide: How to retrieve a list of collections." * parameters: * - name: expand * in: query 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 7838727758..b6251aee59 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 @@ -6,7 +6,7 @@ * x-authenticated: false * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve - * description: Storefront guide: How to retrieve a collection. + * 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_customers_me.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts index fa576bc92c..f757bd6aa3 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 @@ -7,7 +7,7 @@ * 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. + * 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 873e8c4ac5..10cf1da964 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 @@ -7,7 +7,7 @@ * 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. + * description: "Storefront guide: How to retrieve the logged-in customer's addresses." * parameters: * - name: expand * in: query 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 28ac6dd45d..8ae51b04c2 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 @@ -6,7 +6,7 @@ * x-authenticated: false * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment - * description: Storefront guide: How to implement payment during checkout. + * description: "Storefront guide: How to implement payment during checkout." * parameters: * - name: expand * in: query 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 c936c0e766..d88b0f242d 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 @@ -6,7 +6,7 @@ * 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. + * description: "Storefront guide: How to retrieve a list of product categories." * parameters: * - name: expand * in: query 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 bc05f5ad06..1a7638b320 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 @@ -6,7 +6,7 @@ * 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. + * description: "Storefront guide: How to retrieve a product category." * parameters: * - name: id * in: path 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 722def5f4b..08c0b76c34 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 @@ -6,7 +6,7 @@ * 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. + * description: "Storefront guide: How to retrieve a product variants' prices." * parameters: * - name: expand * in: query @@ -134,11 +134,11 @@ * in: query * 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: Filter by a collection's ID to retrieve the products in it. + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products + * description: "Storefront guide: Retrieve a collection's products." * items: * type: string * title: collection_id @@ -870,13 +870,13 @@ * in: query * 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 ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes. + * 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." * - name: country_code * in: query * description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes. 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 65ad7adf2b..38b7cd86af 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 @@ -6,7 +6,7 @@ * 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. + * description: "Storefront guide: How to retrieve a product variants' prices." * parameters: * - name: id * in: path @@ -36,13 +36,13 @@ * in: query * 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 ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes. + * 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." * - name: country_code * in: query * description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes. 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 a48f82d891..8a0e60a90a 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 @@ -6,7 +6,7 @@ * 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. + * description: "Storefront guide: How to retrieve a list of regions." * parameters: * - name: expand * in: query @@ -120,20 +120,6 @@ * items: * type: object * title: $or - * - name: currency_code - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: currency_code - * description: The region's currency code. - * - type: array - * description: The region's currency code. - * items: - * type: string - * title: currency_code - * description: The currency code's details. * x-codeSamples: * - lang: Shell * label: cURL 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 193cbfe11a..8ae042d9cc 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 @@ -9,7 +9,7 @@ * 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. + * description: "Storefront guide: How to implement shipping during checkout." * x-authenticated: false * parameters: * - name: fields diff --git a/www/utils/generated/oas-output/operations/store/post_auth_token_refresh.ts b/www/utils/generated/oas-output/operations/store/post_auth_token_refresh.ts index 7e05a56a99..0f5431e1f8 100644 --- a/www/utils/generated/oas-output/operations/store/post_auth_token_refresh.ts +++ b/www/utils/generated/oas-output/operations/store/post_auth_token_refresh.ts @@ -10,7 +10,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/auth/token/refresh' \ + * source: |- + * curl -X POST '{backend_url}/auth/token/refresh' \ * -H 'Authorization: Bearer {token}' * tags: * - Auth diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts index 34f2f77cff..ce82e90f2d 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts @@ -6,7 +6,7 @@ * x-authenticated: false * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart - * description: Storefront guide: How to implement cart completion during checkout. + * description: "Storefront guide: How to implement cart completion during checkout." * parameters: * - name: id * in: path diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts index ccf60dfb12..754e7596d7 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -6,7 +6,7 @@ * description: Add a product variant as a line item in the cart. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#add-product-variant-to-cart - * description: Storefront guide: How to add a product variant to the cart. + * description: "Storefront guide: How to add a product variant to the cart." * x-authenticated: false * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts index 7d7c3bf7af..d2bb645e44 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -6,7 +6,7 @@ * description: Update a line item's details in the cart. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#update-line-item-in-cart - * description: Storefront guide: How to update a cart's line item. + * description: "Storefront guide: How to update a cart's line item." * x-authenticated: false * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts index 74e5a1a56a..39a3520836 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts @@ -6,7 +6,7 @@ * description: Add a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping - * description: Storefront guide: How to implement shipping during checkout. + * description: "Storefront guide: How to implement shipping during checkout." * x-authenticated: false * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers.ts b/www/utils/generated/oas-output/operations/store/post_store_customers.ts index f0019228b1..9c835f83f6 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers.ts @@ -5,7 +5,7 @@ * description: Register a customer. Use the `/auth/customer/emailpass/register` API route first to retrieve the registration token and pass it in the header of the request. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/register - * description: Storefront guide: How to register a customer. + * description: "Storefront guide: How to register a customer." * x-authenticated: true * parameters: * - name: expand diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts index 37480ef3a6..b279daf76d 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts @@ -5,7 +5,7 @@ * description: Update the logged-in customer's details. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/profile - * description: Storefront guide: How to edit a customer's profile. + * description: "Storefront guide: How to edit a customer's profile." * x-authenticated: true * parameters: * - name: expand diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts index 3473a6d13f..1ec92df186 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -6,7 +6,7 @@ * description: Create an address for the logged-in customer. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#add-customer-address - * description: Storefront guide: How to create an address for the logged-in customer. + * description: "Storefront guide: How to create an address for the logged-in customer." * x-authenticated: true * parameters: * - name: expand diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index b4b7da90bd..f247ea7ab8 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -6,7 +6,7 @@ * description: Update the logged-in customer's address. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#edit-an-address - * description: Storefront guide: How to update an address of the logged-in customer. + * description: "Storefront guide: How to update an address of the logged-in customer." * x-authenticated: true * parameters: * - name: address_id diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts index a5c7c6b235..bc002502d1 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts @@ -5,7 +5,7 @@ * description: Create a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment - * description: Storefront guide: How to implement payment during checkout. + * description: "Storefront guide: How to implement payment during checkout." * x-authenticated: false * parameters: * - name: expand diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts index 6f8bc79825..ef949a512c 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts @@ -6,7 +6,7 @@ * description: Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment - * description: Storefront guide: How to implement payment during checkout. + * description: "Storefront guide: How to implement payment during checkout." * x-authenticated: false * parameters: * - name: id