You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 3
Next »
STATUS: Draft
External API:
1 High Level Component Definition and Architectural Relationships
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlN0ZXBoZW4gVGVycmlsbCIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJNYXR0aGlldSBHZWVyZWJhZXJ0IiwibGFuZ3VhZ2UiOiJlbiIsImRpYWdyYW1EaXNwbGF5TmFtZSI6IkV4dGVybmFsQVBJIFN5c3RlbSBDb250ZXh0IFZpZXciLCJzRmlsZUlkIjoiIiwiYXR0SWQiOiI2MDg4NDQ1NCIsImRpYWdyYW1OYW1lIjoiRXh0ZXJuYWxBUEkgU3lzdGVtIENvbnRleHQgVmlldyIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJBUkMgRXh0ZXJuYWxBUEkgQ29tcG9uZW50IERlc2NyaXB0aW9uIC0gRHVibGluIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo2MDg4NDQ0OCwiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6NjA4ODQ0ODQsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjUsIm1hY3JvSWQiOiJlNjFkOTk4Yi1jMzQ0LTRmODEtYTdlNS0yMjBiNGVmNzFmODIiLCJwcmV2aWV3TmFtZSI6IkV4dGVybmFsQVBJIFN5c3RlbSBDb250ZXh0IFZpZXcucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjYwMCIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTU1MzAxMDA2NjAwMCwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
External API exposes ONAPs capabilities through defined interfaces. Enables ONAP to be viewed as a "black box".
It provides
Exposes the ONAP service catalogue capabilities
Exposes the ONAP inventory capabiliteis
Exposes ONAP Service Ordering capabilities
Interaces to manage subscription to ExternalAPI events
2. API definitions
Extenal API provides the following interfaces:
| Interface Name | Interface Definition | Interface Capabilities |
|---|
| ExternalAPIE-1 NBI Management Interface | Retrieve the avaible NBIS and Validates the health of a NBI interface
| Provides:- Discover NBI services
- Request a 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 from the catalogue
- Create a service (course grain action)
|
| ExternalAPIE-4 Service Ording 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
|
Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface
The current API documents can be found at:
ExternalAPI consumes the following Interfaces:
| Interface Name | Purpose Reason For Use |
|---|
| SDCE-6 | To receive the notifications of a new service. |
| SDCE-7 | To query the catalogue for service specifications |
| SOE-X | To request a service instantiation |
| AAIE-1 | To query the instantiated services |
3. Component Description:
A more detailed figure and description of the component.
<< For later inclusion >>
4. known system limitations
5. Used Models
ExternalAPI uses the following models:
6. System Deployment Architecture
ExternalAPI consists of 1 containers:
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlN0ZXBoZW4gVGVycmlsbCIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJFcmljIERlYmVhdSIsImxhbmd1YWdlIjoiZW4iLCJkaWFncmFtRGlzcGxheU5hbWUiOiJFeHRlcm5hbEFQSSBydW50aW1lIGFyY2hpdGVjdHVyZSIsInNGaWxlSWQiOiIiLCJhdHRJZCI6IjYwODg0NDU2IiwiZGlhZ3JhbU5hbWUiOiJFeHRlcm5hbEFQSSBydW50aW1lIGFyY2hpdGVjdHVyZSIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJBUkMgRXh0ZXJuYWxBUEkgQ29tcG9uZW50IERlc2NyaXB0aW9uIC0gRHVibGluIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo2MDg4NDQ0OCwiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6NjA4ODQ0ODQsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjIsIm1hY3JvSWQiOiJhNjliZTVlOS0xNjk5LTRiNDAtYWRiMi02YzE3ODQ2M2IyNWUiLCJwcmV2aWV3TmFtZSI6IkV4dGVybmFsQVBJIHJ1bnRpbWUgYXJjaGl0ZWN0dXJlLnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiIyMzEiLCJzaW1wbGVWaWV3ZXIiOmZhbHNlLCJsYXN0TW9kaWZpZWQiOjE1NTI0MDAzOTgwMDAsImV4Y2VlZFBhZ2VXaWR0aCI6ZmFsc2UsIm9DbGllbnRJZCI6IiJ9
This needs to be updated
7. New Capabilities in this Release
This release, ExternalAPI adds the following Capabilities:
- Service inventory notification
- Service inventory improvements
- Update from springboot 1.x to springboot 2.x
- Refactor API testing
8. References
- External API architecture: https://docs.onap.org/en/casablanca/submodules/externalapi/nbi.git/docs/architecture/architecture.html
- External API interface: https://docs.onap.org/en/casablanca/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdf
