X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fapiref%2Findex.rst;h=ac2be8e067d917cf417690b870da390151ce9ce1;hb=4d10aa4c66d0cd5280a61cd0bf6a3ec2229cb7ff;hp=277dd15743f812965fe9650a58ce2395af5d8107;hpb=70823aff0d159b9ae7983b39d27cdd8e7cb95a89;p=doc.git diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 277dd1574..ac2be8e06 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -2,14 +2,16 @@ 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 --------------- @@ -20,7 +22,7 @@ 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 ------------------- @@ -30,12 +32,12 @@ 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> + SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst> VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst> + NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst> Common Services --------------- @@ -44,8 +46,19 @@ 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> + DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst> + Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst> + MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst> + MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst> + Music <../../../submodules/music.git/docs/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>