Please provide comments on this wiki page by 20 NOV 2017
Draft of the recommended new "Practice Area" for Information and Data Modeling for the M3 Deliverables for API Freeze Milestone Checklist Template.
Practice Area | Checkpoint | Yes/No | Evidences | How to? |
---|---|---|---|---|
Information and Data Modeling | Has the Project team completed API specific Use Cases that describe the information exchanges supported by each API? | YES/NO | If Yes, please provide link to the API specific Use Cases and associated Sequence Diagrams. | Describe the interactions and behavior of each API with Use Case templates and Sequence Diagrams. |
Has the Project team completed a Data Model for each API? | YES/NO | If Yes, please provide link to the API Data Model. | Data Models (e.g., JSON, YANG, etc.) that define the data exchanged across each API. | |
Has the Project team mapped the API data elements into the ONAP Common Information Model? | YES/NO | If Yes, please provide link to the API Data Element Mapping. | Mapping to understand how the data elements in each API relate to the ONAP Common Information Model. | |
Has the Project team reviewed the API Data Models and Use Case artifacts with the Modeling Sub-Committee? | YES/NO | If Yes, please provide link to the review findings. | Modeling walkthrough to understand how each project contributes to the ONAP Common Information Model. Modeling Sub-Committee to organize the walkthrough | |
Is there a plan to address the findings the API Modeling review? | YES/NO | If Yes, please provide link to the plan. | The plan could be as simple as a Jira issue to track the resolution of findings or a documented plan within the wiki. |