New revision of dialog available in response header after change

[elsand]

Introduction

Whenever a part of the dialog aggregate is changed, causing a new revision to made, the new revision should be made available to callers

Description

In order for a client to keep track of revisions, whenever a POST is performed for a new dialog, a PUT/PATCH is performed on an existing dialog, or a POST is performed to add a transmission or activity, the updated revision id should be made available in a HTTP response header.

Implementation

As this is a custom reponse header, it should be prefixed with x-, such as x-dialog-new-revision-id

Tasks

Preview Give feedback

1. Add response header to all commands causing a dialog revision to be updated
2. Prepare documentation (if relevant - either update working document, or add a new file in docs)
3. Add e2e-test (if relevant)

Threat modelling

Preview Give feedback

1. Does this change introduce any potential security issues? No

Acceptance criteria

Case 1: New Dialog Created

GIVEN a client performs a POST request to create a new dialog,
WHEN the dialog is successfully created,
THEN the response includes an x-dialog-new-revision-id header containing the new revision ID.

Case 2: Existing Dialog Updated

GIVEN a client performs a PUT or PATCH request to update an existing dialog,
WHEN the update is successful and a new revision is created,
THEN the response includes an x-dialog-new-revision-id header containing the updated revision ID.

Case 3: Transmission or Activity Added

GIVEN a client performs a POST request to add a transmission or activity to a dialog,
WHEN the addition is successful and a new revision is created,
THEN the response includes an x-dialog-new-revision-id header containing the new revision ID.

Negative Case: No Revision Created

GIVEN a client performs any of the above requests,
WHEN the operation fails or does not result in a new revision being created,
THEN the response does not include the x-dialog-new-revision-id header.