url correction and improve API doc

[so.git] / docs / api / offered_consumed_apis.rst

diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst
index 6f8b7fc..1d0a8f0 100644 (file)
--- a/docs/api/offered_consumed_apis.rst
+++ b/docs/api/offered_consumed_apis.rst
@@ -3,13 +3,44 @@
 .. Copyright 2018 Huawei Technologies Co., Ltd.
 
 SO Offered and Consumed APIs
-=====================================
+============================
+
+The list of APIs that SO offers can be found in following table:
+
+.. |yml-icon| image:: swagger/images/yaml.png
+              :width: 40px
+
+.. |swagger-icon| image:: swagger/images/swagger.png
+                   :width: 40px
+
+.. |html-icon| image:: swagger/images/html.png
+               :width: 40px
+
+.. csv-table::
+   :header: "|Swagger-icon|", "|html-icon|", "|yml-icon|"
+   :widths: 60,60,60
+
+   "swagger json file", "html doc", "yaml doc"
+   ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.yaml>`"
+
+The list of APIs that SO offerers for monitoring the BPMN flows
+could be found in the following table:
+
+.. csv-table::
+   :header: "|Swagger-icon|", "|yml-icon|"
+   :widths: 60,60
+
+   "swagger json file", "yaml doc"
+   ":download:`link <swagger/SO_MONITORING_SWAGGER.json>`", ":download:`link <swagger/SO_MONITORING_SWAGGER.yaml>`"
+
+Further Reading
+---------------
+
+Detailed documentation can be found here:
 
-SO APIs
---------
-All the Service Orchestrator APIs, both inward and outward are documented in the below link of onap wiki.
- 
 .. toctree::
    :maxdepth: 1
-   
-   SO_Interface.rst
+
+   apis/serviceInstances-api.rst
+   apis/e2eServiceInstances-api.rst
+   apis/consumed-apis.rst