From b61af03a63be48f7792ec6639d64d37f62a57990 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 3 Feb 2025 14:34:26 +0200 Subject: [PATCH] docs: fix description of update cart OAS (#11278) --- www/apps/api-reference/specs/store/openapi.full.yaml | 2 +- .../api-reference/specs/store/paths/store_carts_{id}.yaml | 8 ++++++-- .../oas-output/operations/store/post_store_carts_[id].ts | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 9d26880895..c2302ca6c8 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -694,7 +694,7 @@ paths: post: operationId: PostCartsId summary: Update a Cart - description: Update a cart's details. This unsets the shipping an payment methods chosen before, and the customer would have to choose them again. + description: Update a cart's details. This unsets the payment methods chosen before, and the customer would have to choose them again. Also, if the customer has chosen a shipping method whose option isn't valid for the cart's shipping address anymore, the shipping method will be unset. For example, if the shipping option is valid only in the US geo zone, and the shipping address's country code is `DE`, the shipping method will be unset. x-authenticated: false parameters: - name: id diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index 8b69fbd011..d4561870d3 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -68,8 +68,12 @@ post: operationId: PostCartsId summary: Update a Cart description: >- - Update a cart's details. This unsets the shipping an payment methods chosen - before, and the customer would have to choose them again. + Update a cart's details. This unsets the payment methods chosen before, and + the customer would have to choose them again. Also, if the customer has + chosen a shipping method whose option isn't valid for the cart's shipping + address anymore, the shipping method will be unset. For example, if the + shipping option is valid only in the US geo zone, and the shipping address's + country code is `DE`, the shipping method will be unset. x-authenticated: false parameters: - name: id diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts index 3f2ac4eb00..ca50f4f6de 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts @@ -2,7 +2,7 @@ * @oas [post] /store/carts/{id} * operationId: PostCartsId * summary: Update a Cart - * description: Update a cart's details. This unsets the shipping an payment methods chosen before, and the customer would have to choose them again. + * description: Update a cart's details. This unsets the payment methods chosen before, and the customer would have to choose them again. Also, if the customer has chosen a shipping method whose option isn't valid for the cart's shipping address anymore, the shipping method will be unset. For example, if the shipping option is valid only in the US geo zone, and the shipping address's country code is `DE`, the shipping method will be unset. * x-authenticated: false * parameters: * - name: id