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
- API offered by the various components.
+ REST API offered by the various components.
User Interfaces
---------------
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>
+ VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst>
Platform Components
-------------------
:titlesonly:
APPC - Application Controller <../../../submodules/appc.git/docs/index.rst>
- DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.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>
+ SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/offeredapis.html>
+ SO - Service Orchestration <../../../submodules/so.git/docs/api/offered_consumed_apis.rst>
VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
Common Services
: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>
+ AAI ESR <../../../submodules/aai/esr-server.git/docs/offeredapis.rst>
+ DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+ ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
+ Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
+ MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
+ Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
+ MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst>
+ OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst>
+ VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
+
+SDK
+---
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>