Provide SDs for all changes to the existing API (part 1)

[ggrg]

Goal:

As a core OSS team member
I want to update the stack of settlement related sequence diagrams (SDs)
so that Request settlement by currency is supported by Settlements API v2.

The scope of this story is to provide all SDs to accommodate for all changes referred in OSS Settlement BRD, section 6.1 Request settlement by currency.

Tasks:

• Provide sequence diagrams for Request settlement by currency
  • 6.1.2. Close Settlement Window (closeSettlementWindow) [@ggrg]
    • Validate and update following peer review [@ggrg]
  • 6.2.1. Trigger Settlement Event (createSettlement) [@ggrg]
    • Validate and update following peer review [@ggrg]
  • 6.2.5. Acknowledgement of Settlement Transfer (updateSettlementById) [@ggrg]
• Peer review and validation [@ggrg]
• Present to DA [@ggrg]
• Apply requested DA changes [@ggrg]

Outside epic scope:

List of sequence diagrams which are not included in Request Settlement by Currency epic

• Provide SDs for all changes to the existing API (part 2) #1105 diagrams
• (new) Define a Settlement Model
• (new) Get Settlement Model By Id

Acceptance Criteria:

• Existing SD stack is updated
• SDs are approved by the DA
• Documentation is updated

Pull Requests:

• feature/1094 Sequence Diagrams Part 1 documentation#148

Follow-up:

• Provide SDs for all changes to the existing API (part 2) #1105

Dependencies:

• Alter DB schema to support for Request settlement by currency #1093

Accountability:

• Owner: @ggrg, @MichaelJBRichards
• QA/Review: DA

[ggrg]

@elnyry, @MichaelJBRichards - story is moved to Blocked until the peer review is made