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:

1. Should follow ONAP or wider best practice
   1. Use swagger to design interface (& generate Open API document)
2. Discussed and agreed within CPS Team (incl. Tony)
3. Discussed and agreed with wider community
   1. 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:

1. Models (add, list)
2. Data (CRUD)
3. Queries

See also https://wiki.onap.org/pages/viewpage.action?pageId=84655884#HighLevelDesign(PoC)-Interfaces