[POLICY_STORE] Dedicated removal of policy from BPNL

[mkanal]

As user
I want to remove policy from a BPNL collection
so that the user removes a dedicated policy from a BPNL

Link

• relates [POLICY_STORE] No movement of policyId from one BPNL to other BPNL in case of Update #560
• relates to [Concept] Improvement of Policy Store API #561
• relates to [POLICY_STORE] Improvements Policy Store input validation #528
• relates to [POLICY_STORE] Dedicated removal of policy from BPNL #559
• relates to [POLICY_STORE] No movement of policyId from one BPNL to other BPNL in case of Update #560

Hints / Details

• ...

Acceptance Criteria

• [ ] API endpoints supports removal of policyId from BPNL
• [ ] Add integration tests to cover the functionality

DELETE /irs/policies/<thePolicyId>/bpnl/<theBPNL>

disadvantages:

only 1:1 delete
requires another endpoint for adding BPNL to a polidy

advantage:

easy error handling

Out of Scope

• ...

[dsmf]

suggestion:
DELETE /irs/policies/<thePolicyId>/bpnl/<theBPNL>

disadvantages:

• only 1:1 delete
• requires another endpoint for adding BPNL to a polidy

advantage:

• easy error handling

more flexible alternatives that do both update and delete:

with entry point BPNL:

PATCH /irs/bpnls/<BPNL>

body for automatic addition / removal:

{
	policyIds: [ <list of policyIds> ]
}

body for for defined addition / removal:

{
	policyIdsToAdd: [ <list of policyIds> ],
	policyIdsToRemove: [ <list of policyIds> ] 
}


in both cases response:

{
	policyIdsAdded: [ <list of policyIds> ],
	policyIdsRemoved: [ <list of policyIds> ],
        errors: [ ... ]
}

with entry point policy:

PATCH /irs/policies/<policyId>

body for automatic addition / removal:

{
	bpnls: [ <list of BPNLs> ]  
}

body for for defined addition / removal:

{
	bpnlsToAdd: [ <list of BPNLs> ],  
	bpnlsToRemove: [ <list of BPNLs> ]
}


in both cases response:


response

{
	bpnlsAdded: [ <list of policyIds> ],
	bpnlsRemoved: [ <list of policyIds> ],
        errors: [...]
}

Delete policy from all BPNLs stays as it is currently implemented:

DELETE /irs/policies/<thePolicyId>

[dsmf]

Pull Request

• Feat/559 Dedicated Removal of Policy from BPNL #614 (merged)
• Synch PR: Synch catenax-ng/tx-item-relationship-service#931

Outcome

• DELETE /irs/policies/<thePolicyId>/bpnl/<theBPNL> implemented
• integration test: TRI-2005

[dsmf]

ready for peer review

[dsmf]

@mkanal, @ds-kgassner -> ready for test

[ds-kgassner]

tested successfully - approved from my side

[dsmf]

@mkanal -> ready for PO review

[mkanal]

LGFM. PO acceptance in behalf of @jzbmw