summaryrefslogtreecommitdiffstats
path: root/docs/guides
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2017-11-06 20:33:21 +0000
committerEric Debeau <eric.debeau@orange.com>2017-11-06 20:35:25 +0000
commit70823aff0d159b9ae7983b39d27cdd8e7cb95a89 (patch)
tree93584811082b49f7fca37db0d74c400eda0ce769 /docs/guides
parentdc8ff9d4790e59d3cf0d7c1d03fc8ae5c4fe549c (diff)
Create API reference page
Change-Id: Ia6945fd05a94155f17d2f16dfdb75c1ae8577caf ISSUE-ID: DOC-152 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/onap-developer/apiref/index.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index bad279375..277dd1574 100644
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -7,3 +7,45 @@
API Reference
=============
+.. note::
+ Some high level groupings are introduced below with references to
+ API offered by the various components.
+
+User Interfaces
+---------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst>
+ SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst>
+ VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/Virtual Function Controller.rst>
+
+Platform Components
+-------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ APPC - Application Controller <../../../submodules/appc.git/docs/index.rst>
+ DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
+ Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
+ Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
+ SDNC - SDN Controller <../../../submodules/sdnc/northbound.git/docs/offeredapis.rst>
+ SO - Service Orchestrator <../../../submodules/so.git/docs/offered_consumed_apis.rst>
+ VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
+
+Common Services
+---------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ AAF - Application Authorization Framework <../../../submodules/aaf/authz.git/docs/AAF-API-Documentation/AAF-API-Documentation.rst>
+ AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
+ DMaaP - Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/message-router/message-router.rst>
+ MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
+ Multi VIM/Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>