Skip to content

Update required-configuration-files.md #265

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update required-configuration-files.md #265

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37f57a8
Update required-configuration-files.md
yogesh-valiya May 11, 2024
98db011
Update required-configuration-files.md
yogesh-valiya May 11, 2024
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
6 changes: 4 additions & 2 deletions src/pages/development/build/required-configuration-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,14 @@ In addition to those files, a module also has nested configuration directories i

* `<your module root dir>/etc/adminhtml/`
* `<your module root dir>/etc/frontend/`
* `<your module root dir>/etc/graphql/`
* `<your module root dir>/etc/webapi_rest/`
* `<your module root dir>/etc/webapi_soap/`

### Global vs local

* Configuration files that are in the top level of that module's `etc` directory are global to that component.
* Configuration files placed in subdirectories (`adminhtml`, `frontend`, `webapi_rest`, `webapi_soap`) apply only to those respective functional areas.
* Configuration files placed in subdirectories (`adminhtml`, `frontend`, `graphql`, `webapi_rest`, `webapi_soap`) apply only to those respective functional areas.

### Requirements

Expand All @@ -57,9 +58,10 @@ Similarly, if your module changes the UI, you should add the needed configuratio
* `<your module root dir>/etc/frontend/di.xml`
* `<your module root dir>/etc/frontend/page_types.xml`

If the module is a service that may call an API, or does some other work that is not manifested in the UI you should add any needed configuration files in the REST and/or SOAP webapi configuration directories, like this:
If the module is a service that may call an API, or does some other work that is not manifested in the UI you should add any needed configuration files in the GraphQL, REST and/or SOAP webapi configuration directories, like this:

* `<your module root dir>/etc/webapi_rest/di.xml`
* `<your module root dir>/etc/webapi_soap/di.xml`
* `<your module root dir>/etc/graphql/di.xml`

Keep in mind that you might be able to handle your module's configuration solely with configuration files at the top level of your module's `etc` directory, but the nested directory is a useful way to keep the configuration neatly compartmentalized.
Loading