Versions Compared

Old Version 4

changes.mady.by.user Stephen terrill

Saved on

compared with

New Version 5

changes.mady.by.user Eric Debeau

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

External API exposes ONAPs capabilities through defined TMF standardized interfaces.  Enables It enables ONAP to be viewed as a "black box"hide the internal API.


It provides

  • Exposes the ONAP service catalogue capabilities

  • Exposes the ONAP inventory capabiliteiscapabilities

  • Exposes ONAP Service Ordering capabilities

  • Interaces Interfaces to manage subscription to ExternalAPI events 

2. API definitions

Extenal External API provides the following interfaces:

Interface NameInterface Definition Interface Capabilities
ExternalAPIE-1 NBI Management Interface

Retrieve the avaible NBIS and Validates the health of a NBI interfaceProvides a healthcheck to verify that the NBI component is running fine


Provides:
  • Discover NBI services
  • Request a healthcheck Healthcheck of a NBI service
ExternalAPIE-2 Subscription Management Interface

Provides the ability to subscribe to and unsubscribe from External API events.

(also known as the External API Hub interface) 

Provides:
  • Create/Delete a Notification hub
  • List notification hubs
  • Retrieve a notification hub
  • Listen to notifications
ExternalAPIE-3 Service Catalogue Interface Find service specifications that can be instantiated

 Provides:

  • Search for services in the catalogue (with filters)
  • Retrieve a service specificaiton specification from the catalogue
  • Create a service (course grain action)
ExternalAPIE-4 Service Ording Ordering Interface Request the instantiation of a service

 Provides

  • Search for service orders
  • Retrieve a service order
  • Request a service instantiation
ExternalAPIE-5 Service Inventory Interface Query information about instantiated services Provides
  • Search for instantiated Services
  • Retrieve information about an instantiated order

...

<< For later inclusion >>

4.

...

Known system limitations

  • FFS


5. Used Models

ExternalAPI uses the following models:

...

6. System Deployment Architecture

ExternalAPI consists of 1 of 3 containers:

  • ExternalAPI

Drawio
bordertrue
viewerToolbartrue
fitWindowfalse
diagramDisplayNameExternalAPI runtime architecture
lboxtrue
revision2
diagramNameExternalAPI runtime architecture
simpleViewerfalse
width
linksauto
tbstyletop
diagramWidth231

...

This release, ExternalAPI adds the following Capabilities in Dublin:

  • Service inventory notification
  • Service inventory improvements
  • Update from springboot 1.x to springboot 2.x
  • Refactor API testing
  • Improved HealthCheck

8. References

  1. External API architecture: https://docs.onap.org/en/casablanca/submodules/externalapi/nbi.git/docs/architecture/architecture.html
  2. External API interface: https://docs.onap.org/en/casablanca/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdf 

...