From f00ff6c58ba1d5f7e5acc95f41dcb14f0b77edcd Mon Sep 17 00:00:00 2001
From: Christos Tranoris <tranoris@gmail.com>
Date: Fri, 24 Jan 2025 14:15:31 +0200
Subject: [PATCH] updated doc

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5b7f8d4..6b1e690 100644
--- a/README.md
+++ b/README.md
@@ -18,4 +18,17 @@ here we have:
 
 The project registers automatically the two Resource Specifications (RSpecs) and we added handler functions for create, update and delete.
 
-So when you create CFSs services using these (RSpecs) the Service Orchestrator will call these functions via the queue
\ No newline at end of file
+So when you create CFSs services using these (RSpecs) the Service Orchestrator will call these functions via the queue
+
+See BootstrapService that registers the two RSpecs as LogicalResourceSpecifications
+
+The two classes has function to transform to TMF RSpecs, as well as to save back to OpenSlice their Resource Instances (thus they will go to the inventory)
+
+The ResourceRepoService class has method calls for the handling of the messages from the orchestrator.
+
+Useful metadata are included in some headers of the message:
+
+- important header org.etsi.osl.resourceId  is the UUID of the related resource that was created in OpenSlice and reflects the resource that this controller will handle. NOTE: you need to UPDATE this resource back in TMFAPI and set the status at least ResourceStatusType.AVAILABLE or TERMINATED if there are errors, etc 
+- header org.etsi.osl.serviceOrderId is the UUID of the related service order
+- header org.etsi.osl.serviceId is the UUID of the related services 
+
-- 
GitLab