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