ForgeFlux/docs
2
0
Fork 0
Code Issues 1 Pull requests 2 Projects Releases Packages Wiki Activity
docs/content/services/interface.md
dat-adi 40bce2aec3 Moved everything into the parent directory 
I figured that this is going to be the main source of truth unlike
an OpenAPI Specification, and as such is the only one that we
should be following.
2022-01-12 13:13:45 +05:30

981 B
Raw Blame History

+++ title = "Interface" weight = 40 +++

Interface

Interface is a service that acts as a connecting end of the bridge, listening in for Notifications from a particular forge repository.

These notifications, which may be in the form of a Comment, Issue, or Pull Request, are then further defined into Events to create a workable unit set, that the interface can use to translate operations from one forge to another forge.

The procedure of the Notification-Event Translation System, works as follows,

  1. Upon creation of the Interface, and set up of a forge repository to look for, the interface subscribes to the forge's notifications.
  2. Every notification received by the interface from the forges, is then identified and translated into it's respective Event model, be it an Issue or PR.
  3. Upon conversion into the respective model, Interface processes these Events, and converts them into the model required for the destination forge.