From bc5006bf5a7a7c2d8c01bfca6ac64b4ca8009770 Mon Sep 17 00:00:00 2001 From: kmohr-soprasteria <57349523+kmohr-soprasteria@users.noreply.github.com> Date: Thu, 5 Jun 2025 14:04:58 +0200 Subject: [PATCH] [Refinement-Notifications] Update readme for latest changes Fixes #1280 --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ceb8667..2a42627b 100644 --- a/README.md +++ b/README.md @@ -62,10 +62,18 @@ Also **notification handling** has been changed: - now, Kafka has been added in between NP and MWDI to overcome the performance problems - NP will push the notifications to Kafka ("proper" notification topic) - MWDI will pull the notifications from Kafka ("proper" notification topic) - - the *regard*-services previously called by NP to push the notifications to MWDI, will now be called from MWDI internally after pulling of notifications + - the *regard*-services previously called by NP to push the notifications to MWDI have been deprecated + - as their functionality shall be used internally, their callbacks have been modified slightly (input descriptions now consider whether the callbacks are called from the *regard*-service or via the internal process) + - however, to process the notifications the functionality from the *regard*-services shall be executed internally (i.e. without opening new http sessions). + - for each proper notification type, there is a new callback under /v1/embed-yourself, + - that has an *apply* substep, which takes the related notifications of that type as input (url contains the MWDI tcp client uuid as target, as there is no explicit service related) + - this substep is followed by the substeps taken from the callback sections of the *regard*-services (due to nesting, the original callback names from *regard*-services had to used as substep names, the url had to be provided in the substep lines instead of an additional url line; also where required, substeps from *regard*-service callbacks were split into separate substeps). The list of related issues can be found in issue collection [MWDI v2.0.0_spec](https://github.com/openBackhaul/MicroWaveDeviceInventory/milestone/20). + Any issues found during implementer review will be found in [MWDI v2.0.1_spec](https://github.com/openBackhaul/MicroWaveDeviceInventory/milestone/21). +- this e.g. contains updating the testcases +- but also contains an issue related to a possible change in how MWDI interacts with Kafka **v1.2.1** Spec release version 1.2.2 fixes further findings found by implementers during implementation of v1.2.1.