From 5e155eb8e18322feaf349aeb76ee41b9c29e1046 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Mon, 18 Nov 2019 10:14:25 -0600 Subject: [PATCH 1/4] Added colons to common psuedo-headers --- _checks/styles/style-rules-prod | 2 +- guides/v2.2/b2b/company-object.md | 34 +++--- guides/v2.2/b2b/company-structures.md | 50 ++++----- guides/v2.2/b2b/company-users.md | 22 ++-- guides/v2.2/b2b/credit-manage.md | 64 +++++------ guides/v2.2/b2b/negotiable-checkout.md | 100 +++++++++--------- guides/v2.2/b2b/negotiable-manage.md | 50 ++++----- guides/v2.2/b2b/negotiable-order-workflow.md | 84 +++++++-------- guides/v2.2/b2b/negotiable-update.md | 20 ++-- guides/v2.2/b2b/roles.md | 34 +++--- guides/v2.2/b2b/shared-cat-company.md | 22 ++-- guides/v2.2/b2b/shared-cat-manage.md | 32 +++--- guides/v2.2/b2b/shared-cat-product-assign.md | 44 ++++---- .../versioning/check-version.md | 6 +- .../frontend-dev-guide/themes/debug-theme.md | 2 +- .../javascript/js_logger.md | 40 +++---- guides/v2.2/rest/modules/catalog-pricing.md | 84 +++++++-------- .../v2.2/rest/operation-status-endpoints.md | 4 +- guides/v2.2/rest/operation-status-search.md | 4 +- .../v2.2/rest/retrieve-filtered-responses.md | 4 +- .../create-configurable-product.md | 6 +- .../create-personalization-option.md | 6 +- .../create-simple-products.md | 6 +- .../define-config-product-options.md | 12 +-- .../configurable-product/plan-product.md | 8 +- guides/v2.2/rest/tutorials/index.md | 6 +- .../rest/tutorials/orders/order-add-items.md | 32 +++--- .../tutorials/orders/order-admin-token.md | 14 +-- .../tutorials/orders/order-create-customer.md | 16 +-- .../tutorials/orders/order-create-invoice.md | 16 +-- .../tutorials/orders/order-create-order.md | 16 +-- .../tutorials/orders/order-create-quote.md | 8 +- .../tutorials/orders/order-create-shipment.md | 8 +- .../tutorials/orders/order-issue-refund.md | 8 +- .../orders/order-prepare-checkout.md | 16 +-- .../prerequisite-tasks/create-admin-token.md | 8 +- .../get-customer-authorization-token.md | 4 +- .../mutations/add-configurable-products.md | 4 +- .../graphql/mutations/add-simple-products.md | 8 +- .../graphql/mutations/add-virtual-products.md | 4 +- guides/v2.3/graphql/mutations/apply-coupon.md | 4 +- .../v2.3/graphql/mutations/apply-giftcard.md | 4 +- .../graphql/mutations/apply-store-credit.md | 4 +- .../mutations/change-customer-password.md | 4 +- .../create-braintree-client-token.md | 4 +- .../mutations/create-customer-address.md | 4 +- .../v2.3/graphql/mutations/create-customer.md | 4 +- .../graphql/mutations/create-empty-cart.md | 8 +- .../mutations/create-payflow-pro-token.md | 4 +- .../mutations/create-paypal-express-token.md | 4 +- .../mutations/delete-customer-address.md | 4 +- .../graphql/mutations/delete-payment-token.md | 4 +- .../mutations/generate-customer-token.md | 4 +- .../mutations/handle-payflow-pro-response.md | 4 +- guides/v2.3/graphql/mutations/place-order.md | 4 +- .../mutations/redeem-giftcard-balance.md | 4 +- .../v2.3/graphql/mutations/remove-coupon.md | 4 +- .../v2.3/graphql/mutations/remove-giftcard.md | 4 +- guides/v2.3/graphql/mutations/remove-item.md | 4 +- .../graphql/mutations/remove-store-credit.md | 4 +- .../mutations/revoke-customer-token.md | 4 +- .../graphql/mutations/send-email-to-friend.md | 4 +- .../graphql/mutations/set-billing-address.md | 4 +- .../v2.3/graphql/mutations/set-guest-email.md | 4 +- .../graphql/mutations/set-payment-method.md | 4 +- .../mutations/set-payment-place-order.md | 4 +- .../graphql/mutations/set-shipping-address.md | 4 +- .../graphql/mutations/set-shipping-method.md | 4 +- .../graphql/mutations/update-cart-items.md | 4 +- .../mutations/update-customer-address.md | 4 +- .../v2.3/graphql/mutations/update-customer.md | 4 +- .../graphql/payment-methods/authorize-net.md | 4 +- .../payment-methods/braintree-vault.md | 4 +- .../v2.3/graphql/payment-methods/braintree.md | 4 +- .../graphql/payment-methods/hosted-pro.md | 4 +- .../payment-methods/payflow-express.md | 4 +- .../graphql/payment-methods/payflow-link.md | 4 +- .../graphql/payment-methods/payflow-pro.md | 4 +- .../payment-methods/payments-advanced.md | 4 +- .../paypal-express-checkout.md | 4 +- .../graphql/product/configurable-product.md | 2 +- .../graphql/product/downloadable-product.md | 4 +- guides/v2.3/graphql/queries/cart.md | 4 +- guides/v2.3/graphql/queries/category.md | 8 +- .../graphql/queries/checkout-agreements.md | 4 +- guides/v2.3/graphql/queries/cms-blocks.md | 4 +- guides/v2.3/graphql/queries/cms-page.md | 4 +- .../queries/custom-attribute-metadata.md | 4 +- .../queries/customer-downloadable-products.md | 4 +- .../v2.3/graphql/queries/customer-orders.md | 4 +- .../queries/customer-payment-tokens.md | 4 +- guides/v2.3/graphql/queries/customer.md | 8 +- .../graphql/queries/directory-countries.md | 4 +- .../v2.3/graphql/queries/directory-country.md | 4 +- .../graphql/queries/directory-currency.md | 4 +- .../graphql/queries/get-hosted-pro-url.md | 4 +- .../graphql/queries/get-payflow-link-token.md | 4 +- .../v2.3/graphql/queries/giftcard-account.md | 4 +- guides/v2.3/graphql/queries/index.md | 8 +- .../graphql/queries/is-email-available.md | 4 +- guides/v2.3/graphql/queries/products.md | 14 +-- guides/v2.3/graphql/queries/store-config.md | 16 +-- guides/v2.3/graphql/queries/url-resolver.md | 4 +- guides/v2.3/graphql/queries/wishlist.md | 4 +- .../checkout/checkout-add-product-to-cart.md | 8 +- .../checkout/checkout-billing-address.md | 16 +-- .../tutorials/checkout/checkout-coupon.md | 8 +- .../tutorials/checkout/checkout-customer.md | 8 +- .../checkout/checkout-payment-method.md | 12 +-- .../checkout/checkout-place-order.md | 4 +- .../checkout/checkout-quote-email.md | 4 +- .../checkout/checkout-shipping-address.md | 12 +-- .../checkout/checkout-shipping-method.md | 4 +- .../checkout/checkout-shopping-cart.md | 4 +- .../rest/modules/inventory/bulk-inventory.md | 34 +++--- .../inventory/check-salable-quantity.md | 28 ++--- .../modules/inventory/link-stocks-sources.md | 28 ++--- .../modules/inventory/manage-low-quantity.md | 22 ++-- .../modules/inventory/manage-source-items.md | 22 ++-- .../inventory/manage-source-selection.md | 38 +++---- .../rest/modules/inventory/manage-sources.md | 28 ++--- .../rest/modules/inventory/manage-stocks.md | 34 +++--- .../v2.3/rest/operation-status-endpoints.md | 4 +- guides/v2.3/rest/operation-status-search.md | 4 +- .../v2.3/rest/retrieve-filtered-responses.md | 4 +- .../create-configurable-simple-products.md | 6 +- .../create-personalization-option.md | 6 +- .../define-config-product-options.md | 12 +-- .../bulk-configurable-product/plan-product.md | 8 +- guides/v2.3/rest/tutorials/index.md | 10 +- .../inventory/assign-source-to-stock.md | 10 +- .../inventory/bulk-transfer-products.md | 14 +-- .../inventory/create-cart-add-products.md | 48 ++++----- .../tutorials/inventory/create-customer.md | 30 +++--- .../tutorials/inventory/create-invoice.md | 10 +- .../rest/tutorials/inventory/create-order.md | 10 +- .../tutorials/inventory/create-shipment.md | 28 ++--- .../tutorials/inventory/create-sources.md | 10 +- .../rest/tutorials/inventory/create-stock.md | 10 +- .../inventory/prepare-for-checkout.md | 20 ++-- .../reassign-products-to-another-source.md | 20 ++-- .../v2.3/rest/tutorials/inventory/run-ssa.md | 20 ++-- .../tutorials/orders/order-issue-refund.md | 8 +- marketplace/eqp/v1/auth.md | 6 +- marketplace/eqp/v1/files.md | 10 +- marketplace/eqp/v1/filtering.md | 4 +- marketplace/eqp/v1/packages.md | 18 ++-- marketplace/eqp/v1/users.md | 24 ++--- 148 files changed, 934 insertions(+), 934 deletions(-) diff --git a/_checks/styles/style-rules-prod b/_checks/styles/style-rules-prod index 92b0c6e27b4..bdd573c2e33 100644 --- a/_checks/styles/style-rules-prod +++ b/_checks/styles/style-rules-prod @@ -29,7 +29,7 @@ rule 'MD032' exclude_rule 'MD033' exclude_rule 'MD034' rule 'MD035' -exclude_rule 'MD036' +rule 'MD036' rule 'MD037' rule 'MD038' exclude_rule 'MD039' diff --git a/guides/v2.2/b2b/company-object.md b/guides/v2.2/b2b/company-object.md index 80d5cc1eef5..267560dc071 100644 --- a/guides/v2.2/b2b/company-object.md +++ b/guides/v2.2/b2b/company-object.md @@ -16,11 +16,11 @@ functional_areas: This section describes the REST endpoints used to manage `Company` objects. -**Service Name** +**Service Name:** `companyCompanyRepositoryV1` -**REST Endpoints** +**REST Endpoints:** ```json POST /V1/company/ @@ -61,11 +61,11 @@ Name | Description | Format | Requirements The following example creates a company and assigns the default shared catalog (`customer_group_id`). The company admin (`super_user_id`) must be a previously-defined `customer_id`. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/company/` -**Payload** +**Payload:** ```json { @@ -87,7 +87,7 @@ The following example creates a company and assigns the default shared catalog ( } ``` -**Response** +**Response:** ```json { @@ -121,11 +121,11 @@ The following example creates a company and assigns the default shared catalog ( The following call changes the company status to Rejected (`2`) and explains why. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/company/2` -**Payload** +**Payload:** ```json { @@ -150,7 +150,7 @@ The following call changes the company status to Rejected (`2`) and explains why } ``` -**Response** +**Response:** ```json { @@ -183,15 +183,15 @@ The following call changes the company status to Rejected (`2`) and explains why ### Return all information about a company This call returns detailed information about the specified company. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/company/2` -**Payload** +**Payload:** None -**Response** +**Response:** ```json { @@ -226,15 +226,15 @@ None When you delete a company, Magento assigns the "Inactive" status to all company members. The system also removes company ID from the customer profile of all company members. -**Sample Usage** +**Sample Usage:** `DELETE /rest//V1/company/2` -**Payload** +**Payload:** None -**Response** +**Response:** `true`, indicating the request was successful @@ -244,15 +244,15 @@ The following call returns all companies that are located in California (`region See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/company?searchCriteria[filter_groups][0][filters][0][field]=region_id&searchCriteria[filter_groups][0][filters][0][value]=12&searchCriteria[filter_groups][0][filters][0][condition_type]=eq` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} ```json diff --git a/guides/v2.2/b2b/company-structures.md b/guides/v2.2/b2b/company-structures.md index d8467854c66..0840cba304d 100644 --- a/guides/v2.2/b2b/company-structures.md +++ b/guides/v2.2/b2b/company-structures.md @@ -13,11 +13,11 @@ functional_areas: Company teams allow you to group company users by location, job responsibilities, or any criteria you choose. You can assign individual company users to a team with the company hierarchy endpoints. -**Service name** +**Service name:** `companyTeamRepositoryV1` -**REST Endpoints** +**REST Endpoints:** ```terminal POST /V1/team/:companyId @@ -39,11 +39,11 @@ description | An optional description of the team. | string | Optional A newly-created team is placed under Company Admin in the company hierarchy. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/team/2` -**Payload** +**Payload:** ```json { @@ -54,7 +54,7 @@ A newly-created team is placed under Company Admin in the company hierarchy. } ``` -**Response** +**Response:** The team ID, such as `4`. @@ -62,11 +62,11 @@ The team ID, such as `4`. You can only change the name or description of a team. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/team/4` -**Payload** +**Payload:** ```json { @@ -77,7 +77,7 @@ You can only change the name or description of a team. } ``` -**Response** +**Response:** `true`, indicating the request was successful @@ -85,15 +85,15 @@ You can only change the name or description of a team. The `GET` call returns the team `id`, `name`, and `description`. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/team/4` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { @@ -107,15 +107,15 @@ Not applicable You cannot delete a team if members are assigned to it. -**Sample Usage** +**Sample Usage:** `DELETE /rest//V1/team/4` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** An empty array @@ -125,15 +125,15 @@ The following query returns information about all teams (`team_id` ≥ `0`) See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/team?searchCriteria[filter_groups][0][filters][0][field]=team_id&searchCriteria[filter_groups][0][filters][0][value]=0&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** {% collapsible Show code sample %} ```json @@ -175,11 +175,11 @@ In the B2B storefront, a buyer can view the company structure represented as a h You can use REST endpoints to retrieve the current structure and move teams and buyers within the hierarchy. You cannot delete teams or buyers. -**Service name** +**Service name:** `companyHierarchyV1` -**REST Endpoints** +**REST Endpoints:** ```terminal GET /V1/hierarchy/:id @@ -201,15 +201,15 @@ Admin (structure_id = 2) | |-- Teresa Gomez (customer, structure_id = 5) ``` -**Sample Usage** +**Sample Usage:** `GET /rest//V1/hierarchy/2` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** {% collapsible Show code sample %} @@ -265,11 +265,11 @@ Not applicable The following example moves Bryce Martin (`structure_id = 4`) to the West team (`structure_id = 7`) -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/hierarchy/move/5` -**Payload** +**Payload:** ```json { @@ -277,7 +277,7 @@ The following example moves Bryce Martin (`structure_id = 4`) to the West team ( } ``` -**Response** +**Response:** `[]` (an empty array) diff --git a/guides/v2.2/b2b/company-users.md b/guides/v2.2/b2b/company-users.md index 0a65c530eca..a9dc219ba53 100644 --- a/guides/v2.2/b2b/company-users.md +++ b/guides/v2.2/b2b/company-users.md @@ -16,11 +16,11 @@ This topic discusses only the features of the `customerCustomerRepositoryV1` ser This section describes the REST endpoints used to manage company users. -**Service Name** +**Service Name:** `customerCustomerRepositoryV1` -**REST Endpoints** +**REST Endpoints:** ```terminal POST /V1/customers/ @@ -43,11 +43,11 @@ Name | Description | Format | Requirements The `POST /V1/customers` call creates a Magento customer. B2B extends the `customerAccountManagementV1` service so that you can create a company user. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/customers` -**Payload** +**Payload:** Add the `company_attributes` code block to the payload that is required to create a standard customer. @@ -82,7 +82,7 @@ Full example: } ``` -**Response** +**Response:** ```json { @@ -116,11 +116,11 @@ The following example changes the status of a company user to inactive. If you change the `status` to inactive, the account is locked. If the company user has child users, the system re-assigns the child users to the parent of the deactivated user. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/customers/13` -**Payload** +**Payload:** ```json { @@ -140,7 +140,7 @@ If you change the `status` to inactive, the account is locked. If the company us } ``` -**Response** +**Response:** ```json { @@ -172,15 +172,15 @@ If the specified company user has child users, the system re-assigns the child u Magento locks the deleted user's quotes and changes their status to Closed. The system does not allow to make changes on such quotes. -**Sample Usage** +**Sample Usage:** `DELETE /rest//V1/customers/13` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** `true`, indicating the request was successful diff --git a/guides/v2.2/b2b/credit-manage.md b/guides/v2.2/b2b/credit-manage.md index a32fa284782..f2ffbd231f6 100644 --- a/guides/v2.2/b2b/credit-manage.md +++ b/guides/v2.2/b2b/credit-manage.md @@ -19,7 +19,7 @@ The credit limit is allocated by seller, while available credit and outstanding When you create a company, the credit limit is set to 0. Use the `PUT /V1/companyCredits/:id` call to change this value and perform other updates to the company's credit settings. -**REST Endpoints** +**REST Endpoints:** ```terminal PUT /V1/companyCredits/:id @@ -45,15 +45,15 @@ Name | Description | Format | Requirements This call changes the company's credit limit to $1000. The `available_limit` parameter is calculated, so you cannot specify the value. -**Service Name** +**Service Name:** `companyCreditCreditLimitRepositoryV1` -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/companyCredits/2` -**Payload** +**Payload:** ```json { @@ -66,7 +66,7 @@ This call changes the company's credit limit to $1000. The `available_limit` par } ``` -**Response** +**Response:** ```json { @@ -84,19 +84,19 @@ This call changes the company's credit limit to $1000. The `available_limit` par This call returns data on the credit limit for the specified credit ID. -**Service Name** +**Service Name:** `companyCreditCreditLimitRepositoryV1` -**Sample Usage** +**Sample Usage:** `GET /rest//V1/companyCredits/2` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { @@ -114,19 +114,19 @@ Not applicable This call returns information about the credit limit for a specified company. -**Service Name** +**Service Name:** `companyCreditCreditLimitManagementV1` -**Sample Usage** +**Sample Usage:** `GET /rest//V1/companyCredits/company/2` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { @@ -146,15 +146,15 @@ The following call returns information for all companies whose credit balance is See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/companyCredits?searchCriteria[filter_groups][0][filters][0][field]=balance&searchCriteria[filter_groups][0][filters][0][value]=0&searchCriteria[filter_groups][0][filters][0][condition_type]=eq` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** {% collapsible Show code sample %} @@ -211,11 +211,11 @@ Not applicable The company's outstanding balance can be updated as the buyer makes payments, purchases, and other transactions. -**Service Name** +**Service Name:** `companyCreditCreditBalanceManagementV1` -**REST Endpoints** +**REST Endpoints:** ```terminal POST /V1/companyCredits/:creditId/decreaseBalance @@ -245,11 +245,11 @@ Name | Description | Format | Requirements This call increases the company credit with an Allocate, Update, Refund, Revert, or Reimburse transaction. (You cannot specify the Purchased (3) operation type.) This call also decreases the company's outstanding balance. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/companyCredits/2/increaseBalance` -**Payload** +**Payload:** ```json { @@ -260,7 +260,7 @@ This call increases the company credit with an Allocate, Update, Refund, Revert, } ``` -**Response** +**Response:** `true`, indicating the increase to the company credit balance succeeded @@ -268,11 +268,11 @@ This call increases the company credit with an Allocate, Update, Refund, Revert, This call decreases the company credit with an Update (operation type = 2), Purchased (3), or Reimbursed (4) transaction. (You cannot specify the other operation types.) This call also increases company's outstanding balance. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/companyCredits/2/decreaseBalance` -**Payload** +**Payload:** ```json { @@ -283,7 +283,7 @@ This call decreases the company credit with an Update (operation type = 2), Purc } ``` -**Response** +**Response:** `true`, indicating the decrease to the company credit balance succeeded @@ -291,10 +291,10 @@ This call decreases the company credit with an Update (operation type = 2), Purc A Reimburse transaction can be updated to include a purchase order and comment. -**Service Name** +**Service Name:** `companyCreditCreditHistoryManagementV1` -**REST Endpoints** +**REST Endpoints:** ``` GET /V1/companyCredits/history PUT /V1/companyCredits/history/:historyId @@ -304,11 +304,11 @@ PUT /V1/companyCredits/history/:historyId This call updates the credit history to specify a purchase order number. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/companyCredits/history/6` -**Payload** +**Payload:** ```json { @@ -317,7 +317,7 @@ This call updates the credit history to specify a purchase order number. } ``` -**Response** +**Response:** `true`, indicating the call was successful @@ -327,15 +327,15 @@ The following call returns a list instances in which the credit limit was set to See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/companyCredits/history?searchCriteria[filter_groups][0][filters][0][field]=credit_limit&searchCriteria[filter_groups][0][filters][0][value]=500&searchCriteria[filter_groups][0][filters][0][condition_type]=gt` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { diff --git a/guides/v2.2/b2b/negotiable-checkout.md b/guides/v2.2/b2b/negotiable-checkout.md index c4e5a736120..8f0ad7a3df8 100644 --- a/guides/v2.2/b2b/negotiable-checkout.md +++ b/guides/v2.2/b2b/negotiable-checkout.md @@ -21,7 +21,7 @@ The following diagram illustrates the workflow for {{site.data.var.b2b}} negotia A negotiated quote can be initiated without a shipping address. However, before the order can be placed, the shipping address must be provided. -**REST Endpoints** +**REST Endpoints:** ```json POST /V1/negotiable-carts/:cartId/estimate-shipping-methods @@ -33,15 +33,15 @@ POST /V1/negotiable-carts/:cartId/shipping-information This call takes a full shipping address as input and estimates shipping fees. It returns a list of available shipping methods. -**Service Name** +**Service Name:** `negotiableQuoteShipmentEstimationV1` -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiable-carts/86/estimate-shipping-methods` -**Payload** +**Payload:** ```json { @@ -61,7 +61,7 @@ This call takes a full shipping address as input and estimates shipping fees. It } ``` -**Response** +**Response:** ```json [ @@ -84,15 +84,15 @@ This call takes a full shipping address as input and estimates shipping fees. It This call takes an address ID as input and estimates shipping fees. It returns a list of available shipping methods. -**Service Name** +**Service Name:** `negotiableQuoteShippingMethodManagementV1` -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiable-carts/86/estimate-shipping-methods-by-address-id` -**Payload** +**Payload:** ```json { @@ -100,7 +100,7 @@ This call takes an address ID as input and estimates shipping fees. It returns a } ``` -**Response** +**Response:** ```json [ @@ -123,15 +123,15 @@ This call takes an address ID as input and estimates shipping fees. It returns a In this call, you specify the shipping and billing addresses, as well as the selected `shipping_carrier_code` and `shipping_method_code`. Magento returns a list of payment options and calculates the order totals. -**Service Name** +**Service Name:** `negotiableQuoteShippingMethodManagementV1` -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiable-carts/86/shipping-information` -**Payload** +**Payload:** ```json { @@ -170,7 +170,7 @@ In this call, you specify the shipping and billing addresses, as well as the sel } ``` -**Response** +**Response:** {% collapsible Show code sample %} @@ -341,11 +341,11 @@ In this call, you specify the shipping and billing addresses, as well as the sel If the billing address isn't provided through another call, use the `POST /V1/negotiable-carts/:cartId/billing-address` to specify it. -**Service Name** +**Service Name:** `negotiableQuoteBillingAddressManagementV1` -**REST Endpoints** +**REST Endpoints:** ```json POST /V1/negotiable-carts/:cartId/billing-address @@ -356,11 +356,11 @@ GET /V1/negotiable-carts/:cartId/billing-address This call assigns a billing address to the specified negotiable quote. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiable-carts/86/billing-address` -**Payload** +**Payload:** ```json { "address": { @@ -383,7 +383,7 @@ This call assigns a billing address to the specified negotiable quote. } ``` -**Response** +**Response:** [] @@ -391,15 +391,15 @@ This call assigns a billing address to the specified negotiable quote. This call returns the billing address for the specified negotiable quote. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/negotiable-carts/86/billing-address` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { @@ -427,11 +427,11 @@ Not applicable B2B allows coupons to be used toward payment. -**Service Name** +**Service Name:** `negotiableQuoteCouponManagementV1` -**REST Endpoints** +**REST Endpoints:** ```json PUT /V1/negotiable-carts/:cartId/coupons/:couponCode @@ -442,15 +442,15 @@ DELETE /V1/negotiable-carts/:cartId/coupons If the initial quote applies a coupon to the totals, Magento ignores the coupon when it converts the quote to a negotiable quote. However, you can apply a coupon at checkout. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/negotiable-carts/6/coupons/SAVE5` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** `true`, indicting the request was successful @@ -458,11 +458,11 @@ Not applicable B2B allows gift cards to be used as payment. -**Service Name** +**Service Name:** `negotiableQuoteGiftCardAccountManagementV1` -**REST Endpoints** +**REST Endpoints:** ```json POST /V1/negotiable-carts/:cartId/giftCards @@ -473,11 +473,11 @@ DELETE /V1/negotiable-carts/:cartId/giftCards/:giftCardCode If the initial quote applies a gift card to the totals, Magento ignores the gift card when it converts the quote to a negotiable quote. However, you can apply a gift card at checkout. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiable-carts/6/giftCards` -**Payload** +**Payload:** ```json { @@ -489,7 +489,7 @@ If the initial quote applies a gift card to the totals, Magento ignores the gift } ``` -**Response** +**Response:** `true` @@ -497,15 +497,15 @@ If the initial quote applies a gift card to the totals, Magento ignores the gift This call removes a gift card that has been applied to a negotiable quote. -**Sample Usage** +**Sample Usage:** `DELETE /rest//V1/negotiable-carts/6/giftCards/00HELHQED6RV` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** `true`, indicating the request was successful @@ -513,11 +513,11 @@ Not applicable When you submit payment information, Magento creates an order and sends an order confirmation to the buyer. -**Service Name** +**Service Name:** `negotiableQuotePaymentInformationManagementV1` -**REST Endpoints** +**REST Endpoints:** ```json POST /V1/negotiable-carts/:cartId/payment-information @@ -529,11 +529,11 @@ POST /V1/negotiable-carts/:cartId/set-payment-information This call sets payment information and the billing address for the negotiable quote. However, Magento does not create an order afterward. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiable-carts/86/set-payment-information` -**Payload** +**Payload:** ```json { "paymentMethod": { @@ -558,7 +558,7 @@ This call sets payment information and the billing address for the negotiable qu } ``` -**Response** +**Response:** `true`, indicating the payment information was set @@ -566,11 +566,11 @@ This call sets payment information and the billing address for the negotiable qu This call sets payment information and the billing address for the negotiable quote, then creates an order. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiable-carts/86/payment-information` -**Payload** +**Payload:** ```json { "paymentMethod": { @@ -595,7 +595,7 @@ This call sets payment information and the billing address for the negotiable qu } ``` -**Response** +**Response:** An order ID, such as `83` @@ -603,15 +603,15 @@ An order ID, such as `83` This call returns returns payment information and all information from the `totals` object. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/negotiable-carts/86/payment-information` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** {% collapsible Show code sample %} @@ -782,25 +782,25 @@ Not applicable This call is similar to `GET /V1/negotiable-carts/:cartId/payment-information`, except it does not return payment information. -**Service Name** +**Service Name:** `negotiableQuoteCartTotalRepositoryV1` -**REST Endpoints** +**REST Endpoints:** ```json GET /V1/negotiable-carts/:cartId/totals ``` -**Sample Usage** +**Sample Usage:** `GET /rest//V1/negotiable-carts/86/totals` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** {% collapsible Show code sample %} diff --git a/guides/v2.2/b2b/negotiable-manage.md b/guides/v2.2/b2b/negotiable-manage.md index 5b89e247e5a..d71655d9ae2 100644 --- a/guides/v2.2/b2b/negotiable-manage.md +++ b/guides/v2.2/b2b/negotiable-manage.md @@ -17,7 +17,7 @@ This topic describes the calls required to initiate a negotiable quote and to pr {: .bs-callout-info } All negotiable quote calls require an admin authorization token. -**REST Endpoints** +**REST Endpoints:** ```json POST /V1/negotiableQuote/request @@ -62,15 +62,15 @@ If the negotiable quote requires a shipping address (for negotiation or tax calc {:.bs-callout .bs-callout-info} Requesting a negotiable quote requires an admin authorization token. -**Service Name** +**Service Name:** `negotiableQuoteNegotiableQuoteManagementV1` -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiableQuote/request` -**Payload** +**Payload:** ```json { @@ -86,7 +86,7 @@ Requesting a negotiable quote requires an admin authorization token. } ``` -**Response** +**Response:** `true`, indicating the request was successful @@ -108,15 +108,15 @@ When the quote is submitted to the buyer: * Items that are no longer active or available for this buyer are removed from quote and prices are recalculated. * The quote state is changed to Submitted by admin. -**Service Name** +**Service Name:** `negotiableQuoteNegotiableQuoteManagementV1` -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiableQuote/submitToCustomer` -**Payload** +**Payload:** ```json { @@ -125,7 +125,7 @@ When the quote is submitted to the buyer: } ``` -**Response** +**Response:** `true`, indicating the request was successful @@ -139,11 +139,11 @@ The process of completing a negotiable quote can take days, or even longer. Duri The request can be applied to one or more quotes at the same time. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiableQuote/pricesUpdated` -**Payload** +**Payload:** ```json { @@ -151,7 +151,7 @@ The request can be applied to one or more quotes at the same time. } ``` -**Response** +**Response:** `true`, indicating the request was successful @@ -159,11 +159,11 @@ The request can be applied to one or more quotes at the same time. To set the shipping method, the quote must be in the `created`, `processing_by_admin` or `submitted_by_customer`. In addition, the quote must have a shipping address but no shipping method or shipping price. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/negotiableQuote/3/shippingMethod` -**Payload** +**Payload:** ```json { @@ -171,7 +171,7 @@ To set the shipping method, the quote must be in the `created`, `processing_by_a } ``` -**Response** +**Response:** ### Decline a quote @@ -183,15 +183,15 @@ The seller can send a request to decline the quote. The request can be submitted When you decline a quote, all custom pricing will be removed from the quote. The buyer will be able to place an order using their standard catalog prices and discounts. -**Service Name** +**Service Name:** `negotiableQuoteNegotiableQuoteManagementV1` -**Sample Usage** +**Sample Usage:** `POST /rest//V1/negotiableQuote/decline` -**Payload** +**Payload:** ```json { @@ -200,7 +200,7 @@ When you decline a quote, all custom pricing will be removed from the quote. The } ``` -**Response** +**Response:** `true`, indicating the request was successful @@ -212,15 +212,15 @@ These tasks are not essential for completing a negotiable quote, but might be us Magento returns all the comments associated with the specified quote ID. The comments are listed in chronological order, with the oldest comment listed first. A `creator_type` value of `3` indicates the buyer made the comment. If the value is `2`, the seller commented. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/negotiableQuote/87/comments` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json [ @@ -307,15 +307,15 @@ Use the `attachmentContent` call to retrieve the files (in base64 format) attach `negotiableQuoteAttachmentContentManagementV1` -**Sample Usage** +**Sample Usage:** `GET /rest//V1/negotiableQuote/attachmentContent` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { diff --git a/guides/v2.2/b2b/negotiable-order-workflow.md b/guides/v2.2/b2b/negotiable-order-workflow.md index cd825110520..f813d570c23 100644 --- a/guides/v2.2/b2b/negotiable-order-workflow.md +++ b/guides/v2.2/b2b/negotiable-order-workflow.md @@ -20,22 +20,22 @@ The steps in this section are similar to those in the [Order processing tutorial In this example, the customer is a company user (buyer). -**Endpoint** +**Endpoint:** `POST /V1/carts/mine` -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Payload** +**Payload:** None -**Response** +**Response:** The response is the `quoteId`: `5` @@ -43,11 +43,11 @@ The response is the `quoteId`: `5` This example adds 15 Pursuit Lumaflex Tone Bands and 10 Harmony Lumaflex Strength Band Kits to the cart. You must make two calls to add these products. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/carts/mine` -**Headers** +**Headers:** ```terminal Content-Type application/json @@ -110,18 +110,18 @@ Authorization Bearer You can determine shipping costs after initiating a negotiable quote, but doing it now provides a more detailed picture of the final costs to the buyer. If you want to defer setting the shipping address until after the negotiable quote has been created, use the `/V1/negotiable-carts/:cartId/estimate-shipping-methods` call. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/carts/mine/estimate-shipping-methods` -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Payload** +**Payload:** ```json { "address": { @@ -144,7 +144,7 @@ Authorization Bearer } ``` -**Response** +**Response:** ```json [ @@ -179,18 +179,18 @@ Authorization Bearer You can also set shipping and billing information after initiating a negotiable quote by calling `POST /V1/negotiable-carts/:cartId/shipping-information`. -**Endpoint** +**Endpoint:** `POST /V1/carts/mine/shipping-information` -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Payload** +**Payload:** ```json { @@ -231,7 +231,7 @@ Authorization Bearer } ``` -**Response** +**Response:** {% collapsible Show code sample %} @@ -389,22 +389,22 @@ Authorization Bearer This is an optional step to show the status of the cart before you begin the negotiable quote process. -**Endpoint** +**Endpoint:** `GET /V1/carts/mine` -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} @@ -603,18 +603,18 @@ In this example, the buyer initiates a negotiable quote, asking for a 2.5% disco Initiating a negotiable quote places it in the `processing_by_admin` state. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/negotiableQuote/request` -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Payload** +**Payload:** ```json { @@ -624,7 +624,7 @@ Authorization Bearer } ``` -**Response** +**Response:** `true` @@ -632,18 +632,18 @@ Authorization Bearer The seller accepts the buyer's request for a 2.5% discount. The `negotiated_price_type` value of `1` indicates a percentage discount. -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Endpoint** +**Endpoint:** `PUT /V1/negotiableQuote/5` -**Payload** +**Payload:** ```json { @@ -659,7 +659,7 @@ Authorization Bearer } ``` -**Response** +**Response:** `[]` @@ -669,18 +669,18 @@ Now that the seller has updated the quote, it must be returned to the buyer. The This call places the quote in the `submitted_by_admin` state. -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Endpoint** +**Endpoint:** `POST /V1/negotiableQuote/submitToCustomer` -**Payload** +**Payload:** ```json { @@ -689,7 +689,7 @@ Authorization Bearer } ``` -**Response** +**Response:** `true` @@ -697,22 +697,22 @@ Authorization Bearer The price of each item has been reduced by 2.5 percent. In addition, the `negotiable_quote` section of the response has been updated. -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Endpoint** +**Endpoint:** `GET` /V1/carts/5 -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} @@ -938,18 +938,18 @@ None The buyer is now ready to complete the purchase. Since the buyer has already specified the billing address, only the `paymentMethod` information must be included. -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Endpoint** +**Endpoint:** `/V1/negotiable-carts/3/payment-information` -**Payload** +**Payload:** ```json { "paymentMethod": { @@ -959,7 +959,7 @@ Authorization Bearer } ``` -**Response** +**Response:** The response is the order `id`: `4` @@ -969,18 +969,18 @@ Now that the negotiable quote has been converted into an order, you can issue an In this example, the `companyId` is `1`. -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Endpoint** +**Endpoint:** `POST /V1/companyCredits/1/increaseBalance` -**Payload** +**Payload:** ```json { @@ -991,7 +991,7 @@ Authorization Bearer } ``` -**Response** +**Response:** `true`, indicating the reimbursement was successfully applied. Magento sends an email to the buyer. diff --git a/guides/v2.2/b2b/negotiable-update.md b/guides/v2.2/b2b/negotiable-update.md index 9f3d5cc7d68..0261b55b46d 100644 --- a/guides/v2.2/b2b/negotiable-update.md +++ b/guides/v2.2/b2b/negotiable-update.md @@ -50,15 +50,15 @@ The `negotiated_price_type` can have one of the following values: `3` - Set a proposed price for the entire quote. The `negotiated_price_value`parameter specifies the proposed price. -**Service Name** +**Service Name:** `quoteCartRepositoryV1` -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/negotiableQuote/6` -**Payload** +**Payload:** ```json { @@ -81,18 +81,18 @@ The buyer can add, update, or delete items from the quote under the following co * The quote is in one of the following system states: `created`, `processing_by_admin`, or `submitted_by_customer`. * The quote doesn't have a negotiated price. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/carts/mine/items` -**Headers** +**Headers:** ```terminal Content-Type application/json Authorization Bearer ``` -**Payload** +**Payload:** ```json { @@ -104,7 +104,7 @@ Authorization Bearer } ``` -**Response** +**Response:** ```json { @@ -128,11 +128,11 @@ Authorization Bearer ### Change the quote expiration date -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/negotiableQuote/6` -**Payload** +**Payload:** ```json { @@ -147,7 +147,7 @@ Authorization Bearer } ``` -**Response** +**Response:** `[]` diff --git a/guides/v2.2/b2b/roles.md b/guides/v2.2/b2b/roles.md index 29c313c3b2c..a2e13c37ceb 100644 --- a/guides/v2.2/b2b/roles.md +++ b/guides/v2.2/b2b/roles.md @@ -57,11 +57,11 @@ Magento_Company::credit_history | view | 3 The Company Admin controls the possible actions for each customer within the company by creating common roles with embedded permissions and then assigning them to company users. In most cases, a few roles will be sufficient to cover all the different possible combinations of permissions needed for a company. -**Service Name** +**Service Name:** `companyRoleRepositoryV1` -**REST Endpoints** +**REST Endpoints:** ```json POST /V1/company/role/ @@ -97,11 +97,11 @@ This example creates a role named "Junior Buyer". It allows the assignee to acce All resources that are not explicitly allowed are denied. You must specify the `Magento_Company::index` resource in all calls. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/company/role` -**Payload** +**Payload:** ```json { @@ -120,7 +120,7 @@ All resources that are not explicitly allowed are denied. You must specify the ` } ``` -**Response** +**Response:** {% collapsible Show code sample %} ```json @@ -291,11 +291,11 @@ Each update call must include all resources the assignee will have access to. This example call adds access to all Negotiable Quote resources except "View quotes of subordinate users" to the Junior Buyer role. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/company/role/6` -**Payload** +**Payload:** ```json { @@ -319,7 +319,7 @@ This example call adds access to all Negotiable Quote resources except "View quo } ``` -**Response** +**Response:** {% collapsible Show code sample %} ```json @@ -488,15 +488,15 @@ This example call adds access to all Negotiable Quote resources except "View quo This call returns the `id`, role name, and set of permissions defined within the specified `role_id`. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/company/role/6` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} ```json @@ -665,15 +665,15 @@ None You cannot delete a role if it is the only role defined within the company. -**Sample Usage** +**Sample Usage:** `DELETE /rest//V1/company/role/5` -**Payload** +**Payload:** None -**Response** +**Response:** `true`, indicating the request was successful @@ -683,15 +683,15 @@ The following call returns all roles that have been created for a company (`com See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/company/role?searchCriteria[filter_groups][0][filters][0][field]=company_id&searchCriteria[filter_groups][0][filters][0][value]=2&searchCriteria[filter_groups][0][filters][0][condition_type]=eq` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} ```json diff --git a/guides/v2.2/b2b/shared-cat-company.md b/guides/v2.2/b2b/shared-cat-company.md index ff96533d4dc..0d0199ba48b 100644 --- a/guides/v2.2/b2b/shared-cat-company.md +++ b/guides/v2.2/b2b/shared-cat-company.md @@ -10,11 +10,11 @@ functional_areas: A shared catalog must be assigned to one or more companies before it can be accessed by the company users. -**Service name** +**Service name:** `sharedCatalogCompanyManagementV1` -**REST endpoints** +**REST endpoints:** ```terminal POST /V1/sharedCatalog/:sharedCatalogId/assignCompanies @@ -37,11 +37,11 @@ This action works as an update. It does not replace companies that have already If a specified company is already assigned to a different shared catalog, this request unassigns the company from the previous catalog and assigns to the new one. -**Sample usage** +**Sample usage:** `POST /rest//V1/sharedCatalog/2/assignCompanies` -**Payload** +**Payload:** ```json { @@ -56,7 +56,7 @@ If a specified company is already assigned to a different shared catalog, this r } ``` -**Response** +**Response:** `true`, indicating the operation was successful @@ -64,11 +64,11 @@ If a specified company is already assigned to a different shared catalog, this r When you unassign a company from a custom catalog, the system automatically assigns this company to the public shared catalog. You cannot unassign a company from the public catalog. -**Sample usage** +**Sample usage:** `POST /rest//V1/sharedCatalog/2/unassignCompanies` -**Payload** +**Payload:** ```json { @@ -80,7 +80,7 @@ When you unassign a company from a custom catalog, the system automatically assi } ``` -**Response** +**Response:** `true`, indicating the operation was successful @@ -88,15 +88,15 @@ When you unassign a company from a custom catalog, the system automatically assi The `GET` call returns an array of company IDs. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/sharedCatalog/2/companies` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** `"[\"1\",\"2\"]"` diff --git a/guides/v2.2/b2b/shared-cat-manage.md b/guides/v2.2/b2b/shared-cat-manage.md index 129a6570d14..2d5ec140ebb 100644 --- a/guides/v2.2/b2b/shared-cat-manage.md +++ b/guides/v2.2/b2b/shared-cat-manage.md @@ -12,11 +12,11 @@ functional_areas: {{site.data.var.b2b}} provides two types of shared catalog: public and custom. A public catalog is the default shared catalog. It is automatically displayed to all guest customers and to logged-in customers that are not company users. The seller assigns a custom shared catalog to specific companies as configured by admin. There can only be one public catalog, and it cannot be deleted. -**Service name** +**Service name:** `sharedCatalogSharedCatalogRepositoryV1` -**REST Endpoints** +**REST Endpoints:** ```terminal POST /V1/sharedCatalog @@ -43,11 +43,11 @@ Name | Description | Format | Requirements When B2B is enabled, the system creates a public shared catalog named `Default (General)`. Magento allows only one public shared catalog at a time. You can create an unlimited number of custom shared catalogs. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/sharedCatalog` -**Payload** +**Payload:** ```json { @@ -60,7 +60,7 @@ When B2B is enabled, the system creates a public shared catalog named `Default ( } ``` -**Response** +**Response:** The shared catalog `id`, such as `2`. @@ -68,7 +68,7 @@ The shared catalog `id`, such as `2`. You cannot change the `type` from public (`1`) to custom (`0`). If you need to replace the public shared catalog, create a custom catalog and change its type to public. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/sharedCatalog/2` @@ -85,7 +85,7 @@ You cannot change the `type` from public (`1`) to custom (`0`). If you need to r } ``` -**Response** +**Response:** The shared catalog `id`, such as `2`. @@ -93,15 +93,15 @@ The shared catalog `id`, such as `2`. This call returns information about the specified shared catalog. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/sharedCatalog/2` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { @@ -121,15 +121,15 @@ Not applicable Only custom shared catalogs can be deleted. When a custom catalog is deleted, the assigned companies are re-assigned to the default public catalog. -**Sample Usage** +**Sample Usage:** `DELETE /rest//V1/sharedCatalog/2` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** `true`, indicating the request was successful @@ -139,15 +139,15 @@ The following search returns all the custom shared catalogs (`type = 0`) in the See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/sharedCatalog?searchCriteria[filter_groups][0][filters][0][field]=type&searchCriteria[filter_groups][0][filters][0][value]=0&searchCriteria[filter_groups][0][filters][0][condition_type]=eq` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json { diff --git a/guides/v2.2/b2b/shared-cat-product-assign.md b/guides/v2.2/b2b/shared-cat-product-assign.md index 52c5955ca46..3f2655c955e 100644 --- a/guides/v2.2/b2b/shared-cat-product-assign.md +++ b/guides/v2.2/b2b/shared-cat-product-assign.md @@ -21,11 +21,11 @@ The `sharedCatalogCategoryManagementV1` service is based on `catalogCategoryMana {: .bs-callout-info } Products that are defined within a category are not included when you assign a category to a shared catalog. You must add products separately. -**Service name** +**Service name:** `sharedCatalogCategoryManagementV1` -**REST Endpoints** +**REST Endpoints:** ```terminal POST /V1/sharedCatalog/:id/assignCategories @@ -46,11 +46,11 @@ Name | Description | Format | Requirements The following example adds the Luma Gear category (`id=3`) as well as its subcategories (`id=4,5,6`) to a custom shared catalog. -**Sample usage** +**Sample usage:** `POST /rest//V1/sharedCatalog/2/assignCategories` -**Payload** +**Payload:** ```json { @@ -71,7 +71,7 @@ The following example adds the Luma Gear category (`id=3`) as well as its subcat } ``` -**Response** +**Response:** `true`, indicating the operation was successful @@ -81,11 +81,11 @@ When you unassign a category from a shared catalog, Magento also removes its pro The following example removes two categories from the shared catalog. -**Sample usage** +**Sample usage:** `POST /rest//V1/sharedCatalog/2/unassignCategories` -**Payload** +**Payload:** ```json { @@ -101,7 +101,7 @@ The following example removes two categories from the shared catalog. } ``` -**Response** +**Response:** `true`, indicating the operation was successful @@ -109,15 +109,15 @@ The following example removes two categories from the shared catalog. The `GET` call returns an array of catalog IDs. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/sharedCatalog/2/categories` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json [ @@ -132,11 +132,11 @@ Not applicable The `sharedCatalogProductManagementV1` service is based on `catalogProductManagementV1`. To return a list of products defined within a category, call `GET /V1/categories/:categoryId/products`. -**Service name** +**Service name:** `sharedCatalogProductManagementV1` -**REST endpoints** +**REST endpoints:** ```terminal POST /V1/sharedCatalog/:id/assignProducts @@ -157,11 +157,11 @@ Name | Description | Format | Requirements The following example adds two products each in the Bags, Fitness Equipment, and Watches categories to a custom shared catalog. The specified products do not have to be in the same category. -**Sample usage** +**Sample usage:** `POST /rest//V1/sharedCatalog/2/assignProducts` -**Payload** +**Payload:** ```json { @@ -188,7 +188,7 @@ The following example adds two products each in the Bags, Fitness Equipment, and } ``` -**Response** +**Response:** `true`, indicating the operation was successful @@ -196,11 +196,11 @@ The following example adds two products each in the Bags, Fitness Equipment, and Unassigning a product does not remove it from its category or categories. -**Sample usage** +**Sample usage:** `POST /rest//V1/sharedCatalog/2/unassignProducts` -**Payload** +**Payload:** ```json { @@ -212,7 +212,7 @@ Unassigning a product does not remove it from its category or categories. } ``` -**Response** +**Response:** `true`, indicating the operation was successful @@ -220,15 +220,15 @@ Unassigning a product does not remove it from its category or categories. The `GET` call returns an array of SKUs. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/sharedCatalog/2/products` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json [ diff --git a/guides/v2.2/extension-dev-guide/versioning/check-version.md b/guides/v2.2/extension-dev-guide/versioning/check-version.md index b4860290196..c31bd0f9bbb 100644 --- a/guides/v2.2/extension-dev-guide/versioning/check-version.md +++ b/guides/v2.2/extension-dev-guide/versioning/check-version.md @@ -22,7 +22,7 @@ The following command returns the Magento version. bin/magento --version ``` -**Response** +**Response:** ```terminal Magento CLI version 2.3.0 @@ -32,13 +32,13 @@ Magento CLI version 2.3.0 An HTTP request returns less detailed information about the Magento version. -**Request** +**Request:** ```text http:///magento_version ``` -**Response** +**Response:** ```text Magento/2.3 (Community) diff --git a/guides/v2.2/frontend-dev-guide/themes/debug-theme.md b/guides/v2.2/frontend-dev-guide/themes/debug-theme.md index dc1adc93847..4ec41565e1b 100644 --- a/guides/v2.2/frontend-dev-guide/themes/debug-theme.md +++ b/guides/v2.2/frontend-dev-guide/themes/debug-theme.md @@ -18,7 +18,7 @@ To enable template hints: 1. Click **Stores** > **Settings** > **Configuration** > ADVANCED > **Developer**. -1. In the **Scope** dropdown in the upper-left corner select the view for which you want the template hints. +1. In the **Scope:** dropdown in the upper-left corner select the view for which you want the template hints. 1. In the **Debug** tab, set **Template Path Hints for storefront** to **Yes**. To enable path hints for [Admin](https://glossary.magento.com/admin) set **Template Path Hints for Admin** to **Yes**. 1. To save the changes, click **Save Config** in the upper-right corner. diff --git a/guides/v2.2/javascript-dev-guide/javascript/js_logger.md b/guides/v2.2/javascript-dev-guide/javascript/js_logger.md index 83bef022dbb..66ca9cc5582 100644 --- a/guides/v2.2/javascript-dev-guide/javascript/js_logger.md +++ b/guides/v2.2/javascript-dev-guide/javascript/js_logger.md @@ -16,7 +16,7 @@ The `Logger` class provides logging functionality for an application. It can be ### `new Logger(outputHandler, entryFactory)` -**Parameters** +**Parameters:** - `outputHandler: LogOutputHandler`: An instance of `LogOutputHandler` used to display log entries. - `entryFactory: LogEntryFactory`: A factory of the `LogEntry` instances. @@ -24,26 +24,26 @@ The `Logger` class provides logging functionality for an application. It can be ### `setDisplayLevel(level)` Sets the boundary entry level. The entries whose level is lower, than the specified one, are not passed to the output. -**Parameters** +**Parameters:** `level: number`: Minimum display level for an entry. ### `addDisplayCriteria(criteria)` Adds a function that is used to define whether newly created entries should be passed to the output. -**Parameters** +**Parameters:** `criteria: Function`: A function that accepts instance of the `LogEntry` and returns a Boolean value. ### removeDisplayCriteria(criteria) Removes the previously added display criteria. -**Parameters** +**Parameters:** `criteria: Function`: The display criteria to be removed. ### `error(message, [messageData])` Creates a `LogEntry` with the `ERROR` level and passes it to the output, if it matches all current display criteria. -**Parameters** +**Parameters:** `message: string`: Entry's message. `messageData?: Object`: Optional data associated with the message. @@ -53,7 +53,7 @@ Creates a `LogEntry` with the `ERROR` level and passes it to the output, if it m ### `warn(message, [messageData])` Creates a `LogEntry` with the `WARN` level and passes it to the output, if it matches all current display criteria. -**Parameters** +**Parameters:** `message: string`: Entry's message. `messageData?: Object`: Optional data associated with the message. @@ -63,7 +63,7 @@ Creates a `LogEntry` with the `WARN` level and passes it to the output, if it ma ### `info(message, [messageData])` Creates a `LogEntry` with the `INFO` level and passes it to the output if it matches all current display criteria. -**Parameters** +**Parameters:** `message: string`: Entry's message. `messageData?: Object`: Optional data associated with the message. @@ -73,7 +73,7 @@ Creates a `LogEntry` with the `INFO` level and passes it to the output if it mat ### `debug(message, [messageData])` Creates a `LogEntry` with the `DEBUG` level and passes it to the output, if it matches all current display criteria. -**Parameters** +**Parameters:** `message: string`: Entry's message. `messageData?: Object`: Optional data associated with the message. @@ -83,14 +83,14 @@ Creates a `LogEntry` with the `DEBUG` level and passes it to the output, if it m ### `getEntries([criteria])` Returns all available log entries. It can additionally filter out the entries that don't match the provided criteria. -**Parameters** +**Parameters:** `criteria?: Function`: Optional function that accepts an instance of `LogEntry` and implements the filter criteria by which the entries are added to the resulting array. **Returns:** `Array`: An array of `LogEntry`. ### `dump(criteria)` -**Parameters** +**Parameters:** `criteria?: Function`: Optional function that accepts an instance of `LogEntry` and implements the filter criteria by which entries are passed to the output handler. ## `LogEntry` @@ -100,7 +100,7 @@ Returns all available log entries. It can additionally filter out the entries th ### new LogEntry(message, level, [data]) -**Parameters** +**Parameters:** - `message: string`: Entry's message. - `level: number`: Entry's level. @@ -126,21 +126,21 @@ The `LogOutputHandler` class responsible for the output of entries passed by `Lo ### new LogOutputHandler(formatter) -**Parameters** +**Parameters:** `formatter: LogFormatter`: An instance of `LogFormatter` that will be used to create a display message for the provided entries. ### show(entry) Displays the provided entry. -**Parameters** +**Parameters:** `entry: LogEntry`: The entry to be displayed. ### dump(entries) Displays multiple entries at once. -**Parameters** +**Parameters:** `entries: Array`: An array of the `LogEntry` instances to be displayed. ## LogFormatter @@ -160,7 +160,7 @@ The `LogFormatter` class is responsible for processing the message of the provid ### new LogFormatter([dateFormat], [template]) -**Parameters** +**Parameters:** - `dateFormat = "YYYY-MM-DD hh:mm:ss"`: Date format that is applied to display the entry creation time. - `template = "[${ $.date }] [${ $.entry.levelName }] ${ $.message }`: Template used to create the resulting message of an entry. @@ -168,7 +168,7 @@ The `LogFormatter` class is responsible for processing the message of the provid ### `process(entry)` Creates a text representation of the provided entry. If default settings are used, the resulting string looks like following: `[2017-04-07 01:36:24] [DEBUG] Log message`. -**Parameters** +**Parameters:** `entry: LogEntry`: An instance of `LogEntry` to be processed. **Returns:** String @@ -194,7 +194,7 @@ Returns a list of available log levels. ### `getNameByCode(code)` -**Parameters** +**Parameters:** `code: string`: Level's identifier. **Returns:** Number @@ -208,7 +208,7 @@ Implements a collection of predefined messages used by `consoleLogger`. ### `getMessage(code)` Returns message that matches the provided code. -**Parameters** +**Parameters:** `code: string`: Message's identifier. **Returns:** String @@ -216,7 +216,7 @@ Returns message that matches the provided code. ### `addMessage(code, message)` Adds a new message to the pool. -**Parameters** +**Parameters:** `code: string`: Message's identifier. `message: string`: Text of the message. @@ -224,7 +224,7 @@ Adds a new message to the pool. ### `hasMessage(code)` Checks whether a message with the provided code exists in the pool. -**Parameters** +**Parameters:** `code: string`: Message's identifier. **Returns:** Boolean diff --git a/guides/v2.2/rest/modules/catalog-pricing.md b/guides/v2.2/rest/modules/catalog-pricing.md index fff4d3f23c4..8f923badde7 100644 --- a/guides/v2.2/rest/modules/catalog-pricing.md +++ b/guides/v2.2/rest/modules/catalog-pricing.md @@ -20,11 +20,11 @@ The `POST /V1/products/special-price` call sets special prices for the following * Virtual * Downloadable -**Service Name** +**Service Name:** `SpecialPriceStorageInterface` -**REST Endpoints** +**REST Endpoints:** ```http POST /V1/products/special-price @@ -51,11 +51,11 @@ For bundled products, the value of the `price` parameter must be expressed as a You can set multiple special prices in a single call, as shown in the example below. The call sets special prices for a simple product, downloadable product, and bundle product for two days. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/special-price` -**Payload** +**Payload:** ```json { @@ -86,7 +86,7 @@ You can set multiple special prices in a single call, as shown in the example be ``` -**Response** +**Response:** `[]` (an empty array) @@ -94,11 +94,11 @@ You can set multiple special prices in a single call, as shown in the example be The following call returns the special price information for three SKU values. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/special-price-information` -**Payload** +**Payload:** ```json { @@ -110,7 +110,7 @@ The following call returns the special price information for three SKU values. } ``` -**Response** +**Response:** ```json [ @@ -142,11 +142,11 @@ The following call returns the special price information for three SKU values. If any item to be deleted has an invalid `price`, `store_id`, `sku` or date, Magento marks the item as failed and excludes it from the delete list. Valid items are deleted as requested. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/special-price-delete` -**Payload** +**Payload:** ```json { @@ -176,7 +176,7 @@ If any item to be deleted has an invalid `price`, `store_id`, `sku` or date, Mag } ``` -**Response** +**Response:** `[]` (an empty array) @@ -193,11 +193,11 @@ Bundle | discount Virtual | fixed, discount Downloadable | fixed, discount -**Service Name** +**Service Name:** `TierPriceStorageInterface` -**REST Endpoints** +**REST Endpoints:** ```http POST /V1/products/tier-prices @@ -222,11 +222,11 @@ Name | Description | Format | Requirements The `POST /V1/products/tier-prices` call adds new tier prices or updates existing prices. You can specify tier prices for multiple products in the same call. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/tier-prices` -**Payload** +**Payload:** ```json @@ -260,7 +260,7 @@ The `POST /V1/products/tier-prices` call adds new tier prices or updates existin } ``` -**Response** +**Response:** `[]` (an empty array) @@ -270,11 +270,11 @@ The replace request removes all existing tier prices for a specified product and The following example removes the $10 tier price for `sku` 24-UG04 and changes the customer group for the `sku`'s other tier prices. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/products/tier-prices` -**Payload** +**Payload:** ```json { @@ -299,7 +299,7 @@ The following example removes the $10 tier price for `sku` 24-UG04 and changes t } ``` -**Response** +**Response:** `[]` (an empty array) @@ -307,11 +307,11 @@ The following example removes the $10 tier price for `sku` 24-UG04 and changes t Magento returns all active tier prices for the specified list of `skus`. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/tier-prices-information` -**Payload** +**Payload:** ```json { @@ -322,7 +322,7 @@ Magento returns all active tier prices for the specified list of `skus`. } ``` -**Response** +**Response:** ```json [ @@ -365,11 +365,11 @@ Magento returns all active tier prices for the specified list of `skus`. You must specify each tier price that is to be deleted. You can delete multiple tier prices in a single call. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/tier-prices-delete` -**Payload** +**Payload:** ```json { @@ -386,7 +386,7 @@ You must specify each tier price that is to be deleted. You can delete multiple } ``` -**Response** +**Response:** `[]` (an empty array) @@ -397,7 +397,7 @@ A base price is the price of a product, before any discounts or extra costs (suc {:.bs-callout .bs-callout-info} You cannot delete a base price. It can only be changed to another value (0 or greater). -**REST Endpoints** +**REST Endpoints:** ```http POST /V1/products/base-prices @@ -424,11 +424,11 @@ The `POST /V1/products/base-price` call can set base prices for the following ty The following example sets the base price for a simple and a downloadable product. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/base-prices` -**Payload** +**Payload:** ```json { @@ -447,7 +447,7 @@ The following example sets the base price for a simple and a downloadable produc } ``` -**Response** +**Response:** `[]` (an empty array) @@ -455,11 +455,11 @@ The following example sets the base price for a simple and a downloadable produc The following example returns the base prices for a simple and a downloadable product. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/base-prices-information` -**Payload** +**Payload:** ```json { "skus": [ @@ -469,7 +469,7 @@ The following example returns the base prices for a simple and a downloadable pr } ``` -**Response** +**Response:** ```json [ @@ -490,7 +490,7 @@ The following example returns the base prices for a simple and a downloadable pr The cost is the actual cost of a product. Tracking costs is optional, but having this information available can be helpful when you are setting discounts. -**REST Endpoints** +**REST Endpoints:** ```http POST /V1/products/cost @@ -517,11 +517,11 @@ The `POST /V1/products/cost` call can set the cost values for the following type The following example sets the cost value for a simple and a downloadable product. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/cost` -**Payload** +**Payload:** ```json { @@ -540,7 +540,7 @@ The following example sets the cost value for a simple and a downloadable produc } ``` -**Response** +**Response:** `[]` (an empty array) @@ -548,11 +548,11 @@ The following example sets the cost value for a simple and a downloadable produc The following example returns the cost values for a simple and a downloadable product. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/cost-information` -**Payload** +**Payload:** ```json { "skus": [ @@ -562,7 +562,7 @@ The following example returns the cost values for a simple and a downloadable pr } ``` -**Response** +**Response:** ```json [ @@ -583,11 +583,11 @@ The following example returns the cost values for a simple and a downloadable pr The following example deletes the previously-defined cost values for a simple and a downloadable product. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/products/cost-delete` -**Payload** +**Payload:** ```json { "skus": [ @@ -597,6 +597,6 @@ The following example deletes the previously-defined cost values for a simple an } ``` -**Response** +**Response:** `true`, indicating the cost values were deleted diff --git a/guides/v2.2/rest/operation-status-endpoints.md b/guides/v2.2/rest/operation-status-endpoints.md index 0a694b2e08f..4b8ac7d280b 100644 --- a/guides/v2.2/rest/operation-status-endpoints.md +++ b/guides/v2.2/rest/operation-status-endpoints.md @@ -30,7 +30,7 @@ Field name | Data type | Description `user_id` | Integer | The user ID that executed the request. `operation_count` | Integer | The number of operations processed in the request. -**Response** +**Response:** ```json { @@ -75,7 +75,7 @@ Field name | Data type | Description `user_id` | Integer | The user ID that executed the request. `operation_count` | Integer | The number of operations processed in the request. -**Response** +**Response:** ```json { diff --git a/guides/v2.2/rest/operation-status-search.md b/guides/v2.2/rest/operation-status-search.md index 986a2565c06..30375e23e97 100644 --- a/guides/v2.2/rest/operation-status-search.md +++ b/guides/v2.2/rest/operation-status-search.md @@ -22,7 +22,7 @@ You can specify any of the following fields to filter on operation statuses: * `bulk_uuid` - UUID generated by an [asynchronous API request]({{ page.baseurl }}/rest/asynchronous-web-endpoints.html) or [Bulk API request]({{ page.baseurl }}/rest/bulk-endpoints.html). * `topic_name` - Queue topic name -**Sample usage** +**Sample usage:** The following call returns bulk operations that contain an error that cannot be retried. @@ -35,7 +35,7 @@ searchCriteria[filter_groups][0][filters][0][condition_type]=eq See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for more information about the syntax of search requests. -**Response** +**Response:** The operation with bulk UUID `c43ed402-3dd3-4100-92e2-dc5852d3009b` contains a `status` code of 3. diff --git a/guides/v2.2/rest/retrieve-filtered-responses.md b/guides/v2.2/rest/retrieve-filtered-responses.md index e1c37f0632f..e16ca6c08d2 100644 --- a/guides/v2.2/rest/retrieve-filtered-responses.md +++ b/guides/v2.2/rest/retrieve-filtered-responses.md @@ -117,7 +117,7 @@ The following POST operation and payload creates a [catalog](https://glossary.ma `POST /rest//V1/categories?fields=id,parent_id,name` -**Payload** +**Payload:** ```json { @@ -128,7 +128,7 @@ The following POST operation and payload creates a [catalog](https://glossary.ma } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.2/rest/tutorials/configurable-product/create-configurable-product.md b/guides/v2.2/rest/tutorials/configurable-product/create-configurable-product.md index 2bbfca853a6..ee1a58b826b 100644 --- a/guides/v2.2/rest/tutorials/configurable-product/create-configurable-product.md +++ b/guides/v2.2/rest/tutorials/configurable-product/create-configurable-product.md @@ -22,11 +22,11 @@ The `visibility` attribute is set to 4, meaning the product can be found by brow {:.bs-callout .bs-callout-info} Before you using this code sample, verify that the attribute values are the same in your installation. See [Get the list of attributes defined in an attribute searchCriteria]({{ page.baseurl }}/rest/tutorials/configurable-product/plan-product.html#get-attributes) for more information. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/products` -**Payload** +**Payload:** ```json { @@ -80,7 +80,7 @@ Before you using this code sample, verify that the attribute values are the same } ``` -**Response** +**Response:** {% collapsible Show code sample %} ```json diff --git a/guides/v2.2/rest/tutorials/configurable-product/create-personalization-option.md b/guides/v2.2/rest/tutorials/configurable-product/create-personalization-option.md index eec27dd52ea..23c847c6248 100644 --- a/guides/v2.2/rest/tutorials/configurable-product/create-personalization-option.md +++ b/guides/v2.2/rest/tutorials/configurable-product/create-personalization-option.md @@ -17,11 +17,11 @@ Let's add a text box to the product page that allows the customer to add his nam The `product_sku` is the `sku` of the configurable product. The `sku` specified in the payload is a string that is appended to the `product_sku` when a customer decides to purchase this option. Likewise, the `price` supplied in the payload is added to the configurable product price. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/products/options` -**Payload** +**Payload:** ```json { @@ -39,7 +39,7 @@ The `product_sku` is the `sku` of the configurable product. The `sku` specified } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.2/rest/tutorials/configurable-product/create-simple-products.md b/guides/v2.2/rest/tutorials/configurable-product/create-simple-products.md index dd64c8254c7..9e25814360d 100644 --- a/guides/v2.2/rest/tutorials/configurable-product/create-simple-products.md +++ b/guides/v2.2/rest/tutorials/configurable-product/create-simple-products.md @@ -28,11 +28,11 @@ Although it's not required, the simple product payload also includes `stock_item {: .bs-callout-info } Before you using this code sample, verify that the attribute values are the same in your installation. See [Get the list of attributes defined in an attribute searchCriteria]({{ page.baseurl }}/rest/tutorials/configurable-product/plan-product.html#get-attributes) for more information. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/products` -**Payload** +**Payload:** ```json { @@ -95,7 +95,7 @@ Before you using this code sample, verify that the attribute values are the same } ``` -**Response** +**Response:** {% collapsible Show code sample %} diff --git a/guides/v2.2/rest/tutorials/configurable-product/define-config-product-options.md b/guides/v2.2/rest/tutorials/configurable-product/define-config-product-options.md index 42c8a3c9a68..94eb8d22324 100644 --- a/guides/v2.2/rest/tutorials/configurable-product/define-config-product-options.md +++ b/guides/v2.2/rest/tutorials/configurable-product/define-config-product-options.md @@ -21,11 +21,11 @@ The `POST V1/configurable-products/:sku/options` call assigns the specified `att The value assigned to the `value_index` must be unique within the system. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/configurable-products/MS-Champ/options` -**Payload** +**Payload:** ```json { @@ -43,7 +43,7 @@ The value assigned to the `value_index` must be unique within the system. } ``` -**Response** +**Response:** A configurable option ID number, such as `"335"`. @@ -51,11 +51,11 @@ A configurable option ID number, such as `"335"`. The call to link a simple (child) product to the configurable product accepts only one `childSku` value. You must repeat this call for the `MS-Champ-M` and `MS-Champ-L` products. -**Endpoint** +**Endpoint:** `POST /rest/default/V1/configurable-products/MS-Champ/child` -**Payload** +**Payload:** ```json { @@ -63,7 +63,7 @@ The call to link a simple (child) product to the configurable product accepts on } ``` -**Response** +**Response:** `true` diff --git a/guides/v2.2/rest/tutorials/configurable-product/plan-product.md b/guides/v2.2/rest/tutorials/configurable-product/plan-product.md index fdfc5135466..eb817c9bb08 100644 --- a/guides/v2.2/rest/tutorials/configurable-product/plan-product.md +++ b/guides/v2.2/rest/tutorials/configurable-product/plan-product.md @@ -55,7 +55,7 @@ The sample data provides multiple attribute sets, including Default, Top, and Bo Use the following call to search for the attribute set named `Top`. -**Endpoint** +**Endpoint:** ```html GET /rest//V1/eav/attribute-sets/list? @@ -64,7 +64,7 @@ searchCriteria[filter_groups][0][filters][0][value]=Top& searchCriteria[filter_groups][0][filters][0][condition_type]=eq ``` -**Response** +**Response:** The `attribute_set_id` for the Top attribute set is `9`. @@ -99,11 +99,11 @@ The `attribute_set_id` for the Top attribute set is `9`. Use the `GET V1/products/attribute-sets/:attributeSetId/attributes` call to return information about the attributes defined in the Top attribute set. -**Endpoint** +**Endpoint:** `GET /rest/default/V1/products/attribute-sets/9/attributes` -**Response** +**Response:** The response contains almost 3,000 lines. The following table provides a summary of the attributes that are relevant in this tutorial. diff --git a/guides/v2.2/rest/tutorials/index.md b/guides/v2.2/rest/tutorials/index.md index 5c9dd349e48..3513d13612c 100644 --- a/guides/v2.2/rest/tutorials/index.md +++ b/guides/v2.2/rest/tutorials/index.md @@ -35,7 +35,7 @@ You will need Although some steps require that you configure Magento in some way, you perform most steps by sending one or more REST calls to Magento. Each step that makes a REST call provides the following information: -**Endpoint** +**Endpoint:** This section lists the HTTP verb and full path to the endpoint. The basic structure of a REST call in Magento is @@ -54,10 +54,10 @@ Element | Description This section indicates which key/value pairs you must specify in the HTTP headers. All calls require one or more HTTP headers. -**Payload** +**Payload:** This section lists the information that is sent to Magento. All payload samples are valid and can be copied and pasted into your calls, but you might need to change the `id` values that Magento returns. -**Response** +**Response:** This section lists the information that Magento sends to the REST client. These values are often referenced in other steps in the tutorial. The values Magento returns might be different than the values listed in the examples provided in this tutorial. diff --git a/guides/v2.2/rest/tutorials/orders/order-add-items.md b/guides/v2.2/rest/tutorials/orders/order-add-items.md index c8180c7710a..6aa7b0cdf44 100644 --- a/guides/v2.2/rest/tutorials/orders/order-add-items.md +++ b/guides/v2.2/rest/tutorials/orders/order-add-items.md @@ -24,17 +24,17 @@ To add a [simple product](https://glossary.magento.com/simple-product) to a cart The following example adds an orange medium-sized Radiant women's t-shirt (`sku`: `WS12-M-Orange`) to the cart. -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine/items` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** ```json { @@ -46,7 +46,7 @@ The following example adds an orange medium-sized Radiant women's t-shirt (`sku` } ``` -**Response** +**Response:** ```json { @@ -65,17 +65,17 @@ The requirements for adding a [downloadable product](https://glossary.magento.co The following example adds the downloadable product Advanced Pilates & Yoga (`sku`: 240-LV08) -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine/items` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** ```json { @@ -87,7 +87,7 @@ The following example adds the downloadable product Advanced Pilates & Yoga (`sk } ``` -**Response** +**Response:** ```json { @@ -135,17 +135,17 @@ The `GET /V1/configurable-products/:sku/children` call returns information about We now know the values for `option_value` for `size` and `color` are `168` and `52`, so we're ready to add the product to the cart. -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine/items` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** ```json { @@ -172,7 +172,7 @@ We now know the values for `option_value` for `size` and `color` are `168` and ` } ``` -**Response** +**Response:** ```json { @@ -317,17 +317,17 @@ For this example, we'll configure the Sprite Yoga Companion Kit as follows: * 8 ft Sprite Yoga strap (`id`: `6`) * Sprite Foam Roller (`id`: `8`) -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine/items` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** {% collapsible Show code sample %} @@ -369,7 +369,7 @@ For this example, we'll configure the Sprite Yoga Companion Kit as follows: {% endcollapsible %} -**Response** +**Response:** {% collapsible Show code sample %} diff --git a/guides/v2.2/rest/tutorials/orders/order-admin-token.md b/guides/v2.2/rest/tutorials/orders/order-admin-token.md index 701a296f893..30c39b502e9 100644 --- a/guides/v2.2/rest/tutorials/orders/order-admin-token.md +++ b/guides/v2.2/rest/tutorials/orders/order-admin-token.md @@ -18,7 +18,7 @@ functional_areas: Each step in this tutorial provides the following information: -**Endpoint** +**Endpoint:** This section lists the HTTP verb and full path to the endpoint. The basic structure of a REST call in Magento is @@ -37,11 +37,11 @@ Element | Description This section indicates which key/value pairs you must specify in the HTTP headers. All calls require one or more HTTP headers. -**Payload** +**Payload:** This section lists the information that is sent to Magento. All payload samples are valid and can be copied and pasted into your calls, but you might need to change the `id` values that Magento returns. -**Response** +**Response:** This section lists the information that Magento sends to the REST client. These values are often referenced in other steps in the tutorial. The values Magento returns might be different than the values listed in the examples provided in this tutorial. @@ -53,15 +53,15 @@ By default, an admin token is valid for 4 hours. To change this value, log in to See [Token-based authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication-token.html) for more information about authorization tokens. -**Endpoint** +**Endpoint:** `POST /rest//V1/integration/admin/token` -**Headers** +**Headers:** `Content-Type` `application/json` -**Payload** +**Payload:** ```json { @@ -70,7 +70,7 @@ See [Token-based authentication]({{ page.baseurl }}/get-started/authentication/g } ``` -**Response** +**Response:** Magento returns the admin's access token. diff --git a/guides/v2.2/rest/tutorials/orders/order-create-customer.md b/guides/v2.2/rest/tutorials/orders/order-create-customer.md index bf86e443ef5..061931d5147 100644 --- a/guides/v2.2/rest/tutorials/orders/order-create-customer.md +++ b/guides/v2.2/rest/tutorials/orders/order-create-customer.md @@ -32,17 +32,17 @@ Creating a customer account requires [admin](https://glossary.magento.com/admin) {:.bs-callout .bs-callout-info} This example shows a simplified way of creating a customer account. Typically, you would not define a customer password using plain text. Instead, you would specify the payload without the `password` parameter. By default if the call is successful, Magento sends a "Welcome" email to the customer that includes a request to set the password. You could also initiate a password reset email by calling `PUT /V1/customers/password`. -**Endpoint** +**Endpoint:** `POST /rest//V1/customers` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** It is recommended that you substitute the value of the `email` parameter with a real email address so that you receive all notifications. @@ -77,7 +77,7 @@ It is recommended that you substitute the value of the `email` parameter with a {% endcollapsible %} -**Response** +**Response:** Magento assigned this user `id` value of `2`. @@ -134,15 +134,15 @@ To get a customer's access token, you must specify the customer's username and p By default, a customer token is valid for 1 hour. To change this value, log in to Admin and go to **Stores** > Settings > **Configuration** > **Services** > **OAuth** > **Access Token Expiration**. -**Endpoint** +**Endpoint:** `POST /rest//V1/integration/customer/token` -**Headers** +**Headers:** `Content-Type` `application/json` -**Payload** +**Payload:** ```json { @@ -151,7 +151,7 @@ By default, a customer token is valid for 1 hour. To change this value, log in t } ``` -**Response** +**Response:** Magento returns the customer's access token. This token must be specified in the authorization header of every call the customer makes on his or her own behalf. diff --git a/guides/v2.2/rest/tutorials/orders/order-create-invoice.md b/guides/v2.2/rest/tutorials/orders/order-create-invoice.md index 576e42a162c..d2dc6f2dea0 100644 --- a/guides/v2.2/rest/tutorials/orders/order-create-invoice.md +++ b/guides/v2.2/rest/tutorials/orders/order-create-invoice.md @@ -23,19 +23,19 @@ You create an [invoice](https://glossary.magento.com/invoice) after you receive This example creates a full invoice. You can create a partial invoice by adding to the payload an array of items to be invoiced. -**Endpoint** +**Endpoint:** `POST /rest//V1/order/3/invoice` where `3` is the `orderid` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** ```json { "capture": true, @@ -43,7 +43,7 @@ where `3` is the `orderid` } ``` -**Response** +**Response:** An invoice `id`, such as `3`. @@ -51,21 +51,21 @@ An invoice `id`, such as `3`. An invoice is structurally similar to an order, but an order contains more details. -**Endpoint** +**Endpoint:** `GET /rest//V1/invoices/3` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** You will use the `order_item_id` values to create a [shipment](https://glossary.magento.com/shipment) in the next step. diff --git a/guides/v2.2/rest/tutorials/orders/order-create-order.md b/guides/v2.2/rest/tutorials/orders/order-create-order.md index 5bc2dd8f516..e573a194eeb 100644 --- a/guides/v2.2/rest/tutorials/orders/order-create-order.md +++ b/guides/v2.2/rest/tutorials/orders/order-create-order.md @@ -23,17 +23,17 @@ The [shopping cart](https://glossary.magento.com/shopping-cart) contains three i When you submit payment information, Magento creates an order and sends an order confirmation to the customer. Since we are using an offline [payment method](https://glossary.magento.com/payment-method) in this tutorial, we do not need to provide detailed payment information. The endpoint used in this example requires only the payment method and billing address information. -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine/payment-information` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** {% collapsible Show code sample %} @@ -60,7 +60,7 @@ When you submit payment information, Magento creates an order and sends an order {% endcollapsible %} -**Response** +**Response:** An `orderID`, such as `3`. @@ -68,23 +68,23 @@ An `orderID`, such as `3`. When you request an order object, the response contains full details about the order, including customer information, payment details, as well as totals and subtotals for the order and each individual item. -**Endpoint** +**Endpoint:** `GET /rest//V1/orders/3` where `3` is the `orderid` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** {% collapsible Show code sample %} diff --git a/guides/v2.2/rest/tutorials/orders/order-create-quote.md b/guides/v2.2/rest/tutorials/orders/order-create-quote.md index 4915cbfca2c..91258acb6d3 100644 --- a/guides/v2.2/rest/tutorials/orders/order-create-quote.md +++ b/guides/v2.2/rest/tutorials/orders/order-create-quote.md @@ -38,21 +38,21 @@ Magento identifies three types of users that can create a shopping cart: This tutorial manages the cart of a logged-in customer. Unless otherwise noted, all calls must specify customer's token `q0u66k8h42yaevtchv09uyy3y9gaj2ap` in the header. -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** None -**Response** +**Response:** The response is the `quoteId`: `4` diff --git a/guides/v2.2/rest/tutorials/orders/order-create-shipment.md b/guides/v2.2/rest/tutorials/orders/order-create-shipment.md index f3dc02bf062..4fa773002c5 100644 --- a/guides/v2.2/rest/tutorials/orders/order-create-shipment.md +++ b/guides/v2.2/rest/tutorials/orders/order-create-shipment.md @@ -24,19 +24,19 @@ To create a partial shipment, specify only those `order_item_id`s that are to be If the call is successful on a full shipment, Magento changes the status of an order to Complete. -**Endpoint** +**Endpoint:** `POST /rest//V1/order/3/ship` where `3` is the order id. -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** The `tracks` array optionally allows you to include one or more tracking numbers for the [shipment](https://glossary.magento.com/shipment). @@ -70,7 +70,7 @@ The `tracks` array optionally allows you to include one or more tracking numbers {% endcollapsible %} -**Response** +**Response:** A shipment ID, such as `3`. diff --git a/guides/v2.2/rest/tutorials/orders/order-issue-refund.md b/guides/v2.2/rest/tutorials/orders/order-issue-refund.md index f779c92b601..2b10af906e3 100644 --- a/guides/v2.2/rest/tutorials/orders/order-issue-refund.md +++ b/guides/v2.2/rest/tutorials/orders/order-issue-refund.md @@ -33,17 +33,17 @@ If the customer had selected the `flatrate` shipping method ($5 per item), we wo The `return_to_stock_items` array specifies which `order_item_id`s can be returned to stock and be resold. -**Endpoint** +**Endpoint:** `POST /rest//V1/order/5/refund` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** ```json { @@ -67,7 +67,7 @@ The `return_to_stock_items` array specifies which `order_item_id`s can be return } ``` -**Response** +**Response:** A [credit memo](https://glossary.magento.com/credit-memo) id, such as `3`. diff --git a/guides/v2.2/rest/tutorials/orders/order-prepare-checkout.md b/guides/v2.2/rest/tutorials/orders/order-prepare-checkout.md index 6ec7a3c93f0..793d13bf855 100644 --- a/guides/v2.2/rest/tutorials/orders/order-prepare-checkout.md +++ b/guides/v2.2/rest/tutorials/orders/order-prepare-checkout.md @@ -25,17 +25,17 @@ Now that all the items have been added to the cart, we can prepare the order for Magento calculates shipping costs for each shipping method that can be applied to the order. In this tutorial, the `flatrate` ($5 per item) and `tablerate` shipping methods are active. -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine/estimate-shipping-methods` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** The payload contains the shipping address. @@ -62,7 +62,7 @@ The payload contains the shipping address. ``` {% endcollapsible %} -**Response** +**Response:** Note that the cost for the `flatrate` shipping method is $15. The Sprite Yoga Companion Kit bundled product counts as one item. The Advanced Pilates & Yoga item does not have a shipping charge because the customer downloads this item. @@ -104,17 +104,17 @@ In this call, you specify the shipping and billing addresses, as well as the sel Magento returns a list of payment options and calculates the order totals. -**Endpoint** +**Endpoint:** `POST /rest//V1/carts/mine/shipping-information` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** {% collapsible Show code sample %} @@ -159,7 +159,7 @@ Magento returns a list of payment options and calculates the order totals. {% endcollapsible %} -**Response** +**Response:** The subtotal of the order is $160, and shipping charges are $5. The grand total is $165. diff --git a/guides/v2.2/rest/tutorials/prerequisite-tasks/create-admin-token.md b/guides/v2.2/rest/tutorials/prerequisite-tasks/create-admin-token.md index 10b049f3d86..3f18dbf157e 100644 --- a/guides/v2.2/rest/tutorials/prerequisite-tasks/create-admin-token.md +++ b/guides/v2.2/rest/tutorials/prerequisite-tasks/create-admin-token.md @@ -12,15 +12,15 @@ By default, an admin token is valid for 4 hours. To change this value, log in to See [Token-based authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication-token.html) for more information about authorization tokens. -**Endpoint** +**Endpoint:** `POST /rest//V1/integration/admin/token` -**Headers** +**Headers:** `Content-Type` `application/json` -**Payload** +**Payload:** ```json { @@ -29,7 +29,7 @@ See [Token-based authentication]({{ page.baseurl }}/get-started/authentication/g } ``` -**Response** +**Response:** Magento generates the admin's access token diff --git a/guides/v2.3/graphql/get-customer-authorization-token.md b/guides/v2.3/graphql/get-customer-authorization-token.md index fe5deea770a..2a42bf29ee2 100644 --- a/guides/v2.3/graphql/get-customer-authorization-token.md +++ b/guides/v2.3/graphql/get-customer-authorization-token.md @@ -9,7 +9,7 @@ To successfully retrieve information about a specific customer using GraphQL, yo The following example shows how to retrieve a customer's authorization token: -**Request** +**Request:** ```text mutation { @@ -19,7 +19,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/add-configurable-products.md b/guides/v2.3/graphql/mutations/add-configurable-products.md index 2798526ab78..610d22b85f2 100644 --- a/guides/v2.3/graphql/mutations/add-configurable-products.md +++ b/guides/v2.3/graphql/mutations/add-configurable-products.md @@ -13,7 +13,7 @@ Use the `addConfigurableProductsToCart` mutation to add configurable products to The following example adds two black Teton Pullover Hoodies size extra-small to the specified shopping cart. The `cart_id` used in this example was [generated]({{ page.baseurl }}/graphql/mutations/create-empty-cart.html) by creating an empty cart. -**Request** +**Request:** ```graphql mutation { @@ -50,7 +50,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/add-simple-products.md b/guides/v2.3/graphql/mutations/add-simple-products.md index 747257603fe..379a7b1214e 100644 --- a/guides/v2.3/graphql/mutations/add-simple-products.md +++ b/guides/v2.3/graphql/mutations/add-simple-products.md @@ -19,7 +19,7 @@ These examples show the minimal payload and a payload that includes customizable The following example adds a simple product to a cart. The response contains the entire contents of the customer's cart. -**Request** +**Request:** ```text mutation { @@ -50,7 +50,7 @@ mutation { } ``` -**Response** +**Response:** ```json { @@ -77,7 +77,7 @@ mutation { If a product has a customizable option, you can specify the option's value in the `addSimpleProductsToCart` request. -**Request** +**Request:** ``` text mutation { @@ -116,7 +116,7 @@ mutation { } ``` -**Response** +**Response:** ```text { diff --git a/guides/v2.3/graphql/mutations/add-virtual-products.md b/guides/v2.3/graphql/mutations/add-virtual-products.md index aaf3351ea23..d6ec03e8ded 100644 --- a/guides/v2.3/graphql/mutations/add-virtual-products.md +++ b/guides/v2.3/graphql/mutations/add-virtual-products.md @@ -17,7 +17,7 @@ The `addVirtualProductsToCart` mutation allows you to add multiple virtual produ The Luma sample data does not include any virtual products. The following example requires that you create a virtual product with the `sku` value of `Membership-Gold` with a price of $49.99. -**Request** +**Request:** ```text @@ -53,7 +53,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/apply-coupon.md b/guides/v2.3/graphql/mutations/apply-coupon.md index 11c9eb62a75..1c415cca1b4 100644 --- a/guides/v2.3/graphql/mutations/apply-coupon.md +++ b/guides/v2.3/graphql/mutations/apply-coupon.md @@ -15,7 +15,7 @@ The `applyCouponToCart` mutation applies a pre-defined coupon code to the specif The following example applies the coupon code `H2O` to the cart. For this coupon to be valid, the Affirm Water Bottle (`sku`: 24-UG06) must be in the cart. -**Request** +**Request:** ``` text mutation { @@ -46,7 +46,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/apply-giftcard.md b/guides/v2.3/graphql/mutations/apply-giftcard.md index c3879787dd4..8b862ef99f8 100644 --- a/guides/v2.3/graphql/mutations/apply-giftcard.md +++ b/guides/v2.3/graphql/mutations/apply-giftcard.md @@ -16,7 +16,7 @@ The `applyGiftCardToCart` mutation applies a pre-defined gift card code to the s The following example adds a gift card with the code `0330CEIVTLB4` to the cart. The gift card has a value of $20. -**Request** +**Request:** ```graphql mutation { @@ -44,7 +44,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/apply-store-credit.md b/guides/v2.3/graphql/mutations/apply-store-credit.md index ba0a84513a2..84345879743 100644 --- a/guides/v2.3/graphql/mutations/apply-store-credit.md +++ b/guides/v2.3/graphql/mutations/apply-store-credit.md @@ -21,7 +21,7 @@ If the amount of available store credit equals or exceeds the grand total of the In the following example, the customer starts with $10 of store credit. The subtotal of the items in the cart before applying the store credit plus shipping and tax is $34.64. The grand total on the cart after applying the store credit is $24.64. -**Request** +**Request:** ```graphql mutation { @@ -52,7 +52,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/change-customer-password.md b/guides/v2.3/graphql/mutations/change-customer-password.md index d9c933f204d..09dcea120fc 100644 --- a/guides/v2.3/graphql/mutations/change-customer-password.md +++ b/guides/v2.3/graphql/mutations/change-customer-password.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call updates the customer's password. -**Request** +**Request:** ```graphql mutation { @@ -29,7 +29,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/create-braintree-client-token.md b/guides/v2.3/graphql/mutations/create-braintree-client-token.md index 6d88cf6769c..1d47b838174 100644 --- a/guides/v2.3/graphql/mutations/create-braintree-client-token.md +++ b/guides/v2.3/graphql/mutations/create-braintree-client-token.md @@ -13,7 +13,7 @@ The `createBraintreeClientToken` mutation creates the client token for Braintree ## Example usage -**Request** +**Request:** ```graphql mutation { @@ -21,7 +21,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/create-customer-address.md b/guides/v2.3/graphql/mutations/create-customer-address.md index 7f867f266c1..b0c47e1a20c 100644 --- a/guides/v2.3/graphql/mutations/create-customer-address.md +++ b/guides/v2.3/graphql/mutations/create-customer-address.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call creates an address for the specified customer. -**Request** +**Request:** ```graphql mutation { @@ -53,7 +53,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/create-customer.md b/guides/v2.3/graphql/mutations/create-customer.md index ac962a528bf..e661ff52407 100644 --- a/guides/v2.3/graphql/mutations/create-customer.md +++ b/guides/v2.3/graphql/mutations/create-customer.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call creates a new customer. -**Request** +**Request:** ```graphql mutation { @@ -39,7 +39,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/create-empty-cart.md b/guides/v2.3/graphql/mutations/create-empty-cart.md index b0a68954c5c..180647c0431 100644 --- a/guides/v2.3/graphql/mutations/create-empty-cart.md +++ b/guides/v2.3/graphql/mutations/create-empty-cart.md @@ -17,7 +17,7 @@ If you are creating a cart for a logged in customer, you must include the custom ### Create a cart with a randomly-generated cart ID -**Request** +**Request:** ```graphql mutation { @@ -25,7 +25,7 @@ mutation { } ``` -**Response** +**Response:** The response is the cart ID, which is sometimes called the quote ID. The remaining examples in this topic will use this cart ID. @@ -41,7 +41,7 @@ The response is the cart ID, which is sometimes called the quote ID. The remaini You can also create an empty cart with a specified `cart_id`. -**Request** +**Request:** ``` text mutation { @@ -50,7 +50,7 @@ mutation { } ``` -**Response** +**Response:** The mutation returns the same `cart_id`. diff --git a/guides/v2.3/graphql/mutations/create-payflow-pro-token.md b/guides/v2.3/graphql/mutations/create-payflow-pro-token.md index 833741bc575..d9c6a26f542 100644 --- a/guides/v2.3/graphql/mutations/create-payflow-pro-token.md +++ b/guides/v2.3/graphql/mutations/create-payflow-pro-token.md @@ -15,7 +15,7 @@ See [Paypal Payflow Pro payment method]({{page.baseurl}}/graphql/payment-methods The following example requests a token in a Payflow Pro transaction. -**Request** +**Request:** ```graphql mutation { @@ -38,7 +38,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/create-paypal-express-token.md b/guides/v2.3/graphql/mutations/create-paypal-express-token.md index 9fc8d55e1bb..dc1e3893879 100644 --- a/guides/v2.3/graphql/mutations/create-paypal-express-token.md +++ b/guides/v2.3/graphql/mutations/create-paypal-express-token.md @@ -17,7 +17,7 @@ The input includes the cart ID, the payment method code, and a set of URLs that ## Example usage -**Request** +**Request:** ```graphql mutation { @@ -42,7 +42,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/delete-customer-address.md b/guides/v2.3/graphql/mutations/delete-customer-address.md index 893f63b1ab7..ee78c62a80e 100644 --- a/guides/v2.3/graphql/mutations/delete-customer-address.md +++ b/guides/v2.3/graphql/mutations/delete-customer-address.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call deletes a customer's address. -**Request** +**Request:** ```graphql mutation { @@ -23,7 +23,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/delete-payment-token.md b/guides/v2.3/graphql/mutations/delete-payment-token.md index 791198a10a5..99d2ebc03bd 100644 --- a/guides/v2.3/graphql/mutations/delete-payment-token.md +++ b/guides/v2.3/graphql/mutations/delete-payment-token.md @@ -16,7 +16,7 @@ You must specify the customer's authorization token in the header of the call. The following example deletes the Discover Card listed in the results of the `customerPaymentTokens` query. The `public_hash` you specify will be unique to your application. -**Request** +**Request:** ```graphql mutation { @@ -37,7 +37,7 @@ mutation { ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/generate-customer-token.md b/guides/v2.3/graphql/mutations/generate-customer-token.md index 6e344063647..3fd328d2446 100644 --- a/guides/v2.3/graphql/mutations/generate-customer-token.md +++ b/guides/v2.3/graphql/mutations/generate-customer-token.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call creates a new customer token. -**Request** +**Request:** ```graphql mutation { @@ -28,7 +28,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/handle-payflow-pro-response.md b/guides/v2.3/graphql/mutations/handle-payflow-pro-response.md index 4c4373f5f60..25bd4bf87cd 100644 --- a/guides/v2.3/graphql/mutations/handle-payflow-pro-response.md +++ b/guides/v2.3/graphql/mutations/handle-payflow-pro-response.md @@ -28,7 +28,7 @@ See [Paypal Payflow Pro payment method]({{page.baseurl}}/graphql/payment-methods The following example sends the Payflow Pro payload to Magento: -**Request** +**Request:** ```graphql mutation { @@ -47,7 +47,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/place-order.md b/guides/v2.3/graphql/mutations/place-order.md index ad5741abf6c..18506ca5178 100644 --- a/guides/v2.3/graphql/mutations/place-order.md +++ b/guides/v2.3/graphql/mutations/place-order.md @@ -23,7 +23,7 @@ Perform the following actions before using the `placeOrder` mutation: ## Example usage -**Request** +**Request:** ``` text mutation { @@ -39,7 +39,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/redeem-giftcard-balance.md b/guides/v2.3/graphql/mutations/redeem-giftcard-balance.md index 057d70a8284..f4446915730 100644 --- a/guides/v2.3/graphql/mutations/redeem-giftcard-balance.md +++ b/guides/v2.3/graphql/mutations/redeem-giftcard-balance.md @@ -17,7 +17,7 @@ Run this mutation on behalf of logged-in customers only. [Get customer authoriza The following example redeems the gift card with code `“056MHP57TJ5C”`. -**Request** +**Request:** ```graphql mutation { @@ -34,7 +34,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/remove-coupon.md b/guides/v2.3/graphql/mutations/remove-coupon.md index 3bf26f8a962..b67feb8aa14 100644 --- a/guides/v2.3/graphql/mutations/remove-coupon.md +++ b/guides/v2.3/graphql/mutations/remove-coupon.md @@ -15,7 +15,7 @@ The `removeCouponFromCart` mutation removes a previously-applied coupon from the The following example removes a coupon from the cart. -**Request** +**Request:** ``` text mutation { @@ -44,7 +44,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/remove-giftcard.md b/guides/v2.3/graphql/mutations/remove-giftcard.md index 42d0816be83..e7063fb6301 100644 --- a/guides/v2.3/graphql/mutations/remove-giftcard.md +++ b/guides/v2.3/graphql/mutations/remove-giftcard.md @@ -14,7 +14,7 @@ The `removeGiftCardFromCart` mutation removes a previously-applied gift card fro The following example removes a gift card from the cart. -**Request** +**Request:** ``` text mutation { @@ -33,7 +33,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/remove-item.md b/guides/v2.3/graphql/mutations/remove-item.md index cd565dcc523..950bce8253c 100644 --- a/guides/v2.3/graphql/mutations/remove-item.md +++ b/guides/v2.3/graphql/mutations/remove-item.md @@ -15,7 +15,7 @@ The `removeItemFromCart` mutation deletes the entire quantity of a specified ite The following example removes cart item 14 from the cart. -**Request** +**Request:** ```graphql mutation { @@ -43,7 +43,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/remove-store-credit.md b/guides/v2.3/graphql/mutations/remove-store-credit.md index ce938dff89c..3358dcf752b 100644 --- a/guides/v2.3/graphql/mutations/remove-store-credit.md +++ b/guides/v2.3/graphql/mutations/remove-store-credit.md @@ -14,7 +14,7 @@ Store credit must be enabled on the store to run this mutation. ## Example usage -**Request** +**Request:** ```graphql mutation { @@ -45,7 +45,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/revoke-customer-token.md b/guides/v2.3/graphql/mutations/revoke-customer-token.md index b145885b51e..98a74de561c 100644 --- a/guides/v2.3/graphql/mutations/revoke-customer-token.md +++ b/guides/v2.3/graphql/mutations/revoke-customer-token.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call revokes the customer's token. -**Request** +**Request:** ```graphql mutation { @@ -25,7 +25,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/send-email-to-friend.md b/guides/v2.3/graphql/mutations/send-email-to-friend.md index 24da260b2c2..f549daa0855 100644 --- a/guides/v2.3/graphql/mutations/send-email-to-friend.md +++ b/guides/v2.3/graphql/mutations/send-email-to-friend.md @@ -16,7 +16,7 @@ The **Stores** > **Configuration** > **Catalog** > **Email to a friend** > **Ena The following example sends a message to two friends. -**Request** +**Request:** ```graphql mutation { @@ -46,7 +46,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/set-billing-address.md b/guides/v2.3/graphql/mutations/set-billing-address.md index 2cfa2e598c5..b3e6c24f4fb 100644 --- a/guides/v2.3/graphql/mutations/set-billing-address.md +++ b/guides/v2.3/graphql/mutations/set-billing-address.md @@ -15,7 +15,7 @@ The `setBillingAddressOnCart` mutation sets the billing address for a specific c The following example creates a new billing address for a specific cart. -**Request** +**Request:** ```graphql mutation { @@ -54,7 +54,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/set-guest-email.md b/guides/v2.3/graphql/mutations/set-guest-email.md index f58040727f9..d2748ecf02f 100644 --- a/guides/v2.3/graphql/mutations/set-guest-email.md +++ b/guides/v2.3/graphql/mutations/set-guest-email.md @@ -15,7 +15,7 @@ A logged-in customer specifies an email address when they create an account. The ## Example usage -**Request** +**Request:** ```graphql mutation { @@ -32,7 +32,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/set-payment-method.md b/guides/v2.3/graphql/mutations/set-payment-method.md index c2dce5ded77..527926a3b2b 100644 --- a/guides/v2.3/graphql/mutations/set-payment-method.md +++ b/guides/v2.3/graphql/mutations/set-payment-method.md @@ -38,7 +38,7 @@ Supported online payment methods include: The following example assigns the `banktransfer` payment method to the specified cart. -**Request** +**Request:** ```text mutation { @@ -58,7 +58,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/set-payment-place-order.md b/guides/v2.3/graphql/mutations/set-payment-place-order.md index 8e5c36f9913..cd7fa92273d 100644 --- a/guides/v2.3/graphql/mutations/set-payment-place-order.md +++ b/guides/v2.3/graphql/mutations/set-payment-place-order.md @@ -29,7 +29,7 @@ Perform the following actions before using the `setPaymentMethodAndPlaceOrder` m ## Example usage -**Request** +**Request:** ```graphql mutation { @@ -48,7 +48,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/set-shipping-address.md b/guides/v2.3/graphql/mutations/set-shipping-address.md index d503e1c4c78..0bf00951d23 100644 --- a/guides/v2.3/graphql/mutations/set-shipping-address.md +++ b/guides/v2.3/graphql/mutations/set-shipping-address.md @@ -16,7 +16,7 @@ The `setShippingAddressesOnCart` mutation sets one or more shipping addresses on ## Example usage -**Request** +**Request:** ```graphql mutation { @@ -56,7 +56,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/set-shipping-method.md b/guides/v2.3/graphql/mutations/set-shipping-method.md index 1d7a0cd5a99..927ebd9e457 100644 --- a/guides/v2.3/graphql/mutations/set-shipping-method.md +++ b/guides/v2.3/graphql/mutations/set-shipping-method.md @@ -25,7 +25,7 @@ United States Postal Service | usps | Varies The following example sets the shipping method to Best Way. -**Request** +**Request:** ```graphql mutation { @@ -58,7 +58,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/update-cart-items.md b/guides/v2.3/graphql/mutations/update-cart-items.md index 26d405a6e7d..fab158711bc 100644 --- a/guides/v2.3/graphql/mutations/update-cart-items.md +++ b/guides/v2.3/graphql/mutations/update-cart-items.md @@ -18,7 +18,7 @@ Setting the quantity to `0` removes an item from the cart. The following example changes the quantity of cart item `13`. The new quantity is `3`. -**Request** +**Request:** ```graphql mutation { @@ -51,7 +51,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/update-customer-address.md b/guides/v2.3/graphql/mutations/update-customer-address.md index e70ab440219..894493c51dc 100644 --- a/guides/v2.3/graphql/mutations/update-customer-address.md +++ b/guides/v2.3/graphql/mutations/update-customer-address.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call updates the customer's city and postcode. -**Request** +**Request:** ```graphql mutation { @@ -30,7 +30,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/mutations/update-customer.md b/guides/v2.3/graphql/mutations/update-customer.md index a2d64b15e0a..44b8a582d4c 100644 --- a/guides/v2.3/graphql/mutations/update-customer.md +++ b/guides/v2.3/graphql/mutations/update-customer.md @@ -15,7 +15,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call updates the first name and email address for a specific customer. -**Request** +**Request:** ```graphql mutation { @@ -33,7 +33,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/authorize-net.md b/guides/v2.3/graphql/payment-methods/authorize-net.md index 1c8ca5227ed..a7cc1aca7d5 100644 --- a/guides/v2.3/graphql/payment-methods/authorize-net.md +++ b/guides/v2.3/graphql/payment-methods/authorize-net.md @@ -41,7 +41,7 @@ Attribute | Data Type | Description The following example assigns the `authorizenet_acceptjs` payment method to the specified cart. -**Request** +**Request:** ```graphql mutation { @@ -66,7 +66,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/braintree-vault.md b/guides/v2.3/graphql/payment-methods/braintree-vault.md index e20c6a15557..662a20440f9 100644 --- a/guides/v2.3/graphql/payment-methods/braintree-vault.md +++ b/guides/v2.3/graphql/payment-methods/braintree-vault.md @@ -50,7 +50,7 @@ Attribute | Data Type | Description The following example shows the `setPaymentMethodOnCart` mutation constructed for the Braintree Vault payment method. -**Request** +**Request:** ```graphql mutation { @@ -71,7 +71,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/braintree.md b/guides/v2.3/graphql/payment-methods/braintree.md index c02b0fdd0e9..1cccd5c8589 100644 --- a/guides/v2.3/graphql/payment-methods/braintree.md +++ b/guides/v2.3/graphql/payment-methods/braintree.md @@ -61,7 +61,7 @@ Attribute | Data Type | Description The following example shows the `setPaymentMethodOnCart` mutation constructed for the Braintree payment method. -**Request** +**Request:** ```text mutation { @@ -83,7 +83,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/hosted-pro.md b/guides/v2.3/graphql/payment-methods/hosted-pro.md index 5d613e4b05a..2890376c9bb 100644 --- a/guides/v2.3/graphql/payment-methods/hosted-pro.md +++ b/guides/v2.3/graphql/payment-methods/hosted-pro.md @@ -28,7 +28,7 @@ When you set the payment method for a Website Payments Pro Hosted Solution, you The following example shows the `setPaymentMethodOnCart` mutation constructed for the Website Payments Pro Hosted Solution payment method. -**Request** +**Request:** ```graphql mutation { @@ -52,7 +52,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/payflow-express.md b/guides/v2.3/graphql/payment-methods/payflow-express.md index efafa07b03c..4efada184be 100644 --- a/guides/v2.3/graphql/payment-methods/payflow-express.md +++ b/guides/v2.3/graphql/payment-methods/payflow-express.md @@ -34,7 +34,7 @@ When you set the payment method to one of the Express Checkout payment solutions The following example shows the `setPaymentMethodOnCart` mutation with the `code` set to `payflow_express`. -**Request** +**Request:** ```graphql mutation { @@ -57,7 +57,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/payflow-link.md b/guides/v2.3/graphql/payment-methods/payflow-link.md index 969ca1e27a5..04a34434c97 100644 --- a/guides/v2.3/graphql/payment-methods/payflow-link.md +++ b/guides/v2.3/graphql/payment-methods/payflow-link.md @@ -25,7 +25,7 @@ When you set the payment method to Payflow Link in the [`setPaymentMethodOnCart` The following example shows the `setPaymentMethodOnCart` mutation constructed for the Payflow Link payment method. -**Request** +**Request:** ```graphql mutation { @@ -50,7 +50,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/payflow-pro.md b/guides/v2.3/graphql/payment-methods/payflow-pro.md index 5c641293192..0a813053839 100644 --- a/guides/v2.3/graphql/payment-methods/payflow-pro.md +++ b/guides/v2.3/graphql/payment-methods/payflow-pro.md @@ -29,7 +29,7 @@ When you set the payment method to Payflow Pro in the [`setPaymentMethodOnCart`] The following example shows the `setPaymentMethodOnCart` mutation constructed for the Payflow Pro payment method. -**Request** +**Request:** ```graphql mutation { @@ -56,7 +56,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/payments-advanced.md b/guides/v2.3/graphql/payment-methods/payments-advanced.md index 779c5c3b361..6970d3fbd2e 100644 --- a/guides/v2.3/graphql/payment-methods/payments-advanced.md +++ b/guides/v2.3/graphql/payment-methods/payments-advanced.md @@ -29,7 +29,7 @@ When you set the payment method to PayPal Payments Advanced, you must set the `c The following example shows the `setPaymentMethodOnCart` mutation constructed for the Payments Advanced payment method. -**Request** +**Request:** ```graphql mutation { @@ -54,7 +54,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/payment-methods/paypal-express-checkout.md b/guides/v2.3/graphql/payment-methods/paypal-express-checkout.md index 5c9ef7a43ce..fdd9e85b30a 100644 --- a/guides/v2.3/graphql/payment-methods/paypal-express-checkout.md +++ b/guides/v2.3/graphql/payment-methods/paypal-express-checkout.md @@ -30,7 +30,7 @@ When you set the payment method to Express Checkout, you must set the `code` att The following example shows the `setPaymentMethodOnCart` mutation constructed for the PayPal Express payment method. -**Request** +**Request:** ```graphql mutation { @@ -54,7 +54,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/product/configurable-product.md b/guides/v2.3/graphql/product/configurable-product.md index eb09fe3155d..eaefcef7690 100644 --- a/guides/v2.3/graphql/product/configurable-product.md +++ b/guides/v2.3/graphql/product/configurable-product.md @@ -82,7 +82,7 @@ Add the following inline fragment to the output section of your `products` query The following `products` query returns `ConfigurableProduct` information about the `WH01` configurable product, which is defined in the sample data. -**Request** +**Request:** ```text { diff --git a/guides/v2.3/graphql/product/downloadable-product.md b/guides/v2.3/graphql/product/downloadable-product.md index acc1c401c3d..e8bc71fa085 100644 --- a/guides/v2.3/graphql/product/downloadable-product.md +++ b/guides/v2.3/graphql/product/downloadable-product.md @@ -62,7 +62,7 @@ Add the following inline fragment to the output section of your `products` query The following query returns information about downloadable product `240-LV04`, which is defined in the sample data. -**Request** +**Request:** ```graphql { @@ -103,7 +103,7 @@ The following query returns information about downloadable product `240-LV04`, w } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/cart.md b/guides/v2.3/graphql/queries/cart.md index f0332a66f18..db725a6a195 100644 --- a/guides/v2.3/graphql/queries/cart.md +++ b/guides/v2.3/graphql/queries/cart.md @@ -21,7 +21,7 @@ Cart functionality is defined in the `Quote` module. A Quote represents the cont The following query shows the status of a cart that is ready to be converted into an order. -**Request** +**Request:** ```text query { @@ -127,7 +127,7 @@ query { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/category.md b/guides/v2.3/graphql/queries/category.md index 8f21f751193..563ad532753 100644 --- a/guides/v2.3/graphql/queries/category.md +++ b/guides/v2.3/graphql/queries/category.md @@ -19,7 +19,7 @@ category ( The following query returns information about category ID `20` and four levels of subcategories. In the sample data, category ID `20` is assigned to the "Women" category. -**Request** +**Request:** ```graphql { @@ -60,7 +60,7 @@ The following query returns information about category ID `20` and four levels o } ``` -**Response** +**Response:** ```json { @@ -140,7 +140,7 @@ The following query returns information about category ID `20` and four levels o The following query returns breadcrumb information about the women's tops category (`id` = 25). -**Request** +**Request:** ```graphql { @@ -160,7 +160,7 @@ The following query returns breadcrumb information about the women's tops catego } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/checkout-agreements.md b/guides/v2.3/graphql/queries/checkout-agreements.md index b5b9eaf36e7..610c054f548 100644 --- a/guides/v2.3/graphql/queries/checkout-agreements.md +++ b/guides/v2.3/graphql/queries/checkout-agreements.md @@ -16,7 +16,7 @@ The `checkoutAgreements` query retrieves checkout agreements. The query will alw The following query returns enabled checkout agreements. -**Request** +**Request:** ```graphql { @@ -32,7 +32,7 @@ The following query returns enabled checkout agreements. } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/cms-blocks.md b/guides/v2.3/graphql/queries/cms-blocks.md index eac5700af8d..113a4c1a692 100644 --- a/guides/v2.3/graphql/queries/cms-blocks.md +++ b/guides/v2.3/graphql/queries/cms-blocks.md @@ -15,7 +15,7 @@ Return the contents of one or more CMS blocks: The following query returns information about the `login-data` block: -**Request** +**Request:** ```graphql { @@ -29,7 +29,7 @@ The following query returns information about the `login-data` block: } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/cms-page.md b/guides/v2.3/graphql/queries/cms-page.md index fefc01546da..04119897ed9 100644 --- a/guides/v2.3/graphql/queries/cms-page.md +++ b/guides/v2.3/graphql/queries/cms-page.md @@ -17,7 +17,7 @@ Return the contents of a CMS page: The following query returns information about the "404 Not Found" CMS page: -**Request** +**Request:** ```graphql { @@ -34,7 +34,7 @@ The following query returns information about the "404 Not Found" CMS page: } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/custom-attribute-metadata.md b/guides/v2.3/graphql/queries/custom-attribute-metadata.md index bc6437d3dbe..cbe9523dc05 100644 --- a/guides/v2.3/graphql/queries/custom-attribute-metadata.md +++ b/guides/v2.3/graphql/queries/custom-attribute-metadata.md @@ -15,7 +15,7 @@ The `customAttributeMetadata` query returns the attribute type, given an attribu The following query returns the attribute type for various custom and EAV attributes. -**Request** +**Request:** ```graphql { @@ -38,7 +38,7 @@ The following query returns the attribute type for various custom and EAV attrib } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/customer-downloadable-products.md b/guides/v2.3/graphql/queries/customer-downloadable-products.md index ee5ec33e998..d35868615ef 100644 --- a/guides/v2.3/graphql/queries/customer-downloadable-products.md +++ b/guides/v2.3/graphql/queries/customer-downloadable-products.md @@ -13,7 +13,7 @@ Use the `customerDownloadableProducts` query to retrieve the list of purchased d The following example returns the list of purchased downloadable products for the logged-in customer. -**Request** +**Request:** ```graphql { @@ -29,7 +29,7 @@ The following example returns the list of purchased downloadable products for th } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/customer-orders.md b/guides/v2.3/graphql/queries/customer-orders.md index 0c7ccc4bda8..ac24e855e14 100644 --- a/guides/v2.3/graphql/queries/customer-orders.md +++ b/guides/v2.3/graphql/queries/customer-orders.md @@ -17,7 +17,7 @@ Magento recommends you use customer tokens in the header of your GraphQL calls. The following query returns the order history of the logged in customer. -**Request** +**Request:** ```graphql { @@ -33,7 +33,7 @@ The following query returns the order history of the logged in customer. } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/customer-payment-tokens.md b/guides/v2.3/graphql/queries/customer-payment-tokens.md index b78c0f8528f..54b148aa8ef 100644 --- a/guides/v2.3/graphql/queries/customer-payment-tokens.md +++ b/guides/v2.3/graphql/queries/customer-payment-tokens.md @@ -20,7 +20,7 @@ You must specify the customer's authorization token in the header of the call. The following example returns all the current customer's payment tokens. The `public_hash` output values will be unique to your application. -**Request** +**Request:** ```graphql query { @@ -35,7 +35,7 @@ query { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/customer.md b/guides/v2.3/graphql/queries/customer.md index dd3149c3d33..4f506291b60 100644 --- a/guides/v2.3/graphql/queries/customer.md +++ b/guides/v2.3/graphql/queries/customer.md @@ -19,7 +19,7 @@ To return or modify information about a customer, Magento recommends you use cus The following call returns information about the logged-in customer. Provide the customer's token in the header section of the query. -**Request** +**Request:** ```graphql { @@ -47,7 +47,7 @@ The following call returns information about the logged-in customer. Provide the } ``` -**Response** +**Response:** ```json { @@ -85,7 +85,7 @@ The following call returns information about the logged-in customer. Provide the The following example returns the store credit history for the logged-in user. -**Request** +**Request:** ```graphql query { @@ -123,7 +123,7 @@ query { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/directory-countries.md b/guides/v2.3/graphql/queries/directory-countries.md index 35f306a91a7..74229b1dd07 100644 --- a/guides/v2.3/graphql/queries/directory-countries.md +++ b/guides/v2.3/graphql/queries/directory-countries.md @@ -13,7 +13,7 @@ Use the `countries` query to return all countries in which the entity can do bus The following query returns all countries listed for the current instance of Magento: -**Request** +**Request:** ```graphql query { @@ -32,7 +32,7 @@ query { } ``` -**Response** +**Response:** In this example, the response is intentionally truncated. diff --git a/guides/v2.3/graphql/queries/directory-country.md b/guides/v2.3/graphql/queries/directory-country.md index 3070ce6885d..5d05bfd5473 100644 --- a/guides/v2.3/graphql/queries/directory-country.md +++ b/guides/v2.3/graphql/queries/directory-country.md @@ -15,7 +15,7 @@ Use the `country` query to retrieve information about a specific country. The following query returns information about Australia. -**Request** +**Request:** ```graphql query { @@ -34,7 +34,7 @@ query { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/directory-currency.md b/guides/v2.3/graphql/queries/directory-currency.md index 1593e8c77be..090bd7e463b 100644 --- a/guides/v2.3/graphql/queries/directory-currency.md +++ b/guides/v2.3/graphql/queries/directory-currency.md @@ -13,7 +13,7 @@ Use the `currency` query to return information about the store's currency config The following query returns the currency for the current instance of Magento: -**Request** +**Request:** ```graphql query { @@ -31,7 +31,7 @@ query { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/get-hosted-pro-url.md b/guides/v2.3/graphql/queries/get-hosted-pro-url.md index e501ba6a69b..d6927a8fe80 100644 --- a/guides/v2.3/graphql/queries/get-hosted-pro-url.md +++ b/guides/v2.3/graphql/queries/get-hosted-pro-url.md @@ -13,7 +13,7 @@ The `getHostedProUrl` query is required to complete a transaction when the [PayP The following query returns the customer's wish list: -**Request** +**Request:** ```graphql query { @@ -23,7 +23,7 @@ query { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/get-payflow-link-token.md b/guides/v2.3/graphql/queries/get-payflow-link-token.md index d1a69bb4933..e2afce4c67c 100644 --- a/guides/v2.3/graphql/queries/get-payflow-link-token.md +++ b/guides/v2.3/graphql/queries/get-payflow-link-token.md @@ -15,7 +15,7 @@ See [Paypal Payflow Link payment method]({{page.baseurl}}/graphql/payment-method The following example requests a token in a Payflow Link transaction. -**Request** +**Request:** ```graphql { @@ -28,7 +28,7 @@ The following example requests a token in a Payflow Link transaction. } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/giftcard-account.md b/guides/v2.3/graphql/queries/giftcard-account.md index 44d9368da2c..31d320ea0f3 100644 --- a/guides/v2.3/graphql/queries/giftcard-account.md +++ b/guides/v2.3/graphql/queries/giftcard-account.md @@ -16,7 +16,7 @@ The `giftCardAccount` query returns information for a specific gift card. The following example returns information about the `01PNC9L76H4H` gift card code. -**Request** +**Request:** ```graphql query { @@ -31,7 +31,7 @@ query { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/index.md b/guides/v2.3/graphql/queries/index.md index c4bb97680e4..1dc9d8dc692 100644 --- a/guides/v2.3/graphql/queries/index.md +++ b/guides/v2.3/graphql/queries/index.md @@ -145,7 +145,7 @@ For Magento, introspection queries MUST have the operation name `IntrospectionQu The following query returns a list of Magento queries. The results are truncated. -**Request** +**Request:** ```graphql query IntrospectionQuery { @@ -160,7 +160,7 @@ query IntrospectionQuery { } ``` -**Response** +**Response:** ```json { @@ -187,7 +187,7 @@ query IntrospectionQuery { The following introspection query returns details about the `ProductAttributeFilterInput` data type. -**Request** +**Request:** ```graphql query IntrospectionQuery { @@ -219,7 +219,7 @@ query IntrospectionQuery { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/is-email-available.md b/guides/v2.3/graphql/queries/is-email-available.md index 3612c2dbf50..28f52b4fd0b 100644 --- a/guides/v2.3/graphql/queries/is-email-available.md +++ b/guides/v2.3/graphql/queries/is-email-available.md @@ -13,7 +13,7 @@ The `isEmailAvailable` query checks whether the specified email has already been The following example checks whether the email address `customer@example.com` is available to create a customer account. -**Request** +**Request:** ```graphql { @@ -23,7 +23,7 @@ The following example checks whether the email address `customer@example.com` is } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/products.md b/guides/v2.3/graphql/queries/products.md index 773b5556cea..002bbb3a458 100644 --- a/guides/v2.3/graphql/queries/products.md +++ b/guides/v2.3/graphql/queries/products.md @@ -499,7 +499,7 @@ The following query shows how to get related products, Up-sells and Cross-sells } ``` -**Response** +**Response:** ```json { @@ -606,7 +606,7 @@ The following query returns layered navigation for products that have a `sku` co The following query returns media gallery information about the product with the `sku` of `24-MB01`. -**Request** +**Request:** ```graphql query { @@ -648,7 +648,7 @@ query { } ``` -**Response** +**Response:** ```json { @@ -685,7 +685,7 @@ query { The [ProductInterface]({{ page.baseurl }}/graphql/product/product-interface.html) can include information about the `Website` object. -**Request** +**Request:** ```graphql { @@ -705,7 +705,7 @@ The [ProductInterface]({{ page.baseurl }}/graphql/product/product-interface.html } ``` -**Response** +**Response:** ```json { @@ -734,7 +734,7 @@ The [ProductInterface]({{ page.baseurl }}/graphql/product/product-interface.html The following product query returns URL rewrite information about the Joust Duffle Bag. -**Request** +**Request:** ```graphql { @@ -754,7 +754,7 @@ The following product query returns URL rewrite information about the Joust Duff } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/store-config.md b/guides/v2.3/graphql/queries/store-config.md index 3ba9fbb229a..211124622fe 100644 --- a/guides/v2.3/graphql/queries/store-config.md +++ b/guides/v2.3/graphql/queries/store-config.md @@ -17,7 +17,7 @@ The `storeConfig` query defines information about a store's configuration. You c The following call returns all details of a store's configuration. -**Request** +**Request:** ```graphql { @@ -42,7 +42,7 @@ The following call returns all details of a store's configuration. } ``` -**Response** +**Response:** ```json { @@ -73,7 +73,7 @@ The following call returns all details of a store's configuration. The following query returns information about the store's default title, keywords, and welcome text. -**Request** +**Request:** ```graphql { @@ -85,7 +85,7 @@ The following query returns information about the store's default title, keyword } ``` -**Response** +**Response:** ```json { @@ -103,7 +103,7 @@ The following query returns information about the store's default title, keyword The following query returns information about the store's content pages. -**Request** +**Request:** ```graphql { @@ -118,7 +118,7 @@ The following query returns information about the store's content pages. } ``` -**Response** +**Response:** ```json { @@ -139,7 +139,7 @@ The following query returns information about the store's content pages. The following query returns information about the store's catalog configuration. -**Request** +**Request:** ```graphql { @@ -157,7 +157,7 @@ The following query returns information about the store's catalog configuration. } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/url-resolver.md b/guides/v2.3/graphql/queries/url-resolver.md index 11059f10919..d033b5a32f0 100644 --- a/guides/v2.3/graphql/queries/url-resolver.md +++ b/guides/v2.3/graphql/queries/url-resolver.md @@ -19,7 +19,7 @@ The `urlResolver` query returns the canonical URL for a specified product, categ The following query returns information about the URL containing `joust-duffle-bag.html`. -**Request** +**Request:** ```graphql { @@ -31,7 +31,7 @@ The following query returns information about the URL containing `joust-duffle-b } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/queries/wishlist.md b/guides/v2.3/graphql/queries/wishlist.md index f6e27e5c3f2..b9f35e038c8 100644 --- a/guides/v2.3/graphql/queries/wishlist.md +++ b/guides/v2.3/graphql/queries/wishlist.md @@ -15,7 +15,7 @@ Use the `wishlist` query to retrieve information about a customer's wish list. [ The following query returns the customer's wish list: -**Request** +**Request:** ```graphql { @@ -38,7 +38,7 @@ The following query returns the customer's wish list: } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md b/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md index 08ac249bf83..9c851b330e1 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md @@ -28,7 +28,7 @@ If you add a product to the shopping cart as a registered customer, be sure to s The following mutation adds a **simple product** into shopping cart. -**Request** +**Request:** ```text mutation { @@ -59,7 +59,7 @@ mutation { } ``` -**Response** +**Response:** ```json { @@ -86,7 +86,7 @@ mutation { The following mutation adds a **virtual product** into shopping cart. -**Request** +**Request:** ```text mutation { @@ -117,7 +117,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md b/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md index 7ee2f6fdc59..20d0fdcbac7 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md @@ -27,7 +27,7 @@ Use the [setBillingAddressOnCart]({{ page.baseurl }}/graphql/mutations/set-billi The following mutation adds a new billing address. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request** +**Request:** {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. @@ -72,7 +72,7 @@ mutation { } ``` -**Response** +**Response:** ```json { @@ -105,7 +105,7 @@ mutation { The following mutation includes the `use_for_shipping` attribute, which allows the same address to be used for billing and shipping. -**Request** +**Request:** ```text mutation { @@ -161,7 +161,7 @@ mutation { } ``` -**Response** +**Response:** ```json { @@ -212,7 +212,7 @@ mutation { First, query the customer to return the list of address IDs. -**Request** +**Request:** ```text query { @@ -226,7 +226,7 @@ query { } ``` -**Response** +**Response:** ```text "data": { @@ -247,7 +247,7 @@ Set `{ CUSTOMER_ADDRESS_ID }` to an `id` returned in the query. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request** +**Request:** ```text mutation { @@ -278,7 +278,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md b/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md index 667aea14348..3c01923afff 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md @@ -20,7 +20,7 @@ Use [applyCouponToCart]({{ page.baseurl }}/graphql/mutations/apply-coupon.html) `{ COUPON_CODE }` is an existing Magento coupon code. It cannot be generated with GraphQL. -**Request** +**Request:** {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. @@ -42,7 +42,7 @@ mutation { } ``` -**Response** +**Response:** ```json { @@ -60,7 +60,7 @@ mutation { Use [removeCouponFromCart]({{ page.baseurl }}/graphql/mutations/remove-coupon.html) to remove a discount coupon from the shopping cart. -**Request** +**Request:** {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. @@ -77,7 +77,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md b/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md index 7aa8470bea5..bd5340551ad 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md @@ -24,7 +24,7 @@ To place order as a new customer, use the `createCustomer` mutation to register {:.bs-callout .bs-callout-info} Skip this step if you want to place order as a guest user. -**Request** +**Request:** ```text mutation { @@ -48,7 +48,7 @@ mutation { } ``` -**Response** +**Response:** ```json { @@ -70,7 +70,7 @@ mutation { To place an order as a new customer, you must get the customer's authorization token. Use the `generateCustomerToken` mutation for that. -**Request** +**Request:** ```text mutation { @@ -80,7 +80,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md b/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md index dee093e2d39..ced55da87d8 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md @@ -21,7 +21,7 @@ Use the following `cart` query to determine which payment methods which are avai `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request** +**Request:** {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. @@ -37,7 +37,7 @@ query { } ``` -**Response** +**Response:** ```json { @@ -65,7 +65,7 @@ There are two mutation queries in GraphQl which can be use to set the payment me Use the `setPaymentMethodOnCart` mutation to set the payment method for your order. The value `checkmo` ("Check / Money order" payment method code) was returned in the query. -**Request** +**Request:** {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. @@ -87,7 +87,7 @@ mutation { } ``` -**Response** +**Response:** If the operation is successful, the response contains the code of the selected payment method. @@ -109,7 +109,7 @@ If the operation is successful, the response contains the code of the selected p Use the `setPaymentMethodAndPlaceOrder` mutation to set the payment method and place the order. -**Request** +**Request:** ```text mutation { @@ -126,7 +126,7 @@ mutation { } ``` -**Response** +**Response:** If the operation is successful, the response contains the order ID. diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md b/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md index 74a1c6c9097..ed99224ef77 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md @@ -18,7 +18,7 @@ The `placeOrder` mutation places an order. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request** +**Request:** {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. @@ -33,7 +33,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md b/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md index 64eac46fbcc..0070c5b4c6f 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md @@ -21,7 +21,7 @@ If you place an order as a guest user, you must set a quote email address. Use t `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request** +**Request:** ```text mutation { @@ -36,7 +36,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md b/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md index 06631f48986..1a58e744293 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md @@ -26,7 +26,7 @@ The following mutation adds a shipping address to the quote. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request** +**Request:** {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. @@ -74,7 +74,7 @@ mutation { } ``` -**Response** +**Response:** `setShippingAddressesOnCart` returns the new address details. @@ -119,7 +119,7 @@ mutation { First, query the customer to return a list of address IDs. -**Request** +**Request:** ```text query { @@ -133,7 +133,7 @@ query { } ``` -**Response** +**Response:** ```text { @@ -165,7 +165,7 @@ Set `{ CUSTOMER_ADDRESS_ID }` to an `id` returned in the query. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request** +**Request:** ```text mutation { @@ -201,7 +201,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-method.md b/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-method.md index 3c53ac9d889..0d18d869c7d 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-method.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-method.md @@ -25,7 +25,7 @@ The `setShippingMethodsOnCart` mutation defines the shipping methods for your or {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. -**Request** +**Request:** The following mutation query assigns UPS "Ground" method. @@ -54,7 +54,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md b/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md index 3e0a370bfec..5662da961d5 100644 --- a/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md +++ b/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md @@ -19,7 +19,7 @@ The `createEmptyCart` mutation creates an empty shopping cart and generates a ca {:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the Authorization parameter of the header. See ["Get customer authorization token"]({{ page.baseurl }}/graphql/get-customer-authorization-token.html) for more information. -**Request** +**Request:** The following mutation creates an empty cart: @@ -29,7 +29,7 @@ mutation { } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/rest/modules/inventory/bulk-inventory.md b/guides/v2.3/rest/modules/inventory/bulk-inventory.md index 5b0429e9a8a..cb1d25223ea 100644 --- a/guides/v2.3/rest/modules/inventory/bulk-inventory.md +++ b/guides/v2.3/rest/modules/inventory/bulk-inventory.md @@ -9,7 +9,7 @@ Magento provides several endpoints that allow Multi Source merchants to make qui * The bulk assign source endpoint adds sources to multiple products. * The bulk unassign source endpoint removes sources from the products. Any inventory quantity assigned to that source is no longer available. -**Service names** +**Service names:** ```http inventoryCatalogApiBulkInventoryTransferV1 @@ -18,7 +18,7 @@ inventoryCatalogApiBulkSourceAssignV1 inventoryCatalogApiBulkSourceUnassignV1 ``` -**REST endpoints** +**REST endpoints:** ```http POST /V1/inventory/bulk-product-source-transfer @@ -35,7 +35,7 @@ Bulk transfer allows you to specify multiple products, the origin source from wh Unlike an unassign source action, Magento also retains product data by moving the status (in stock/out of stock), and the Notify Quantity from one source to another. If the origin and destination sources are in different stocks, performing a bulk transfer affects the aggregated Salable Quantity and reservations for in-progress orders. -**Parameters** +**Parameters:** Name | Description | Type | Requirements --- | --- | --- | --- @@ -44,11 +44,11 @@ Name | Description | Type | Requirements `destinationSource` | The target source for the SKUs. This source must be already defined. | String | Required `unassignFromOrigin` | If `true`, the current source is removed as a source for the products. If `false`, the original source is retained, but the products are marked as being out of stock with a quantity of 0. | Boolean | Required -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/bulk-product-source-transfer` -**Payload** +**Payload:** ```json { @@ -62,7 +62,7 @@ Name | Description | Type | Requirements } ``` -**Response** +**Response:** `true` if the request was successful @@ -70,7 +70,7 @@ Name | Description | Type | Requirements You can use the `V1/inventory/bulk-partial-source-transfer` endpoint to transfer a limited quantity of a product from one source to another. As with full transfers, Magento keeps track of the stock status as well as the Notify Quantity when you move products from one source to another. -**Parameters** +**Parameters:** Name | Description | Type | Requirements --- | --- | --- | --- @@ -80,11 +80,11 @@ Name | Description | Type | Requirements `sku` | A product to transfer | String | Required `qty` | The quantity of the product to transfer | Float | Required -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/bulk-partial-source-transfer` -**Payload** +**Payload:** ```json { @@ -103,7 +103,7 @@ Name | Description | Type | Requirements } ``` -**Response** +**Response:** An empty array @@ -115,18 +115,18 @@ After adding new custom sources, you can add inventory quantities per product or The sources are added to the products with an inventory quantity of 0. You can add inventory amounts as available per source. -**Parameters** +**Parameters:** Name | Description | Type | Requirements --- | --- | --- | --- `skus` | A comma-separated list of existing SKUs to assign | Array | Required `sourceCodes` | A comma-separated list of existing sources | Array | Required -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/bulk-product-source-assign` -**Payload** +**Payload:** ```json { @@ -141,7 +141,7 @@ Name | Description | Type | Requirements } ``` -**Response** +**Response:** An ID that identifies the request, such as `1`. @@ -156,11 +156,11 @@ We strongly recommend completing all orders and shipments for those products pri If you unassign all sources from a product, you will not be able to sell the product. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/bulk-product-source-unassign` -**Payload** +**Payload:** ```json { @@ -174,6 +174,6 @@ If you unassign all sources from a product, you will not be able to sell the pro } ``` -**Response** +**Response:** An ID that identifies the request, such as `1`. \ No newline at end of file diff --git a/guides/v2.3/rest/modules/inventory/check-salable-quantity.md b/guides/v2.3/rest/modules/inventory/check-salable-quantity.md index 6a79a7b4939..66cde3c1cd2 100644 --- a/guides/v2.3/rest/modules/inventory/check-salable-quantity.md +++ b/guides/v2.3/rest/modules/inventory/check-salable-quantity.md @@ -5,7 +5,7 @@ title: Check salable quantities Magento provides several endpoints that allow you to check whether a product from a specified stock is salable and the available quantity. -**Service names** +**Service names:** ```http inventorySalesApiGetProductSalabilityV1 @@ -14,7 +14,7 @@ inventorySalesApiIsProductSalableForRequestedQtyV1 inventorySalesApiStockResolverV1 ``` -**REST endpoints** +**REST endpoints:** ```http GET /V1/inventory/get-product-salable-quantity/:sku/:stockId @@ -37,7 +37,7 @@ Name | Description | Type This call returns the available quantity of a product assigned to the specified stock ID. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/get-product-salable-quantity/sp2/2` @@ -46,11 +46,11 @@ Name | Description | Type `sku` | The SKU of the product | String `stock_id` | The ID of the stock the product is assigned to | Integer -**Payload** +**Payload:** None -**Response** +**Response:** An integer indicating the salable quantity of the product, such as `75`. @@ -58,15 +58,15 @@ An integer indicating the salable quantity of the product, such as `75`. This call returns a boolean value that indicates whether the product from the specified stock is salable. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/is-product-salable/sp2/2` -**Payload** +**Payload:** None -**Response** +**Response:** `true` or `false` @@ -74,15 +74,15 @@ None This call indicates whether a product is salable for the specified quantity and stock ID. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/is-product-salable-for-requested-qty/sp2/2/30` -**Payload** +**Payload:** None -**Response** +**Response:** ```json { @@ -95,15 +95,15 @@ None This call returns the stock ID associated with the specified sales channel type and name. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/stock-resolver/website/na_site` -**Payload** +**Payload:** None -**Response** +**Response:** ```json { diff --git a/guides/v2.3/rest/modules/inventory/link-stocks-sources.md b/guides/v2.3/rest/modules/inventory/link-stocks-sources.md index e84e9380f9a..659caf86302 100644 --- a/guides/v2.3/rest/modules/inventory/link-stocks-sources.md +++ b/guides/v2.3/rest/modules/inventory/link-stocks-sources.md @@ -8,7 +8,7 @@ In Admin, you can assign (link) sources to a stock when you create the stock. In To link a source to a stock, you must specify the `source_code`, `stock_id`, and `priority` attributes. The `priority` value indicates where the source ranks in descending order. The Source Selection Algorithm uses this priority order when recommending order fulfillment. All sources linked to a stock are displayed in prioritized order in the Admin. -**Service names** +**Service names:** ```http inventoryApiStockSourceLinksSaveV1 @@ -17,7 +17,7 @@ InventoryApiGetStockSourceLinksV1 inventoryApiGetSourcesAssignedToStockOrderedByPriorityV1 ``` -**REST endpoints** +**REST endpoints:** ```http POST /V1/inventory/stock-source-links @@ -37,11 +37,11 @@ Name | Description | Type | Requirements If you specify a sales channel that is already assigned to another stock, Magento reassigns the sales channel from the previous stock to the current stock. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/stock-source-links` -**Payload** +**Payload:** ```json { @@ -60,7 +60,7 @@ If you specify a sales channel that is already assigned to another stock, Magent } ``` -**Response** +**Response:** Magento returns empty array. @@ -70,11 +70,11 @@ Magento returns empty array. The `POST /V1/inventory/stock-source-links-delete` endpoint breaks the link between a stock and one or more sources. Magento does not recalculate priority of sources after you delete links. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/inventory/stock-source-links-delete` -**Payload** +**Payload:** ```json { @@ -87,7 +87,7 @@ The `POST /V1/inventory/stock-source-links-delete` endpoint breaks the link betw } ``` -**Response** +**Response:** Magento returns empty array. @@ -99,15 +99,15 @@ The following call returns the link information for `stock_id = 4`. See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/stock-source-links?searchCriteria[filter_groups][0][filters][0][field]=stock_id&searchCriteria[filter_groups][0][filters][0][value]=4&searchCriteria[filter_groups][0][filters][0][condition_type]=eq` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} @@ -148,15 +148,15 @@ None The `GET /V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/:stock_id` endpoint returns details about each source that is assigned to the specified stock. [Manage sources]({{ page.baseurl }}/rest/modules/inventory/manage-sources.html) provides definitions for each attribute returned. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/4` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} diff --git a/guides/v2.3/rest/modules/inventory/manage-low-quantity.md b/guides/v2.3/rest/modules/inventory/manage-low-quantity.md index 18bddb54fae..fecb35b995d 100644 --- a/guides/v2.3/rest/modules/inventory/manage-low-quantity.md +++ b/guides/v2.3/rest/modules/inventory/manage-low-quantity.md @@ -13,7 +13,7 @@ Magento deducts either the global or the overriding quantity from the total sala The REST low-quantity notification endpoints manage the values that merchants set from the **Notify Quantity** fields. -**Service names** +**Service names:** ```http inventoryLowQuantityNotificationApiGetSourceItemConfigurationV1 @@ -21,7 +21,7 @@ inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1 inventoryLowQuantityNotificationApiDeleteSourceItemsConfigurationV1 ``` -**REST endpoints** +**REST endpoints:** ```http POST /V1/inventory/low-quantity-notification @@ -41,11 +41,11 @@ Name | Description | Type | Requirements The `POST /V1/inventory/low-quantity-notification` endpoint accepts an array of values that map a SKU to a source and specify when to notify the merchant of a low stock quantity. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/low-quantity-notification` -**Payload** +**Payload:** ```json { @@ -69,7 +69,7 @@ The `POST /V1/inventory/low-quantity-notification` endpoint accepts an array of } ``` -**Response** +**Response:** An empty array `[]` @@ -77,15 +77,15 @@ An empty array `[]` This call returns the `notify_stock_qty` for the specified source and SKU. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/low-quantity-notification/reno_wh/sp1` -**Payload** +**Payload:** None -**Response** +**Response:** ```json { @@ -99,11 +99,11 @@ None The `POST /V1/inventory/low-quantity-notifications-delete` endpoint deletes the notification threshold for an array of sourceItem objects. Each object specified a SKU amd source. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/low-quantity-notifications-delete` -**Payload** +**Payload:** ```json { @@ -116,7 +116,7 @@ The `POST /V1/inventory/low-quantity-notifications-delete` endpoint deletes the } ``` -**Response** +**Response:** Magento returns an empty array. diff --git a/guides/v2.3/rest/modules/inventory/manage-source-items.md b/guides/v2.3/rest/modules/inventory/manage-source-items.md index 7adae06cd43..85b08f70204 100644 --- a/guides/v2.3/rest/modules/inventory/manage-source-items.md +++ b/guides/v2.3/rest/modules/inventory/manage-source-items.md @@ -6,7 +6,7 @@ title: Manage source items If Magento is configured to manage inventory, when you upgrade to version 2.3, Magento assigns all existing products to the default source. Currently, Magento also assigns newly-created products to the default source. Single Source merchants do not need to manage source items, but Multi Source merchants may need to move products from the default source to a custom source, or move products from one custom source to another. -**Service names** +**Service names:** ```http inventoryApiSourceItemsDeleteV1 @@ -14,7 +14,7 @@ inventoryApiSourceItemsSaveV1 inventoryApiSourceItemRepositoryV1 ``` -**REST endpoints** +**REST endpoints:** ```http POST V1/inventory/source-items-delete @@ -38,11 +38,11 @@ Use the `POST V1/inventory/source-items-delete` endpoint to unassign one or more {:.bs-callout .bs-callout-warning} Unassigning a source clears all quantity data. For this example, this is OK, because the default source did not contain any quantity data. Reassigning a source that contains real quantity data can potentially cause havoc with pending orders with reservations and affect the salable quantity counts. See the [merchant documentation](https://github.com/magento-engcom/msi/wiki/Overview) for more details. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/source-items-delete` -**Payload** +**Payload:** ```json { @@ -57,7 +57,7 @@ Unassigning a source clears all quantity data. For this example, this is OK, bec } ``` -**Response** +**Response:** Magento returns an empty array. @@ -69,11 +69,11 @@ Magento returns an empty array. The following example assigns `1000` units of product `new_product1` to the `central` source and `2000` units to the `east` source. It also assigns `500` units of product `new_product2` to the `central` source and `250` units to the `east` source. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/source-items` -**Payload** +**Payload:** ```json { @@ -104,7 +104,7 @@ The following example assigns `1000` units of product `new_product1` to the `cen } ``` -**Response** +**Response:** Magento returns an empty array. @@ -116,15 +116,15 @@ The following call returns all source items for `sku` = `new_product2`. See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/source-items?searchCriteria[filter_groups][0][filters][0][field]=sku&searchCriteria[filter_groups][0][filters][0][value]=new_product2&searchCriteria[filter_groups][0][filters][0][condition_type]=eq` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} diff --git a/guides/v2.3/rest/modules/inventory/manage-source-selection.md b/guides/v2.3/rest/modules/inventory/manage-source-selection.md index f6d7f3b7a42..6e0834cfc33 100644 --- a/guides/v2.3/rest/modules/inventory/manage-source-selection.md +++ b/guides/v2.3/rest/modules/inventory/manage-source-selection.md @@ -20,7 +20,7 @@ The SSA also manages shipments by providing recommendations for the best sources Third parties can also extend SSA to create customized algorithms for recommending cost-effective shipments. -**Service names** +**Service names:** ```http inventorySourceSelectionApiGetSourceSelectionAlgorithmListV1 @@ -30,7 +30,7 @@ inventoryDistanceBasedSourceSelectionApiGetDistanceV1 inventoryDistanceBasedSourceSelectionApiGetLatLngFromAddressV1 ``` -**REST endpoints** +**REST endpoints:** ```http GET /V1/inventory/source-selection-algorithm-list @@ -41,15 +41,15 @@ POST /V1/inventory/source-selection-algorithm-result Currently, Inventory Management supports only the default SSA for priority. Third-party developers and future releases may add support for additional algorithms. -**Sample usage** +**Sample usage:** `GET /rest/us/V1/inventory/source-selection-algorithm-list` -**Payload** +**Payload:** None -**Response** +**Response:** An array containing a list of SSA codes, titles, and descriptions. @@ -72,7 +72,7 @@ An array containing a list of SSA codes, titles, and descriptions. The `POST V1/inventory/source-selection-algorithm-result` endpoint uses the algorithm defined by the `algorithmCode` attribute to calculate the recommended sources and quantities for each item defined in the items array. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/source-selection-algorithm-result` @@ -94,7 +94,7 @@ Name | Description | Type | Requirements ### Source Priority Algorithm -**Payload** +**Payload:** ```json { @@ -113,7 +113,7 @@ Name | Description | Type | Requirements } ``` -**Response** +**Response:** ```json { @@ -155,7 +155,7 @@ Name | Description | Type | Requirements ### Distance Priority algorithm -**Payload** +**Payload:** ```json { @@ -183,7 +183,7 @@ Name | Description | Type | Requirements } ``` -**Response** +**Response:** ```json { @@ -231,15 +231,15 @@ Magento provides several endpoints to help determine GPS coordinates. The `GET /V1/inventory/get-distance-provider-code` endpoint returns the configured distance provider for the Distance Priority algorithm. The value can be `google` or `offline`. -**Sample usage** +**Sample usage:** `GET /rest//V1/inventory/get-distance-provider-code` -**Payload** +**Payload:** None -**Response** +**Response:** `offline` @@ -256,15 +256,15 @@ Name | Description `destination[lat]` | The latitude of the destination `destination[lng]` | The longitude of the destination -**Sample usage** +**Sample usage:** `GET /V1/inventory/get-distance?source[lat]=30.271129&source[lng]=-97.7437&destination[lat]=39.290882&destination[lng]=-76.610759` -**Payload** +**Payload:** None -**Response** +**Response:** The distance, in kilometers @@ -282,15 +282,15 @@ address[street] | The street of the shipping address address[region] | The region code of the shipping address address[city] | The city of the shipping address -**Sample usage** +**Sample usage:** `GET /V1/inventory/get-latlng-from-address?address[country]=US&address[postcode]=10577&address[street]=123%20Oak&address[region]=NY&address[city]=Purchase` -**Payload** +**Payload:** None -**Response** +**Response:** ```json { diff --git a/guides/v2.3/rest/modules/inventory/manage-sources.md b/guides/v2.3/rest/modules/inventory/manage-sources.md index 239f416c32c..d0b456c2be1 100644 --- a/guides/v2.3/rest/modules/inventory/manage-sources.md +++ b/guides/v2.3/rest/modules/inventory/manage-sources.md @@ -18,11 +18,11 @@ Disabling a custom source has the following effects: {:.bs-callout .bs-callout-info} Bundle and grouped products currently do not support multi-sourcing and must be assigned to the default source and default stock. -**Service name** +**Service name:** `inventoryApiSourceRepositoryV1` -**REST endpoints** +**REST endpoints:** ```http POST /V1/inventory/sources @@ -59,11 +59,11 @@ Name | Description | Type | Requirements The value of the `source_code` parameter can contain upper and lower case letters, numbers, dashes, and underscores. You use this ID when assigning stock to sources and when exporting or importing data. -**Sample Usage** +**Sample Usage:** `POST /rest//V1/inventory/sources` -**Payload** +**Payload:** ```json { @@ -86,7 +86,7 @@ The value of the `source_code` parameter can contain upper and lower case letter } ``` -**Response** +**Response:** Magento returns an empty array. @@ -98,11 +98,11 @@ All PUT requests must contain the `name`, `country_id`, and `postcode` parameter This example updates the contact information (`contact_name`, `email`, and `phone` parameters) of the source. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/inventory/sources/central` -**Payload** +**Payload:** ```json { @@ -117,7 +117,7 @@ This example updates the contact information (`contact_name`, `email`, and `phon } ``` -**Response** +**Response:** Magento returns an empty array. @@ -127,15 +127,15 @@ Magento returns an empty array. This call returns detailed information about the specified source. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/sources/central` -**Payload** +**Payload:** None -**Response** +**Response:** ```json { @@ -164,15 +164,15 @@ The following call returns all sources that are located in the United States (`c See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/sources?searchCriteria[filter_groups][0][filters][0][field]=country_id&searchCriteria[filter_groups][0][filters][0][value]=US&searchCriteria[filter_groups][0][filters][0][condition_type]=eq` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} diff --git a/guides/v2.3/rest/modules/inventory/manage-stocks.md b/guides/v2.3/rest/modules/inventory/manage-stocks.md index e5fbfbaaa57..7b6a8326d6d 100644 --- a/guides/v2.3/rest/modules/inventory/manage-stocks.md +++ b/guides/v2.3/rest/modules/inventory/manage-stocks.md @@ -11,11 +11,11 @@ The `stock_id` of the default stock is `1`. You cannot delete or add sources to Any sales channels that are not explicitly assigned to a custom stock are assigned to the Default Stock. -**Service name** +**Service name:** `inventoryApiStockRepositoryV1` -**REST endpoints** +**REST endpoints:** ```http POST /V1/inventory/stocks @@ -39,11 +39,11 @@ Name | Description | Type | Requirements Only one stock can be mapped to each sales channel. If you assign a sales channel that is already mapped to another stock, the sales channel will be removed from the original stock. -**Sample usage** +**Sample usage:** `POST /rest//V1/inventory/stocks` -**Payload** +**Payload:** ```json { @@ -61,7 +61,7 @@ Only one stock can be mapped to each sales channel. If you assign a sales channe } ``` -**Response** +**Response:** A `stock_id`, such as `4`. @@ -71,11 +71,11 @@ You can change the name of a custom stock and its associated sales channels. Eac If you change a sales channel between stocks, we recommend that you first complete any open orders and shipments that may need access to the assigned sources. -**Sample Usage** +**Sample Usage:** `PUT /rest//V1/inventory/stocks/4` -**Payload** +**Payload:** ```json { @@ -93,7 +93,7 @@ If you change a sales channel between stocks, we recommend that you first comple } ``` -**Response** +**Response:** A `stock_id`, such as `4`. @@ -101,15 +101,15 @@ A `stock_id`, such as `4`. This call returns detailed information about the specified stock. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/stocks/4` -**Payload** +**Payload:** None -**Response** +**Response:** ```json { @@ -131,15 +131,15 @@ None You cannot delete a stock if it is assigned to a sales channel. You can unassign a stock's sales channels by omitting the `sales_channels` array in a `PUT /V1/inventory/stocks/:stockId` call. -**Sample Usage** +**Sample Usage:** `DELETE /rest//V1/inventory/stocks/4` -**Payload** +**Payload:** None -**Response** +**Response:** Magento returns an empty array. @@ -151,15 +151,15 @@ The following call returns all stocks whose name contains the string `Stock`. See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query. -**Sample Usage** +**Sample Usage:** `GET /rest//V1/inventory/stocks?searchCriteria[filter_groups][0][filters][0][field]=name&searchCriteria[filter_groups][0][filters][0][value]=%25Stock%25&searchCriteria[filter_groups][0][filters][0][condition_type]=like` -**Payload** +**Payload:** None -**Response** +**Response:** {% collapsible Show code sample %} ```json diff --git a/guides/v2.3/rest/operation-status-endpoints.md b/guides/v2.3/rest/operation-status-endpoints.md index f324fd34b64..81cf1513cee 100644 --- a/guides/v2.3/rest/operation-status-endpoints.md +++ b/guides/v2.3/rest/operation-status-endpoints.md @@ -30,7 +30,7 @@ Field name | Data type | Description `user_id` | Integer | The user ID that executed the request. `operation_count` | Integer | The number of operations processed in the request. -**Response** +**Response:** ```json { @@ -77,7 +77,7 @@ Field name | Data type | Description `user_id` | Integer | The user ID that executed the request. `operation_count` | Integer | The number of operations processed in the request. -**Response** +**Response:** ```json { diff --git a/guides/v2.3/rest/operation-status-search.md b/guides/v2.3/rest/operation-status-search.md index d4469c0cd50..63241cbcb47 100644 --- a/guides/v2.3/rest/operation-status-search.md +++ b/guides/v2.3/rest/operation-status-search.md @@ -21,7 +21,7 @@ You can specify any of the following fields to filter on operation statuses: * `bulk_uuid` - UUID generated by an [asynchronous API request]({{ page.baseurl }}/rest/asynchronous-web-endpoints.html) or [Bulk API request]({{ page.baseurl }}/rest/bulk-endpoints.html). * `topic_name` - Queue topic name -**Sample usage** +**Sample usage:** The following call returns bulk operations that contain an error that cannot be retried. @@ -34,7 +34,7 @@ searchCriteria[filter_groups][0][filters][0][condition_type]=eq See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for more information about the syntax of search requests. -**Response** +**Response:** The operation with bulk UUID `c43ed402-3dd3-4100-92e2-dc5852d3009b` contains a `status` code of 3. diff --git a/guides/v2.3/rest/retrieve-filtered-responses.md b/guides/v2.3/rest/retrieve-filtered-responses.md index d2f47bb1354..cd6812fcde5 100644 --- a/guides/v2.3/rest/retrieve-filtered-responses.md +++ b/guides/v2.3/rest/retrieve-filtered-responses.md @@ -117,7 +117,7 @@ The following POST operation and payload creates a [catalog](https://glossary.ma `POST /rest//V1/categories?fields=id,parent_id,name` -**Payload** +**Payload:** ```json { @@ -128,7 +128,7 @@ The following POST operation and payload creates a [catalog](https://glossary.ma } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/rest/tutorials/bulk-configurable-product/create-configurable-simple-products.md b/guides/v2.3/rest/tutorials/bulk-configurable-product/create-configurable-simple-products.md index 33861b761e0..86a49dc0c91 100644 --- a/guides/v2.3/rest/tutorials/bulk-configurable-product/create-configurable-simple-products.md +++ b/guides/v2.3/rest/tutorials/bulk-configurable-product/create-configurable-simple-products.md @@ -43,11 +43,11 @@ Before you use this code sample, verify that the attribute values are the same i {:.bs-callout .bs-callout-info} The payload contains both the configurable product and the simple products. - **Endpoint** + **Endpoint:** `POST /rest/default/async/bulk/V1/products` - **Payload** + **Payload:** {% collapsible Show code sample %} @@ -280,7 +280,7 @@ The payload contains both the configurable product and the simple products. {% endcollapsible %} - **Response** + **Response:** ```json { diff --git a/guides/v2.3/rest/tutorials/bulk-configurable-product/create-personalization-option.md b/guides/v2.3/rest/tutorials/bulk-configurable-product/create-personalization-option.md index 0361e236c60..f2a3689bd39 100644 --- a/guides/v2.3/rest/tutorials/bulk-configurable-product/create-personalization-option.md +++ b/guides/v2.3/rest/tutorials/bulk-configurable-product/create-personalization-option.md @@ -19,11 +19,11 @@ Let's add a text box to the product page that allows the customer to add his nam The `product_sku` is the `sku` of the configurable product. The `sku` specified in the payload is a string that is appended to the `product_sku` when a customer selects to purchase this item. Likewise, the `price` supplied in the payload is added to the configurable product price. -**Endpoint** +**Endpoint:** `POST /rest/default/async/bulk/V1/products/options` -**Payload** +**Payload:** ```json [{ @@ -41,7 +41,7 @@ The `product_sku` is the `sku` of the configurable product. The `sku` specified }] ``` - **Response** + **Response:** ```json { diff --git a/guides/v2.3/rest/tutorials/bulk-configurable-product/define-config-product-options.md b/guides/v2.3/rest/tutorials/bulk-configurable-product/define-config-product-options.md index d2252ed2f60..e7cbc5d55a4 100644 --- a/guides/v2.3/rest/tutorials/bulk-configurable-product/define-config-product-options.md +++ b/guides/v2.3/rest/tutorials/bulk-configurable-product/define-config-product-options.md @@ -23,11 +23,11 @@ contributor_link: http://comwrap.com/ The value assigned to the `value_index` must be unique within the system. - **Endpoint** + **Endpoint:** `POST /rest/default/async/bulk/V1/configurable-products/bySku/options` - **Payload** + **Payload:** ```json [{ @@ -46,7 +46,7 @@ contributor_link: http://comwrap.com/ }] ``` - **Response** + **Response:** ```json { @@ -66,14 +66,14 @@ contributor_link: http://comwrap.com/ Now that you have set the configurable attribute to be `sku`, you can link all simple products to the configurable product and execute a single call with a payload that contains an array of simple products. To do this, specify the `sku` of the configurable product, and the `childSku` of each simple product. - **Endpoint** + **Endpoint:** {:.bs-callout .bs-callout-info} Bulk endpoint routes cannot contain input parameters, such as a `sku` value. You must replace input parameters with a string that begins with `by` and ends with the input parameter name, such as `bySku`. See [`bulk endpoints`]({{ page.baseurl }}/rest/bulk-endpoints.html) for more information. `POST /rest/default/async/bulk/V1/configurable-products/bySku/child` - **Payload** + **Payload:** ```json [ @@ -93,7 +93,7 @@ Bulk endpoint routes cannot contain input parameters, such as a `sku` value. Yo ] ``` - **Response** + **Response:** ```json { diff --git a/guides/v2.3/rest/tutorials/bulk-configurable-product/plan-product.md b/guides/v2.3/rest/tutorials/bulk-configurable-product/plan-product.md index a3df0fdf399..8acda5833bb 100644 --- a/guides/v2.3/rest/tutorials/bulk-configurable-product/plan-product.md +++ b/guides/v2.3/rest/tutorials/bulk-configurable-product/plan-product.md @@ -57,7 +57,7 @@ Description | The Champ Tee keeps you cool and dry while you do your thing. Let Use the following call to search for the attribute set named `Top`. - **Endpoint** + **Endpoint:** ```html GET /rest//V1/eav/attribute-sets/list? @@ -66,7 +66,7 @@ searchCriteria[filter_groups][0][filters][0][value]=Top& searchCriteria[filter_groups][0][filters][0][condition_type]=eq ``` - **Response** + **Response:** The `attribute_set_id` for the Top attribute set is `9`. @@ -101,11 +101,11 @@ searchCriteria[filter_groups][0][filters][0][condition_type]=eq Use the `GET V1/products/attribute-sets/:attributeSetId/attributes` call to return information about the attributes defined in the Top attribute set. - **Endpoint** + **Endpoint:** `GET /rest/default/V1/products/attribute-sets/9/attributes` - **Response** + **Response:** The response contains almost 3,000 lines. The following table provides a summary of the attributes that are relevant in this tutorial. diff --git a/guides/v2.3/rest/tutorials/index.md b/guides/v2.3/rest/tutorials/index.md index f607a6a9ae1..f310069405d 100644 --- a/guides/v2.3/rest/tutorials/index.md +++ b/guides/v2.3/rest/tutorials/index.md @@ -39,7 +39,7 @@ Before you begin any tutorial, make sure you know the basics about {{site.data.v Although some steps require that you configure Magento in some way, you perform most steps by sending one or more REST calls to Magento. Each step that makes a REST call provides the following information: -**Endpoint** +**Endpoint:** This section lists the HTTP verb and full path to the endpoint. The basic structure of a REST call in Magento is @@ -54,18 +54,18 @@ Element | Description `scope` | Specifies which store the call affects. In this tutorial, this value is `default`. `endpoint` | The full URI (Uniform Resource Identifier) to the endpoint. These values always start with `/V1`. For example, `/V1/orders/4`. -**Scope** +**Scope:** -The **Scope** section is included when the tutorial requires that you send requests to different stores. +The **Scope:** section is included when the tutorial requires that you send requests to different stores. **HTTP headers** This section indicates which key/value pairs you must specify in the HTTP headers. All calls require one or more HTTP headers. -**Payload** +**Payload:** This section lists the information that is sent to Magento. All payload samples are valid and can be copied and pasted into your calls, but you might need to change the `id` values that Magento returns. -**Response** +**Response:** This section lists the information that Magento sends to the REST client. These values are often referenced in other steps in the tutorial. The values Magento returns might be different than the values listed in the examples provided in this tutorial. diff --git a/guides/v2.3/rest/tutorials/inventory/assign-source-to-stock.md b/guides/v2.3/rest/tutorials/inventory/assign-source-to-stock.md index a5b779548d3..a4e682c0b16 100644 --- a/guides/v2.3/rest/tutorials/inventory/assign-source-to-stock.md +++ b/guides/v2.3/rest/tutorials/inventory/assign-source-to-stock.md @@ -28,21 +28,21 @@ The `POST V1/inventory/stock-source-links` endpoint accepts an array of links, s In this example, we configure the Baltimore warehouse to be the primary source for North America orders. Austin and Reno are the second- and third-choice sources. In Europe, Berlin is preferred, followed by Frankfurt. HQ is the last choice for both stocks. -**Endpoint** +**Endpoint:** `POST /rest/all/V1/inventory/stock-source-links` -**Scope** +**Scope:** `all` store views -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -86,7 +86,7 @@ In this example, we configure the Baltimore warehouse to be the primary source f } ``` -**Response** +**Response:** Magento returns empty array. [] diff --git a/guides/v2.3/rest/tutorials/inventory/bulk-transfer-products.md b/guides/v2.3/rest/tutorials/inventory/bulk-transfer-products.md index a9920fcccb0..b24c270f0f0 100644 --- a/guides/v2.3/rest/tutorials/inventory/bulk-transfer-products.md +++ b/guides/v2.3/rest/tutorials/inventory/bulk-transfer-products.md @@ -21,21 +21,21 @@ In this scenario, there are no pending orders that contain the product, nor is t The `POST /V1/inventory/bulk-product-source-transfer` endpoint allows you to specify an array of SKUs to bulk transfer from one source to another, but this example includes only one SKU. If you set the `unassignFromOrigin` attribute to `true`, the origin source is no longer associated with the specified products. If the attribute is `false`, Magento designates the products as being out of stock at the origin source with a quantity of 0. -**Endpoint** +**Endpoint:** `POST /rest/all/V1/inventory/bulk-product-source-transfer` -**Scope** +**Scope:** `all` store views -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -48,7 +48,7 @@ The `POST /V1/inventory/bulk-product-source-transfer` endpoint allows you to spe } ``` -**Response** +**Response:** `true` @@ -56,7 +56,7 @@ The `POST /V1/inventory/bulk-product-source-transfer` endpoint allows you to spe Use the same endpoint to bulk transfer the product to Austin. -**Payload** +**Payload:** ```json { @@ -69,7 +69,7 @@ Use the same endpoint to bulk transfer the product to Austin. } ``` -**Response** +**Response:** `true` diff --git a/guides/v2.3/rest/tutorials/inventory/create-cart-add-products.md b/guides/v2.3/rest/tutorials/inventory/create-cart-add-products.md index e5e47819ad0..b9f53151c9a 100644 --- a/guides/v2.3/rest/tutorials/inventory/create-cart-add-products.md +++ b/guides/v2.3/rest/tutorials/inventory/create-cart-add-products.md @@ -18,25 +18,25 @@ Next, we'll create a cart and add the items that we modified in [Step 5. Reassig The call to create a cart and add items must contain the customer’s authorization token in the authorization header. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/carts/mine` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** None -**Response** +**Response:** The response is the `quoteId`: 3 @@ -55,25 +55,25 @@ Later in this step, we'll order 20 `24-WB01` items and 50 `24-WB03` items. We ca The `get-product-salable-quantity` endpoint indicates how many items are available for sale for the specified product (24-WB01) and source (2). -**Endpoint** +**Endpoint:** `GET /rest/us/V1/inventory/get-product-salable-quantity/24-WB01/2` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** `70` @@ -81,25 +81,25 @@ Not applicable Use the same endpoint to check the quantity available for product `24-WB03`. -**Endpoint** +**Endpoint:** `GET /rest/us/V1/inventory/get-product-salable-quantity/24-WB03/2` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** `61` @@ -111,21 +111,21 @@ We have ensured that we have enough physical products in stock to fulfill the po In this call, we'll add 20 `24-WB01` items. This portion of the order can be fulfilled from the Baltimore or Reno warehouse. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/carts/mine/items` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -137,7 +137,7 @@ In this call, we'll add 20 `24-WB01` items. This portion of the order can be ful } ``` -**Response** +**Response:** Note the `item_id` for use in subsequent steps. @@ -156,7 +156,7 @@ Note the `item_id` for use in subsequent steps. Use the same endpoint to add 50 items of `24-WB03` to the cart. Multiple sources will be required to fulfill this potential order. -**Payload** +**Payload:** ```json { @@ -167,7 +167,7 @@ Use the same endpoint to add 50 items of `24-WB03` to the cart. Multiple sources } } ``` -**Response** +**Response:** Note the `item_id` for use in subsequent steps. @@ -187,7 +187,7 @@ Note the `item_id` for use in subsequent steps. Finally, we'll add a single instance of a downloadable product to the cart. -**Payload** +**Payload:** ```json { @@ -199,7 +199,7 @@ Finally, we'll add a single instance of a downloadable product to the cart. } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/rest/tutorials/inventory/create-customer.md b/guides/v2.3/rest/tutorials/inventory/create-customer.md index e3801bebc71..1575124ea20 100644 --- a/guides/v2.3/rest/tutorials/inventory/create-customer.md +++ b/guides/v2.3/rest/tutorials/inventory/create-customer.md @@ -19,25 +19,25 @@ In this step, we will create a customer account that is tied to the `us` web vie The `GET /V1/store/storeViews` endpoint returns an array of store view IDs, along with the corresponding website and store group IDs. When you create a customer, change the `id` parameter to the `store_id` parameter -**Endpoint** +**Endpoint:** `GET /rest/all/V1/store/storeViews` -**Scope** +**Scope:** `all` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** The value of the `id` and `website_id` parameters for the US Store View is `2`. @@ -82,21 +82,21 @@ The value of the `id` and `website_id` parameters for the US Store View is `2`. We can use the same customer definition presented in [Step 3. Create a customer]({{ page.baseurl }}/rest/tutorials/orders/order-create-customer.html), with the only differences being the scope of the call (`us` instead of `default`) and inserting the `store_id` and `website_id` parameters into the payload. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/customers` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -131,7 +131,7 @@ We can use the same customer definition presented in [Step 3. Create a customer] } ``` -**Response** +**Response:** The customer `id` is `3`. @@ -185,19 +185,19 @@ To generate a customer's access token, you must specify the customer's username By default, a customer token is valid for 1 hour. To change this value, click **Stores** > Settings > **Configuration** > **Services** > **OAuth** > **Access Token Expiration**. Then enter a new value for **Customer Token Lifetime (hours)**. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/integration/customer/token` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` -**Payload** +**Payload:** ```json { @@ -206,7 +206,7 @@ By default, a customer token is valid for 1 hour. To change this value, click ** } ``` -**Response** +**Response:** Magento returns the customer's access token. Your integration must specify a customer token in the authorization header of every call customers make on their own behalf. diff --git a/guides/v2.3/rest/tutorials/inventory/create-invoice.md b/guides/v2.3/rest/tutorials/inventory/create-invoice.md index 6c23a9b95f3..628b728373a 100644 --- a/guides/v2.3/rest/tutorials/inventory/create-invoice.md +++ b/guides/v2.3/rest/tutorials/inventory/create-invoice.md @@ -20,23 +20,23 @@ After you submit the invoice, Magento adjusts the Quantity per Source value for This example creates a full invoice. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/order/3/invoice` where `3` is the `orderid` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -45,7 +45,7 @@ where `3` is the `orderid` } ``` -**Response** +**Response:** An invoice `id`, such as `3`. diff --git a/guides/v2.3/rest/tutorials/inventory/create-order.md b/guides/v2.3/rest/tutorials/inventory/create-order.md index bc1405df4d1..586f703eea2 100644 --- a/guides/v2.3/rest/tutorials/inventory/create-order.md +++ b/guides/v2.3/rest/tutorials/inventory/create-order.md @@ -20,21 +20,21 @@ When you create an order, Magento enters reservations for the total amount of pr When you submit payment information, Magento creates an order and sends an order confirmation to the customer. Since we are using an offline [payment method](https://glossary.magento.com/payment-method) in this tutorial, we do not need to provide detailed payment information. The endpoint used in this example requires only the payment method and billing address information. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/carts/mine/payment-information` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -57,7 +57,7 @@ When you submit payment information, Magento creates an order and sends an order } ``` -**Response** +**Response:** An `orderID`, such as `3` diff --git a/guides/v2.3/rest/tutorials/inventory/create-shipment.md b/guides/v2.3/rest/tutorials/inventory/create-shipment.md index 2a9e7cc1efe..a3053dff0c3 100644 --- a/guides/v2.3/rest/tutorials/inventory/create-shipment.md +++ b/guides/v2.3/rest/tutorials/inventory/create-shipment.md @@ -28,23 +28,23 @@ Although you can use the `POST V1/shipment` endpoint to create a shipment, the ` We'll ship 20 `24-WB01` items and 19 `24-WB03` items from the Baltimore warehouse. The `order_item_id` value for `24-WB01` is 3, and the value for `24-WB03` is 4. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/order/3/ship` where `3` is the `orderid` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -70,7 +70,7 @@ where `3` is the `orderid` } ``` -**Response** +**Response:** The shipment ID, such as `3`. @@ -78,7 +78,7 @@ The shipment ID, such as `3`. Use the same endpoint to ship the remaining 31 `24-WB03` items from the Reno warehouse. -**Payload** +**Payload:** ```json { @@ -100,7 +100,7 @@ Use the same endpoint to ship the remaining 31 `24-WB03` items from the Reno war } ``` -**Response** +**Response:** The shipment ID, such as `4`. @@ -110,21 +110,21 @@ Magento also supports the `POST /V1/shipment` endpoint for sending full or parti ### Ship from the Baltimore warehouse -**Endpoint** +**Endpoint:** `POST /rest/us/V1/shipment` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -159,7 +159,7 @@ Magento also supports the `POST /V1/shipment` endpoint for sending full or parti } ``` -**Response** +**Response:** ```json { @@ -205,7 +205,7 @@ Magento also supports the `POST /V1/shipment` endpoint for sending full or parti Use the same endpoint to ship the remaining 35 `sp2` items from the Reno warehouse. -**Payload** +**Payload:** ```json { @@ -230,7 +230,7 @@ Use the same endpoint to ship the remaining 35 `sp2` items from the Reno warehou } ``` -**Response** +**Response:** ```json { diff --git a/guides/v2.3/rest/tutorials/inventory/create-sources.md b/guides/v2.3/rest/tutorials/inventory/create-sources.md index ea11733ef66..9e10d5546a4 100644 --- a/guides/v2.3/rest/tutorials/inventory/create-sources.md +++ b/guides/v2.3/rest/tutorials/inventory/create-sources.md @@ -30,21 +30,21 @@ The `POST V1/inventory/sources` endpoint creates the Baltimore Warehouse (`balti The `source_code` values will be used in subsequent steps. -**Endpoint** +**Endpoint:** `POST /rest/all/V1/inventory/sources` -**Scope** +**Scope:** `all` store views -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -64,7 +64,7 @@ The `source_code` values will be used in subsequent steps. } ``` -**Response** +**Response:** Magento returns an empty array. diff --git a/guides/v2.3/rest/tutorials/inventory/create-stock.md b/guides/v2.3/rest/tutorials/inventory/create-stock.md index 56625935c6d..4aea4767655 100644 --- a/guides/v2.3/rest/tutorials/inventory/create-stock.md +++ b/guides/v2.3/rest/tutorials/inventory/create-stock.md @@ -24,21 +24,21 @@ For more information about stock, see [Inventory Management overview]({{ page.ba The `POST V1/inventory/stocks` endpoint creates a stock. The `name`, `type`, and `code` attributes are required. The `code` value cannot be changed. -**Endpoint** +**Endpoint:** `POST /rest/all/V1/inventory/stocks` -**Scope** +**Scope:** `all` store views -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** The `name` attribute is required. @@ -59,7 +59,7 @@ The `name` attribute is required. } ``` -**Response** +**Response:** Magento returns the `stock_id`, such as `2`. The value will be used in subsequent steps. diff --git a/guides/v2.3/rest/tutorials/inventory/prepare-for-checkout.md b/guides/v2.3/rest/tutorials/inventory/prepare-for-checkout.md index b459ab7c2cb..e1bbb22682a 100644 --- a/guides/v2.3/rest/tutorials/inventory/prepare-for-checkout.md +++ b/guides/v2.3/rest/tutorials/inventory/prepare-for-checkout.md @@ -21,21 +21,21 @@ Now that all the items have been added to the cart, we can prepare the quote for Magento calculates shipping costs for each shipping method that can be applied to the order. In this tutorial, the `flatrate` ($5 per item) shipping method is active. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/carts/mine/estimate-shipping-methods` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** The payload contains the shipping address. @@ -60,7 +60,7 @@ The payload contains the shipping address. } ``` -**Response** +**Response:** The cost for the `flatrate` shipping method is $350 (70 items x $5 each). The downloadable item does not have a shipping charge because it is not a physical product. @@ -87,21 +87,21 @@ In this call, you specify the shipping and billing addresses, as well as the sel Magento returns a list of payment options and calculates the order totals. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/carts/mine/shipping-information` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -142,7 +142,7 @@ Magento returns a list of payment options and calculates the order totals. } ``` -**Response** +**Response:** The subtotal of the order is $2462, and shipping charges are $350. The grand total is $2812. diff --git a/guides/v2.3/rest/tutorials/inventory/reassign-products-to-another-source.md b/guides/v2.3/rest/tutorials/inventory/reassign-products-to-another-source.md index f340f25b650..a5bff6bf274 100644 --- a/guides/v2.3/rest/tutorials/inventory/reassign-products-to-another-source.md +++ b/guides/v2.3/rest/tutorials/inventory/reassign-products-to-another-source.md @@ -30,21 +30,21 @@ Use the `POST V1/inventory/source-items-delete` endpoint to unassign one or more {:.bs-callout .bs-callout-warning} When you unassign a source from a product, all source data including inventory amounts is removed from that product. This can affect salable quantities and reservations for unprocessed orders. After checkout and before shipment, all product quantities in the order have associated reservations. If you unassign a source, you can cause issues with reservations and processing orders. In a production environment, Magento strongly recommends completing all orders and shipments for those products prior to removing the source. -**Endpoint** +**Endpoint:** `POST /rest/all/V1/inventory/source-items-delete` -**Scope** +**Scope:** `all` store views -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -63,7 +63,7 @@ When you unassign a source from a product, all source data including inventory a } ``` -**Response** +**Response:** Magento returns an empty array. @@ -73,20 +73,20 @@ Magento returns an empty array. Now we can assign each product to one or more sources. The `POST V1/inventory/source-items` endpoint allows you to specify the quantity of each product that is available at each source. -**Endpoint** +**Endpoint:** `POST /rest/all/V1/inventory/source-items` -**Scope** +**Scope:** `all` store views -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer `` -**Payload** +**Payload:** ```json { @@ -159,7 +159,7 @@ Now we can assign each product to one or more sources. The `POST V1/inventory/so } ``` -**Response** +**Response:** Magento returns an empty array. diff --git a/guides/v2.3/rest/tutorials/inventory/run-ssa.md b/guides/v2.3/rest/tutorials/inventory/run-ssa.md index d2387ccb072..062853e9d74 100644 --- a/guides/v2.3/rest/tutorials/inventory/run-ssa.md +++ b/guides/v2.3/rest/tutorials/inventory/run-ssa.md @@ -21,25 +21,25 @@ For more information about shipping and SSAs, see [About Source Selection Algori Currently, Magento supports SSAs based on priority and on distance. Third-party developers and future releases may add support for additional algorithms. -**Endpoint** +**Endpoint:** `GET /rest/us/V1/inventory/source-selection-algorithm-list` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** Not applicable -**Response** +**Response:** ```json [ @@ -62,21 +62,21 @@ The `POST V1/inventory/source-selection-algorithm-result` endpoint uses the algo This tutorial does not consider complications such selling out of products or back ordering. We can ask the SSA to determine the best way to immediately ship all the items ordered (20 items of product `24-WB01` and 50 items of product `24-WB03`). If the `shippable` attribute in the response is `false`, there are not enough salable items to complete a full shipment, but the merchant can still perform a partial shipment. -**Endpoint** +**Endpoint:** `POST /rest/us/V1/inventory/source-selection-algorithm-result` -**Scope** +**Scope:** `us` store view -**Headers** +**Headers:** `Content-Type`: `application/json` `Authorization`: `Bearer ` -**Payload** +**Payload:** ```json { @@ -95,7 +95,7 @@ This tutorial does not consider complications such selling out of products or ba } ``` -**Response** +**Response:** The SSA recommends shipping from the following sources: diff --git a/guides/v2.3/rest/tutorials/orders/order-issue-refund.md b/guides/v2.3/rest/tutorials/orders/order-issue-refund.md index 40b246b81e9..2d2b4e12b8f 100644 --- a/guides/v2.3/rest/tutorials/orders/order-issue-refund.md +++ b/guides/v2.3/rest/tutorials/orders/order-issue-refund.md @@ -33,17 +33,17 @@ If the customer had selected the `flatrate` shipping method ($5 per item), we wo The `return_to_stock_items` array specifies which `order_item_id`s can be returned to stock and be resold. -**Endpoint** +**Endpoint:** `POST /rest//V1/order/5/refund` -**Headers** +**Headers:** `Content-Type` `application/json` `Authorization` `Bearer ` -**Payload** +**Payload:** ```json { @@ -67,7 +67,7 @@ The `return_to_stock_items` array specifies which `order_item_id`s can be return } ``` -**Response** +**Response:** A [credit memo](https://glossary.magento.com/credit-memo) id, such as `3`. diff --git a/marketplace/eqp/v1/auth.md b/marketplace/eqp/v1/auth.md index f8a7930ff42..af1fc1799e0 100644 --- a/marketplace/eqp/v1/auth.md +++ b/marketplace/eqp/v1/auth.md @@ -44,7 +44,7 @@ The following endpoint grants an application session token: POST /rest/v1/app/session/token ``` -**Parameters** +**Parameters:** You must specify the grant type in the request body: @@ -62,7 +62,7 @@ Field details: Other parameters are accepted but ignored. -**Request** +**Request:** The following example shows a request to the sandbox, using the application ID and secret from above: @@ -74,7 +74,7 @@ curl -X POST \ https://developer-stg-api.magento.com/rest/v1/app/session/token ``` -**Response** +**Response:** A successful HTTP 200 OK response will be sent for a valid application ID and secret: diff --git a/marketplace/eqp/v1/files.md b/marketplace/eqp/v1/files.md index da7d8fbb5aa..9efde912308 100644 --- a/marketplace/eqp/v1/files.md +++ b/marketplace/eqp/v1/files.md @@ -36,7 +36,7 @@ Use the upload ID to retrieve details about a file upload. GET /rest/v1/files/uploads/:file_upload_id ``` -**Parameters** +**Parameters:** |Field|Type|Description| |-----|----|-----------| @@ -49,7 +49,7 @@ Sorting and filtering parameters are currently not available for this endpoint. If the `file_upload_id` parameter is specified, a single file record will be returned. If it is omitted, then a batch response will be returned: an array of records for all files uploaded by the current user. -**Request** +**Request:** ```bash curl -X GET \ @@ -57,7 +57,7 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/files/uploads/dhsiXjdksW17623 ``` -**Response** +**Response:** ```json { @@ -140,7 +140,7 @@ Content-Type: application/pdf |filename|string|Should be the original name of the file.| |Content-Type|string|Should be the correct mime-type for the file.| -**Request** +**Request:** If the request body given above was saved into a temporary file at `/tmp/files-payload`, you may use it in your POST request to upload the files: @@ -153,7 +153,7 @@ curl -X POST \ https://developer-stg-api.magento.com/rest/v1/files/uploads ``` -**Response** +**Response:** The above request gives an output similar to: diff --git a/marketplace/eqp/v1/filtering.md b/marketplace/eqp/v1/filtering.md index 678b02d8b2e..24285f1987e 100644 --- a/marketplace/eqp/v1/filtering.md +++ b/marketplace/eqp/v1/filtering.md @@ -54,7 +54,7 @@ GET /rest/v1/products/packages/?submission_id=12345 The difference is that the first returns a single object or an error, while the second returns a list containing zero or one elements. The following request filters all `themes` sorted by `platform` in ascending order and `created_time` in descending order: -**Request** +**Request:** ```bash curl -X GET \ @@ -62,6 +62,6 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/products/packages?type=theme&sort=+platform,-created_time ``` -**Response** +**Response:** A list of theme packages can be returned in the same way as described in [Get package details](packages.html#get-package-details). diff --git a/marketplace/eqp/v1/packages.md b/marketplace/eqp/v1/packages.md index df149bad020..f685b3a8cd8 100644 --- a/marketplace/eqp/v1/packages.md +++ b/marketplace/eqp/v1/packages.md @@ -573,7 +573,7 @@ single submissions must be sent as an array containing one item. If you save the request body to a file, for example, `/tmp/one-click-submission-1.0.0.json`, the following example shows the package submission process: -**Request** +**Request:** ```bash curl -X POST \ @@ -583,7 +583,7 @@ curl -X POST \ https://developer-stg-api.magento.com/rest/v1/products/packages ``` -**Response** +**Response:** ```json [ @@ -633,7 +633,7 @@ The only difference is to supply `submission_id` for each item obtained from the The PUT method also allows for updating a single package with `submission_id` as shown in the following example: -**Request** +**Request:** ```bash curl -X PUT \ @@ -730,7 +730,7 @@ GET /rest/v1/products/packages/item/:item_id/status This sample call lists all packages belonging to a user: -**Request** +**Request:** ```bash curl -X GET \ @@ -738,7 +738,7 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/products/packages ``` -**Response** +**Response:** ```json [ @@ -889,7 +889,7 @@ curl -X GET \ In the previous example, submission `f4eacd72be` failed. Specify the submission_id query parameter to get a more detailed report: -**Request** +**Request:** ```bash curl -X GET \ @@ -897,7 +897,7 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/products/packages/f4eacd72be/status ``` -**Response** +**Response:** ```json { @@ -976,7 +976,7 @@ The following fields enable both sorting and filtering support. Refer to the [Pa A sample cURL request filtering all `themes` sorted by `platform` in ascending order and `created_time` in descending order: -**Request** +**Request:** ```bash curl -X GET \ @@ -984,6 +984,6 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/products/packages?type=theme&sort=+platform,-created_time ``` -**Response** +**Response:** A list of theme packages can be returned in the same way as described in [Get package details](#get-package-details). diff --git a/marketplace/eqp/v1/users.md b/marketplace/eqp/v1/users.md index 005fe901d9c..51b70d04e2d 100644 --- a/marketplace/eqp/v1/users.md +++ b/marketplace/eqp/v1/users.md @@ -27,7 +27,7 @@ You can limit the amount of data that the request returns by using the `style=su The following example shows the request/response body for retrieving all profile data: -**Request** +**Request:** ```bash curl -X GET \ @@ -35,7 +35,7 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/users/MAG123456789 ``` -**Response** +**Response:** ```json { @@ -132,7 +132,7 @@ curl -X GET \ The following example shows the request/response body for retrieving a subset of profile data: -**Request** +**Request:** ```bash curl -X GET \ @@ -140,7 +140,7 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/users/MAG123456789?style=summary ``` -**Response** +**Response:** ```json { @@ -184,7 +184,7 @@ The `action` field specifies which update operation to perform: [Marketplace Store Partners page](https://marketplace.magento.com/partners.html). * `draft` — The update is saved on the Developer Portal, but not published. -**Request** +**Request:** ```bash curl -X PUT \ @@ -224,7 +224,7 @@ The following table lists available query parameters, all of which are optional: The following example shows the request/response body for retrieving keys without any query parameters: -**Request** +**Request:** ```bash curl -X GET \ @@ -232,7 +232,7 @@ curl -X GET \ https://developer-stg-api.magento.com/rest/v1/users/MAG123456789/keys ``` -**Response** +**Response:** ```json { @@ -294,7 +294,7 @@ POST /rest/v1/users/:mage_id/keys } ``` -**Request** +**Request:** ```bash curl -X POST \ @@ -304,7 +304,7 @@ curl -X POST \ https://developer-stg-api.magento.com/rest/v1/users/MAG123456789/keys ``` -**Response** +**Response:** ```json { @@ -342,7 +342,7 @@ You must specify the key-pair in the request using a URL-encoded string. PUT /rest/v1/users/:mage_id/keys/:url_encoded_label_of_m2_key ``` -**Request** +**Request:** ```bash curl -X PUT \ @@ -352,7 +352,7 @@ curl -X PUT \ https://developer-stg-api.magento.com/rest/v1/users/MAG123456789/keys/key_for_bob ``` -**Response** +**Response:** ```json { @@ -377,7 +377,7 @@ DELETE /rest/v1/users/:mage_id/keys/:url_encoded_label_of_m2_key The following curl example illustrates the call to be made: -**Request** +**Request:** ```bash curl -X DELETE \ From 7b317cf818955282c14f260cd4f07fc9d2797084 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Mon, 18 Nov 2019 12:55:01 -0600 Subject: [PATCH 2/4] Added colons to less common psuedo headers --- README.md | 4 +- guides/v2.2/b2b/company-object.md | 2 +- guides/v2.2/b2b/credit-manage.md | 2 +- guides/v2.2/b2b/negotiable-manage.md | 2 +- guides/v2.2/b2b/negotiable-order-workflow.md | 8 ++-- guides/v2.2/b2b/roles.md | 4 +- guides/v2.2/b2b/shared-cat-company.md | 2 +- guides/v2.2/b2b/shared-cat-product-assign.md | 4 +- .../cloud/cdn/cloud-vcl-custom-snippets.md | 2 +- .../cloud/cdn/fastly-image-optimization.md | 2 +- .../v2.2/cloud/cdn/fastly-vcl-badreferer.md | 2 +- guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md | 2 +- .../cloud/live/stage-prod-migrate-prereq.md | 2 +- guides/v2.2/cloud/live/stage-prod-migrate.md | 2 +- guides/v2.2/cloud/reference/cloud-composer.md | 2 +- .../release-notes/cloud-release-archive.md | 22 ++++----- .../code-standard-demarcation.md | 16 +++---- .../coding-standards/code-standard-html.md | 22 ++++----- .../coding-standards/code-standard-less.md | 10 ++-- .../technical-vision/webapi.md | 8 ++-- .../contributor-guide/contributing_dod.md | 4 +- .../number-formats/number-formats.md | 8 ++-- .../admin/placement-and-design.md | 16 +++---- .../storefront/storefront-best-practices.md | 6 +-- .../build/module-file-structure.md | 2 +- guides/v2.2/extension-dev-guide/depend-inj.md | 2 +- guides/v2.2/extension-dev-guide/plugins.md | 2 +- .../extension-dev-guide/prepare/lifecycle.md | 2 +- .../versioning/check-version.md | 2 +- .../layouts/xml-instructions.md | 2 +- .../themes/theme-inherit.md | 6 +-- .../themes/theme-workflow.md | 2 +- .../tools/tools_overview.md | 2 +- .../v2.2/install-gde/basics/basics_login.md | 2 +- .../install-gde/basics/basics_os-version.md | 2 +- .../install/cli/install-cli-backup.md | 2 +- .../install/cli/install-cli-install.md | 2 +- .../javascript/js-resources.md | 6 +-- .../javascript/js_logger.md | 2 +- .../v2.2/mtf/create_test/create_new_test.md | 10 ++-- guides/v2.2/mtf/features/reporting.md | 2 +- .../progressIndicator/progressIndicator.md | 2 +- .../image_uploader/image_uploader.md | 12 ++--- .../pattern-library/navigation/links/links.md | 4 +- .../navigation/wizard/wizard.md | 22 ++++----- guides/v2.2/rest/modules/catalog-pricing.md | 8 ++-- guides/v2.2/rest/tutorials/index.md | 2 +- .../tutorials/orders/order-admin-token.md | 2 +- .../concepts/ui_comp_modifier_concept.md | 6 +-- .../concepts/ui_comp_uiregistry.md | 2 +- .../code-standard-demarcation.md | 46 +++++++++---------- .../build/module-file-structure.md | 2 +- .../extension-dev-guide/prepare/lifecycle.md | 2 +- .../layouts/xml-instructions.md | 2 +- guides/v2.3/graphql/develop/resolvers.md | 4 +- guides/v2.3/graphql/functional-testing.md | 16 +++---- .../inventory/check-salable-quantity.md | 2 +- .../modules/inventory/link-stocks-sources.md | 2 +- .../modules/inventory/manage-low-quantity.md | 2 +- .../modules/inventory/manage-source-items.md | 2 +- .../inventory/manage-source-selection.md | 6 +-- .../rest/modules/inventory/manage-sources.md | 2 +- .../rest/modules/inventory/manage-stocks.md | 2 +- guides/v2.3/rest/tutorials/index.md | 2 +- 64 files changed, 178 insertions(+), 178 deletions(-) diff --git a/README.md b/README.md index 1423ab6eb0a..dd748223ff7 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ ruby -v ### Install the latest Ruby (if the Ruby version is less than 2.4) -**MacOS users** +**MacOS users:** 1. Install Homebrew. See the [Homebrew site](https://brew.sh) for instructions. 1. Use Homebrew to install the latest stable version of Ruby: @@ -37,7 +37,7 @@ ruby -v brew install ruby ``` -**Unix, Windows, and other OS users** +**Unix, Windows, and other OS users:** See the [Ruby site](https://www.ruby-lang.org/en/documentation/installation) for instructions. diff --git a/guides/v2.2/b2b/company-object.md b/guides/v2.2/b2b/company-object.md index 267560dc071..ac8c7389f1d 100644 --- a/guides/v2.2/b2b/company-object.md +++ b/guides/v2.2/b2b/company-object.md @@ -30,7 +30,7 @@ DELETE /V1/company/:companyId GET /V1/company/ ``` -**CompanyInterface Parameters** +**CompanyInterface Parameters:** The following table lists the parameters defined in `CompanyInterface`. diff --git a/guides/v2.2/b2b/credit-manage.md b/guides/v2.2/b2b/credit-manage.md index f2ffbd231f6..eb4ca94a4f8 100644 --- a/guides/v2.2/b2b/credit-manage.md +++ b/guides/v2.2/b2b/credit-manage.md @@ -222,7 +222,7 @@ POST /V1/companyCredits/:creditId/decreaseBalance POST /V1/companyCredits/:creditId/increaseBalance ``` -**Balance Parameters** +**Balance Parameters:** Name | Description | Format | Requirements --- | --- | --- | --- diff --git a/guides/v2.2/b2b/negotiable-manage.md b/guides/v2.2/b2b/negotiable-manage.md index d71655d9ae2..0ebb36b9233 100644 --- a/guides/v2.2/b2b/negotiable-manage.md +++ b/guides/v2.2/b2b/negotiable-manage.md @@ -29,7 +29,7 @@ GET /V1/negotiableQuote/attachmentContent PUT /V1/negotiableQuote/:quoteId/shippingMethod ``` -**NegotiableQuoteManagementInterface Parameters** +**NegotiableQuoteManagementInterface Parameters:** The following table lists the parameters defined in `CompanyInterface`. diff --git a/guides/v2.2/b2b/negotiable-order-workflow.md b/guides/v2.2/b2b/negotiable-order-workflow.md index f813d570c23..8e59261c52a 100644 --- a/guides/v2.2/b2b/negotiable-order-workflow.md +++ b/guides/v2.2/b2b/negotiable-order-workflow.md @@ -54,7 +54,7 @@ Content-Type application/json Authorization Bearer ``` -**Payload 1** +**Payload 1:** ```json { @@ -66,7 +66,7 @@ Authorization Bearer } ``` -**Response 1** +**Response 1:** ```json { @@ -80,7 +80,7 @@ Authorization Bearer } ``` -**Payload 2** +**Payload 2:** ```json { @@ -92,7 +92,7 @@ Authorization Bearer } ``` -**Response 2** +**Response 2:** ```json { diff --git a/guides/v2.2/b2b/roles.md b/guides/v2.2/b2b/roles.md index a2e13c37ceb..5f3e76f1e01 100644 --- a/guides/v2.2/b2b/roles.md +++ b/guides/v2.2/b2b/roles.md @@ -71,7 +71,7 @@ DELETE /V1/company/role/:roleId GET /V1/company/role/ ``` -**RoleInterface Parameters** +**RoleInterface Parameters:** The following table lists the parameters defined in `RoleInterface`. @@ -82,7 +82,7 @@ Name | Description | Format | Requirements `permissions` | A list of resources and permissions granted to the role. See the Permissions array table below for details. | Array[string] | Required to create a role `company_id` | The company associated with this role | integer | Required to create a role -**Permissions array** +**Permissions array:** Name | Description | Format | Requirements --- | --- | --- | --- diff --git a/guides/v2.2/b2b/shared-cat-company.md b/guides/v2.2/b2b/shared-cat-company.md index 0d0199ba48b..779e8aae1e8 100644 --- a/guides/v2.2/b2b/shared-cat-company.md +++ b/guides/v2.2/b2b/shared-cat-company.md @@ -22,7 +22,7 @@ POST /V1/sharedCatalog/:sharedCatalogId/unassignCompanies GET /V1/sharedCatalog/:sharedCatalogId/companies ``` -**Company parameters** +**Company parameters:** {: .bs-callout-info } Although you can specify other parameters defined within a `categories` object, the `id` is the only one used to assign or unassign a category to a shared catalog. diff --git a/guides/v2.2/b2b/shared-cat-product-assign.md b/guides/v2.2/b2b/shared-cat-product-assign.md index 3f2655c955e..70810680836 100644 --- a/guides/v2.2/b2b/shared-cat-product-assign.md +++ b/guides/v2.2/b2b/shared-cat-product-assign.md @@ -33,7 +33,7 @@ POST /V1/sharedCatalog/:id/unassignCategories GET /V1/sharedCatalog/:id/categories ``` -**Category parameters** +**Category parameters:** {: .bs-callout-info } Although you can specify other parameters defined within a `categories` object, the `id` is the only one used to assign or unassign a category to a shared catalog. @@ -144,7 +144,7 @@ POST /V1/sharedCatalog/:id/unassignProducts GET /V1/sharedCatalog/:id/products ``` -**Category parameters** +**Category parameters:** {: .bs-callout-info } Although you can specify other parameters defined within a `products` object, the `sku` is the only one used to assign or unassign a product to a shared catalog. diff --git a/guides/v2.2/cloud/cdn/cloud-vcl-custom-snippets.md b/guides/v2.2/cloud/cdn/cloud-vcl-custom-snippets.md index b5c2e1afcd5..a10ce1e651d 100644 --- a/guides/v2.2/cloud/cdn/cloud-vcl-custom-snippets.md +++ b/guides/v2.2/cloud/cdn/cloud-vcl-custom-snippets.md @@ -96,7 +96,7 @@ See the following examples that show how to create and manage custom VCL snippet The following walk-through shows you how to create regular VCL snippet files and add them to your Fastly service configuration using the Fastly API. You can create and manage the snippets from the _terminal_ application. You do not need an SSH connection into a specific environment. -**Prerequisites** +**Prerequisites:** - Configure your {{ site.var.data.ece }} environment for Fastly services. See [Set up Fastly]({{ page.baseurl }}/cloud/cdn/configure-fastly.html). diff --git a/guides/v2.2/cloud/cdn/fastly-image-optimization.md b/guides/v2.2/cloud/cdn/fastly-image-optimization.md index 2e308cb3e9a..c5e324543cd 100644 --- a/guides/v2.2/cloud/cdn/fastly-image-optimization.md +++ b/guides/v2.2/cloud/cdn/fastly-image-optimization.md @@ -22,7 +22,7 @@ Based on your configuration settings, the Fastly Image Optimization (Fastly IO) You can enable Fastly image optimization (Fastly IO) from the Admin panel by uploading the Fastly IO VCL snippet. When you upload the VCL snippet, it provides the Fastly service with configuration instructions to process all images through image optimizers, using default configurations. -**Prerequisites** +**Prerequisites:** - Install or upgrade to Fastly module version 1.2.62 or later - [Configure Fastly Origin shield and backend]({{ page.baseurl }}/cloud/cdn/configure-fastly.html#backend) diff --git a/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md b/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md index 15d882663d0..03714511508 100644 --- a/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md +++ b/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md @@ -14,7 +14,7 @@ The following example shows how to configure [Fastly Edge Dictionary](https://do {: .bs-callout-info } We recommend adding custom VCL configurations to a Staging environment where you can test them before running them against the Production environment. -**Prerequisites** +**Prerequisites:** - Configure the {{ site.var.data.ece }} environment for Fastly services. See [Set up Fastly]({{ page.baseurl }}/cloud/cdn/configure-fastly.html). diff --git a/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md b/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md index f4203974aca..26f879c8373 100644 --- a/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md +++ b/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md @@ -11,7 +11,7 @@ functional_areas: The following example shows how to use a custom VCL snippet with a [Fastly Access Control List (ACL)](https://docs.fastly.com/guides/access-control-lists/about-acls) to secure access to the Magento Admin UI for a {{ site.data.var.ece }} project environment by client IP address. When you add the custom VCL snippet, Fastly allows only requests from IP addresses included in the ACL. -**Prerequisites** +**Prerequisites:** - Configure the {{ site.var.data.ece }} environment for Fastly services. See [Set up Fastly]({{ page.baseurl }}/cloud/cdn/configure-fastly.html). diff --git a/guides/v2.2/cloud/live/stage-prod-migrate-prereq.md b/guides/v2.2/cloud/live/stage-prod-migrate-prereq.md index 2f576a1e3db..bfbdfa40ea8 100644 --- a/guides/v2.2/cloud/live/stage-prod-migrate-prereq.md +++ b/guides/v2.2/cloud/live/stage-prod-migrate-prereq.md @@ -26,7 +26,7 @@ For Starter, merge all code into a "staging" branch for testing prior to deployi You can deploy to Starter environments from the Project Web Interface or using CLI commands. -**Prerequisites** +**Prerequisites:** 1. Get your [access URLs and SSH](#starter-urls) information. 1. [Add your public SSH key](#add-public-ssh-key) to your project. diff --git a/guides/v2.2/cloud/live/stage-prod-migrate.md b/guides/v2.2/cloud/live/stage-prod-migrate.md index 560ea973560..f1c9fda6d40 100644 --- a/guides/v2.2/cloud/live/stage-prod-migrate.md +++ b/guides/v2.2/cloud/live/stage-prod-migrate.md @@ -49,7 +49,7 @@ For Starter, deploy the development branch you created to Staging and Production You can use the [Magento Cloud CLI commands]({{ page.baseurl }}/cloud/reference/cli-ref-topic.html) to deploy code to Starter and Pro environments. You need SSH and Git access to your project. See [prepare for deployment]({{ page.baseurl}}/cloud/live/stage-prod-migrate-prereq.html). -**Prerequisites** +**Prerequisites:** - [Build and deploy on local]({{ page.baseurl }}/cloud/live/live-sanity-check.html) - [Prepare to deploy to Staging and Production]({{ page.baseurl }}/cloud/live/stage-prod-migrate-prereq.html) diff --git a/guides/v2.2/cloud/reference/cloud-composer.md b/guides/v2.2/cloud/reference/cloud-composer.md index 5abdbfe6cd8..57626d961cf 100644 --- a/guides/v2.2/cloud/reference/cloud-composer.md +++ b/guides/v2.2/cloud/reference/cloud-composer.md @@ -20,7 +20,7 @@ Magento extension and module developers use the `composer.json` file to manage p The `composer.lock` file stores a set of exact version dependencies that satisfy all of the version constraints of every requirement for every package in the dependency tree of the project. -**Common commands** +**Common commands:** Command | Description --- | --- diff --git a/guides/v2.2/cloud/release-notes/cloud-release-archive.md b/guides/v2.2/cloud/release-notes/cloud-release-archive.md index ecbdb1effed..8fb1db83a30 100644 --- a/guides/v2.2/cloud/release-notes/cloud-release-archive.md +++ b/guides/v2.2/cloud/release-notes/cloud-release-archive.md @@ -10,7 +10,7 @@ functional_areas: {:.bs-callout .bs-callout-info} We merged [`vendor/magento/ece-patches`]({{ site.baseurl }}/guides/v2.2/cloud/composer-packages/ece-patches.html) with `vendor/magento/ece-tools` in this release. You no longer need to update the `vendor/magento/ece-patches` package separately. -**New features** +**New features:** - **Improved logging** - We improved log messaging to provide better explanations when the build or deploy process overrides an environment variable. @@ -32,7 +32,7 @@ We merged [`vendor/magento/ece-patches`]({{ site.baseurl }}/guides/v2.2/cloud/co - We implemented smart patching. Now the package applies patches based not on {{site.data.var.ece}} version, but on patched package version. -**Resolved issues** +**Resolved issues:** - We fixed a logging issue that was causing build errors. @@ -56,13 +56,13 @@ We merged [`vendor/magento/ece-patches`]({{ site.baseurl }}/guides/v2.2/cloud/co ## v2002.0.7 -**Resolved issues** +**Resolved issues:** - We removed `var/view_preprocessed` symlinking to fix an issue that was causing JavaScript minification conflicts. ## v2002.0.6 -**Resolved issues** +**Resolved issues:** - We fixed an issue that was causing `gzip` errors when a file or directory name contains spaces. @@ -70,7 +70,7 @@ We merged [`vendor/magento/ece-patches`]({{ site.baseurl }}/guides/v2.2/cloud/co ## v2002.0.5 -**New features** +**New features:** - **Configure a cron consumer with an environment variable**—You can now configure cron consumers using the new `CRON_CONSUMERS_RUNNER` environment variable. @@ -90,7 +90,7 @@ We merged [`vendor/magento/ece-patches`]({{ site.baseurl }}/guides/v2.2/cloud/co - **Cron interval limitations lifted**—The default cron interval for all environments provisioned in the us-3, eu-3, and ap-3 regions is 1 minute. The default cron interval in all other regions is 5 minutes for Pro Integration environments and 1 minute for Pro Staging and Production environments. To modify your existing cron jobs, edit your settings in `.magento.app.yaml` or create a support ticket for Production/Staging environments. Refer to [Set up cron jobs]({{ site.baseurl }}/guides/v2.2/cloud/configure/setup-cron-jobs.html) for more information. -**Resolved issues** +**Resolved issues:** - We fixed an issue that was causing long deploy times due to the deploy process invoking the `cache-clean` operation before static content deployment. @@ -110,31 +110,31 @@ We merged [`vendor/magento/ece-patches`]({{ site.baseurl }}/guides/v2.2/cloud/co ## v2002.0.4 -**Resolved issues** +**Resolved issues:** - You can now [manually reset stuck Magento cron jobs]({{ site.baseurl }}/guides/v2.2/cloud/trouble/reset-cron-jobs.html) using a CLI command in all environments via SSH access. The deployment process automatically resets cron jobs. ## v2002.0.3 -**Resolved issues** +**Resolved issues:** - We fixed an issue that was causing pages to time out because Redis was taking too long to read/write. You can now use the `disable_locking` parameter in Redis configurations to prevent this issue. ## v2002.0.2 -**Resolved issues** +**Resolved issues:** - The RabbitMQ configuration process now obtains all required parameters automatically. ## v2002.0.1 -**New features** +**New features:** - {{site.data.var.ece}} now supports scopes and [static content deployment strategies]({{ site.baseurl }}/guides/v2.2/config-guide/cli/config-cli-subcommands-static-deploy-strategies.html). We have added the `–s` parameter with a default setting of `quick` for the static content deployment strategy. You can use the environment variable [SCD_STRATEGY]({{ site.baseurl }}/guides/v2.2/cloud/env/variables-deploy.html) to customize and use these strategies with your build and deploy actions. This variable supports the options `standard`, `quick`, or `compact`. If you select `compact`, we override the `STATIC_CONTENT_THREADS` value with `1`, which can slow deployment, especially in production environments. Not available in 2.1. - We have created a log file on environments to capture and compile build and deploy actions. The file is located in the `var/log/cloud.log` file inside the Magento root application directory. -**Resolved issues** +**Resolved issues:** - Refactored the `{{site.data.var.ct}}` package to make it compatible with {{site.data.var.ece}} 2.2.0 and higher. diff --git a/guides/v2.2/coding-standards/code-standard-demarcation.md b/guides/v2.2/coding-standards/code-standard-demarcation.md index b0d7c036e87..6a209a1d7f8 100644 --- a/guides/v2.2/coding-standards/code-standard-demarcation.md +++ b/guides/v2.2/coding-standards/code-standard-demarcation.md @@ -28,7 +28,7 @@ Use [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt) to interpret the "MUST," "MU Helps simplify and unify naming conventions that are used to apply visual styles to page elements. -**Acceptable** +**Acceptable:** ```html
@@ -38,7 +38,7 @@ Helps simplify and unify naming conventions that are used to apply visual styles Scroll to text ``` -**Unacceptable** +**Unacceptable:** ```html
@@ -57,7 +57,7 @@ Helps simplify and unify naming conventions that are used to apply visual styles - Forces engineers to think about reusable page components instead of unique singleton components. - Reduces long-term maintenance efforts. -**Acceptable PHTML template** +**Acceptable PHTML template:** The following acceptable example is terse and uses an Accessible Rich Internet Applications (ARIA) approach. @@ -74,7 +74,7 @@ The following acceptable example is terse and uses an Accessible Rich Internet A Scroll to text ``` -**Unacceptable combination of PHTML, JavaScript, and CSS files** +**Unacceptable combination of PHTML, JavaScript, and CSS files:** The following unacceptable example replaces a single PHTML file with a combination of a PHTML, JavaScript, and CSS files. @@ -86,13 +86,13 @@ The following unacceptable example replaces a single PHTML file with a combinati ``` -**JavaScript file** +**JavaScript file:** ```js $('#my-special-menu').on('click','li[id^="button"]', function() { ... }) ``` -**CSS file** +**CSS file:** ```css #my-special-menu { ... } @@ -283,7 +283,7 @@ $('[role="menu"]').navigation(); HTML helper class names added in JavaScript REQUIRE underscore symbol ("_") at the beginning and must be written in lowercase. -**Acceptable** +**Acceptable:** ```html
Content
@@ -292,7 +292,7 @@ HTML helper class names added in JavaScript REQUIRE underscore symbol ("_") at t
Content
``` -**Unacceptable** +**Unacceptable:** ```html
Content
diff --git a/guides/v2.2/coding-standards/code-standard-html.md b/guides/v2.2/coding-standards/code-standard-html.md index 51160b6a8a5..6057512c7f2 100644 --- a/guides/v2.2/coding-standards/code-standard-html.md +++ b/guides/v2.2/coding-standards/code-standard-html.md @@ -21,7 +21,7 @@ Use only spaces for indentation: * Indent size: 4 spaces * Continuation indent: 4 spaces -**Recommended** +**Recommended:** ```html
    @@ -38,7 +38,7 @@ Add a blank line at the end of file. Always close self-closing tags. -**Inappropriate** +**Inappropriate:** ```html
    @@ -46,7 +46,7 @@ Always close self-closing tags. ``` -**Recommended** +**Recommended:** ```html
    @@ -58,13 +58,13 @@ Always close self-closing tags. Avoid code lines longer than 120 characters. When using an editor, it is inconvenient to scroll right and left to read the HTML code. Align tag attributes one under another to increase code readability. -**Inappropriate** +**Inappropriate:** ```html ``` -**Recommended** +**Recommended:** ```html ``` -**Recommended** +**Recommended:** ```html @@ -98,14 +98,14 @@ Spaces around equals sign ("=") are acceptable, but not recommended. The code wi Use no space before the colon and one space after the colon for the sake of readability. -**Not recommended** +**Not recommended:** ```html ``` -**Recommended** +**Recommended:** ```html @@ -121,13 +121,13 @@ Use appropriate HTML5 elements for blocks. The following diagram shows how to de Use semantic class names and IDs. Avoid presentational class names. -**Inappropriate** +**Inappropriate:** ```html ``` -**Recommended** +**Recommended:** ```html diff --git a/guides/v2.2/coding-standards/code-standard-less.md b/guides/v2.2/coding-standards/code-standard-less.md index b79bf08e35c..2369c4a965b 100644 --- a/guides/v2.2/coding-standards/code-standard-less.md +++ b/guides/v2.2/coding-standards/code-standard-less.md @@ -228,7 +228,7 @@ Add a semicolon after property. Avoid using the `!important` property if possible. If it is required, add a space before the property. -**Correct** +**Correct:** ```css .jquery-ui-calendar-item { @@ -249,7 +249,7 @@ Avoid using the `!important` property if possible. If it is required, add a spac First and second level comments must be surrounded by empty lines. First, second and third level comments should have two spaces after "//". Inline comments should have one space after "//". -**Correct** +**Correct:** ```css // @@ -346,7 +346,7 @@ Helper class names should be lowercase and start with underscore ("_"). Some parts of Magento code might not comply with this standard yet. You might still find helper names with no underscores. We are working to gradually remove the inconsistency. -**Example**: +**Example:**: ```css ._active { @@ -640,7 +640,7 @@ color: #ff0000; If variables are local and used only in a [module](https://glossary.magento.com/module) scope, they should be located in the module file, in the beginning of the general comment. -**Example** `_module.less`: +**Example:** `_module.less`: ```css ... @@ -728,7 +728,7 @@ For [mixin](https://glossary.magento.com/mixin) naming apply the class naming ru For mixins grouping use the double underscore "__" prefix. -**Example**: +**Example:**: ```css .extend__clearfix (...) { diff --git a/guides/v2.2/coding-standards/technical-vision/webapi.md b/guides/v2.2/coding-standards/technical-vision/webapi.md index 715e4c2691f..db32c50e06b 100644 --- a/guides/v2.2/coding-standards/technical-vision/webapi.md +++ b/guides/v2.2/coding-standards/technical-vision/webapi.md @@ -70,7 +70,7 @@ To extend an interface, use [extension attributes]({{ page.baseurl }}/extension- Any new design related to Web API must satisfy the following constraints to keep the model consistency. -**General** +**General:** 1. REST and SOAP must be designed for Admin Panel integrations and be equal in terms of coverage. GraphQL should be designed for storefront scenarios. 1. Any identifier exposed in guest APIs (for example, cart ID) must be masked to prevent the possibility of unauthorized access to the data of other guest users. @@ -86,7 +86,7 @@ Any new design related to Web API must satisfy the following constraints to keep 1. Internal server errors must be masked and never shown to the user in production mode. In developer mode, original exceptions must never be masked and should be displayed along with the related stacktrace. 1. Pagination must be supported by all list operations. -**GraphQL** +**GraphQL:** 1. Unlimited nesting should be supported during requests for related entities. (For example, get Order => Order Items => Products => Related Products) 1. Field filtration must be performed with SQL queries. Do not filter on the application layer after you've fetched all possible fields. @@ -96,7 +96,7 @@ Any new design related to Web API must satisfy the following constraints to keep 1. All queries must return the 200 HTTP status code. If an error occurs, return the error in the response body. A 500 status code is allowed when an exception occurs when generating a schema, but not during requests. 1. The Store code should be passed via headers. -**REST** +**REST:** 1. The resource URL should be versioned (for example: V1). The version must be specified in the following format: `V\d.+` 1. Resource names in a URL should be in plural form (for example: products, carts) @@ -108,7 +108,7 @@ Any new design related to Web API must satisfy the following constraints to keep 1. Responses must return responses with standard [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). 1. The store code must be passed via URL. For example `GET /rest/frenchStoreView/V1/products`. Persistence operations that should be performed for all stores at once, should have 'all' store code in the URL. -**SOAP** +**SOAP:** 1. SOAP is designed for systems integration. It supports token authentication for customers and admins, as well as no authentication for anonymous service methods. Cookie authentication and OAuth 1.0 are not supported. 1. The schema is available in the form of a WSDL for all exposed services. diff --git a/guides/v2.2/contributor-guide/contributing_dod.md b/guides/v2.2/contributor-guide/contributing_dod.md index d648a6ab653..8d0fea9595f 100644 --- a/guides/v2.2/contributor-guide/contributing_dod.md +++ b/guides/v2.2/contributor-guide/contributing_dod.md @@ -174,7 +174,7 @@ For example: * Scan for all XML-files of certain type and validate them using appropriate XML-schema. * Scan for declarations of templates and invoke "fallback" mechanism to ensure they resolve. -**Static Code Analysis** +**Static Code Analysis:** Code to cover: @@ -182,7 +182,7 @@ Code to cover: Expected code coverage: must cover all applicable files in entire code base. -**Legacy Tests** +**Legacy Tests:** Code to cover: diff --git a/guides/v2.2/design-styleguide/number-formats/number-formats.md b/guides/v2.2/design-styleguide/number-formats/number-formats.md index e2c0c48020f..28107e5f561 100644 --- a/guides/v2.2/design-styleguide/number-formats/number-formats.md +++ b/guides/v2.2/design-styleguide/number-formats/number-formats.md @@ -102,7 +102,7 @@ This is how we write about money: * Years ... *Correct example:* Use "2017", not "'17". -**Correct Examples** +**Correct Examples:** * The conference begins ... @@ -120,7 +120,7 @@ This is how we write about money: ### Times -**General Usage** +**General Usage:** * Formatting. Use numerals and "am" or "pm" without a space. Example: 10am. @@ -130,7 +130,7 @@ This is how we write about money: * Use "noon" and "midnight". Do not use 12pm and 12am. -**Time Ranges** +**Time Ranges:**
    • Use a hyphen between times to indicate a time period. Example: 7am-10:30pm.
      • @@ -150,7 +150,7 @@ This is how we write about money:
    -**Time Zones** +**Time Zones:** * Formatting. When a time is not adjusted by the system to reflect the current time zone, append the time zone after the time. ... *Correct examples:* "7:30am CT", "7-10:30am CT" diff --git a/guides/v2.2/ext-best-practices/admin/placement-and-design.md b/guides/v2.2/ext-best-practices/admin/placement-and-design.md index d6c29c1c9ff..bb90286a82c 100644 --- a/guides/v2.2/ext-best-practices/admin/placement-and-design.md +++ b/guides/v2.2/ext-best-practices/admin/placement-and-design.md @@ -42,13 +42,13 @@ From the list of extension types below, determine the type of extension you have These extensions provide additional [API](https://glossary.magento.com/api) over Magento's existing API and is responsible for providing settings between Magento and another system. -**Placement** +**Placement:** All required settings for this connector type should appear in the **Stores** > **Settings** > **Configuration** section. The actual listings for these extension settings should appear after all of Magento's listed settings. All the setting details and configurations should appear in the section to the right. ![Connector settings placement]({{ site.baseurl }}/common/images/ext-best-practices/connector-settings-placement.png) -**Style** +**Style:** * The style of the listing for your settings should match the look of Magento's listed settings. * Icons or images should not be used in the navigation listing for your settings. @@ -60,7 +60,7 @@ All required settings for this connector type should appear in the **Stores** > These extensions are responsible for integrating with different systems and need additional settings displayed under specific entries in the **Store** > **Settings** > **Configuration** section. -**Placement** +**Placement:** The settings for these extensions should be displayed under its respective parent section under the **Store** > **Settings > **Configuration** section. @@ -74,7 +74,7 @@ For example, if the extension is for Shipping, then you can place it under **Sto These extensions are responsible for integrating with different systems and need additional settings and configurations for synchronizing with these systems. -**Placement** +**Placement:** If all the settings for an extension can be consolidated into one section, then the extension can be added to one of the primary navigation's submenu as links under the appropriate parent item. Avoid placing extension settings in multiple sections, such as the Configuration section and another related section. @@ -82,7 +82,7 @@ For example, if your extension is related to the "Reports" functionality then it ![Connector with additional features placement]({{ site.baseurl }}/common/images/ext-best-practices/additional-feature-placement.png) -**Style** +**Style:** * The styles of the links in the admin should follow the same styles of the default Magento Navigation Links. * Do not introduce custom icons in the navigation submenus. @@ -93,7 +93,7 @@ For example, if your extension is related to the "Reports" functionality then it These are extensions which provide additional functionality to Magento that do not already exist as a feature. These extensions usually demand an additional primary navigation item. -**Placement** +**Placement:** There will be a new, dedicated section designed for such exclusive extensions. When feature-level extensions are installed, those extensions will live under this section. The exact final name of this new section has not been decided (we welcome your feedback), but in the image below it is named Extensions. @@ -111,7 +111,7 @@ Since this section is not yet available, you should place your extension in one These are add-ons to existing Magento feature and might appear as a nested feature. -**Placement** +**Placement:** As these are integrated features no direct/indirect accessible links are available from the admin. @@ -121,6 +121,6 @@ As these are integrated features no direct/indirect accessible links are availab These extensions are created as a code and do not need to have a representation in the admin panel. -**Placement** +**Placement:** As these extensions do not have additional settings no direct/indirect accessible links are available from the admin. diff --git a/guides/v2.2/ext-best-practices/storefront/storefront-best-practices.md b/guides/v2.2/ext-best-practices/storefront/storefront-best-practices.md index dd28b70a2c3..45670ace391 100644 --- a/guides/v2.2/ext-best-practices/storefront/storefront-best-practices.md +++ b/guides/v2.2/ext-best-practices/storefront/storefront-best-practices.md @@ -15,7 +15,7 @@ Forgetting to clear or disable caching can cause a lot of development headache. You can manage your cache in the [Admin](https://glossary.magento.com/admin) section under **System** > Tools > **Cache Management**. -**Recommended Reading** +**Recommended Reading:** * [Clear directories during development]({{ page.baseurl }}/howdoi/php/php_clear-dirs.html) @@ -23,7 +23,7 @@ You can manage your cache in the [Admin](https://glossary.magento.com/admin) sec When developing your theme extension, you should check how it looks using different resolutions or devices. We recommend you apply [responsive web design(RWD)](https://en.wikipedia.org/wiki/Responsive_web_design){:target="_blank"} concepts to optimize the look and feel of your theme on different devices and resolutions. To help you with this task, both [Chrome](https://developer.chrome.com/devtools){:target="_blank"} and [Firefox](https://developer.mozilla.org/en-US/docs/Tools){:target="_blank"} web browsers have built-in developer tools that allow you to view your theme under different resolutions. -**Recommended Reading** +**Recommended Reading:** * [How to make your theme responsive and mobile]({{ page.baseurl }}/frontend-dev-guide/responsive-web-design/rwd_overview.html) @@ -31,6 +31,6 @@ When developing your theme extension, you should check how it looks using differ There is a lot of work in building a theme extension for Magento from scratch. This is why we recommend you inherit and customize an existing theme. Magento comes with both Blank and Luma themes after initial install. You can leverage the work already done to make those two themes responsive by setting one of them as your theme's parent. -**Recommended Reading** +**Recommended Reading:** * [Theme inheritance]({{ page.baseurl }}/frontend-dev-guide/themes/theme-inherit.html) diff --git a/guides/v2.2/extension-dev-guide/build/module-file-structure.md b/guides/v2.2/extension-dev-guide/build/module-file-structure.md index 4971c5b5513..5b41c815e6a 100644 --- a/guides/v2.2/extension-dev-guide/build/module-file-structure.md +++ b/guides/v2.2/extension-dev-guide/build/module-file-structure.md @@ -102,6 +102,6 @@ For more details on the theme folder structure, see [Magento theme structure]({{ {% include php-dev/lang-pack-file-struct.md %} -**Next** +**Next:** [Register your component]({{ page.baseurl }}/extension-dev-guide/build/component-registration.html) diff --git a/guides/v2.2/extension-dev-guide/depend-inj.md b/guides/v2.2/extension-dev-guide/depend-inj.md index 68d99122d9e..f2b62d3e7bf 100644 --- a/guides/v2.2/extension-dev-guide/depend-inj.md +++ b/guides/v2.2/extension-dev-guide/depend-inj.md @@ -106,7 +106,7 @@ Since you cannot specify this data in the constructor signature, Magento cannot To get around this limitation, injectable objects can depend on [factories] that produce newable objects. -**Related topics** +**Related topics:** * [The `di.xml` file]({{ page.baseurl }}/extension-dev-guide/build/di-xml-file.html) * [ObjectManager]({{ page.baseurl }}/extension-dev-guide/object-manager.html) diff --git a/guides/v2.2/extension-dev-guide/plugins.md b/guides/v2.2/extension-dev-guide/plugins.md index f731b607f4f..2f8e17fe6a7 100644 --- a/guides/v2.2/extension-dev-guide/plugins.md +++ b/guides/v2.2/extension-dev-guide/plugins.md @@ -304,7 +304,7 @@ The prioritization rules for ordering plugins: * During each plugin execution, the current plugin will first finish executing its around method. * When the around method completes, the plugin executes its after method before moving on to the next plugin. -**Example** +**Example:** The table shows the plugins observing the same method with the following properties: diff --git a/guides/v2.2/extension-dev-guide/prepare/lifecycle.md b/guides/v2.2/extension-dev-guide/prepare/lifecycle.md index 265149462d4..bc41121539d 100644 --- a/guides/v2.2/extension-dev-guide/prepare/lifecycle.md +++ b/guides/v2.2/extension-dev-guide/prepare/lifecycle.md @@ -281,7 +281,7 @@ However, module-specific configurations such as its dependency injection and eve Avoid this situation by not including dependencies in your uninstall event class -**Related Topics** +**Related Topics:** * Magento's [versioning policy] diff --git a/guides/v2.2/extension-dev-guide/versioning/check-version.md b/guides/v2.2/extension-dev-guide/versioning/check-version.md index c31bd0f9bbb..24edbec1a10 100644 --- a/guides/v2.2/extension-dev-guide/versioning/check-version.md +++ b/guides/v2.2/extension-dev-guide/versioning/check-version.md @@ -16,7 +16,7 @@ Use any of the following ways to determine which version of Magento is installed The following command returns the Magento version. -**Command** +**Command:** ```bash bin/magento --version diff --git a/guides/v2.2/frontend-dev-guide/layouts/xml-instructions.md b/guides/v2.2/frontend-dev-guide/layouts/xml-instructions.md index 5956a416573..49ae0ff4817 100644 --- a/guides/v2.2/frontend-dev-guide/layouts/xml-instructions.md +++ b/guides/v2.2/frontend-dev-guide/layouts/xml-instructions.md @@ -274,7 +274,7 @@ To pass multiple arguments use the following construction: Arguments values set in a layout file can be accessed in [templates] using the `getData('{ArgumentName}')` and `hasData('{ArgumentName}')` methods. The latter returns a boolean defining whether there's any value set. `{ArgumentName}` is obtained from the `name` attribute the following way: for getting the value of `` the method name is `getData('some_string')`. -**Example**: +**Example:**: Setting a value of `css_class` in the `[app/code/Magento/Theme/view/frontend/layout/default.xml]` layout file: diff --git a/guides/v2.2/frontend-dev-guide/themes/theme-inherit.md b/guides/v2.2/frontend-dev-guide/themes/theme-inherit.md index 66d2f52ba6b..7314d3d5aab 100644 --- a/guides/v2.2/frontend-dev-guide/themes/theme-inherit.md +++ b/guides/v2.2/frontend-dev-guide/themes/theme-inherit.md @@ -81,7 +81,7 @@ If module context is defined for a file: 1. Module static view files for the `frontend` area: `/view/frontend/web/` 1. Module static view files for the `base` area: `/view/base/web/` -**Example** +**Example:** A company named OrangeCo created a theme named Orange. The theme files are located in `app/design/frontend/OrangeCo/orange`. Orange inherits from the Magento Blank theme. @@ -110,7 +110,7 @@ So if you need to customize a certain template, you need to create an overriding For example, if you must override the `/view/frontend/templates/category/widget/link/link_block.phtml` template, the `` is `category/widget/link/` -**Example** +**Example:** By default, according to the module template, in the mini [shopping cart](https://glossary.magento.com/shopping-cart) products are listed under the Go to [Checkout](https://glossary.magento.com/checkout) button: ![In the minishopping cart products are listed under the Go to Checkout button]({{ site.baseurl }}/common/images/inherit_mini1.png) @@ -144,7 +144,7 @@ To add an extending layout file: * Put your custom layout file in the `/_/layout/` directory. -**Example** +**Example:** OrangeCo decided they should remove the "Report bugs" link from the footer, defined in `/view/frontend/layout/default.xml` To do this, they added an extending layout in `app/design/frontend/OrangeCo/orange/Magento_Theme/layout/default.xml` : diff --git a/guides/v2.2/frontend-dev-guide/themes/theme-workflow.md b/guides/v2.2/frontend-dev-guide/themes/theme-workflow.md index a6880cae6d4..efbe28db2da 100644 --- a/guides/v2.2/frontend-dev-guide/themes/theme-workflow.md +++ b/guides/v2.2/frontend-dev-guide/themes/theme-workflow.md @@ -7,7 +7,7 @@ functional_areas: --- Continue From: -**Install Magento** +**Install Magento:** ### Enable development mode diff --git a/guides/v2.2/frontend-dev-guide/tools/tools_overview.md b/guides/v2.2/frontend-dev-guide/tools/tools_overview.md index de7accf40b2..6443141e900 100644 --- a/guides/v2.2/frontend-dev-guide/tools/tools_overview.md +++ b/guides/v2.2/frontend-dev-guide/tools/tools_overview.md @@ -8,6 +8,6 @@ functional_areas: This chapter describes how to install and use additional tools that can make your Magento frontend development tasks easier. -**Chapter Contents** +**Chapter Contents:** - [Using Grunt for Magento tasks]({{ page.baseurl }}/frontend-dev-guide/tools/using_grunt.html) diff --git a/guides/v2.2/install-gde/basics/basics_login.md b/guides/v2.2/install-gde/basics/basics_login.md index be602e8802f..b2cba1a0a49 100644 --- a/guides/v2.2/install-gde/basics/basics_login.md +++ b/guides/v2.2/install-gde/basics/basics_login.md @@ -13,7 +13,7 @@ functional_areas: To complete almost all of the tasks in this guide, you must remotely log in to your Magento server. -**Prerequisites**: You must have: +**Prerequisites:**: You must have: * A terminal application diff --git a/guides/v2.2/install-gde/basics/basics_os-version.md b/guides/v2.2/install-gde/basics/basics_os-version.md index 72895ffbdc3..68e582a7e84 100644 --- a/guides/v2.2/install-gde/basics/basics_os-version.md +++ b/guides/v2.2/install-gde/basics/basics_os-version.md @@ -9,7 +9,7 @@ functional_areas: How can you tell what operating system and version your Magento server runs? -**Prerequisites**: You must access the server using a command prompt (an application that enables you to enter commands directly). +**Prerequisites:**: You must access the server using a command prompt (an application that enables you to enter commands directly). If you can log in directly to the machine, the application is usually called Terminal. diff --git a/guides/v2.2/install-gde/install/cli/install-cli-backup.md b/guides/v2.2/install-gde/install/cli/install-cli-backup.md index 71d6b7a0e2b..b3485d81c10 100644 --- a/guides/v2.2/install-gde/install/cli/install-cli-backup.md +++ b/guides/v2.2/install-gde/install/cli/install-cli-backup.md @@ -34,7 +34,7 @@ bin/magento config:set system/backup/functionality_enabled 1 ``` {:.bs-callout .bs-callout-warning} -**Deprecation Notice** +**Deprecation Notice:** Magento backup functionality is deprecated as of 2.1.16, 2.2.7, and 2.3.0. We recommend investigating additional backup technologies and binary backup tools (such as Percona XtraBackup). ## Set ulimit for the web server user {#instgde-cli-ulimit} diff --git a/guides/v2.2/install-gde/install/cli/install-cli-install.md b/guides/v2.2/install-gde/install/cli/install-cli-install.md index 3ca757842f3..e3ba3703a23 100644 --- a/guides/v2.2/install-gde/install/cli/install-cli-install.md +++ b/guides/v2.2/install-gde/install/cli/install-cli-install.md @@ -71,7 +71,7 @@ The following tables describe the installation option names and values. For exam {: .bs-callout-info } Any options that contain spaces or special characters must be enclosed in either single or double quotes. -**Admin credentials** +**Admin credentials:** The following options specify the user information and credentials for the Magento admin user. diff --git a/guides/v2.2/javascript-dev-guide/javascript/js-resources.md b/guides/v2.2/javascript-dev-guide/javascript/js-resources.md index 31fcbfc46b0..920418b4329 100644 --- a/guides/v2.2/javascript-dev-guide/javascript/js-resources.md +++ b/guides/v2.2/javascript-dev-guide/javascript/js-resources.md @@ -35,7 +35,7 @@ We recommend specifying JavaScript resources in the templates rather than in the JS resources are accessed using relative paths. -**Example 1** +**Example 1:** * File actual location: `app/code/Magento/ConfigurableProduct/view/frontend/web/js/configurable.js` * File published to `pub/static`: `pub/static/frontend/Magento///Magento_ConfigurableProduct/js/configurable.js`. Here `` and `` are the currently applied in your instance [theme](https://glossary.magento.com/theme) and [locale](https://glossary.magento.com/locale). @@ -46,7 +46,7 @@ JS resources are accessed using relative paths. }); ``` -**Example 2** +**Example 2:** * File actual location: `app/design/frontend/Magento/blank/Magento_Theme/web/js/theme.js` * File published to `pub/static`: `pub/static/frontend/Magento///js/theme.js` @@ -57,7 +57,7 @@ JS resources are accessed using relative paths. }); ``` -**Example 3** +**Example 3:** * File actual location: `lib/web/jquery.js` * File published to `pub/static`: `pub/static//Magento///jquery.js` diff --git a/guides/v2.2/javascript-dev-guide/javascript/js_logger.md b/guides/v2.2/javascript-dev-guide/javascript/js_logger.md index 66ca9cc5582..cda6670384d 100644 --- a/guides/v2.2/javascript-dev-guide/javascript/js_logger.md +++ b/guides/v2.2/javascript-dev-guide/javascript/js_logger.md @@ -106,7 +106,7 @@ Returns all available log entries. It can additionally filter out the entries th - `level: number`: Entry's level. - `data?: Object`: Additional data associated with the entry. -**Properties** +**Properties:** - `message: string`: Entry's message. diff --git a/guides/v2.2/mtf/create_test/create_new_test.md b/guides/v2.2/mtf/create_test/create_new_test.md index 7be9f3e16d3..5d23e1f71fc 100644 --- a/guides/v2.2/mtf/create_test/create_new_test.md +++ b/guides/v2.2/mtf/create_test/create_new_test.md @@ -554,7 +554,7 @@ The SynonymsIndex.xml page must contain the following block to be able to run th Now you can run `generate.php` as we did before to re-generate page classes. -**How to code 'Enter data according to a data set'** +**How to code 'Enter data according to a data set':** We need to enter data from a data set into the form fields. @@ -570,7 +570,7 @@ The `Search/Test` directory in functional tests should be constructed in a simil We need a `fill()` method from the [`\Magento\Mtf\Block\Form`][] class and a mapping file. -**Form mapping** +**Form mapping:** [Learn about form mapping.][]. @@ -631,7 +631,7 @@ In previous step, we created blocks with methods that enable us to perform the r To associate methods with [pages][], blocks must be added to pages. -**Search Synonym page** +**Search Synonym page:** A corresponding page object in a functional test is `/dev/tests/functional/tests/app/Magento/Search/Test/Page/Adminhtml/SynonymsIndex.xml` @@ -646,7 +646,7 @@ The page with a block: ``` -**New Synonym Group page** +**New Synonym Group page:** A corresponding page object in a functional test is `/dev/tests/functional/tests/app/Magento/Search/Test/Page/Adminhtml/SynonymsNew.xml` @@ -708,7 +708,7 @@ Remember our test flow: Let's code it! -**Log in to Admin and open the Search Synonym page** +**Log in to Admin and open the Search Synonym page:** In the FTF, the process of logging in doesn't require a special method and is performed automatically when any page from the Admin is opened. A method, which we will use, is an `open()` method of the `Magento/Mtf/Page/BackendPage` class. There is no need to add this class in `use`, because it is inherited from the `Magento/Search/Test/Page/Adminhtml/SynonymsIndex` class. diff --git a/guides/v2.2/mtf/features/reporting.md b/guides/v2.2/mtf/features/reporting.md index 3fab5c849c8..f682882f00a 100644 --- a/guides/v2.2/mtf/features/reporting.md +++ b/guides/v2.2/mtf/features/reporting.md @@ -70,7 +70,7 @@ An event preset specifies observers and dispatched events handled by them. ` ``` -**Example**: +**Example:**: ```xml diff --git a/guides/v2.2/pattern-library/feedbackToUser/progressIndicator/progressIndicator.md b/guides/v2.2/pattern-library/feedbackToUser/progressIndicator/progressIndicator.md index b5e0d2c0da4..40ef6525894 100644 --- a/guides/v2.2/pattern-library/feedbackToUser/progressIndicator/progressIndicator.md +++ b/guides/v2.2/pattern-library/feedbackToUser/progressIndicator/progressIndicator.md @@ -39,7 +39,7 @@ Spinner is a gif image. In general, it is not recommended to use the progress bar if the process can be completed under 3 seconds. To avoid flickering, the minimum time displayed of progress bar should be 3 seconds. -**States Diagram** +**States Diagram:** ![](img/progressbar-behavior-diagram.png) diff --git a/guides/v2.2/pattern-library/getting-user-input/image_uploader/image_uploader.md b/guides/v2.2/pattern-library/getting-user-input/image_uploader/image_uploader.md index ca578a9a0da..e49af3c2004 100644 --- a/guides/v2.2/pattern-library/getting-user-input/image_uploader/image_uploader.md +++ b/guides/v2.2/pattern-library/getting-user-input/image_uploader/image_uploader.md @@ -20,19 +20,19 @@ This pattern should be used specifically to upload images, and not to upload doc ## Behavior -**Uploading via Browser** +**Uploading via Browser:** The Image Uploader allows the user to browse for images to upload to the [Admin](https://glossary.magento.com/admin) application. This can accommodate single or multiple image upload. To initiate this behavior the user clicking on the "Upload Image" link (target area). The user then proceeds to select the desired images via the browser, using SHIFT + click or ALT/COMMAND + click to select multiple image files. ![](img/image-uploader-browse.jpg) -**Uploading via Drag and Drop** +**Uploading via Drag and Drop:** The user may also upload images (single or multiple) by dragging the desired images onto the Image Upload target area. ![](img/image-uploader-drag.jpg) -**Uploading Video Content** +**Uploading Video Content:** To upload a video to the Magento Admin application the user taps the "Add Video" button. @@ -50,18 +50,18 @@ Once the video information is saved, the video settings panel closes and the use NOTE: Currently Magento 2 does not allow Drag and Drop for Video Content. -**Drag to Arrange Order** +**Drag to Arrange Order:** The order in which images are displayed can be arranged by dragging the image or video to the desired position. ![](img/image-uploader-arrange.jpg"> -**Image Settings** +**Image Settings:** In some areas of the Magento Admin application uploaded images my have additional settings that effect the display of these images on the Storefront (e.g. Product Creation). These settings can be accessed via the "gear" icon found on the image thumbnail. ![](img/image-uploader-settings.jpg) -**Deleting an Image** +**Deleting an Image:** Likewise, an image may be removed from the Magento Admin application by tapping the "trashcan" icon. diff --git a/guides/v2.2/pattern-library/navigation/links/links.md b/guides/v2.2/pattern-library/navigation/links/links.md index dcfc93f22b4..b0361f41fb8 100644 --- a/guides/v2.2/pattern-library/navigation/links/links.md +++ b/guides/v2.2/pattern-library/navigation/links/links.md @@ -51,7 +51,7 @@ Full Guideline Reference: [http://www.w3.org/TR/WCAG10-HTML-TECHS/#links](http:/ ### Breadcrumbs -**Guideline** +**Guideline:** 1. Must always locate above the title as shown. 1. Not be used if all the pages are on the same level. Breadcrumbs are intended to show hierarchy. @@ -62,7 +62,7 @@ Full Guideline Reference: [http://www.w3.org/TR/WCAG10-HTML-TECHS/#links](http:/ 1. Include the full navigational path from the homepage to last level of current page. Not displaying certain levels will confuse users. 1. Never replace primary navigation. They have been devised as a secondary navigation aid and should always be used as such. -**Example** +**Example:** ![](img/example5.png) diff --git a/guides/v2.2/pattern-library/navigation/wizard/wizard.md b/guides/v2.2/pattern-library/navigation/wizard/wizard.md index 3c127846858..a3b275309bf 100644 --- a/guides/v2.2/pattern-library/navigation/wizard/wizard.md +++ b/guides/v2.2/pattern-library/navigation/wizard/wizard.md @@ -30,27 +30,27 @@ The whole structure must be responsive and fluid. ![](img/structure-wizard.jpg) -**1. Wizard Title** +**1. Wizard Title:** This would be the page/modal title -**2. Wizard Progress** +**2. Wizard Progress:** Placement is always on the most left. The width is fluid, depending on the screen size. Must be in one line. The width can go as long to reach the buttons. But if there is not enough room, see **Variation 4** at the bottom of this document. -**3. Action Buttons and Links** +**3. Action Buttons and Links:** The additional links and buttons needed must be between the Wizard Progress and Next & Back buttons. -**4. Next & Back buttons** +**4. Next & Back buttons:** These buttons must be present at all time and in every step of the wizard. If the button is not needed, it can be disabled. Placement is fixed at the most right of the whole container. -**5. Step Labels** +**5. Step Labels:** These labels are optional. Although long labels are not recommended, it is possible. The labels can flow to the next line but only two lines permitted. Any extra text are not shown but the '...' will be use to indicate that the label has extra text. -**6. Current Step Title** +**6. Current Step Title:** This should always be in the format "Step #: Step Label". @@ -62,26 +62,26 @@ Refer to below for basic styling. The special cases of styling can be found unde ## Interaction and Behavior -**Content Behavior** +**Content Behavior:** User navigate between steps of the wizard by clicking 'Back' or 'Next' button. The 'Back' or 'Next' buttons should only change/refreshes the content area, not the whole page. -**Fillings Animation** +**Fillings Animation:** No animation -**Back Buttons behavior** +**Back Buttons behavior:** In every first step, back button is disabled. In all other steps, back button becomes enabled. -**Next Buttons behavior** +**Next Buttons behavior:** If next button exist in the very last step, it should always be disabled. (Note: refer to variations section of this document, some cases may not have next button in last step. If a step required that the user complete the steps before proceeding, next button maybe disabled for that step. -**Visited States behavior** +**Visited States behavior:** If the user is creating a new flow using wizard, the future steps can be disabled. But if a user is EDITING an existing flow using wizard, all steps in the progress-bar will be accessible. The visited states does NOT behave like a visited link. The system should remember if the flow have been visited before even though the visitation is not from the same browser session. diff --git a/guides/v2.2/rest/modules/catalog-pricing.md b/guides/v2.2/rest/modules/catalog-pricing.md index 8f923badde7..619b51cb648 100644 --- a/guides/v2.2/rest/modules/catalog-pricing.md +++ b/guides/v2.2/rest/modules/catalog-pricing.md @@ -32,7 +32,7 @@ POST /V1/products/special-price-information POST /V1/products/special-price-delete ``` -**SpecialPriceStorageInterface Parameters** +**SpecialPriceStorageInterface Parameters:** Name | Description | Format | Requirements --- | --- | --- | --- @@ -206,7 +206,7 @@ POST /V1/products/tier-prices-information POST /V1/products/tier-prices-delete ``` -**TierPriceStorageInterface Parameters** +**TierPriceStorageInterface Parameters:** Name | Description | Format | Requirements --- | --- | --- | --- @@ -404,7 +404,7 @@ POST /V1/products/base-prices POST /V1/products/base-prices-information ``` -**BasePriceStorageInterface Parameters** +**BasePriceStorageInterface Parameters:** Name | Description | Format | Requirements --- | --- | --- | --- @@ -498,7 +498,7 @@ POST /V1/products/cost-information POST /V1/products/cost-delete ``` -**CostStorageInterface Parameters** +**CostStorageInterface Parameters:** Name | Description | Format | Requirements --- | --- | --- | --- diff --git a/guides/v2.2/rest/tutorials/index.md b/guides/v2.2/rest/tutorials/index.md index 3513d13612c..a7555fa2409 100644 --- a/guides/v2.2/rest/tutorials/index.md +++ b/guides/v2.2/rest/tutorials/index.md @@ -50,7 +50,7 @@ Element | Description `scope` | Specifies which store the call affects. In this tutorial, this value is `default`. `endpoint` | The full URI (Uniform Resource Identifier) to the endpoint. These values always start with `/V1`. For example, `/V1/orders/4`. -**HTTP headers** +**HTTP headers:** This section indicates which key/value pairs you must specify in the HTTP headers. All calls require one or more HTTP headers. diff --git a/guides/v2.2/rest/tutorials/orders/order-admin-token.md b/guides/v2.2/rest/tutorials/orders/order-admin-token.md index 30c39b502e9..70e19a4d5df 100644 --- a/guides/v2.2/rest/tutorials/orders/order-admin-token.md +++ b/guides/v2.2/rest/tutorials/orders/order-admin-token.md @@ -33,7 +33,7 @@ Element | Description `scope` | Specifies which store the call affects. In this tutorial, this value is `default`. `endpoint` | The full URI (Uniform Resource Identifier) to the endpoint. These values always start with `/V1`. For example, `/V1/orders/4`. -**HTTP headers** +**HTTP headers:** This section indicates which key/value pairs you must specify in the HTTP headers. All calls require one or more HTTP headers. diff --git a/guides/v2.2/ui_comp_guide/concepts/ui_comp_modifier_concept.md b/guides/v2.2/ui_comp_guide/concepts/ui_comp_modifier_concept.md index 5cb74a6e01c..39bfc29d543 100644 --- a/guides/v2.2/ui_comp_guide/concepts/ui_comp_modifier_concept.md +++ b/guides/v2.2/ui_comp_guide/concepts/ui_comp_modifier_concept.md @@ -17,7 +17,7 @@ So in runtime, the component structure set in the modifier is merged with the co To add a PHP modifier for a UI component, take the following steps: -**Step 1** +**Step 1:** In your custom module, add a class that implements [`\Magento\Ui\DataProvider\Modifier\ModifierInterface`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Ui/DataProvider/Modifier/ModifierInterface.php) with the following methods: @@ -80,7 +80,7 @@ class Example extends AbstractModifier } ``` -**Step 2** +**Step 2:** Declare your modifier in your module Di configuration `/etc/adminhtml/di.xml`. This declaration looks like the following: @@ -101,7 +101,7 @@ Declare your modifier in your module Di configuration `/etc/adm (If you want to use this sample in your `di.xml`, replace the sample values with the real names of your entities.) -**Step 3** +**Step 3:** To use your modifier, add a dependency on [`\Magento\Ui\DataProvider\Modifier\PoolInterface`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Ui/DataProvider/Modifier/PoolInterface.php) to your UI component data provider. For illustration see [`\Magento\Catalog\Ui\DataProvider\Product\Form\ProductDataProvider`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/ProductDataProvider.php) diff --git a/guides/v2.2/ui_comp_guide/concepts/ui_comp_uiregistry.md b/guides/v2.2/ui_comp_guide/concepts/ui_comp_uiregistry.md index d0eaa32e014..1fe08b9d987 100644 --- a/guides/v2.2/ui_comp_guide/concepts/ui_comp_uiregistry.md +++ b/guides/v2.2/ui_comp_guide/concepts/ui_comp_uiregistry.md @@ -31,7 +31,7 @@ If you know a unique property value of a component that you need to find, you ca var component = registry.get('%property% = %propertyValue%'); ``` -**Examples** +**Examples:** The following code shows how to get a component by a full component name: diff --git a/guides/v2.3/coding-standards/code-standard-demarcation.md b/guides/v2.3/coding-standards/code-standard-demarcation.md index 848c72bf846..35380c3a614 100644 --- a/guides/v2.3/coding-standards/code-standard-demarcation.md +++ b/guides/v2.3/coding-standards/code-standard-demarcation.md @@ -30,7 +30,7 @@ Use [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt) to interpret the "MUST," "MU - Helps simplify and unify naming conventions that are used to apply visual styles to page elements. -**Acceptable** +**Acceptable:** ```html
    @@ -40,7 +40,7 @@ Use [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt) to interpret the "MUST," "MU Scroll to text ``` -**Unacceptable** +**Unacceptable:** ```html
    @@ -80,7 +80,7 @@ The following acceptable example is terse and uses an Accessible Rich Internet A The following unacceptable example replaces a single PHTML file with a combination of a PHTML, JavaScript, and CSS files. -**PHTML file** +**PHTML file:** ```php
      @@ -90,13 +90,13 @@ The following unacceptable example replaces a single PHTML file with a combinati
    ``` -**JavaScript file** +**JavaScript file:** ```js $('#my-special-menu').on('click','li[id^="button"]', function() { ... }) ``` -**CSS file** +**CSS file:** ```css #my-special-menu { ... } @@ -225,13 +225,13 @@ this.element.on('click', function() { - Enforces clean, strict separation between visual presentation and markup. - Enables frontend teams quickly and easily clean up old styles. -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php
    ...
    ``` -**Unacceptable PHTML template** +**Unacceptable PHTML template:** ```php
    ...
    @@ -245,14 +245,14 @@ this.element.on('click', function() { - Allows frontend and backend teams to work independently. - Allows changing business logic without affecting styling and vice versa. -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php
    More details
    ``` -**Acceptable JavaScript file** +**Acceptable JavaScript file:** ```js options { @@ -287,7 +287,7 @@ $('[role="menu"]').navigation(); HTML helper class names added in JavaScript REQUIRE underscore symbol ("_") at the beginning and must be written in lowercase. -**Acceptable** +**Acceptable:** ```html
    Content
    @@ -296,7 +296,7 @@ HTML helper class names added in JavaScript REQUIRE underscore symbol ("_") at t
    Content
    ``` -**Unacceptable** +**Unacceptable:** ```html
    Content
    @@ -309,14 +309,14 @@ HTML helper class names added in JavaScript REQUIRE underscore symbol ("_") at t - Allows frontend teams to modify markup and themes without affecting business logic. -**Acceptable JavaScript file** +**Acceptable JavaScript file:** ```js this.element.find('[data-action="edit"]'); this.elements.closest('[data-container]'); ``` -**Unacceptable JavaScript file** +**Unacceptable JavaScript file:** ```js this.element.children().children().html('hello world'); @@ -337,7 +337,7 @@ this.element.parent().find('[data-action="edit"]').data('entity_id'); - Simplifies debugging and reduces number of files to be modified. - Makes styles more extensible and easier to override when needed. -**Acceptable PHP file** +**Acceptable PHP file:** ```php ... @@ -350,7 +350,7 @@ $fieldset->addField('new_category_parent', 'text', array( ... ``` -**Unacceptable PHP file** +**Unacceptable PHP file:** ```php ... @@ -368,7 +368,7 @@ $fieldset->addField('new_category_parent', 'text', array( - Reduces long term maintenance by having frontend business logic stored in one place. - Reduces the number of files to be modified. -**Acceptable PHP file** +**Acceptable PHP file:** ```php ... @@ -379,7 +379,7 @@ public function getSelectorOptions() ... ``` -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php ... @@ -389,7 +389,7 @@ public function getSelectorOptions() or -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php ... @@ -404,7 +404,7 @@ or ... ``` -**Unacceptable PHP file** +**Unacceptable PHP file:** ```php ... @@ -417,7 +417,7 @@ jQuery('#{$htmlId}-suggest').treeSuggest({$selectorOptions}); ... ``` -**Unacceptable PHTML template** +**Unacceptable PHTML template:** ```php getAfterElementHtml(); ?> @@ -444,7 +444,7 @@ public function getAttributeId($element) ... ``` -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php @@ -458,7 +458,7 @@ public function getAttributeId($element) ``` -**Unacceptable PHP file** +**Unacceptable PHP file:** ```php ... @@ -470,7 +470,7 @@ public function getCheckbox($elementName){ ... ``` -**Unacceptable PHTML template** +**Unacceptable PHTML template:** ```php diff --git a/guides/v2.3/extension-dev-guide/build/module-file-structure.md b/guides/v2.3/extension-dev-guide/build/module-file-structure.md index 2ced0a7a9c6..80c5de64484 100644 --- a/guides/v2.3/extension-dev-guide/build/module-file-structure.md +++ b/guides/v2.3/extension-dev-guide/build/module-file-structure.md @@ -100,6 +100,6 @@ For more details on the theme folder structure, see [Magento theme structure]({{ {% include php-dev/lang-pack-file-struct.md %} -**Next** +**Next:** [Register your component]({{ page.baseurl }}/extension-dev-guide/build/component-registration.html) diff --git a/guides/v2.3/extension-dev-guide/prepare/lifecycle.md b/guides/v2.3/extension-dev-guide/prepare/lifecycle.md index 0c27f34c330..138041ad5da 100644 --- a/guides/v2.3/extension-dev-guide/prepare/lifecycle.md +++ b/guides/v2.3/extension-dev-guide/prepare/lifecycle.md @@ -296,7 +296,7 @@ However, module-specific configurations such as its dependency injection and eve Avoid this situation by not including dependencies in your uninstall event class -**Related Topics** +**Related Topics:** * Magento's [versioning policy] diff --git a/guides/v2.3/frontend-dev-guide/layouts/xml-instructions.md b/guides/v2.3/frontend-dev-guide/layouts/xml-instructions.md index c837be027a0..24c243c1af3 100644 --- a/guides/v2.3/frontend-dev-guide/layouts/xml-instructions.md +++ b/guides/v2.3/frontend-dev-guide/layouts/xml-instructions.md @@ -276,7 +276,7 @@ To pass multiple arguments use the following construction: Arguments values set in a layout file can be accessed in [templates] using the `getData('{ArgumentName}')` and `hasData('{ArgumentName}')` methods. The latter returns a boolean defining whether there's any value set. `{ArgumentName}` is obtained from the `name` attribute the following way: for getting the value of `` the method name is `getData('some_string')`. -**Example**: +**Example:**: Setting a value of `css_class` in the `[app/code/Magento/Theme/view/frontend/layout/default.xml]` layout file: diff --git a/guides/v2.3/graphql/develop/resolvers.md b/guides/v2.3/graphql/develop/resolvers.md index e8d20897984..e6badfc6997 100644 --- a/guides/v2.3/graphql/develop/resolvers.md +++ b/guides/v2.3/graphql/develop/resolvers.md @@ -75,7 +75,7 @@ It is a good practice to define separate types for input and output data. This p #### Example -**Wrong approach** +**Wrong approach:** ```text type Mutation { @@ -83,7 +83,7 @@ type Mutation { } ``` -**Correct approach** +**Correct approach:** ```text type Mutation { diff --git a/guides/v2.3/graphql/functional-testing.md b/guides/v2.3/graphql/functional-testing.md index 90a5827257e..422901d35a1 100644 --- a/guides/v2.3/graphql/functional-testing.md +++ b/guides/v2.3/graphql/functional-testing.md @@ -323,7 +323,7 @@ You can also use a predefined directive such as `@expectedExceptionMessage` as a In the following query, a customer provides an incorrect cart ID while trying to retrieve information about his own cart. -**Query** +**Query:** ```text { @@ -337,7 +337,7 @@ In the following query, a customer provides an incorrect cart ID while trying to } ``` -**Result** +**Result:** ```json { @@ -411,13 +411,13 @@ Use the following functions to cover expected exceptions: ### Run all tests in a API functional test suite -**Syntax** +**Syntax:** ```bash vendor/bin/phpunit -c dev/tests/api-functional/phpunit_graphql.xml dev/tests/api-functional/testsuite///.php ``` -**Example** +**Example:** To run all tests from [dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/GenerateCustomerTokenTest.php]({{ site.mage2bloburl }}/2.3.1/dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/GenerateCustomerTokenTest.php), run the following command: @@ -427,13 +427,13 @@ vendor/bin/phpunit -c dev/tests/api-functional/phpunit_graphql.xml dev/tests/api ### Run a single test in a API functional test suite -**Syntax** +**Syntax:** ```bash vendor/bin/phpunit -c dev/tests/api-functional/phpunit_graphql.xml --filter dev/tests/api-functional/testsuite///.php ``` -**Example** +**Example:** To run `testGenerateCustomerValidToken` test from [dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/GenerateCustomerTokenTest.php]({{ site.mage2bloburl }}/2.3.1/dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/GenerateCustomerTokenTest.php), run the following command: @@ -445,13 +445,13 @@ vendor/bin/phpunit -c dev/tests/api-functional/phpunit_graphql.xml --filter test Use the `@group` directive in the test annotation to add the ability to run a group tests. -**Syntax** +**Syntax:** ```bash vendor/bin/phpunit -c dev/tests/api-functional/phpunit_graphql.xml --group dev/tests/api-functional/testsuite///.php ``` -**Example** +**Example:** The `testGetCartTotalsWithNoAddressSet` test is marked with `@group recent`: diff --git a/guides/v2.3/rest/modules/inventory/check-salable-quantity.md b/guides/v2.3/rest/modules/inventory/check-salable-quantity.md index 66cde3c1cd2..cd46a88d88b 100644 --- a/guides/v2.3/rest/modules/inventory/check-salable-quantity.md +++ b/guides/v2.3/rest/modules/inventory/check-salable-quantity.md @@ -23,7 +23,7 @@ GET /V1/inventory/is-product-salable-for-requested-qty/:sku/:stockId/:requestedQ GET /V1/inventory/stock-resolver/:type/:code ``` -**Path parameters** +**Path parameters:** Name | Description | Type --- | --- | --- diff --git a/guides/v2.3/rest/modules/inventory/link-stocks-sources.md b/guides/v2.3/rest/modules/inventory/link-stocks-sources.md index 659caf86302..136040f8fab 100644 --- a/guides/v2.3/rest/modules/inventory/link-stocks-sources.md +++ b/guides/v2.3/rest/modules/inventory/link-stocks-sources.md @@ -25,7 +25,7 @@ POST /V1/inventory/stock-source-links-delete GET /V1/inventory/stock-source-links ``` -**StockSourceLink parameters** +**StockSourceLink parameters:** Name | Description | Type | Requirements --- | --- | --- | --- diff --git a/guides/v2.3/rest/modules/inventory/manage-low-quantity.md b/guides/v2.3/rest/modules/inventory/manage-low-quantity.md index fecb35b995d..565dedb8067 100644 --- a/guides/v2.3/rest/modules/inventory/manage-low-quantity.md +++ b/guides/v2.3/rest/modules/inventory/manage-low-quantity.md @@ -29,7 +29,7 @@ GET /V1/inventory/low-quantity-notification/:sourceCode/:sku POST /V1/inventory/low-quantity-notifications-delete ``` -**sourceItemConfigurations parameters** +**sourceItemConfigurations parameters:** Name | Description | Type | Requirements --- | --- | --- | --- diff --git a/guides/v2.3/rest/modules/inventory/manage-source-items.md b/guides/v2.3/rest/modules/inventory/manage-source-items.md index 85b08f70204..d1a6d4188ff 100644 --- a/guides/v2.3/rest/modules/inventory/manage-source-items.md +++ b/guides/v2.3/rest/modules/inventory/manage-source-items.md @@ -22,7 +22,7 @@ POST V1/inventory/source-items GET V1/inventory/source-items ``` -**sourceItems parameters** +**sourceItems parameters:** Name | Description | Type | Requirements --- | --- | --- | --- diff --git a/guides/v2.3/rest/modules/inventory/manage-source-selection.md b/guides/v2.3/rest/modules/inventory/manage-source-selection.md index 6e0834cfc33..69932af7f02 100644 --- a/guides/v2.3/rest/modules/inventory/manage-source-selection.md +++ b/guides/v2.3/rest/modules/inventory/manage-source-selection.md @@ -76,7 +76,7 @@ The `POST V1/inventory/source-selection-algorithm-result` endpoint uses the algo `POST /rest//V1/inventory/source-selection-algorithm-result` -**inventoryRequest parameters** +**inventoryRequest parameters:** Name | Description | Type | Requirements --- | --- | --- | --- @@ -247,7 +247,7 @@ None The `GET /V1/inventory/get-distance` endpoint calculates the distance between two points, given the longitude and latitude of the source and distance. -**URL parameters** +**URL parameters:** Name | Description --- | --- @@ -272,7 +272,7 @@ The distance, in kilometers The `GET /V1/inventory/get-latlng-from-address` endpoint calculates the latitude and longitude of the shipping address. -**URL parameters** +**URL parameters:** Name | Description --- | --- diff --git a/guides/v2.3/rest/modules/inventory/manage-sources.md b/guides/v2.3/rest/modules/inventory/manage-sources.md index d0b456c2be1..8772b78c238 100644 --- a/guides/v2.3/rest/modules/inventory/manage-sources.md +++ b/guides/v2.3/rest/modules/inventory/manage-sources.md @@ -31,7 +31,7 @@ PUT /V1/inventory/sources/:sourceCode GET /V1/inventory/sources ``` -**SourceInterface parameters** +**SourceInterface parameters:** Name | Description | Type | Requirements --- | --- | --- | --- diff --git a/guides/v2.3/rest/modules/inventory/manage-stocks.md b/guides/v2.3/rest/modules/inventory/manage-stocks.md index 7b6a8326d6d..64f659bae8e 100644 --- a/guides/v2.3/rest/modules/inventory/manage-stocks.md +++ b/guides/v2.3/rest/modules/inventory/manage-stocks.md @@ -25,7 +25,7 @@ DELETE /V1/inventory/stocks/:stockId GET /V1/inventory/stocks ``` -**StockInterface parameters** +**StockInterface parameters:** Name | Description | Type | Requirements --- | --- | --- | --- diff --git a/guides/v2.3/rest/tutorials/index.md b/guides/v2.3/rest/tutorials/index.md index f310069405d..34d6f04187f 100644 --- a/guides/v2.3/rest/tutorials/index.md +++ b/guides/v2.3/rest/tutorials/index.md @@ -58,7 +58,7 @@ Element | Description The **Scope:** section is included when the tutorial requires that you send requests to different stores. -**HTTP headers** +**HTTP headers:** This section indicates which key/value pairs you must specify in the HTTP headers. All calls require one or more HTTP headers. From 27d04576d8635a3d06539a4c2e4710f4367ede9f Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Mon, 18 Nov 2019 14:30:41 -0600 Subject: [PATCH 3/4] Added colons to more less common psuedo headers --- guides/v2.2/b2b/company-structures.md | 2 +- guides/v2.2/b2b/company-users.md | 2 +- guides/v2.2/b2b/credit-manage.md | 4 +- guides/v2.2/b2b/shared-cat-manage.md | 2 +- .../v2.2/cloud/onboarding/onboarding-tasks.md | 2 +- .../code-standard-demarcation.md | 46 +++++++++---------- .../docblock-standard-general.md | 36 ++++++++------- .../config-cli-subcommands-config-mgmt-set.md | 10 ++-- .../deployment/pipeline/technical-details.md | 2 +- .../tutorials/copy-fieldsets.md | 4 +- guides/v2.2/extension-dev-guide/routing.md | 2 +- .../versioning/codebase-changes.md | 2 +- .../versioning/dependencies.md | 2 +- .../install/cli/install-cli-install.md | 4 +- .../javascript-dev-guide/conventions_js.md | 4 +- .../v2.2/mtf/create_test/create_new_test.md | 16 +++---- guides/v2.2/mtf/features/test_suite.md | 6 +-- .../configuration.md | 2 +- guides/v2.2/ui_comp_guide/bk-ui_comps.md | 4 +- .../code-standard-demarcation.md | 22 ++++----- .../declarative-schema/db-schema.md | 4 +- guides/v2.3/extension-dev-guide/routing.md | 2 +- .../configuration.md | 2 +- guides/v2.3/ui_comp_guide/bk-ui_comps.md | 4 +- 24 files changed, 94 insertions(+), 92 deletions(-) diff --git a/guides/v2.2/b2b/company-structures.md b/guides/v2.2/b2b/company-structures.md index 0840cba304d..99c7bfb6fe2 100644 --- a/guides/v2.2/b2b/company-structures.md +++ b/guides/v2.2/b2b/company-structures.md @@ -27,7 +27,7 @@ DELETE /V1/team/:teamId GET /V1/team/ ``` -**Company team parameters** +**Company team parameters:** Name | Description | Format | Requirements --- | --- | --- | --- diff --git a/guides/v2.2/b2b/company-users.md b/guides/v2.2/b2b/company-users.md index a9dc219ba53..558283bf835 100644 --- a/guides/v2.2/b2b/company-users.md +++ b/guides/v2.2/b2b/company-users.md @@ -27,7 +27,7 @@ POST /V1/customers/ PUT /V1/customers/:customerId ``` -**Company user parameters** +**Company user parameters:** The following table lists the parameters that can be used to create a company user. diff --git a/guides/v2.2/b2b/credit-manage.md b/guides/v2.2/b2b/credit-manage.md index eb4ca94a4f8..33913989803 100644 --- a/guides/v2.2/b2b/credit-manage.md +++ b/guides/v2.2/b2b/credit-manage.md @@ -28,7 +28,7 @@ GET /V1/companyCredits/company/:companyId GET /V1/companyCredits/ ``` -**Company credit parameters** +**Company credit parameters:** Name | Description | Format | Requirements --- | --- | --- | --- @@ -232,7 +232,7 @@ Name | Description | Format | Requirements `comment` | Describers the operation | String | Optional `options` | An object that provides additional information for increasing or decreasing the credit balance | Object | Optional -**`options` parameters** +**`options` parameters:** Name | Description | Format | Requirements --- | --- | --- | --- diff --git a/guides/v2.2/b2b/shared-cat-manage.md b/guides/v2.2/b2b/shared-cat-manage.md index 2d5ec140ebb..0c72f1a1011 100644 --- a/guides/v2.2/b2b/shared-cat-manage.md +++ b/guides/v2.2/b2b/shared-cat-manage.md @@ -26,7 +26,7 @@ DELETE /V1/sharedCatalog/:sharedCatalogId GET /V1/sharedCatalog/ ``` -**Shared catalog parameters** +**Shared catalog parameters:** Name | Description | Format | Requirements --- | --- | --- | --- diff --git a/guides/v2.2/cloud/onboarding/onboarding-tasks.md b/guides/v2.2/cloud/onboarding/onboarding-tasks.md index 5cc7fe6a282..29b9d2e8b44 100644 --- a/guides/v2.2/cloud/onboarding/onboarding-tasks.md +++ b/guides/v2.2/cloud/onboarding/onboarding-tasks.md @@ -20,7 +20,7 @@ To quickly onboard your project so you can develop your site for live deployment Once you have an account, you can use the Magento Project Portal to manage the project for your {{site.data.var.ece}} store. The portal provides a Getting Started guide and an interactive workflow that helps project administrators, business users, and developers with the tasks required to develop, build, test, and launch your site. -**Open the Magento Project Portal** +**Open the Magento Project Portal:** 1. Log in to your Magento account. diff --git a/guides/v2.2/coding-standards/code-standard-demarcation.md b/guides/v2.2/coding-standards/code-standard-demarcation.md index 6a209a1d7f8..2eb26e782c5 100644 --- a/guides/v2.2/coding-standards/code-standard-demarcation.md +++ b/guides/v2.2/coding-standards/code-standard-demarcation.md @@ -148,7 +148,7 @@ As the first option, you are required to use [HTML](https://glossary.magento.com - Allows changing look and feel without affecting business functionality, and vice versa. - Enables frontend teams to clean up old styles quickly and easily when refactoring. -**Acceptable CSS selectors** +**Acceptable CSS selectors:** ```css .notices-wrapper { ... } @@ -162,7 +162,7 @@ a:hover { ... } nav li._active { ... } ``` -**Unacceptable CSS selectors** +**Unacceptable CSS selectors:** ```css #header { ... } @@ -186,7 +186,7 @@ content='Exception: CSS attributes where values must be calculated beyond the cs %} -**Acceptable [JavaScript](https://glossary.magento.com/javascript) [widget](https://glossary.magento.com/widget) file** +**Acceptable [JavaScript](https://glossary.magento.com/javascript) [widget](https://glossary.magento.com/widget) file:** ```js ... @@ -203,7 +203,7 @@ content='Exception: CSS attributes where values must be calculated beyond the cs ... ``` -**Unacceptable JavaScript file** +**Unacceptable JavaScript file:** ```js this.element.on('click', function() { @@ -221,13 +221,13 @@ this.element.on('click', function() { - Enforces clean, strict separation between visual presentation and markup. - Enables frontend teams quickly and easily clean up old styles. -**Acceptable PHTML template** +**Acceptable PHTML template;** ```php
    ...
    ``` -**Unacceptable PHTML template** +**Unacceptable PHTML template:** ```php
    ...
    @@ -241,14 +241,14 @@ this.element.on('click', function() { - Allows frontend and backend teams to work independently. - Allows changing business logic without affecting styling and vice versa. -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php
    More details
    ``` -**Acceptable JavaScript file** +**Acceptable JavaScript file:** ```js options { @@ -264,13 +264,13 @@ $( this.options.tooltip).tooltip(); // Globally for ALL tooltip elements ... ``` -**Unacceptable PHTML file** +**Unacceptable PHTML file:** ```php
    ``` -**Unacceptable JavaScript file** +**Unacceptable JavaScript file:** ```js $('#my-widget').doSomething(); @@ -305,14 +305,14 @@ HTML helper class names added in JavaScript REQUIRE underscore symbol ("_") at t Allows frontend teams to modify markup and themes without affecting business logic. -**Acceptable JavaScript file** +**Acceptable JavaScript file:** ```js this.element.find('[data-action="edit"]'); this.elements.closest('[data-container]'); ``` -**Unacceptable JavaScript file** +**Unacceptable JavaScript file:** ```js this.element.children().children().html('hello world'); @@ -333,7 +333,7 @@ this.element.parent().find('[data-action="edit"]').data('entity_id'); - Simplifies debugging and reduces number of files to be modified. - Makes styles more extensible and easier to override when needed. -**Acceptable PHP file** +**Acceptable PHP file:** ```php ... @@ -346,7 +346,7 @@ $fieldset->addField('new_category_parent', 'text', array( ... ``` -**Unacceptable PHP file** +**Unacceptable PHP file:** ```php ... @@ -364,7 +364,7 @@ $fieldset->addField('new_category_parent', 'text', array( - Reduces long term maintenance by having frontend business logic stored in one place. - Reduces the number of files to be modified. -**Acceptable PHP file** +**Acceptable PHP file:** ```php ... @@ -375,7 +375,7 @@ public function getSelectorOptions() ... ``` -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php ... @@ -385,7 +385,7 @@ public function getSelectorOptions() or -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php ... @@ -400,7 +400,7 @@ or ... ``` -**Unacceptable PHP file** +**Unacceptable PHP file:** ```php ... @@ -413,7 +413,7 @@ jQuery('#{$htmlId}-suggest').treeSuggest({$selectorOptions}); ... ``` -**Unacceptable PHTML template** +**Unacceptable PHTML template:** ```php getAfterElementHtml(); ?> @@ -424,7 +424,7 @@ jQuery('#{$htmlId}-suggest').treeSuggest({$selectorOptions}); - Reduces long-term maintenance efforts by having markup stored in one place. - Reduces the number of files to be modified. -**Acceptable PHP file** +**Acceptable PHP file:** ```php public function getAttributeName($element) @@ -439,7 +439,7 @@ public function getAttributeId($element) ... ``` -**Acceptable PHTML template** +**Acceptable PHTML template:** ```php @@ -453,7 +453,7 @@ public function getAttributeId($element) ``` -**Unacceptable PHP file** +**Unacceptable PHP file:** ```php ... @@ -465,7 +465,7 @@ public function getCheckbox($elementName){ ... ``` -**Unacceptable PHTML template** +**Unacceptable PHTML template:** ```php diff --git a/guides/v2.2/coding-standards/docblock-standard-general.md b/guides/v2.2/coding-standards/docblock-standard-general.md index 525f3a760a3..ea1604feedd 100644 --- a/guides/v2.2/coding-standards/docblock-standard-general.md +++ b/guides/v2.2/coding-standards/docblock-standard-general.md @@ -87,7 +87,7 @@ Both short and long descriptions (for file headers and herein) must be separated If description or short description happens to be the first one after DocBlock opening tag (`/**`) or last one before closing tag (`*/`), it should not be separated with an empty line. -**DocBlock Header in a PHP-file** +**DocBlock Header in a PHP-file:** ```php /** @@ -100,7 +100,7 @@ If description or short description happens to be the first one after DocBlock o */ ``` -**DocBlock Header in an XML-file** +**DocBlock Header in an XML-file:** ```xml ``` -**Template for JS Files** +**Template for JS Files:** ```javascript @@ -183,7 +183,7 @@ If the source code file has one and only one standalone structural element (clas So classes that are declared in dedicated files, must have either no DocBlock or exactly one DocBlock, which refers to the class and file at the same time. -**DocBlock for a Class** +**DocBlock for a Class:** ```php @@ -202,7 +202,7 @@ So there are two solutions possible: * Have file header DocBlock separately, then inclusion construct, then a DocBlock for the element with duplicated short description. * Or include after declaring the element (it is possible in PHP and won't cause issues before execution). -**DocBlock with Included Script File** +**DocBlock with Included Script File:** ```php @@ -223,7 +223,7 @@ class Bootstrap { ``` -**DocBlock with Included Class File** +**DocBlock with Included Class File:** ```php namespace Magento\Framework\Profiler\Adapter; @@ -273,7 +273,7 @@ If possible, add use cases where developers can or cannot use the class. It is encouraged to use the short form of the name to encourage readability and consistency with the type hint. The only [exception](https://glossary.magento.com/exception) is in the `Service/DTO` classes due to tooling requirements. -**Example of a Method DocBlock** +**Example of a Method DocBlock:** ```php use Magento\Logger; @@ -303,7 +303,7 @@ private function doSomething(Random $mathRandom, StdlibDateTime $dateTime, $numb Class attributes must have type declaration using `@var` tag. -**Example of Class Attribute** +**Example of Class Attribute:** ```php // ... @@ -375,7 +375,7 @@ Functions and methods should have: * Information that is out of date or has the potential to become out of date. -**Example of a Method DocBlock** +**Example of a Method DocBlock:** ```php @@ -412,7 +412,8 @@ protected function merge($configFiles) In general, use the `@throws` tag when the code uses *throw*: -**Example of Throwing Exception Explicitly** +**Example of Throwing Exception Explicitly:** + ```php /** * Set an arbitrary value to specified element @@ -445,7 +446,7 @@ In this general case, if an exception is thrown in a sub-routine, then `@throws` However, if the only purpose of the referred sub-routine is to throw a specific exception – then `@throws` must be used in the parent method. For example: -**Throwing Exception Implicitly** +**Throwing Exception Implicitly:** ```php /** @@ -558,7 +559,7 @@ The `@inheritdoc` tag SHOULD NOT be used. If a child class method requires a long description to explain its purpose, it may use `@inheritdoc` to indicate the new description is intended as an addition to the parent method description. In general such method overrides are a code smell and should be used as an incentive to make the code more self-documenting if possible. -**DocBlock for the Interface** +**DocBlock for the Interface:** ```php /** @@ -580,7 +581,8 @@ interface MutableInterface } ``` -**DocBlock for the implementation** +**DocBlock for the implementation:** + ```php /** * Limited mutable value object for integer values @@ -669,7 +671,7 @@ public function setScopedPrice($price, $scopeType, $scopeId) For purpose of automatic type hinting in an IDE, an inline notation of `@var` tag can be used wherever the IDE is unable to resolve variable type. This tag declares variables that will emerge in next lines of code as follows: -**Inline Type Hinting** +**Inline Type Hinting:** ```php /** @var libXMLError $error */ @@ -679,7 +681,7 @@ foreach ($errors as $error) { Some IDEs understand a different notation, where type is specified after variable name. This notation is also valid: -**Inline Type Hinting Variation** +**Inline Type Hinting Variation:** ```php /** @var $error libXMLError */ diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-config-mgmt-set.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-config-mgmt-set.md index 9c801518b39..7f3384aae0c 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-config-mgmt-set.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-config-mgmt-set.md @@ -227,7 +227,7 @@ The `bin/magento config:show` command displays the values of any [encrypted valu ### Examples -**Show all saved configurations** +**Show all saved configurations:** ```bash bin/magento config:show @@ -241,7 +241,7 @@ general/region/state_required - AT,BR,CA,CH,EE,ES,FI,LT,LV,RO,US catalog/category/root_id - 2 analytics/subscription/enabled - 1 -**Show all saved configurations for the `base` website** +**Show all saved configurations for the `base` website:** ```bash bin/magento config:show --scope=websites --scope-code=base @@ -252,7 +252,7 @@ Result: 
    web/unsecure/base_url - http://example-for-website.com/
 general/region/state_required - AT,BR,CA
    -**Show the base URL for the default scope** +**Show the base URL for the default scope:** ```bash bin/magento config:show web/unsecure/base_url @@ -262,7 +262,7 @@ Result: 
    web/unsecure/base_url - http://example.com/
    -**Show the base URL for the `base` website** +**Show the base URL for the `base` website:** ```bash bin/magento config:show --scope=websites --scope-code=base web/unsecure/base_url @@ -272,7 +272,7 @@ Result: 
    web/unsecure/base_url - http://example-for-website.com/
    -**Show the base URL for the `default` store** +**Show the base URL for the `default` store:** ```bash bin/magento config:show --scope=stores --scope-code=default web/unsecure/base_url diff --git a/guides/v2.2/config-guide/deployment/pipeline/technical-details.md b/guides/v2.2/config-guide/deployment/pipeline/technical-details.md index 3462ab29b76..964392f732e 100644 --- a/guides/v2.2/config-guide/deployment/pipeline/technical-details.md +++ b/guides/v2.2/config-guide/deployment/pipeline/technical-details.md @@ -264,7 +264,7 @@ After you make the change in the Admin, run `bin/magento app:config:dump` on you {% endcollapsible %} -**env.php** +**env.php:** The default email domain system-specific configuration setting is written to `app/etc/env.php`. diff --git a/guides/v2.2/ext-best-practices/tutorials/copy-fieldsets.md b/guides/v2.2/ext-best-practices/tutorials/copy-fieldsets.md index a4cafe65657..4f7ba7265d0 100644 --- a/guides/v2.2/ext-best-practices/tutorials/copy-fieldsets.md +++ b/guides/v2.2/ext-best-practices/tutorials/copy-fieldsets.md @@ -17,7 +17,7 @@ In this tutorial, you will learn to copy custom data from a [quote](https://glos The following code defines a simple [extension attribute][1] named `demo` for the Cart and Order objects. -**etc/extension_attributes.xml** +**etc/extension_attributes.xml:** ```xml @@ -36,7 +36,7 @@ The following code defines a simple [extension attribute][1] named `demo` for th The following code adds the `demo` field to the `sales_convert_quote` fieldset with the `to_order` aspect. The code snippet in the next step uses the name of the fieldset and aspect to specify which fields to copy. -**etc/fieldset.xml** +**etc/fieldset.xml:** ```xml diff --git a/guides/v2.2/extension-dev-guide/routing.md b/guides/v2.2/extension-dev-guide/routing.md index e74275f434d..8fb9d419f42 100644 --- a/guides/v2.2/extension-dev-guide/routing.md +++ b/guides/v2.2/extension-dev-guide/routing.md @@ -125,7 +125,7 @@ For more details, see [`routes.xsd`]. You can add a `before` or `after` parameter in the `module` entry to override or extend routes in existing modules. -**Example: `routes.xml`** +**Example: `routes.xml`:** ```xml diff --git a/guides/v2.2/extension-dev-guide/versioning/codebase-changes.md b/guides/v2.2/extension-dev-guide/versioning/codebase-changes.md index e6e0e3be0df..0df37eb8d3d 100644 --- a/guides/v2.2/extension-dev-guide/versioning/codebase-changes.md +++ b/guides/v2.2/extension-dev-guide/versioning/codebase-changes.md @@ -38,7 +38,7 @@ Marking public code with `@deprecated` indicates that Magento plans to remove th When Magento deprecates the API or a customization point in favor of a new implementation, the `@see` annotation points to the new implementation. -**Deprecated Code Example** +**Deprecated Code Example:** ```php diff --git a/guides/v2.2/extension-dev-guide/versioning/dependencies.md b/guides/v2.2/extension-dev-guide/versioning/dependencies.md index bc1e3a2afbf..3ebc5073cab 100644 --- a/guides/v2.2/extension-dev-guide/versioning/dependencies.md +++ b/guides/v2.2/extension-dev-guide/versioning/dependencies.md @@ -27,7 +27,7 @@ However, the dependency rules are different: * If a module uses (calls) an API, it should be dependent on the MAJOR version and the system provides backward compatibility in scope of current major version. - **API dependency example** + **API dependency example:** ```json { diff --git a/guides/v2.2/install-gde/install/cli/install-cli-install.md b/guides/v2.2/install-gde/install/cli/install-cli-install.md index e3ba3703a23..7f518cc78e2 100644 --- a/guides/v2.2/install-gde/install/cli/install-cli-install.md +++ b/guides/v2.2/install-gde/install/cli/install-cli-install.md @@ -85,7 +85,7 @@ In Magento Commerce version 2.2.8 and later, you can create the Magento admin us |`--admin-user`|Magento administrator username.|Yes| |`--admin-password`|Magento administrator user password. The password must be at least 7 characters in length and must include at least one alphabetic and at least one numeric character. We recommend a longer, more complex password. Enclose the entire password string in single quotes. For example, `--admin-password='A0b9%t3g'`|Yes| -**Site, database, and RabbitMQ configuration options** +**Site, database, and RabbitMQ configuration options:** |Name|Value|Required?| |--- |--- |--- | @@ -116,7 +116,7 @@ In Magento Commerce version 2.2.8 and later, you can create the Magento admin us |`--amqp-virtualhost`|{{site.data.var.ee}} only. The virtual host for connecting to RabbitMQ. The default is `/`.|No| |`--amqp-ssl`|{{site.data.var.ee}} only. Indicates whether to connect to RabbitMQ. The default is `false`. See RabbitMQ for information about setting up SSL for RabbitMQ.|No| -**Lock configuration options** +**Lock configuration options:** |Name|Value|Required?| |--- |--- |--- | diff --git a/guides/v2.2/javascript-dev-guide/conventions_js.md b/guides/v2.2/javascript-dev-guide/conventions_js.md index 3978ad08cb8..f5e2b61932c 100644 --- a/guides/v2.2/javascript-dev-guide/conventions_js.md +++ b/guides/v2.2/javascript-dev-guide/conventions_js.md @@ -9,7 +9,7 @@ Magento application components, including modules, themes, and language packages The following relative paths are used for modules and themes: -**- ``** +**- ``:** [Theme](https://glossary.magento.com/theme) directory. Usually used when talking about custom themes, or any theme in general. @@ -18,7 +18,7 @@ For Magento out of the box [frontend](https://glossary.magento.com/frontend) the - `app/design/frontend//` - `vendor/magento/theme-frontend-` -**- ``** +**- ``:** Module directory. When talking about a particular Magento module, also notation similar to the following is used: `` diff --git a/guides/v2.2/mtf/create_test/create_new_test.md b/guides/v2.2/mtf/create_test/create_new_test.md index 5d23e1f71fc..3acd5b2dc24 100644 --- a/guides/v2.2/mtf/create_test/create_new_test.md +++ b/guides/v2.2/mtf/create_test/create_new_test.md @@ -480,7 +480,7 @@ Let's see the data set with data. In [Step 3][], we added two [pages][] to the test case class. Because both pages are in the Admin area, we should create them in the `/dev/tests/functional/tests/app/Magento/Search/Test/Page/Adminhtml` directory. -**SynonymsIndex.xml** +**SynonymsIndex.xml:** ```xml @@ -491,7 +491,7 @@ In [Step 3][], we added two [pages][] to the test case class. Because both pages ``` -**SynonymsNew.xml** +**SynonymsNew.xml:** ```xml @@ -523,7 +523,7 @@ Let's see in the [test description][] what actions must be performed: 1. Enter data according to a data set. 1. Click the "Save Synonym Group" button. -**How to code 'Click the "New Synonym Group" button'** +**How to code 'Click the "New Synonym Group" button':** Fortunately, you already have a [block][] that contains a method to add a new entity in a grid: [`\Magento\Backend\Test\Block\GridPageActions`][]. @@ -615,7 +615,7 @@ Then we should add the block class to the `SynonymsNew.xml` page object. To iden ``` -**How to code 'Click the "Save Synonym Group" button'** +**How to code 'Click the "Save Synonym Group" button':** The `save()` method from the [`\Magento\Backend\Test\Block\FormPageActions`][] block class allows you to click the "Save Synonym Group" button. @@ -716,7 +716,7 @@ In the FTF, the process of logging in doesn't require a special method and is pe $this->synonymsIndex->open(); ``` -**Click the "New Synonym Group" button** +**Click the "New Synonym Group" button:** To Click the "New Synonym Group" button, we will use the `addNew()` method from the `pageActionsBlock` block. A `getPageActionsBlock()` of the generated `Magento/Search/Test/Page/Adminhtml/SynonymsIndex` class receives parameters defined in the `pageActionsBlock` block (`class`, `locator`, `strategy`). @@ -726,7 +726,7 @@ $this->synonymsIndex->getPageActionsBlock()->addNew(); This action opens the New Synonym Group page. -**Enter data according to a data set** +**Enter data according to a data set:** To enter data in the form, we use the `fill()` method from the `synonymForm` block of the `synonymsNew` page. An argument for this method is a fixture `Synonym`. A `getSynonymForm()` method of the generated `Magento/Search/Test/Page/Adminhtml/SynonymsNew` class receives parameters defined in the `synonymForm` block. @@ -734,7 +734,7 @@ To enter data in the form, we use the `fill()` method from the `synonymForm` blo $this->synonymsNew->getSynonymForm()->fill($synonym); ``` -**Click the "Save Synonym Group" button** +**Click the "Save Synonym Group" button:** A `save()` method with parameters defined in a `formPageActions` block. Parameters are injected using a `getFormPageActions()` method from the `synonymsNew` page (generated `Magento/Search/Test/Page/Adminhtml/SynonymsNew` page class). @@ -742,7 +742,7 @@ A `save()` method with parameters defined in a `formPageActions` block. Paramete $this->synonymsNew->getFormPageActions()->save(); ``` -**Full `test()` definition** +**Full `test()` definition:** ```php /** diff --git a/guides/v2.2/mtf/features/test_suite.md b/guides/v2.2/mtf/features/test_suite.md index e7f3591fb5a..9424e0fe80e 100644 --- a/guides/v2.2/mtf/features/test_suite.md +++ b/guides/v2.2/mtf/features/test_suite.md @@ -225,7 +225,7 @@ You can use a variation `name` or assign a `tag` node to a [data set][] variatio You can filter tests by variation name using the `` rule. -**Example of a variation** +**Example of a variation:** ```xml @@ -240,7 +240,7 @@ You can filter tests by variation name using the `Scroll to text ``` -**Unacceptable combination of PHTML, JavaScript, and CSS files** +**Unacceptable combination of PHTML, JavaScript, and CSS files:** The following unacceptable example replaces a single PHTML file with a combination of a PHTML, JavaScript, and CSS files. @@ -127,14 +127,14 @@ The following list will help you make a distinction between the actual meaning o ### You must use semantic HTML markup only, and must not use presentation markup -**Acceptable**: +**Acceptable:** ```html

    HTML has been created to semantically represent documents.

    Warning: Following the procedure described below may irreparably damage your equipment.

    ``` -**Unacceptable**: +**Unacceptable:** ```html

    HTML has been created to semantically represent documents.

    @@ -152,7 +152,7 @@ As the first option, you are required to use [HTML](https://glossary.magento.com - Allows changing look and feel without affecting business functionality, and vice versa. - Enables frontend teams to clean up old styles quickly and easily when refactoring. -**Acceptable CSS selectors** +**Acceptable CSS selectors:** ```css .notices-wrapper { ... } @@ -166,7 +166,7 @@ a:hover { ... } nav li._active { ... } ``` -**Unacceptable CSS selectors** +**Unacceptable CSS selectors:** ```css #header { ... } @@ -190,7 +190,7 @@ content='Exception: CSS attributes where values must be calculated beyond the cs %} -**Acceptable [JavaScript](https://glossary.magento.com/javascript) [widget](https://glossary.magento.com/widget) file** +**Acceptable [JavaScript](https://glossary.magento.com/javascript) [widget](https://glossary.magento.com/widget) file:** ```js ... @@ -207,7 +207,7 @@ content='Exception: CSS attributes where values must be calculated beyond the cs ... ``` -**Unacceptable JavaScript file** +**Unacceptable JavaScript file:** ```js this.element.on('click', function() { @@ -268,13 +268,13 @@ $( this.options.tooltip).tooltip(); // Globally for ALL tooltip elements ... ``` -**Unacceptable PHTML file** +**Unacceptable PHTML file:** ```html
    ``` -**Unacceptable JavaScript file** +**Unacceptable JavaScript file:** ```js $('#my-widget').doSomething(); @@ -428,7 +428,7 @@ jQuery('#{$htmlId}-suggest').treeSuggest({$selectorOptions}); - Reduces long-term maintenance efforts by having markup stored in one place. - Reduces the number of files to be modified. -**Acceptable PHP file** +**Acceptable PHP file:** ```php ... diff --git a/guides/v2.3/extension-dev-guide/declarative-schema/db-schema.md b/guides/v2.3/extension-dev-guide/declarative-schema/db-schema.md index c8a399dd9b2..df1080caf55 100644 --- a/guides/v2.3/extension-dev-guide/declarative-schema/db-schema.md +++ b/guides/v2.3/extension-dev-guide/declarative-schema/db-schema.md @@ -440,7 +440,7 @@ It is possible to drop a foreign key only if it exists in the `db_schema_whiteli In this example, Module A defines a new table with primary key `id_column`. Module B declares its own schema, in which it creates a new column (`new_id_column`) and changes the primary index to this column. Module B disables the original primary key and sets a new primary key with a `referenceId` value that is different from PRIMARY. Although this value is different, the real name of the primary key in the database remains PRIMARY. -**Module A declaration** +**Module A declaration:** ```xml ``` -**Module B declaration** +**Module B declaration:** ```xml diff --git a/guides/v2.3/performance-best-practices/configuration.md b/guides/v2.3/performance-best-practices/configuration.md index 14c722e9206..b2cc07cacc8 100644 --- a/guides/v2.3/performance-best-practices/configuration.md +++ b/guides/v2.3/performance-best-practices/configuration.md @@ -51,7 +51,7 @@ This option is available only if **Backorder with any mode** is activated. To improve the storefront responsiveness of your Magento instance, go to the Admin in Default or Developer mode and change the following settings: -**Stores -> Configuration -> Advanced -> Developer** +**Stores -> Configuration -> Advanced -> Developer:** | Settings Group | Setting | Value | | ------------------- | -------------------------- | ------ | diff --git a/guides/v2.3/ui_comp_guide/bk-ui_comps.md b/guides/v2.3/ui_comp_guide/bk-ui_comps.md index c3a7c80b76a..9c7411f621e 100644 --- a/guides/v2.3/ui_comp_guide/bk-ui_comps.md +++ b/guides/v2.3/ui_comp_guide/bk-ui_comps.md @@ -131,10 +131,10 @@ A particular instance of a UI component is defined primarily by the following: ## Things to remember when working with UI components -**UI components have different settings** +**UI components have different settings:** Configuration settings (their list and names) are different among UI components; these settings contain constants, optional and required settings. Developers need to treat every UI component separately. -**Beware of mistakes in XML config** +**Beware of mistakes in XML config:** Surprisingly, most issues occur because of the typos and other mistakes in the UI component's XML configuration. Naming is critical because UI components are heavily cross-referenced. From e913858651ed5ed5efbee2b0b3d617c065dc18d9 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Mon, 18 Nov 2019 14:36:20 -0600 Subject: [PATCH 4/4] Removed emphasis from captions --- .../slideouts-modals-overalys.md | 36 +++++++++---------- .../Expandable_Sections/expand-collapse.md | 3 +- .../date_time_selector/date_time_selector.md | 12 +++---- .../form_elements/form_elements.md | 10 +++--- 4 files changed, 31 insertions(+), 30 deletions(-) diff --git a/guides/v2.2/pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.md b/guides/v2.2/pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.md index 67a49974e4e..4ef28dc45bc 100644 --- a/guides/v2.2/pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.md +++ b/guides/v2.2/pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.md @@ -26,7 +26,7 @@ When the slideout is triggered (by an action taken on the "parent page"), the pa ![Example of panel animation](img/slideout-panel1.png) -_Example of panel animation_ +Example of panel animation ### Anatomy of Slideout @@ -41,7 +41,7 @@ The active panel should include the following elements: ![Example of active panel positioned over "parent"](img/slideout-panel2.png) -_Example of active panel positioned over "parent"_ +Example of active panel positioned over "parent" ### Cancel and Close controls @@ -49,7 +49,7 @@ The close control ( × ) and the "Cancel" link/button will cancel the sub-proces ![Close and cancel controls](img/slideout-panel3.png) -_Close and cancel controls_ +Close and cancel controls ### Passive Close @@ -61,13 +61,13 @@ When two panels are open (one over the other), only the topmost is active. Click ![](img/slideout-panel5.png) -_Passive close "zone" - one level down_ +Passive close "zone" - one level down Clicking or tapping the "alley" that represents the parent page (lowest level) will slide each panel out of view, closing them, and return the user to the parent page. It is recommended that no more than two panels be used in any given "task flow". ![](img/slideout-panel6.png) -_Passive close "zone" - two levels down_ +Passive close "zone" - two levels down ### Slideout Button Bar actions @@ -106,13 +106,13 @@ In its final position the panel does not snap to the page-grid of the parent pag ![](img/slideout-panel7.png) -_Panel position in relation to browser edge_ +Panel position in relation to browser edge A 12-column page-grid is nested inside the content area of the slideout panel, with an additional 15px of padding added to the left edge. ![](img/slideout-panel8.png) -_Nested page-grid with additional padding_ +Nested page-grid with additional padding This method of nesting a 12-column page-grid inside the slideout panel is repeated with each subsequent panel. This is done so that the panels can easily accommodate established page templates used in the Magento framework. With each additional panel, the position of the active panel should indent to create the page-over-page metaphor and allow a zone(s) for the passive close interaction mentioned above. @@ -127,7 +127,7 @@ When an action is taken that triggers a modal, the modal window should appear ce ![](img/modal1.png) -_Example of a Confirmation Modal_ +Example of a Confirmation Modal ### Anatomy of a Modal @@ -146,7 +146,7 @@ Every modal should include a close control ( × ) in the upper right corner as w ![](img/modal3.png) -_Modal "Cancel" and "Close" controls_ +Modal "Cancel" and "Close" controls ### Modal Dimensions @@ -158,11 +158,11 @@ The distance of the modal to the top of the browser should have a fixed distance ![Placement and Padding of Modal](img/modal5.png) -_Placement and Padding of Modal_ +Placement and Padding of Modal ![Sample of progress bar in modal](img/modal6.png) -_Sample of progress bar in modal_ +Sample of progress bar in modal ### Implementation @@ -181,7 +181,7 @@ Drop down overlays behave just as drop down form elements do. A button or contro ![Examples of drop down overlays](img/overlay1.jpg) -_Examples of drop down overlays_ +Examples of drop down overlays ### Flyouts @@ -189,15 +189,15 @@ Flyouts are overlays that typically emerge from a link, menu heading, or other c ![Data-table Filtering Flyout](img/overlay2.jpg) -_Data-table Filtering Flyout_ +Data-table Filtering Flyout ![Data-table In-line Editing Flyout](img/overlay3.jpg) -_Data-table In-line Editing Flyout_ +Data-table In-line Editing Flyout ![Sub-menu Navigation Flyout](img/overlay4.jpg) -_Sub-menu Navigation Flyout_ +Sub-menu Navigation Flyout ### Contextual Help @@ -205,7 +205,7 @@ Contextual Help is similar to a "tooltip" element, except that it is revealed by ![Example of Contextual Help](img/overlay5.jpg) -_Example of Contextual Help_ +Example of Contextual Help ### Alerts and Messages @@ -213,13 +213,13 @@ Within the Magento application it is often necessary and helpful to provide feed ![Field Level Validation message](img/overlay6.jpg) -_Field Level Validation message_ +Field Level Validation message When field level validation is triggered resulting message should appear and persist until the user has taken an action to correct the error (for example, clicks into the form field to re-type an incorrect password). ![Data-table with Confirmation Message](img/overlay7.jpg) -_Data-table with Confirmation Message_ +Data-table with Confirmation Message ## Assets diff --git a/guides/v2.2/pattern-library/controls/Expandable_Sections/expand-collapse.md b/guides/v2.2/pattern-library/controls/Expandable_Sections/expand-collapse.md index 8cfeb370551..1bfb0b2ef3d 100644 --- a/guides/v2.2/pattern-library/controls/Expandable_Sections/expand-collapse.md +++ b/guides/v2.2/pattern-library/controls/Expandable_Sections/expand-collapse.md @@ -2,7 +2,8 @@ group: admin-pattern-library title: Expandable sections --- -_(AKA Expand-Collapse, Collapsible panels)_ + +(AKA Expand-Collapse, Collapsible panels) Expandable sections are expandable content areas which are useful in cases where a lot of information must be accommodated in limited space, thereby reducing clutter and allowing you focus on the primary task. Typically the information to be accommodated can be separated into various sections and/or sub-sections, or topics. diff --git a/guides/v2.2/pattern-library/getting-user-input/date_time_selector/date_time_selector.md b/guides/v2.2/pattern-library/getting-user-input/date_time_selector/date_time_selector.md index 31a49420f37..9fb26290250 100644 --- a/guides/v2.2/pattern-library/getting-user-input/date_time_selector/date_time_selector.md +++ b/guides/v2.2/pattern-library/getting-user-input/date_time_selector/date_time_selector.md @@ -116,27 +116,27 @@ Field selection works the same as a typical text field with ## Style -**Single Date Picker** +**Single Date Picker:** ![](img/datepicker.png) -**Date Range Picker** +**Date Range Picker:** ![](img/rangedatepicker.png) -**Single Time Picker** +**Single Time Picker:** ![](img/timepicker.png) -**Time Range Picker** +**Time Range Picker:** ![](img/timerangepicker.png) -**Single Date and Time Picker** +**Single Date and Time Picker:** ![](img/date&timepicker.png) -**Date and Time Range Picker** +**Date and Time Range Picker:** ![](img/rangedate&timepicker.png) diff --git a/guides/v2.2/pattern-library/getting-user-input/form_elements/form_elements.md b/guides/v2.2/pattern-library/getting-user-input/form_elements/form_elements.md index af05045094a..1a965810f9d 100644 --- a/guides/v2.2/pattern-library/getting-user-input/form_elements/form_elements.md +++ b/guides/v2.2/pattern-library/getting-user-input/form_elements/form_elements.md @@ -16,11 +16,11 @@ _* "best" is a relative term, but there are User Experience principles and best In most cases every text field, text box, radio button group, checkbox or checkbox group, drop down selector and multi-select box will have a label. There are two variations of form [layout](https://glossary.magento.com/layout) – "label-left" and "label-top". Depending on the layout of the page and/or task-at-hand, either of these may be implemented, but whichever layout is deemed appropriate it should be used consistency throughout a given task. -**Example of label-top** +**Example of label-top:** ![](img/form_sample_horiz.png) -**Example of label-left** +**Example of label-left:** ![](img/form_sample_vert.png) @@ -41,11 +41,11 @@ otherwise selecting outside the form element that has focus. For *label-left* form elements the amount of horizontal real estate allowed for the labels should only span a maximum of 3 columns of the page grid. While the element itself should typically span no more than 4 columns. For *label-top* form elements, the label and the form element overall should typically not exceed 5 columns of the page grid, however page layout and/or the amount of information to be collected will influence this. -**Grid and label-left form** +**Grid and label-left form:** ![](img/grid_horiz.png) -**Grid and label-top form** +**Grid and label-top form:** ![](img/grid_vert.png) @@ -183,7 +183,7 @@ Akin to progressive disclosure is "contextual help". This may be used whenever i For specific details concerning styling including fonts, colors and effects and spacing and padding, please refer to the source PSD files and exports located on Box or contact the Magento Product Design and User Experience team. -**Sample of specs** +**Sample of specs:** ![](img/spec_sample.png)