Finalize design and modeling documentation

Issue-ID: CPS-447
Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
Change-Id: I58181dd7018319c46d465c78b8299c3f316f455e

1 files changed, 30 insertions, 6 deletions

diff --git a/docs/content/design.rst b/docs/content/design.rst
index 7a6590d..c414e6d 100644
--- a/docs/content/design.rst
+++ b/docs/content/design.rst
@@ -8,13 +8,37 @@
 CPS Temporal Design
 ===================
 
-.. warning:: Draft
+Exposed APIs
+============
 
-* REST API
+CPS Temporal is providing a REST HTTP API to query historical CPS data.
+Its OPEN API Specification can be found either:
 
-  * Specification
-  * Postman Collection
+* In :download:`openapi.yml <../_static/openapi/swagger/openapi.yml>`
+  file
+* At ``https://<cps-temporal-host>:<cps-temporal-port>/swagger/openapi.yml``
+  endpoint available on CPS Temporal running instance
 
-* Event Schema
+Swagger UI is also available at:
 
-  * Json Schema
+* ``https://<cps-temporal-host>:<cps-temporal-port>/swagger-ui.html``
+
+And following Postman collection can be used to send requests to any running
+instance:
+
+* :download:`CPS Temporal Postman Collection <../_static/postman-collections/cps-temporal-postman-collection.json>`
+
+Event Integration
+=================
+
+CPS Core and CPS Temporal are integrated with an event driven architecture.
+Integration between these two components is event notification based.
+
+For each data modification handled by CPS Core,
+
+* CPS Core is publishing, to a dedicated Kafka topic, an event representing
+  the data configuration or state.
+* CPS Temporal is listening to the same topic for the event and is responsible
+  to keep track of all data over time.
+
+Refer to :doc:`modeling` for more details on the event structure.