Clean the doc
[externalapi/nbi.git] / docs / architecture / architecture.rst
1 .. This work is licensed under
2 .. a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. Copyright 2018 ORANGE
5
6
7 Architecture
8 ============
9
10 ************
11 Introduction
12 ************
13
14
15 NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be
16 used by external systems as BSS for example.
17 These API are based on **TMF API**.
18
19
20 *******************************************
21 Global NBI architecture for Beijing release
22 *******************************************
23
24 Following illustration provides a global view about NBI architecture,
25 integration with other ONAP components and API resource/operation provided.
26
27 .. image:: images/ONAP_External_ID_Beijing.jpg
28    :width: 800px
29
30
31 ***************
32 Developer Guide
33 ***************
34
35 Technical information about NBI
36 (dependencies, configuration, running & testing)
37 could be found here: :doc:`NBI_Developer_Guide <NBI_Developer_Guide>`
38
39 API Flow illustration (with example messages) is described in this document:
40 :download:`nbicallflow.pdf <../offeredapis/pdf/nbicallflow.pdf>`
41