X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=424b3d23c082585fb6667ae7eccbd21de8395421;hb=2aad6d681dcbea5564425648375f7ddca2080940;hp=a83c5d4cee33f1460dbe740d80e00c7e42ffae65;hpb=f172e9d4656c960e81f72cc6d6e52770271df9c9;p=clamp.git 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://: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 `", ":download:`link `", ":download:`link `" Consumed APIs