From de38c5d0d9c8b9969dac52ca17ecceeaf6fdffe8 Mon Sep 17 00:00:00 2001
From: Waleed Akbar <wakbar@cttc.es>
Date: Tue, 11 Jun 2024 10:16:25 +0000
Subject: [PATCH] KpiManager Service README.md file completed

---
 src/kpi_manager/README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/kpi_manager/README.md b/src/kpi_manager/README.md
index 131bf1efd..fdfdf7f54 100644
--- a/src/kpi_manager/README.md
+++ b/src/kpi_manager/README.md
@@ -12,11 +12,11 @@ The following requirements should be fulfilled before the execuation of this mod
 ### Messages format templates
 ["Messages"](https://labs.etsi.org/rep/tfs/controller/-/blob/feat/71-cttc-separation-of-monitoring/src/kpi_manager/tests/test_messages.py) python file enlist the basic messages format used during the testing.
 
-### Test File
+### Test file
 ["KPI manager test"](https://labs.etsi.org/rep/tfs/controller/-/blob/feat/71-cttc-separation-of-monitoring/src/kpi_manager/tests/test_kpi_manager.py) python file enlist the different tests conducted during the experiment.
 
 ### Flow of execution
-1. Call "" and "" function, this will create the required database and table, if they doesn't exist.
-`
-GRPC_HEALTH_PROBE_VERSION=v0.2.0 
-`
+1. Call the `create_database()` and `create_tables()` functions from `Kpi_DB` class to create the required database and table if they don't exist.
+2. Call the gRPC method `SetKpiDescriptor(KpiDescriptor)->KpiId` to add the KpiDescriptor in `Kpi` DB. `KpiDescriptor` and `KpiId` are both pre-defined gRPC message types.
+3. Call `GetKpiDescriptor(KpiId)->KpiDescriptor` to read the `KpiDescriptor` from DB and `DeleteKpiDescriptor(KpiId)` to delete the `KpiDescriptor` from DB.
+4. Call `SelectKpiDescriptor(KpiDescriptorFilter)->KpiDescriptorList` to get all `KpiDescriptor` objects that matches the filter criteria. `KpiDescriptorFilter` and `KpiDescriptorList` are pre-defined gRPC message types.
\ No newline at end of file
-- 
GitLab