Skip to content

Commit 3a3364d

Browse files
magento-engcom-teammagento-engcom-team
committed
ENGCOM-8569: Updated wish list GraphQl read me file #31369
- Merge Pull Request #31369 from chiranjeevi-cj/magento2:update-whishlist-graphql-readme - Merged commits: 1. 628a1e4 2. c16f995 3. cfbc08c 4. 6cb297b 5. 8584f85 6. ee667ff 7. af5765d 8. 7cf7657 9. db1be3f 10. 0b5401f 11. 2a50bef 12. f786e39 13. 427e14b 14. 2610382 15. 350ba94 16. a57297c 17. 200771d 18. 01a656f 19. ed70125 20. 4f4b98a 21. 54d95d0 22. 447f3c6 23. f5fde08 24. 7728961 25. 354d3f6 26. 6c1e76e 27. 13f32b6 28. 0b09f8c 29. c95fee9 30. bdf967d
2 parents 63434d2 + bdf967d commit 3a3364d

File tree

8 files changed

+344
-34
lines changed

8 files changed

+344
-34
lines changed

‎app/code/Magento/WebapiAsync/README.md

+27-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1-
# WebapiAsync
1+
# Magento_WebapiAsync module
22

3-
**WebapiAsync** Extends Webapi extension and provide functional to process asynchronous requests. It handle asynchronous requests, schedule, publish and consum bulk operations from queue.
3+
Magento_WebapiAsync module extends Webapi extension and provide functional to process asynchronous requests.
4+
5+
Magento_WebapiAsync module handles asynchronous requests, schedule, publish and consume bulk operations from a queue.
6+
7+
## Installation details
8+
9+
Before installing this module, note that the Magento_WebapiAsync is dependent on the following modules:
10+
11+
- Magento_AsynchronousOperations
12+
- Magento_Customer
13+
- Magento_User
14+
- Magento_Webapi
15+
16+
For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
17+
18+
## Structure
19+
20+
`Code/` - the directory that contains Remote service reader configuration files.
21+
22+
For information about a typical file structure of a module, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
23+
24+
## Extensibility
25+
26+
Extension developers can interact with the Magento_WebapiAsync 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).
27+
28+
[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_WebapiAsync module.

‎app/code/Magento/WebapiSecurity/README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
1-
# WebapiSecurity
1+
# Magento_WebapiSecurity module
2+
3+
The Magento_WebapiSecurity module enables access management of some Web API resources.
4+
5+
If checkbox enabled in backend through: `Stores -> Configuration -> Services -> Magento Web API -> Web Api Security` then the security of all the services outlined in `app/code/Magento/WebapiSecurity/etc/di.xml` would be loosened. You may modify this list to customize which services should follow this behavior.
26

3-
**WebapiSecurity** enables access management of some Web API resources.
4-
If checkbox is enabled in backend through: Stores -> Configuration -> Services -> Magento Web API -> Web Api Security
5-
then the security of all of the services outlined in app/code/Magento/WebapiSecurity/etc/di.xml would be loosened. You may modify this list to customize which services should follow this behavior.
67
By loosening the security, these services would allow access anonymously (by anyone).
8+
9+
## Installation details
10+
11+
Before installing this module, note that the Magento_WebapiSecurity is dependent on the following modules:
12+
13+
- `Magento_Webapi`
14+
15+
For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).

‎app/code/Magento/Weee/README.md

+91-18
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,99 @@
1-
# Overview
1+
# Magento_Weee module
2+
23
The Magento_Weee module enables the application of fees/fixed product taxes (FPT) on certain types of products, usually related to electronic devices and recycling.
3-
Fixed product taxes can be used to setup a WEEE tax that is a fixed amount, rather than a percentage of the product price. FPT can be configured to be displayed at various places in Magento. Rules, amounts, and display options can be configured in the backend. This module extends the existing functionality of Magento_Tax.
4+
5+
Fixed product taxes can be used to setup a WEEE tax that is a fixed amount, rather than a percentage of the product price. FPT can be configured to be displayed at various places in Magento. Rules, amounts, and display options can be configured in the backend.
6+
7+
This module extends the existing functionality of Magento_Tax.
48

59
The Magento_Weee module includes the following:
610

7-
* ability to add different number of fixed product taxes to product. They are treated as a product attribute;
8-
* configuration of where WEEE appears (on category, product, sales, invoice, or credit memo pages) and whether FPT should be taxed;
9-
* a new line item in the totals section.
11+
- Ability to add different number of fixed product taxes to product. They are treated as a product attribute.
12+
- Configuration of where WEEE appears (on category, product, sales, invoice, or credit memo pages) and whether FPT should be taxed.
13+
- A new line item in the totals section.
14+
15+
## Installation details
16+
17+
The Magento_Weee module can be installed automatically (using native Magento install mechanism) without any additional actions.
18+
19+
Before installing this module, note that the Magento_Weee is dependent on the following modules:
20+
21+
- Magento_Catalog
22+
- Magento_Checkout
23+
- Magento_Customer
24+
- Magento_Quote
25+
- Magento_Sales
26+
- Magento_Store
27+
- Magento_Tax
28+
29+
Refer to [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
30+
31+
## Structure
32+
33+
`Pricing/` - directory that contain tax adjustment.
34+
35+
For information about a typical file structure of a module, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
36+
37+
## Extensibility
38+
39+
Extension developers can interact with the Magento_Weee 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).
40+
41+
[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_Weee module.
42+
43+
### Layouts
44+
45+
This module introduces the following layouts and layout handles in the directories:
46+
47+
- `view/adminhtml/layout`:
48+
- `catalog_product_form`
49+
- `sales_creditmemo_item_price`
50+
- `sales_invoice_item_price`
51+
- `sales_order_create_item_price`
52+
- `sales_order_creditmemo_new`
53+
- `sales_order_creditmemo_updateqty`
54+
- `sales_order_creditmemo_view`
55+
- `sales_order_invoice_new`
56+
- `sales_order_invoice_updateqty`
57+
- `sales_order_invoice_view`
58+
- `sales_order_item_price`
59+
- `sales_order_view`
60+
61+
- `view/base/layout`:
62+
- `catalog_product_prices`
63+
64+
- `view/frantend/layout`:
65+
- `checkout_cart_index`
66+
- `checkout_index_index`
67+
- `checkout_item_price_renderers`
68+
- `default`
69+
- `sales_email_item_price`
70+
- `sales_email_order_creditmemo_items`
71+
- `sales_email_order_invoice_items`
72+
- `sales_email_order_items`
73+
- `sales_guest_creditmemo`
74+
- `sales_guest_invoice`
75+
- `sales_guest_print`
76+
- `sales_guest_printcreditmemo`
77+
- `sales_guest_printinvoice`
78+
- `sales_guest_view`
79+
- `sales_order_creditmemo`
80+
- `sales_order_invoice`
81+
- `sales_order_item_price`
82+
- `sales_order_print`
83+
- `sales_order_printcreditmemo`
84+
- `sales_order_printinvoice`
85+
- `sales_order_view`
86+
87+
For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
1088

11-
# System requirements
12-
The Magento_Weee module does not have any specific system requirements.
89+
### UI components
1390

14-
## Install
15-
Magento_Weee module can be installed automatically (using native Magento install mechanism) without any additional actions
91+
You can extend a customer form and widgets using the configuration files located in the directories
1692

17-
## Uninstall
18-
Magento installation with existing products with FPT:
19-
* Disable FPT on the backend
20-
* Remove all products with FPT
21-
* Remove all FPT attributes from attribute sets
22-
* Delete all FPT attributes
23-
* Remove module directory from the code base
93+
- `view/adminhtml/ui_component`:
94+
- `product_attribute_add_form`
95+
- `view/frontend/ui_component`:
96+
- `widget_recently_compared`
97+
- `widget_recently_viewed`
2498

25-
New Magento installation:
26-
* Can be removed without additional actions
99+
For information about a UI component, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).

‎app/code/Magento/WeeeGraphQl/README.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# WeeeGraphQl
1+
# Magento_WeeeGraphQl module
22

3-
**WeeeGraphQl** provides type information for the GraphQl module
4-
to generate wee tax fields for catalog and product information endpoints.
3+
The Magento_WeeeGraphQl module provides type information for the GraphQl module to generate wee tax fields for the catalog and product information endpoints.
4+
5+
The Magento_WeeeGraphQl module extends Magento_GraphQl and Magento_Weee modules. This module provides type and resolver information for GraphQL API.
6+
7+
## Installation details
8+
9+
Before installing this module, note that the Magento_WeeeGraphQl is dependent on the following modules:
10+
11+
- `Magento_CatalogGraphQl`
12+
- `Magento_Store`
13+
- `Magento_Tax`
14+
- `Magento_Weee`
15+
16+
For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
17+
18+
## Extensibility
19+
20+
Extension developers can interact with the Magento_WeeeGraphQl 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).
21+
22+
[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_WeeeGraphQl module.

‎app/code/Magento/Widget/README.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
The Widget module allows Magento application to be extended with custom widget blocks.
1+
# Magento_Widget module
2+
3+
The Magento_Widget module allows Magento application to be extended with custom widget blocks.
4+
5+
## Installation details
6+
7+
Before installing this module, note that the Magento_Widget is dependent on the following modules:
8+
9+
- Magento_Catalog
10+
- Magento_Cms
11+
- Magento_Store
12+
13+
Before disabling or uninstalling this module, note the following dependencies:
14+
15+
- Magento_CatalogWidget
16+
- Magento_CurrencySymbol
17+
- Magento_Newsletter
18+
19+
Refer to [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
20+
21+
## Extensibility
22+
23+
Extension developers can interact with the Magento_Widget 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).
24+
25+
[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_Widget module.
26+
27+
### Layouts
28+
29+
This module introduces the following layouts and layout handles in the directories:
30+
31+
- `view/adminhtml/layout`:
32+
- `adminhtml_widget_index`
33+
- `adminhtml_widget_instance_block`
34+
- `adminhtml_widget_instance_edit`
35+
- `adminhtml_widget_instance_index`
36+
- `adminhtml_widget_loadoptions`
37+
- `view/frantend/layout`:
38+
- `default`
39+
- `print`
40+
41+
For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).

‎app/code/Magento/Wishlist/README.md

+100-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,100 @@
1-
The Magento_Wishlist implements the Wishlist functionality.
2-
This allows customers to create a list of products that they can add to their shopping cart to be purchased at a later date, or share with friends.
1+
# Magento_Wishlist module
2+
3+
The Magento_Wishlist module implements the Wishlist functionality.
4+
5+
This module allows customers to create a list of products that they can add to their shopping cart to be purchased at a later date, or share with friends.
6+
7+
## Installation details
8+
9+
Before installing this module, note that the Magento_Wishlist is dependent on the following modules:
10+
11+
- Magento_Captcha
12+
- Magento_Catalog
13+
- Magento_Customer
14+
15+
Before disabling or uninstalling this module, note the following dependencies:
16+
17+
- Magento_WishlistAnalytics
18+
19+
Refer to [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
20+
21+
## Structure
22+
23+
`Pricing/` - the directory that contain solutions for configurable and downloadable product price.
24+
25+
For information about a typical file structure of a module, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
26+
27+
## Extensibility
28+
29+
Extension developers can interact with the Magento_Wishlist 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).
30+
31+
[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_Wishlist module.
32+
33+
### Events
34+
35+
The module dispatches the following events:
36+
37+
- `product_option_renderer_init` event in the `\Magento\Wishlist\Block\Customer\Wishlist\Item\Options::_construct()` method. Parameters:
38+
- `block` is a Wishlist block customer items (`\Magento\Wishlist\Block\Customer\Wishlist\Item\Options` class).
39+
- `rss_wishlist_xml_callback` event in the `\Magento\Wishlist\Model\Rss\Wishlist::getRssData()` method. Parameters:
40+
- `$args` is a array of product object (`\Magento\Catalog\Model\Product` class).
41+
- `wishlist_add_item` event in the `\Magento\Wishlist\Model\Wishlist::addItem()` method. Parameters:
42+
- `item` is an item object (`\Magento\Wishlist\Model\Item` class).
43+
- `wishlist_add_product` event in the `\Magento\Wishlist\Controller\Index\Add::execute()` method. Parameters:
44+
- `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class).
45+
- `product` is a product object (`\Magento\Catalog\Api\Data\ProductInterface` class).
46+
- `item` is an item object (`\Magento\Wishlist\Model\Item` class).
47+
- `wishlist_item_collection_products_after_load` event in the `\Magento\Wishlist\Model\ResourceModel\Item\Collection::_assignProducts()` method. Parameters:
48+
- `product_collection` is a product collection object (`\Magento\Catalog\Model\ResourceModel\Product\Collection` class).
49+
- `wishlist_items_renewed` event in the `\Magento\Wishlist\Helper\Data::calculate()` method.
50+
- `wishlist_product_add_after` event in the `\Magento\Wishlist\Model\Wishlist::addNewItem()` method. Parameters:
51+
- `items` is an array of item object (`\Magento\Wishlist\Model\Item` class).
52+
- `wishlist_share` event in the `\Magento\Wishlist\Controller\Index\Send::execute()` method. Parameters:
53+
- `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class).
54+
- `wishlist_update_item` event in the `\Magento\Wishlist\Controller\Index\UpdateItemOptions::execute()` method. Parameters:
55+
- `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class).
56+
- `product` is a product object (`\Magento\Catalog\Api\Data\ProductInterface` class).
57+
- `item` is an item object (`\Magento\Wishlist\Model\Item` class).
58+
59+
For information about the event, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).
60+
61+
### Layouts
62+
63+
This module introduces the following layouts and layout handles in the directories:
64+
65+
- `view/adminhtml/layout`:
66+
- `customer_index_wishlist`
67+
- `view/base/layout`:
68+
- `catalog_product_prices`
69+
- `view/frantend/layout`:
70+
- `catalog_category_view`
71+
- `catalog_product_view`
72+
- `catalogsearch_advanced_result`
73+
- `checkout_cart_index`
74+
- `checkout_cart_item_renderers`
75+
- `customer_account`
76+
- `default`
77+
- `wishlist_email_items`
78+
- `wishlist_email_rss`
79+
- `wishlist_index_configure`
80+
- `wishlist_index_configure_type_bundle`
81+
- `wishlist_index_configure_type_configurable`
82+
- `wishlist_index_configure_type_downloadable`
83+
- `wishlist_index_configure_type_grouped`
84+
- `wishlist_index_configure_type_simple`
85+
- `wishlist_index_index`
86+
- `wishlist_index_share`
87+
- `wishlist_shared_index.xml`
88+
89+
For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
90+
91+
### UI components
92+
93+
You can extend a customer form and widgets using the configuration files located in the directories
94+
- `view/base/ui_component`:
95+
- `customer_form`
96+
- `view/frontend/ui_component`:
97+
- `widget_recently_compared`
98+
- `widget_recently_viewed`
99+
100+
For information about a UI component, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).

‎app/code/Magento/WishlistAnalytics/README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
# Magento_WishlistAnalytics module
22

3-
The Magento_WishlistAnalytics module configures data definitions for a data collection related to the Wishlist module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html).
3+
The Magento_WishlistAnalytics module configures data definitions for a data collection related to the Wishlist module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.4/advanced-reporting/modules.html).
4+
5+
## Installation details
6+
7+
Before installing this module, note that the Magento_WishlistAnalytics is dependent on the following modules:
8+
9+
- Magento_Analytics
10+
- Magento_Wishlist
11+
12+
For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).

0 commit comments

Comments
 (0)