From 2e80492c4034e1e9601805758c3155e2591905cf Mon Sep 17 00:00:00 2001 From: Nikolay Stanchev <ns17@it-innovation.soton.ac.uk> Date: Wed, 7 Aug 2019 09:20:24 +0100 Subject: [PATCH] Adds info on source code files in development guide --- docs/clmc-development-guide.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/clmc-development-guide.md b/docs/clmc-development-guide.md index cf8b7e9..4584bff 100644 --- a/docs/clmc-development-guide.md +++ b/docs/clmc-development-guide.md @@ -207,10 +207,19 @@ The source code is organised in various python subpackages. Each subpackage is t * **src/service/clmcservice/alertsapi** - the source code of the CLMC alerts API used for managing alerts and trigger notifications -* **src/service/clmcservice/graphapi** - the source code of the CLMC graph API used for calculating round-trip time and performing graph-based measurements + * **src/service/clmcservice/alertsapi/alerts_specification_schema.py** - defines the validation schema for alerts specification documents + * **src/service/clmcservice/alertsapi/views.py** - defines the API functions of the alerts API, API endpoints are named with identifiers which are then mapped to URLs + * **src/service/clmcservice/alertsapi/utilities.py** - utility functions used to fill Kapacitor templates (with data extracted from the alerts specification document) +* **src/service/clmcservice/graphapi** - the source code of the CLMC graph API used for calculating round-trip time and performing graph-based measurements + + * **src/service/clmcservice/graphapi/views.py** - defines the API functions of the graph API, API endpoints are named with identifiers which are then mapped to URLs + * **src/service/clmcservice/graphapi/utilities.py** - utility functions used for interacting with the Neo4j graph + * **src/service/clmcservice/managementapi** - the source code of the CLMC data management API used for managing (e.g. deleting) the data of a service function chain + * **src/service/clmcservice/managementapi/views.py** - defines the API functions of the graph API, API endpoints are named with identifiers which are then mapped to URLs + * **src/service/clmcservice/models** - package for any persistency related code (e.g. object relational mappings) * **src/service/clmcservice/static** - static files that are required by the CLMC service, e.g. the TOSCA alerts definitions file -- GitLab