Skip to content

Updated webapi async module readme file #31419

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Updated webapi async module readme file #31419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions app/code/Magento/WebapiAsync/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# WebapiAsync
# Magento_WebapiAsync module

**WebapiAsync** Extends Webapi extension and provide functional to process asynchronous requests. It handle asynchronous requests, schedule, publish and consum bulk operations from queue.
**Magento_WebapiAsync** module extends Webapi extension and provide functional to process asynchronous requests.

**Magento_WebapiAsync** module handles asynchronous requests, schedule, publish and consume bulk operations from a queue.

## Installation details

Before installing this module, note that the **Magento_WebapiAsync** is dependent on the following modules:

- Magento_AsynchronousOperations
- Magento_Customer
- Magento_User
- Magento_Webapi

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).

## Structure

`Code/` - the directory that contains Remote service reader configuration files.

For information about a typical file structure of a module in Magento 2, see [Module file structure](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).

## Extensibility

Extension developers can interact with the Magento_WebapiAsync module. For more information about the Magento extension mechanism, see [Magento plug-ins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).

[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_WebapiAsync module.