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>
diff --git a/docs/index.rst b/docs/index.rst
index a83c5d4..424b3d2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,21 +11,23 @@
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