Generate API documents

[clamp.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 6ba96dc..424b3d2 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,21 +11,23 @@ CLAMP - Closed Loop Automation Management Platform
 
 Offered APIs
 ------------
-CLAMP offers the following API:
-* HealthCheck
+The list of APIs that CLAMP has offered could be find in the following table:
 
-.. line-block::
+.. |pdf-icon| image:: images/pdf.png
+              :width: 40px
 
-   URL: http://<host>:8080/restservices/clds/v1/clds/healthcheck
-   Result: if in good health it will return OK: "HTTP/1.1 200", and the following json string content:
+.. |swagger-icon| image:: images/swagger.png
+                   :width: 40px
 
-.. code-block:: json
+.. |html-icon| image:: images/html.png
+               :width: 40px
 
-    {
-        "healthCheckComponent": "CLDS-APP",
-        "healthCheckStatus": "UP",
-        "description": "OK"
-    }
+.. csv-table::
+   :header: "|Swagger-icon|", "|html-icon|", "|pdf-icon|"
+   :widths: 60,60,60
+
+   "swagger json file", "html doc", "pdf doc"
+   ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.pdf>`"
 
 
 Consumed APIs
@@ -133,32 +135,38 @@ SDC-Controllers config
 This file is a JSON that must be specified to Spring config, here is an example:
 
 .. code-block:: json
-       {
-         "sdc-connections":{
-           "sdc-controller1":{
-               "user": "User1",
-               "consumerGroup": "consumerGroup1",
-               "consumerId": "consumerId1",
-               "environmentName": "environmentName1",
-               "sdcAddress": "sdc.api.simpledemo.onap.org:8080",
-               "password": "bb3871669d893c7fb8aaacda31b77b4f537E67A081C2726889548ED7BC4C2DE6",
-               "pollingInterval":10,
-               "pollingTimeout":30,
-               "messageBusAddresses":["localhost"]
-           },
-            "sdc-controller2":{
-               "user": "User2",
-               "consumerGroup": "consumerGroup2",
-               "consumerId": "consumerId2",
-               "environmentName": "environmentName2",
-               "sdcAddress": "sdc.api.simpledemo.onap.org:8080",
-               "password": "bb3871669d893c7fb8aaacda31b77b4f537E67A081C2726889548ED7BC4C2DE6",
-               "pollingInterval":10,
-               "pollingTimeout":30,
-               "messageBusAddresses":["localhost"]
-           }
-         }
-       }
+ {
+  "sdc-connections":{
+    "sdc-controller1":{
+        "user": "clamp",
+        "consumerGroup": "consumerGroup1",
+        "consumerId": "consumerId1",
+        "environmentName": "AUTO",
+        "sdcAddress": "localhost:8443",
+        "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
+        "pollingInterval":30,
+        "pollingTimeout":30,
+        "activateServerTLSAuth":"false",
+        "keyStorePassword":"",
+        "keyStorePath":"",
+        "messageBusAddresses":["dmaaphost.com"]
+    },
+    "sdc-controller2":{
+        "user": "clamp",
+        "consumerGroup": "consumerGroup1",
+        "consumerId": "consumerId1",
+        "environmentName": "AUTO",
+        "sdcAddress": "localhost:8443",
+        "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
+        "pollingInterval":30,
+        "pollingTimeout":30,
+        "activateServerTLSAuth":"false",
+        "keyStorePassword":"",
+        "keyStorePath":"",
+        "messageBusAddresses":["dmaaphost.com"]
+    }
+  }
+ }
 
 Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.
 Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.