-
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
Open
chiranjeevi-cj
wants to merge
13
commits into
magento:2.4-develop
Choose a base branch
from
chiranjeevi-cj:update-modules-readme-starts-with-v
base: 2.4-develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
83a6e30
updated readme file
724becf
Apply suggestions from code review
chiranjeevi-cj ef17c6c
Update README.md
chiranjeevi-cj 70726a4
Update README.md
chiranjeevi-cj 9cb03a5
Update README.md
chiranjeevi-cj 1f55467
Update README.md
chiranjeevi-cj a402aa9
Update README.md
chiranjeevi-cj 7cbba91
Update README.md
chiranjeevi-cj 3d69c0a
Update README.md
chiranjeevi-cj d17828f
Grammar pass
dobooth 65895ba
Grammar update
dobooth f2ff275
Grammar
dobooth b93026b
Grammar pass
dobooth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,39 @@ | ||
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 creating custom variables and then use them in email templates or in WYSIWYG editor for editing description of system entities. | ||
|
||
## Installation details | ||
|
||
Before installing this module, note that the **Magento_Variable** is dependent on the following modules: | ||
|
||
- Magento_Config | ||
- Magento_Store | ||
|
||
Before disabling or uninstalling this module, please consider the following dependencies: | ||
|
||
- Magento_Cms | ||
- Magento_Email | ||
|
||
Please find here [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). | ||
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. Change all these "Please find here..." to "Refer to [...) for more information." |
||
|
||
### 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 in Magento 2, 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 in Magento 2, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html). | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 the latter available as a payment method in Magento. | ||
|
||
## Installation details | ||
|
||
Before installing this module, note that the **Magento_Vault** 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, please consider the following dependencies: | ||
chiranjeevi-cj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Magento_Paypal | ||
|
||
Please find here [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). | ||
|
||
## 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 information about the event system in Magento 2, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events). | ||
chiranjeevi-cj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 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 in Magento 2, 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 | ||
|
||
[Learn 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 in Magento 2, see [Public interfaces & APIs](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
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 | ||
|
||
Before installing this module, note that the **Magento_VaultGraphQl** is dependent on the following modules: | ||
|
||
- Magento_Vault | ||
- Magento_GraphQl | ||
|
||
For information about enabling or disabling a module in Magento 2, 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
Before installing this module, note that the **Magento_VaultGraphQl** is dependent on the following modules: | ||
|
||
- Magento_Authorization | ||
- Magento_Backend | ||
- Magento_Integration | ||
- Magento_Store | ||
|
||
Before disabling or uninstalling this module, please consider the following dependencies: | ||
chiranjeevi-cj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Magento_WebapiAsync | ||
|
||
For information about enabling or disabling a module in Magento 2, 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 in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.