docs/guides/onap-developer/apiref/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License. http://creativecommons.org/licenses/by/4.0
   3    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5 .. index:: API Reference
   6
   7 .. _doc-apiref:
   8
   9 REST API Reference
  10 ==================
  11
  12 .. note::
  13    Some high level groupings are introduced below with references to
  14    REST API offered by the various components.
  15
  16 User Interfaces
  17 ---------------
  18
  19 .. toctree::
  20    :maxdepth: 1
  21    :titlesonly:
  22
  23    CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst>
  24    Portal <../../../submodules/portal.git/docs/platform/offeredapis.rst>
  25    SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst>
  26    VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst>
  27
  28 Platform Components
  29 -------------------
  30
  31 .. toctree::
  32    :maxdepth: 1
  33    :titlesonly:
  34
  35    APPC - Application Controller <../../../submodules/appc.git/docs/index.rst>
  36    DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
  37    Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
  38    Policy <../../../submodules/policy/parent.git/docs/offeredapis.rst>
  39    SDNC - SDN Controller <../../../submodules/sdnc/oam.git/docs/offeredapis.rst>
  40    SO - Service Orchestration <../../../submodules/so.git/docs/api/offered_consumed_apis.rst>
  41    VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
  42
  43 Common Services
  44 ---------------
  45
  46 .. toctree::
  47    :maxdepth: 1
  48    :titlesonly:
  49
  50    AAF - Application Authorization Framework <../../../submodules/aaf/sms.git/docs/api.rst>
  51    AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI.rst>
  52    AAI ESR - AAI External System Register <../../../submodules/aai/esr-server.git/docs/offeredapis.rst>
  53    DMAAP DBC - Data Management as a Platform (Data Bus Controller) <../../../submodules/dmaap/dbcapi.git/docs/api.rst>
  54    DMAAP DR - Data Management as a Platform (Data Router) <../../../submodules/dmaap/datarouter.git/docs/index.rst>
  55    DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
  56    ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst>
  57    Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
  58    MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
  59    Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-APIv1-Specification.rst>
  60    MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst>
  61    OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst>
  62    VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
  63
  64 SDK
  65 ---
  66
  67 .. toctree::
  68    :maxdepth: 1
  69    :titlesonly:
  70
  71    VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>
  72
  73
  74 Some ONAP Postman collections
  75 -----------------------------
  76
  77 .. toctree::
  78    :maxdepth: 1
  79    :titlesonly:
  80
  81    Some ONAP Postman collections <../../../submodules/integration.git/docs/docs_postman.rst>