From a59e2d7b0af7a2c3f234123becefcae636e81edb Mon Sep 17 00:00:00 2001
From: Nikolay Stanchev <ns17@it-innovation.soton.ac.uk>
Date: Wed, 18 Jul 2018 11:19:59 +0100
Subject: [PATCH] Updates Graph API with Assumptions section
---
docs/clmc-service.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/docs/clmc-service.md b/docs/clmc-service.md
index bbb4828..ab1179f 100644
--- a/docs/clmc-service.md
+++ b/docs/clmc-service.md
@@ -37,6 +37,13 @@ It offers different API endpoints to configure and control the aggregator as wel
#### Graph API Endpoints
+* **Assumptions**
+ * For each service function, there is a field/fields from which the service function response time (service delay) can be derived.
+ * For each service function, there is a field/fields from which an average estimation of the size of a **request** to this service function can be derived.
+ * For each service function, there is a field/fields from which an average estimation of the size of a **response** from this service function can be derived.
+ * All the aforementioned fields reside in a single measurement.
+ * There is at most 1 service function hosted on a particular endpoint.
+
* **POST** ***/graph/temporal?from={timestamp-seconds}&to={timestamp-seconds}***
This API method sends a request to the CLMC service to build a graph related to the time range declared with the *from* and *to* URL parameters.
--
GitLab