From 2aad6d681dcbea5564425648375f7ddca2080940 Mon Sep 17 00:00:00 2001
From: xg353y <xg353y@intl.att.com>
Date: Fri, 18 May 2018 17:59:06 +0200
Subject: Generate API documents

Adding maven plugins to scan Clamp code automatically and generate
swagger.json, html and pdf documents with the exposed Clamp API
information.

Issue-ID: CLAMP-169
Change-Id: Ia46cd2aa7000251b30c9eaaa040f1f8d9246af45
Signed-off-by: xg353y <xg353y@intl.att.com>
---
 docs/index.rst | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

(limited to 'docs/index.rst')

diff --git a/docs/index.rst b/docs/index.rst
index a83c5d4c..424b3d23 100644
--- 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
-- 
cgit 1.2.3-korg