diff options
| author |   Sébastien Determe <sd378r@intl.att.com> | 2018-05-23 15:52:30 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2018-05-23 15:52:30 +0000 |
| commit | 2206cf470405b527b5d666cf657f011eac6e0b80 (patch) | |
| tree | 6a8d2391edcc5092b5047151d540da4a43edfae7 /docs/index.rst | |
| parent | 090d9eadb13e5833bd179ede05d9b158e524ae54 (diff) | |
| parent | 2aad6d681dcbea5564425648375f7ddca2080940 (diff) | |
Merge "Generate API documents"
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/docs/index.rst b/docs/index.rst index a83c5d4ce..424b3d23c 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 |