Merge pull request #2406 from spryker/feature/cc-31953-bapi-e2e-infra…

…structure CC-31953 Introduced How To guide for backend E2E testing
spryker · Jan 9, 2024 · 734b4be · 734b4be
2 parents 9bae039 + 4ede115
commit 734b4be
Show file tree

Hide file tree

Showing 11 changed files with 822 additions and 94 deletions.
diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml
@@ -1607,7 +1607,7 @@ entries:
             - title: Set up
               url: /docs/scos/dev/front-end-development/oryx/getting-started/set-up-oryx.html
             - title: Technology
-              url: /docs/scos/dev/front-end-development/oryx/getting-started/oryx-technology.html              
+              url: /docs/scos/dev/front-end-development/oryx/getting-started/oryx-technology.html
             - title: Boilerplate
               url: /docs/scos/dev/front-end-development/oryx/getting-started/oryx-boilerplate.html
             - title: Packages
@@ -2965,6 +2965,10 @@ entries:
             url: /docs/scos/dev/guidelines/testing-guidelines/executing-tests/execute-tests.html
           - title: Test console commands
             url: /docs/scos/dev/guidelines/testing-guidelines/executing-tests/test-console-commands.html
+          - title: Test Glue API
+            url: /docs/scos/dev/guidelines/testing-guidelines/executing-tests/test-glue-api.html
+          - title: Test Glue Backend API
+            url: /docs/scos/dev/guidelines/testing-guidelines/executing-tests/test-glue-backend-api.html
           - title: Test the asynchronous API
             url: /docs/scos/dev/guidelines/testing-guidelines/executing-tests/test-the-asynchronous-api.html
           - title: Test the publish and synchronization process

diff --git a/_data/sidebars/scu_dev_sidebar.yml b/_data/sidebars/scu_dev_sidebar.yml
@@ -6,30 +6,30 @@ entries:
         url: /docs/scu/dev/spryker-code-upgrader.html
       - title: Spryker CI
         url: /docs/scu/dev/spryker-ci.html
-      - title: How the SCU works
+      - title: How the Upgrader works
         url: /docs/scu/dev/how-the-spryker-code-upgrader-works.html
       - title: SCU in a development workflow
         url: /docs/scu/dev/spryker-code-upgrader-in-a-development-workflow.html
-      - title: Onboard to the SCU
+      - title: Onboard to SCU
         url: /docs/scu/dev/onboard-to-spryker-code-upgrader/onboard-to-spryker-code-upgrader.html
         nested:
-          - title: Prepare a project for the SCU
+          - title: Prepare a project for SCU
             url: /docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.html
-          - title: Connect the Spryker CI to a GitHub managed project
+          - title: Connect Spryker CI to a GitHub managed project
             url: /docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-github-managed-project.html
-          - title: Connect the Spryker CI to a project self-hosted with GitLab
+          - title: Connect Spryker CI to a project self-hosted with GitLab
             url: /docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-project-self-hosted-with-gitlab.html
-          - title: Connect the Spryker CI to a Azure managed project
+          - title: Connect Spryker CI to a Azure managed project
             url: /docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-azure-managed-project.html
-          - title: Connect the Spryker CI to a GitLab managed project
+          - title: Connect Spryker CI to a GitLab managed project
             url: /docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-gitlab-managed-project.html
       - title: Select target branch for PRs
         url: /docs/scu/dev/select-target-branch-for-prs.html
       - title: Invite users to Spryker CI
         url: /docs/scu/dev/invite-users-to-spryker-ci.html
-      - title: Configure the SCU
+      - title: Configure SCU
         url: /docs/scu/dev/configure-spryker-code-upgrader.html
-      - title: Run the SCU
+      - title: Run SCU
         url: /docs/scu/dev/run-spryker-code-upgrader.html
       - title: Change default branch
         url: /docs/scu/dev/change-default-branch.html

diff --git a/_includes/pbc/all/glue-api-guides/202311.0/oreder-shipments-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/oreder-shipments-response-attributes.md
diff --git a/_includes/pbc/all/glue-api-guides/202311.0/shipment-methods-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/shipment-methods-response-attributes.md
@@ -0,0 +1,10 @@
+| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
+| --- | --- | --- | --- |
+| shipment-methods | name | String | The name of the shipment method. |
+| shipment-methods | id | String | The unique identifier of the shipment method. |
+| shipment-methods | name | String | The name of the shipment method. |
+| shipment-methods | carrierName | String | The name of the carrier. |
+| shipment-methods | deliveryTime | Integer | The estimated delivery time. |
+| shipment-methods | defaultGrossPrice | Integer | Default gross price, in cents. |
+| shipment-methods | defaultNetPrice | Integer | Default net price, in cents. |
+| shipment-methods | currencyIsoCode | String | The ISO 4217 code of the currency in which the prices are specified. |
diff --git a/_includes/pbc/all/glue-api-guides/202311.0/shipments-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/shipments-response-attributes.md
@@ -0,0 +1,27 @@
+| shipments | Items | Array | A list of items in the shipment. |
+| shipments | requestedDeliveryDate | Date | The desired delivery date. |
+| shipments | shippingAddress | Object | The address to which this shipment will be delivered. |
+| shipments | shippingAddress.id | String | The unique identifier of a customer address. |
+| shipments | shippingAddress.salutation | String | The salutation to use when addressing the customer. |
+| shipments | shippingAddress.firstName | String | The customer's first name. |
+| shipments | shippingAddress.lastName | String | The customer's last name. |
+| shipments | shippingAddress.address1 | String | The 1st line of the customer's address. |
+| shipments | shippingAddress.address2 | String | The 2nd line of the customer's address. |
+| shipments | shippingAddress.address3 | String | The 3rd line of the customer's address. |
+| shipments | shippingAddress.zipCode | String | The ZIP code. |
+| shipments | shippingAddress.city | String | The name of the city. |
+| shipments | shippingAddress.country | String | The name of the country. |
+| shipments | shippingAddress.iso2Code | String | Specifies an ISO 2 Country Code to use. |
+| shipments | shippingAddress.company | String | Specifies the customer's company. |
+| shipments | shippingAddress.phone | String | Specifies the customer's phone number. |
+| shipments | shippingAddress.isDefaultShipping | Boolean | If true, it is the default shipping address of the customer. |
+| shipments | shippingAddress.isDefaultBilling | Boolean | If true, it is the default billing address of the customer. |
+| shipments | shippingAddress.idCompanyBusinessUnitAddress | String | The unique identifier of a business unit address used for this shipment. |
+| shipments | selectedShipmentMethod | Object | Describes the shipment method for the shipment. |
+| shipments | selectedShipmentMethod.id | String | The unique identifier of the shipment method. |
+| shipments | selectedShipmentMethod.name | String | The name of the shipment method. |
+| shipments | selectedShipmentMethod.carrierName | String | The name of the shipment method provider. |
+| shipments | selectedShipmentMethod.price | String | The price of the shipment method. |
+| shipments | selectedShipmentMethod.taxRate | String | The tax rate for this shipment method. |
+| shipments | selectedShipmentMethod.deliveryTime | String | The estimated delivery time provided by the shipment method provider. |
+| shipments | selectedShipmentMethod.currencyIsoCode | String | The ISO 4217 code of the currency in which the price is specified. |
diff --git a/...ue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.md b/...ue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.md
@@ -522,50 +522,12 @@ To retrieve all available shipment methods, submit checkout data with one or mor
 
 {% include pbc/all/glue-api-guides/202311.0/checkout-data-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/checkout-data-response-attributes.md -->
 
+{% include pbc/all/glue-api-guides/202311.0/shipment-methods-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/shipment-methods-response-attributes.md -->
+
+{% include pbc/all/glue-api-guides/202311.0/shipments-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/shipments-response-attributes.md -->
+
+
 
-| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
-| --- | --- | --- | --- |
-| shipment-methods | name | String | The name of the shipment method. |
-| shipment-methods | id | String | The unique identifier of the shipment method. |
-| shipment-methods | name | String | The name of the shipment method. |
-| shipment-methods | carrierName | String | The name of the carrier. |
-| shipment-methods | deliveryTime | Integer | The estimated delivery time. |
-| shipment-methods | defaultGrossPrice | Integer | Default gross price, in cents. |
-| shipment-methods | defaultNetPrice | Integer | Default net price, in cents. |
-| shipment-methods | currencyIsoCode | String | The ISO 4217 code of the currency in which the prices are specified. |
-| shipments | Items | Array | A list of items in the shipment. |
-| shipments | requestedDeliveryDate | Date | The desired delivery date. |
-| shipments | shippingAddress | Object | The address to which this shipment will be delivered. |
-| shipments | shippingAddress.id | String | The unique identifier of a customer address. |
-| shipments | shippingAddress.salutation | String | The salutation to use when addressing the customer. |
-| shipments | shippingAddress.firstName | String | The customer's first name. |
-| shipments | shippingAddress.lastName | String | The customer's last name. |
-| shipments | shippingAddress.address1 | String | The 1st line of the customer's address. |
-| shipments | shippingAddress.address2 | String | The 2nd line of the customer's address. |
-| shipments | shippingAddress.address3 | String | The 3rd line of the customer's address. |
-| shipments | shippingAddress.zipCode | String | The ZIP code. |
-| shipments | shippingAddress.city | String | The name of the city. |
-| shipments | shippingAddress.country | String | The name of the country. |
-| shipments | shippingAddress.iso2Code | String | Specifies an ISO 2 Country Code to use. |
-| shipments | shippingAddress.company | String | Specifies the customer's company. |
-| shipments | shippingAddress.phone | String | Specifies the customer's phone number. |
-| shipments | shippingAddress.isDefaultShipping | Boolean | If true, it is the default shipping address of the customer. |
-| shipments | shippingAddress.isDefaultBilling | Boolean | If true, it is the default billing address of the customer. |
-| shipments | shippingAddress.idCompanyBusinessUnitAddress | String | The unique identifier of a business unit address used for this shipment. |
-| shipments | selectedShipmentMethod | Object | Describes the shipment method for the shipment. |
-| shipments | selectedShipmentMethod.id | String | The unique identifier of the shipment method. |
-| shipments | selectedShipmentMethod.name | String | The name of the shipment method. |
-| shipments | selectedShipmentMethod.carrierName | String | The name of the shipment method provider. |
-| shipments | selectedShipmentMethod.price | String | The price of the shipment method. |
-| shipments | selectedShipmentMethod.taxRate | String | The tax rate for this shipment method. |
-| shipments | selectedShipmentMethod.deliveryTime | String | The estimated delivery time provided by the shipment method provider. |
-| shipments | selectedShipmentMethod.currencyIsoCode | String | The ISO 4217 code of the currency in which the price is specified. |
-| shipment-methods | name | String | The shipment method name. |
-| shipment-methods | id | String | The unique identifier of the shipment method. |
-| shipment-methods | carrierName | String | The name of the carrier. |
-| shipment-methods | deliveryTime | Integer | The estimated delivery time. |
-| shipment-methods | Price | Integer | The price of the shipment method. |
-| shipment-methods | currencyIsoCode | String | The ISO 4217 code of the currency in which the price is specified. |
 
 ## Possible errors
 

diff --git a/...anage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.md b/...anage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.md
@@ -351,9 +351,9 @@ To retrieve order shipments, include `orders` and `order-shipments`.
 | redirectUrl | String | The URL to perform the payment verification requested by the selected payment method. After completing verification, ensure to [update payment data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html#update-payment-data). If the value is `null` or empty, no additional verification is required. |
 | isExternalRedirect | Boolean | If true, the customer is redirected to an external URL. |
 
-{% include pbc/all/glue-api-guides/202311.0/oreder-shipments-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/oreder-shipments-response-attributes.md -->
+{% include pbc/all/glue-api-guides/202311.0/order-shipments-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/order-shipments-response-attributes.md -->
 
-For the attributes of other included resources, see [Retrieve customer's order](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html)
+{% include pbc/all/glue-api-guides/202311.0/orders-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/orders-response-attributes.md -->
 
 ## Possible errors
 

diff --git a/...311.0/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.md b/...311.0/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.md
@@ -1202,9 +1202,10 @@ To retrieve order shipments, include `orders` and `order-shipments`.
 | redirectUrl | String | The URL to perform the payment verification requested by the selected payment method. After completing verification, ensure to [update payment data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html#update-payment-data). If the value is `null` or empty, no additional verification is required. |
 | isExternalRedirect | Boolean | If true, the customer is redirected to an external URL. |
 
-{% include pbc/all/glue-api-guides/202311.0/oreder-shipments-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/oreder-shipments-response-attributes.md -->
+{% include pbc/all/glue-api-guides/202311.0/order-shipments-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/order-shipments-response-attributes.md -->
+
+{% include pbc/all/glue-api-guides/202311.0/orders-response-attributes.md %} <!-- To edit, see /_includes/pbc/all/glue-api-guides/202311.0/orders-response-attributes.md -->
 
-For the attributes of other included resources, see [Retrieve customer's order](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html)
 
 ## Possible errors