Page Status: Updated for
...
Montreal -
...
Component Status:
...
Approved
Last Reviewed on:
Certified by: Adrian OSullivan
External API:
1 High Level Component Definition and Architectural
...
Relationships (Deprecated)
| Drawio | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
External API exposes ONAPs capabilities through TMF standardized interfaces. It enables ONAP to hide the internal API.
...
Exposes the ONAP service catalogue capabilities
Exposes the ONAP inventory capabilities
Exposes ONAP Service Ordering capabilities
Interfaces to manage subscription to ExternalAPI events
2. API definitions
External API provides 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://wikilf-onap.onapatlassian.orgnet/wiki/download/attachments/7920185116409009/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 |
...
- External API interface: https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/consumedapis/consumedapis.html
3. Component Description:
A more detailed figure and description of the component.
<< For later inclusion >>
4. Known system limitations
- No 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
7. New Capabilities in this Release
8. References
- External API architecture: https://docs.onap.org/en/latest/submodules/externalapi/nbi.git/docs/releasenotes/releasenotes.html
- External API interface: https://docs.onap.org/en/casablanca/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdf
...