Skip to content
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 24 commits into from
Jul 19, 2023
Merged

Glue concept page #1998

merged 24 commits into from
Jul 19, 2023

Conversation

gechetspr
Copy link
Collaborator

PR Description

TBD

Checklist

  • I agree with the Code Contribution License Agreement in CONTRIBUTING.md

@gechetspr gechetspr added TW review needed PR needs Technical writer's review new PR contains a new document labels Jul 12, 2023
@VadymSachenko 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

### 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.
Copy link
Contributor

@VadymSachenko VadymSachenko Jul 13, 2023

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.
Copy link
Contributor

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 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
@VadymSachenko VadymSachenko merged commit da8b90e into master Jul 19, 2023
@VadymSachenko VadymSachenko deleted the glue-concept-page branch July 19, 2023 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new PR contains a new document ready for merge The PR can be merged
Development

Successfully merging this pull request may close these issues.

2 participants