-
Notifications
You must be signed in to change notification settings - Fork 9.4k
[ReadMe] updated readMe file for QuoteBundleOptions-ReleaseNotification modules #33124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,15 @@ | ||
# QuoteBundleOptions | ||
# Magento_QuoteBundleOptions module | ||
|
||
**QuoteBundleOptions** provides data provider for creating buy request for bundle products. | ||
This module provides data provider for creating buy request for bundle products. | ||
|
||
## Installation | ||
|
||
This module does not introduce any database schema modifications or new data. | ||
|
||
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
||
## Extensibility | ||
|
||
Extension developers can interact with the Magento_QuoteBundleOptions module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
||
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteBundleOptions module. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,15 @@ | ||
# QuoteConfigurableOptions | ||
# Magento_QuoteConfigurableOptions module | ||
|
||
**QuoteConfigurableOptions** provides data provider for creating buy request for configurable products. | ||
This module provides data provider for creating buy request for configurable products. | ||
|
||
## Installation | ||
|
||
This module does not introduce any database schema modifications or new data. | ||
|
||
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
||
## Extensibility | ||
|
||
Extension developers can interact with the Magento_QuoteConfigurableOptions module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
||
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteConfigurableOptions module. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,15 @@ | ||
# QuoteDownloadableLinks | ||
# Magento_QuoteDownloadableLinks module | ||
|
||
**QuoteDownloadableLinks** provides data provider for creating buy request for links of downloadable products. | ||
This module provides data provider for creating buy request for links of downloadable products. | ||
|
||
## Installation | ||
|
||
This module does not introduce any database schema modifications or new data. | ||
|
||
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
||
## Extensibility | ||
|
||
Extension developers can interact with the Magento_QuoteDownloadableLinks module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
||
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteDownloadableLinks module. |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,4 +1,82 @@ | ||||||
# QuoteGraphQl | ||||||
# Magento_QuoteGraphQl module | ||||||
|
||||||
**QuoteGraphQl** provides type and resolver information for the GraphQl module | ||||||
This module provides type and resolver information for the GraphQl module | ||||||
to generate quote (cart) information endpoints. Also provides endpoints for modifying a quote. | ||||||
|
||||||
## Installation | ||||||
|
||||||
Before installing this module, note that the Magento_QuoteGraphQl is dependent on the following modules: | ||||||
- `Magento_CatalogGraphQl` | ||||||
|
||||||
This module does not introduce any database schema modifications or new data. | ||||||
|
||||||
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||||||
|
||||||
## Extensibility | ||||||
|
||||||
Extension developers can interact with the Magento_QuoteDownloadableLinks module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||||||
|
||||||
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteDownloadableLinks module. | ||||||
|
||||||
## Additional information | ||||||
|
||||||
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). | ||||||
|
||||||
### GraphQl Query | ||||||
|
||||||
- `cart` query - retrieve information about a particular cart. | ||||||
[Learn more about cart query](https://devdocs.magento.com/guides/v2.4/graphql/queries/cart.html). | ||||||
|
||||||
- `customerCart` query - returns the active cart for the logged-in customer. If the cart does not exist, the query creates one. | ||||||
[Learn more about customerCart query](https://devdocs.magento.com/guides/v2.4/graphql/queries/customer-cart.html). | ||||||
|
||||||
### GraphQl Mutation | ||||||
|
||||||
- `createEmptyCart` mutation - creates an empty shopping cart for a guest or logged in customer. | ||||||
[Learn more about createEmptyCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/create-empty-cart.html). | ||||||
|
||||||
- `addSimpleProductsToCart` mutation - allows you to add any number of simple and group products to the cart at the same time. | ||||||
[Learn more about addSimpleProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-simple-products.html). | ||||||
|
||||||
- `addVirtualProductsToCart` mutation - allows you to add multiple virtual products to the cart at the same time, but you cannot add other product types with this mutation. | ||||||
[Learn more about addVirtualProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-virtual-products.html). | ||||||
|
||||||
- `applyCouponToCart` mutation - applies a pre-defined coupon code to the specified cart. | ||||||
[Learn more about applyCouponToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/apply-coupon.html). | ||||||
|
||||||
- `removeCouponFromCart` mutation - removes a previously-applied coupon from the cart. | ||||||
[Learn more about removeCouponFromCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/remove-coupon.html). | ||||||
|
||||||
- `updateCartItems` mutation - allows you to modify items in the specified cart. | ||||||
[Learn more about updateCartItems mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/update-cart-items.html). | ||||||
|
||||||
- `removeItemFromCart` mutation - deletes the entire quantity of a specified item from the cart. | ||||||
[Learn more about removeItemFromCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/remove-item.html). | ||||||
|
||||||
- `setShippingAddressesOnCart` mutation - sets one or more shipping addresses on a specific cart. | ||||||
[Learn more about setShippingAddressesOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-shipping-address.html). | ||||||
|
||||||
- `setBillingAddressOnCart` mutation - sets the billing address for a specific cart. | ||||||
[Learn more about setBillingAddressOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-billing-address.html). | ||||||
|
||||||
- `setShippingMethodsOnCart` mutation - sets one or more delivery methods on a cart. | ||||||
[Learn more about setShippingMethodsOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-shipping-method.html). | ||||||
|
||||||
- `setPaymentMethodOnCart` mutation - defines which payment method to apply to the cart. | ||||||
[Learn more about setPaymentMethodOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-payment-method.html). | ||||||
|
||||||
- `setGuestEmailOnCart` mutation - assigns email to the quest cart. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done |
||||||
[Learn more about setGuestEmailOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-guest-email.html). | ||||||
|
||||||
- `setPaymentMethodAndPlaceOrder` mutation - sets the cart payment method and converts the cart into an order. This mutation has been deprecated. Use the `setPaymentMethodOnCart` and `placeOrder` mutations instead. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Make the fact this has been deprecated stand out.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done |
||||||
[Learn more about setPaymentMethodAndPlaceOrder mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-payment-place-order.html). | ||||||
|
||||||
- `mergeCarts` mutation - transfers the contents of a guest cart into the cart of a logged-in customer. | ||||||
[Learn more about mergeCarts mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/merge-carts.html). | ||||||
|
||||||
- `placeOrder` mutation - converts the cart into an order and returns an order ID. | ||||||
[Learn more about placeOrder mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/place-order.html). | ||||||
|
||||||
- `addProductsToCart` mutation - adds any type of product to the shopping cart. | ||||||
[Learn more about addProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-products-to-cart.html). | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,19 @@ | ||
# RelatedProductGraphQl | ||
# Magento_RelatedProductGraphQl module | ||
|
||
**RelatedProductGraphQl** provides endpoints for getting Cross Sell / Related/ Up Sell products data. | ||
This module provides endpoints for getting Cross Sell / Related/ Up Sell products data. | ||
|
||
## Installation | ||
|
||
This module does not introduce any database schema modifications or new data. | ||
|
||
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
||
## Extensibility | ||
|
||
Extension developers can interact with the Magento_QuoteDownloadableLinks module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
||
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteDownloadableLinks module. | ||
|
||
## Additional information | ||
|
||
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question - on DevDocs & Knowledge Base use of "Magento" is being switched to "Adobe Commerce" - should we not be doing this on these new README.md now, rather than later?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should leave a Magento as in the Readme template https://github.com/magento/devdocs/wiki/Magento-module-README.md provided by Magento.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Accepted!