X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fapiref%2Findex.rst;h=c251416f4a6c22b6a2e7993342f10e848afcd0fa;hb=ef2ee3fe40792be5127221168b07949316f2a428;hp=bad279375ac20d3098aecf3a33f8784121528d88;hpb=6dd9b673e71a47ce43acfa8303e7b1156613021e;p=doc.git diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index bad279375..c251416f4 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -2,8 +2,72 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: API Reference + .. _doc-apiref: -API Reference -============= +REST API Reference +================== + +.. note:: + Some high level groupings are introduced below with references to + REST API offered by the various components. + +User Interfaces +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +* :ref:`CLAMP - Closed Loop Automation Platform` +* :ref:`Portal` +* :ref:`SDC - Service Design and Creation` +* :ref:`VID - Virtual Infrastructure Deployment` + +Platform Components +------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +* :ref:`APPC - Application Controller` +* :ref:`DCAE - Data Collection Analytics and Events` +* :ref:`Holmes - Alarm Correlation` +* :ref:`Policy` +* :ref:`SDNC - SDN Controller` +* :ref:`SO - Service Orchestration` +* :ref:`VFC - Virtual Function Controller` +* :ref:`CDS - Controller Design Studio` + +Common Services +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +* :ref:`AAF - Application Authorization Framework` +* :ref:`AAI - Active and Available Inventory` +* :ref:`AAI ESR - AAI External System Register` +* :ref:`CPS - Configuration Persistence Service` +* :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)` +* :ref:`DMAAP DR - Data Management as a Platform (Data Router)` +* :ref:`DMAAP MR - Data Management as a Platform (Message Router)` +* :ref:`ExtAPI- External API NBI - NorthBound API` +* :ref:`Modeling Parsers` +* :ref:`MSB - Micro Services Bus` +* :ref:`Multi Cloud` +* :ref:`MUSIC - Multi-site State Coordination Service` +* :ref:`OPTF - Optimization Framework` + +SDK +--- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +* :ref:`VNF Software Development Kit`