...
Component Status: Pending PTL updates and ArchCom Review
Last Reviewed on: Jan-12-2020
Certified by: Adrian OSullivan
External API:
1 High Level Component Definition and Architectural Relationships
| Drawio | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
External API exposes ONAPs capabilities through TMF standardized interfaces. It enables ONAP to hide the internal API.
...
| Interface Name | Interface Definition | Interface Capabilities | API Spec (Swagger) |
|---|---|---|---|
| ExternalAPIE-1 NBI Management Interface | Provides a healthcheck to verify that the NBI component is running fine | Provides:
| 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:
| 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:
| 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
| 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
| 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:
- External API interface: https://docs.onap.org/projects/onap-externalapi-nbi/en/casablancalatest/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdfofferedapis/offeredapis.html
ExternalAPI consumes the following Interfaces:
| Interface Name | Purpose Reason For Use | API Spec (Swagger) |
|---|---|---|
| SDCE-6 | To receive the notifications of a new service. | https://docs.onap.org/projects/onap-sdc/en/latest/_downloads/bf1ca3144efeae56c1ad9c3c682a5314/swagger.json |
| SDCE-7 | To query the catalogue for service specifications | https://docs.onap.org/projects/onap-sdc/en/latest/_downloads/bf1ca3144efeae56c1ad9c3c682a5314/swagger.json |
| SOE-X | To request a service instantiation | https://docs.onap.org/projects/onap-so/en/latest/_downloads/e3bc7468795fb200d2dc59b2e4801dab/swagger.json |
| AAIE-1 | To query the instantiated services | https://lf-onap.atlassian.net/wiki/download/attachments/16409009/aai_swagger_v19.html?api=v2 |
| MSBE-1 | Register NBI API | Microservice Bus API Documentation#RegisterservicetotheMicroserviceBus |
| DMAAPE-1 | Poll 2 topics: AAI events SDC events | https://docs.onap.org/projects/onap-dmaap-messagerouter-messageservice/en/latest/offeredapis/swaggerapi.html |
The current consumer API documents can be found at:
- External API interface: https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/consumedapis/consumedapis.html
3. Component Description:
...
4. Known system limitations
- FFSNo default RBAC on APIs
5. Used Models
ExternalAPI uses the following models:
- -Models used are as per Objects defined in the Swagger.
6. System Deployment Architecture
...