-
Story
-
Resolution: Done
-
Medium
-
None
-
None
Although the PoC will only implement a few of the possible REST API methods it is important to have a good detailed view of the structure and naming of this interface going forward and document it.
Acceptance Criteria for Proposed REST Interface:
- Should follow ONAP or wider best practice
- Use swagger to design interface (& generate Open API document)
- Discussed and agreed within CPS Team (incl. Tony)
- Discussed and agreed with wider community
- Share generated HTML document
Note. any output will remain a 'draft' (version 0.01 ) and can change as we implement these methods.
Currently we are considering 3 'separated' REST APIs or 'groups' of methods:
- Models (add, list)
- Data (CRUD)
- Queries
See also https://wiki.onap.org/pages/viewpage.action?pageId=84655884#HighLevelDesign(PoC)-Interfaces