[ExtAPI] Dublin M3 Architecture Review

1. Project Overview

NBI stands for NorthBound Interface. It brings to ONAP a set of APIs that can be used by external systems such BSS for example. These APIs are based on TMForum APIs

1. New component capabilities for Dublin, functional enhancements

   1. Allow BSS or any other to receive service inventory notifications, by offering both dynamic event criteria notification subscription and event notification for Service Instance Creation, Updates or Removal. REST base APIs. ( use DMaaP as source to read AAI events )

   2. Service Inventory improvement by adding few more information such as the ServiceSpecification Name used to create the instance to the response. API updates have been made to allow service Instances to be retrieved solely using service instance id. 
   3. Application status enhancement, provide a query param to play basis integration test with other modules such aai, sdc, so, dmaap
   4. New ability to allow internal Components of ONAP such as SO to communicate externally to other external systems via the External API Framework.  Service Order API enhancement to allow forwarding internal requests based on Target in API header.
   5. Now External API framework uses the SDC Tosca jar to parse Service CSARs , the external API Framework TOSCA parser has now been removed.

1. New or modified interfaces

   1. /service/{id}

   2. /serviceOrder

   1. /status?viewAll=true

2. Reference to the interfaces

   1. Latest documentation and swagger available on latest readthedoc here

3. System limits

   1. 
      

4. Involved use cases, architectural capabilities or functional requirements

   1. BBS usecase

      1. service inventory notification  ( allowing eventType=ServiceCreationNotification,ServiceAttributeValueChangeNotification, ServiceRemoveNotification to be registered for subscription by external systems )

   2. CCVPN usecase

      1. Service inventory improvement, by retrieving a service instance by id, populating state and relatedParty attributes.

      2. Adding Service Order forwarding capaibility with External API Framework acting as an API Proxy for external communication originating internally from ONAP Service Orchestrator

   3. Technical improvement

      1. Migrate from springboot 1.x to springboot 2.x

      2. Refactor API testing to resolve instability during jenkins jobs, facilitate test maintenance and new feature testing. Karate framework

5. Listing of new or impacted models used by the project (for information only)

   1. None.