Issue : Adding Collaboration Workflow via collaboration header to the Replay API
Status
-
Proposed -
Trialing -
Under review -
Approved -
Retired
Problem Statement
Currently the Replay functionality in the Storage service has two API -
- GET - to fetch replay status.
- POST - to trigger the replay API.
For more context refer to ADR: Replay API
The Replay APIs presently do not offer support for collaboration workflow via the collaboration header. For further context on collaboration context refer to - collaboration workflow.
Proposed solution
GET API - As the GET Replay API does not engage with the storage records, the x-collaboration header is unnecessary. Its primary purpose is to retrieve Replay Status from the ReplayStatus collection within the database.
POST API - As POST API engage with the storage records in storage service, a user may require replaying the record with specific collaboration id. To facilitate this, we need to support the collaboration header in the Replay API. This will require two changes -
- How replay fetch the records Id to perform the replay operation
- How replay publish record change message to the service bus.
The ADR focuses on bringing these two changes to the Replay API.
Consequences
- Replay API start supporting collaboration workflow via collaboration header.