Project Name (from Project Proposal):
- Proposed name for the project:
External API Framework
- Proposed name for the repository:
externalapi
Project description (from Project Proposal):
- This project will describe and define the APIs between ONAP and External Systems, including ONAP interfaces targeted on BSS/OSS, peering, B2B, etc.
- Proposed initial focus may be on the Common APIs between ONAP and BSS/OSS.
Common APIs between ONAP and BSS/OSS allow Service Providers to utilize the capabilities of ONAP using their existing BSS/OSS environment with minimal customization.
Scope of Work For Beijing:
- Deliver points of interoperability between ONAP and External Systems
- Initial focus on ONAP APIs to BSS/OSS
- Service Catalog
- Service Ordering (including Service Instantiation)
- Service Inventory
- Licence Usage (stretch goal)
Alignment with MEF Legato and TM Forum APIs
Definition of Use Cases, Interactions, and Information Model engaging service providers and BSS/OSS vendors
UML Models (Eclipse Papyrus) and API definition (JSON Swagger) for
License Usage
Service Modeling
Service Inventory
Service State Management
Service Quality Management
API development (in conjunction with specific ONAP component projects)
- Well defined specifications for the NB APIs (e.g., JSON Swagger).
- ONAP implementation of these APIs
- Architecture for External APIs
- Identification and involvement of stakeholder ONAP projects
- Document the role of External APIs in Model Driven ONAP
- Work with Modeling project to explore a Model Driven approach: a cohesive way to have a shared view of information across ONAP external interfaces that can be used for or be input into a model driven process whereby the cost of delivering platform functionality is drastically reduced and the time to delivery is dramatically decreased.
- Explore use of Model Driven Tool Chain to automatically generate APIs based on models
Main deliverables of this project may include: User Stories; Use Cases and Interactions (e.g., UML); Information Models (e.g., UML); Data Models (e.g., JSON); Interface Profiles and Functional Definition; ONAP Component Mapping and Functional Analysis.
Resources:
- Primary Contact Person:
- Andy Mayer, AT&T, am803u@att.com
- Names, gerrit IDs, and company affiliations of the committers and contributors:
Key Project Facts
Project Name:
- JIRA project name: externalapi
- JIRA project prefix: externalapi
Repo name:
- org.onap.externalapi/nbi
Lifecycle State: incubation
Primary Contact: Andy Mayer, AT&T, am803u@att.com
Project Lead: Andy Mayer, AT&T, am803u@att.com
mailing list tag [externalapi]
Committers for release 1:
- Andy Mayer, AT&T, am803u@att.com
- Raluca Sirbu, AT&T, rs2184@att.com
- Mark Gibson, Amdocs, markgi@amdocs.com