Skip to content

Commit

Permalink
Updated webapi async module readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
CJ committed Dec 23, 2020
1 parent 38d712e commit 0b5401f
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions app/code/Magento/WebapiAsync/README.md
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.

0 comments on commit 0b5401f

Please sign in to comment.