-
Notifications
You must be signed in to change notification settings - Fork 97
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
Glue concept page #1998
Merged
Merged
Glue concept page #1998
Conversation
This file contains 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
gechetspr
requested review from
VadymSachenko,
lenadoc,
AlexSlawinski and
andriitserkovnyi
as code owners
July 12, 2023 15:03
gechetspr
added
TW review needed
PR needs Technical writer's review
new
PR contains a new document
labels
Jul 12, 2023
VadymSachenko
added
in TW review
PR is in review by a technical writer
and removed
TW review needed
PR needs Technical writer's review
labels
Jul 13, 2023
VadymSachenko
suggested changes
Jul 13, 2023
|
||
### New type of application: Glue Backend API application | ||
|
||
With the current setup out of the box, we have an additional Glue Backend API (BAPI) application that is meant to be an API application for our Back Office. This means that with this new application, infrastructure has direct access to Zed facades from BAPI resources. Also, out of the box, we have a separate `/token` resource specifically for BAPI that uses Back Office users' credentials to issue a token for BAPI resource. |
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.
Adjust the phrase: should be “for a BAPI resource” or “for BAPI resources”
|
||
* **Relationship modules**: Such modules represent relationships between two different resources. Their task is to extend the response of one of the resources with data of related resources. OOTB only applicable for resources that are using JSON:API convention. | ||
|
||
To be able to process API requests correctly, Resource modules need to implement resource plugins that facilitate the routing of requests to the module. Such plugins need to be registered in the application they are related to. Also plugins must implement a convention resource interface if it must implement one. |
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.
Suggested change
To be able to process API requests correctly, Resource modules need to implement resource plugins that facilitate the routing of requests to the module. Such plugins need to be registered in the application they are related to. Also plugins must implement a convention resource interface if it must implement one. | |
To be able to process API requests correctly, the `Resource` modules need to implement resource plugins that facilitate the routing of requests to the module. Such plugins need to be registered in the application they are related to. Also plugins must implement a convention resource interface if it must implement one. |
VadymSachenko
added
ready for merge
The PR can be merged
and removed
in TW review
PR is in review by a technical writer
labels
Jul 18, 2023
gechetspr
commented
Jul 19, 2023
gechetspr
commented
Jul 19, 2023
VadymSachenko
approved these changes
Jul 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Description
TBD
Checklist