-
Notifications
You must be signed in to change notification settings - Fork 9.4k
update read me file for Variable, vault, vaultGraphQl, version, webApi modules #31474
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
base: 2.4-develop
Are you sure you want to change the base?
Changes from all commits
83a6e30
724becf
ef17c6c
70726a4
9cb03a5
1f55467
a402aa9
7cbba91
3d69c0a
d17828f
65895ba
f2ff275
b93026b
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 +1,38 @@ | ||
Magento\Variable Allows to create custom variables and then use them in email templates or in WYSIWYG editor for editing description of system entities. | ||
# Magento_Variable module | ||
|
||
The Magento_Variable module allows the creation of custom variables for use in email templates or in the WYSIWYG editor when editing descriptions of system entities. | ||
|
||
## Installation details | ||
|
||
The Magento_Variable module is dependent on the following modules: | ||
|
||
- Magento_Config | ||
- Magento_Store | ||
|
||
Before disabling or uninstalling this module, note the following dependencies: | ||
|
||
- Magento_Cms | ||
- Magento_Email | ||
|
||
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). | ||
|
||
### Layouts | ||
|
||
This module introduces the following layouts and layout handles in the directories: | ||
|
||
- `view/adminhtml/layout`: | ||
- `adminhtml_system_variable_edit` | ||
- `adminhtml_system_variable_grid_block` | ||
- `adminhtml_system_variable_index` | ||
|
||
For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). | ||
|
||
### UI components | ||
|
||
You can extend a customer form and widgets using the configuration files located in the directories | ||
|
||
- `view/adminhtml/ui_component`: | ||
- `variables_modal` | ||
|
||
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). | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,59 @@ | ||
The Magento_Vault module implements the integration with the Vault payment gateway and makes the latter available as a payment method in Magento. | ||
# Magento_Vault module | ||
|
||
The Magento_Vault module implements the integration with the Vault payment gateway and makes it available as a payment method in Magento. | ||
|
||
## Installation details | ||
|
||
The Magento_Vault module is dependent on the following modules: | ||
|
||
- Magento_Checkout | ||
- Magento_Customer | ||
- Magento_Payment | ||
- Magento_Quote | ||
- Magento_Sales | ||
- Magento_Store | ||
- Magento_Theme | ||
|
||
Before disabling or uninstalling this module, note the following dependencies: | ||
|
||
- Magento_Paypal | ||
|
||
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). | ||
|
||
## Extensibility | ||
|
||
Extension developers can interact with the Magento_Vault 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_Vault module. | ||
|
||
### Events | ||
|
||
The module dispatches the following events: | ||
|
||
- `payment_method_assign_data_vault` event in the `\Magento\Vault\Model\Method\Vault::assignData()` method. Parameters: | ||
- `method` is a method code (`\Magento\Vault\Model\Method\Vault` class). | ||
- `payment_model` is a payment information model object (`\Magento\Payment\Model\InfoInterface` class). | ||
|
||
For more information about the event, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events). | ||
|
||
### Layouts | ||
|
||
This module introduces the following layouts and layout handles in the directories: | ||
|
||
- `view/frantend/layout`: | ||
- `checkout_index_index` | ||
- `customer_account` | ||
- `vault_cards_listaction` | ||
|
||
For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). | ||
|
||
### Public APIs | ||
|
||
`\Magento\Vault\Api\PaymentMethodListInterface`: | ||
|
||
- Contains methods to retrieve vault payment methods. | ||
- This interface is consistent with \Magento\Payment\Api\PaymentMethodListInterface | ||
|
||
Read a detailed description of the [Magento_Sales API](https://devdocs.magento.com/guides/v2.4/mrg/ce/Sales/services.html). | ||
|
||
For information about a public API, see [Public interfaces & APIs](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,28 @@ | ||
# VaultGraphQl | ||
# Magento_VaultGraphQl module | ||
|
||
**VaultGraphQl** provides type and resolver information for the GraphQl module | ||
to generate Vault (stored payment information) information endpoints. This module also | ||
provides mutations for modifying a payment token. | ||
The Magento_VaultGraphQl module extends Magento_GraphQl and Magento_Vault modules. | ||
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. This shouldn't be the first line. I'm not sure you need it at all, considering the contents of the Installation details section. |
||
|
||
The Magento_VaultGraphQl module provides type and resolver information for the GraphQl module to generate Vault (stored payment information) information endpoints. | ||
|
||
The Magento_VaultGraphQl module also provides mutations for modifying a payment token. | ||
|
||
## Installation details | ||
|
||
The Magento_VaultGraphQl is dependent on the following modules: | ||
|
||
- Magento_Vault | ||
- Magento_GraphQl | ||
|
||
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). | ||
|
||
## Additional information | ||
|
||
For more information about the Magento_VaultGraphQl [Queries](#queries) and [Mutations](#mutations) see below: | ||
|
||
### Queries {#queries} | ||
|
||
- [`customerPaymentTokens`](https://devdocs.magento.com/guides/v2.4/graphql/queries/customer-payment-tokens.html) | ||
|
||
### Mutations {#mutations} | ||
|
||
- [`deletePaymentToken`](https://devdocs.magento.com/guides/v2.4/graphql/mutations/delete-payment-token.html) |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1 +1,3 @@ | ||||||
Magento\Version Allows to get Magento version and edition by HTTP GET request | ||||||
# Magento_Version module | ||||||
|
||||||
The Magento_Version module allows to get Magento version and edition by HTTP GET request. | ||||||
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
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,5 +1,30 @@ | ||||||
# Webapi | ||||||
# Magento_Webapi module | ||||||
|
||||||
**Webapi** provides the framework for the application to expose REST and SOAP web services. It exposes an area for REST | ||||||
and another area for SOAP services and routes requests based on the Webapi configuration. It also handles | ||||||
deserialization of requests and serialization of responses. | ||||||
The Magento_Webapi module provides the framework for the application to expose REST and SOAP web services. It exposes an area for REST and another area for SOAP services and routes requests based on the Webapi configuration. | ||||||
|
||||||
The Magento_Webapi module also handles deserialization of requests and serialization of responses. | ||||||
|
||||||
## Installation details | ||||||
|
||||||
The Magento_VaultGraphQl is dependent on the following modules: | ||||||
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
|
||||||
|
||||||
- Magento_Authorization | ||||||
- Magento_Backend | ||||||
- Magento_Integration | ||||||
- Magento_Store | ||||||
|
||||||
Before disabling or uninstalling this module, note the following dependencies: | ||||||
|
||||||
- Magento_WebapiAsync | ||||||
|
||||||
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). | ||||||
|
||||||
### Layouts | ||||||
|
||||||
This module introduces the following layouts and layout handles in the directories: | ||||||
|
||||||
- `view/adminhtml/layout`: | ||||||
- `adminhtml_integration_edit` | ||||||
- `adminhtml_integration_permissionsdialog` | ||||||
|
||||||
For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). |
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.