diff options
Diffstat (limited to 'docs/offeredapis')
| -rw-r--r-- | docs/offeredapis/index.rst | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/docs/offeredapis/index.rst b/docs/offeredapis/index.rst index bbc8c8d..de8e8a5 100644 --- a/docs/offeredapis/index.rst +++ b/docs/offeredapis/index.rst @@ -3,27 +3,27 @@ .. Copyright 2018 ORANGE -============ +================================================== nbi - northbound interface - External API for ONAP -============ -*************** +================================================== +************ Introduction -*************** +************ 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**. -*************** +******************************************* Global NBI architecture for Beijing release -*************** +******************************************* Following illustration provides a global view about nbi architecture,integration with other ONAP components and API resource/operation provided. .. image:: images/ONAP_External_ID_Beijing.jpg :width: 800px -*************** +*********** API Version -*************** +*********** APIs are described with a state version with “v” following the API Name, e.g.: nbi/api/v1/productOrder. The schema associated with a REST API must have its version number aligned with that of the REST API. @@ -41,13 +41,14 @@ For minor modifications of the API, version numbering must not be updated, provi - If new enumerated values are included, the former ones and its meaning must be kept. - If new operations are added, the existing operations must be kept - New parameters added to existing operations must be optional and existing parameters + must be kept For major modifications of the API, not backward compatible and forcing client implementations to be changed, the version number must be updated. -*************** +********* API Table -*************** +********* .. |pdf-icon| image:: images/pdf.png :width: 40px @@ -73,9 +74,9 @@ API Table :widths: 10,5,5,5,5,5,5 " ", "json file", "html doc", "plantUML doc", "Swagger Editor", "Postman Collection", "pdf doc" - "serviceCatalog", ":download:`link <swaggers/serviceCatalog_1_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "`link <http://editor2.swagger.io/?url=http://onap.readthedocs.io/en/latest/_downloads/serviceCatalog_1_0_0.json>`_", "coming", "coming" - "serviceInventory", ":download:`link <swaggers/serviceInventory_1_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "`link <http://editor2.swagger.io/?url=http://onap.readthedocs.io/en/latest/_downloads/serviceInventory_1_0_0.json>`_", "coming", "coming" - "serviceOrder", ":download:`link <swaggers/serviceOrder_1_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "`link <http://editor2.swagger.io/?url=http://onap.readthedocs.io/en/latest/_downloads/serviceOrder_1_0_0.json>`_", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" + "serviceCatalog", ":download:`link <swaggers/serviceCatalog_1_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming" + "serviceInventory", ":download:`link <swaggers/serviceInventory_1_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming" + "serviceOrder", ":download:`link <swaggers/serviceOrder_1_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" *************** @@ -174,16 +175,14 @@ ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change). prerequisites & assumptions : • Cloud & tenant information MUST BE defined in the external API property file -• Management of ONAP customer for add service action: +• Management of ONAP customer for add service action + With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information: • It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not. • If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists. - • Additionally nbi will create in AAI the service-type if it did not exists for the customer - • Integration is done at service-level: nbi will trigger only SO request at serviceInstance level --> ONAP prerequisite: SO must be able to find a BPMN to process service fulfillment (integrate vnf, vnf activation in SDNC, VF module - • State management: States are only managed by ServiceOrder component and could not be updated from north side via API. Accordingly to service order item fulfillment progress, order item state are updated. Order state is automatically updated based on item state. |