Versions Compared

Old Version 4

changes.mady.by.user Chaker Al-Hakim

Saved on

compared with

New Version 5

changes.mady.by.user Adrian OSullivan

Saved on

Key

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

...

Interface NameInterface Definition Interface CapabilitiesAPI Spec (Swagger)
ExternalAPIE-1 NBI Management Interface

Provides a healthcheck to verify that the NBI component is running fine


Provides:
  • Healthcheck of a NBI service
https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/350675a49dbe01d7970309dac13aaa30/swagger.json
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
  • List notification
  • Retrieve a notification
  • Listen to notifications
https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/7a0359a1069cff9bb3f7db69109b5294/swagger.json
ExternalAPIE-3 Service Catalogue Interface Find service specifications that can be instantiated

 Provides:

  • Search for services in the catalogue (with filters)
  • Retrieve a service specification from the catalogue
https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/ca979e4ad0e48c22d6e62f403b4b0c7c/swagger.json
ExternalAPIE-4 Service Ordering Interface Request the instantiation of a service

 Provides

  • Search for service orders
  • Retrieve a service order
  • Request a service instantiation
https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/9450323ada78d8f7eeb360141ed68b63/swagger.json
ExternalAPIE-5 Service Inventory Interface Query information about instantiated services Provides
  • Search for instantiated Services
  • Retrieve information about an instantiated order
https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/58f285f89bb1416ea0a0ceec1e325800/swagger.json

Note:   xxxI interface is a Component internal interface.  xxxxE interface is a component external interface

The current offered API documents including swagger and ReDoc version can be found at:

ExternalAPI consumes the following Interfaces:

Interface NamePurpose Reason For UseAPI Spec (Swagger)
SDCE-6To receive the notifications of a new service.
SDCE-7To query the catalogue for service specifications 
SOE-X To request a service instantiation 
AAIE-1 To query the instantiated services 
MSBE-1Register NBI API
DMAAPE-1

Poll 2 topics:

AAI events

SDC events


The current consumer API documents can be found at:

3. Component Description:

...