Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 2355fae1356e8a8c7ba0b3c9ee22caa104bb0070 / . / docs / guides / onap-developer / apiref / index.rst
blob: c79d38bab8590982d8aa35c1b25e8f6dcd387ebb [file] [log] [blame]
Rich Bennett6dd9b672017-11-03 15:27:24 -0400[diff] [blame]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
Rich Bennettb921b992017-11-17 08:28:37 -0500[diff] [blame]5.. index:: API Reference
6
Rich Bennett6dd9b672017-11-03 15:27:24 -0400[diff] [blame]7.. _doc-apiref:
8
Eric Debeau2b12a502017-11-07 21:40:02 +0000[diff] [blame]9REST API Reference
10==================
Rich Bennett6dd9b672017-11-03 15:27:24 -0400[diff] [blame]11
Eric Debeau70823af2017-11-06 20:33:21 +0000[diff] [blame]12.. note::
13 Some high level groupings are introduced below with references to
Eric Debeau2b12a502017-11-07 21:40:02 +0000[diff] [blame]14 REST API offered by the various components.
Eric Debeau70823af2017-11-06 20:33:21 +0000[diff] [blame]15
16User Interfaces
17---------------
18
19.. toctree::
20 :maxdepth: 1
21 :titlesonly:
22
23 CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst>
Eric Debeauface2892018-11-15 21:45:45 +0000[diff] [blame]24 Portal <../../../submodules/portal.git/docs/platform/offeredapis.rst>
Eric Debeau70823af2017-11-06 20:33:21 +0000[diff] [blame]25 SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst>
Rich Bennett7e34ab32018-04-18 11:03:25 -0400[diff] [blame]26 VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst>
Eric Debeau70823af2017-11-06 20:33:21 +0000[diff] [blame]27
28Platform Components
29-------------------
30
31.. toctree::
32 :maxdepth: 1
33 :titlesonly:
34
35 APPC - Application Controller <../../../submodules/appc.git/docs/index.rst>
Eric Debeau7dd3d6b2017-11-10 19:55:34 +0000[diff] [blame]36 DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
Eric Debeau70823af2017-11-06 20:33:21 +0000[diff] [blame]37 Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
38 Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
Eric Debeauface2892018-11-15 21:45:45 +0000[diff] [blame]39 SDNC - SDN Controller <../../../submodules/sdnc/oam.git/docs/offeredapis.rst>
seshukm11c603c2018-09-08 18:07:34 +0800[diff] [blame]40 SO - Service Orchestration <../../../submodules/so.git/docs/api/offered_consumed_apis.rst>
Eric Debeau70823af2017-11-06 20:33:21 +0000[diff] [blame]41 VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
42
43Common Services
44---------------
45
46.. toctree::
47 :maxdepth: 1
48 :titlesonly:
49
Eric Debeauface2892018-11-15 21:45:45 +0000[diff] [blame]50 AAF - Application Authorization Framework <../../../submodules/aaf/sms.git/docs/api.rst>
Jimmy Forsyth921c6352019-05-30 13:48:45 -0400[diff] [blame]51 AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI.rst>
Eric Debeauface2892018-11-15 21:45:45 +0000[diff] [blame]52 AAI ESR - AAI External System Register <../../../submodules/aai/esr-server.git/docs/offeredapis.rst>
Manish Kumar6c4a9de2019-01-10 16:54:47 +0530[diff] [blame]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>
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]55 DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
Eric Debeauface2892018-11-15 21:45:45 +0000[diff] [blame]56 ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst>
Eric Debeau2b12a502017-11-07 21:40:02 +0000[diff] [blame]57 Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
Eric Debeau7dd3d6b2017-11-10 19:55:34 +0000[diff] [blame]58 MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
Bin Yangc0faac82018-11-03 04:14:43 +0000[diff] [blame]59 Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-APIv1-Specification.rst>
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]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>
Bozawglanian, Hagop (hb755d)4d10aa42018-05-09 22:13:25 +0000[diff] [blame]62 VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
Eric Debeau7dd3d6b2017-11-10 19:55:34 +0000[diff] [blame]63
64SDK
65---
66
67.. toctree::
68 :maxdepth: 1
69 :titlesonly:
70
Eric Debeau634c1e42017-11-13 14:47:41 +0000[diff] [blame]71 VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>
Rene_Robert2bbb2d62019-08-02 14:39:48 +0200[diff] [blame]72
73
74Some 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>