-
Story
-
Resolution: Done
-
High
-
None
Includes
- Ensure all request data is well described
- Ensure all response data is well described (not just string for a json object) e.g.
- DataNode is described for CPS-Data and CPS-Query interfaces as 'Object' or 'String' (both for request and response data
- Ensure examples are correct (eg. no additional formatting for partial object definitions)
- For error messages use a 'generic example' at the HTTP error code level
Scope (create subtasks as needed)
- CPS Core
- CPS NCMP
- DMI Plugin
- CPS Temporal
Preliminary Analysis
- what to do about when data is returned
Out of Scope
- Deprecated APIs
- Other functional changes to API
Note
Discuss examples with team
1.
|
Define response objects (schemas) in cps-ncmp | Closed | puthuparambil.aditya | |
2.
|
Create proposal for Including examples for Request parameters, request body and Response | Closed | puthuparambil.aditya | |
3.
|
dmi-plugin openapi documentation to be generated from openapi.yml | Closed | puthuparambil.aditya | |
4.
|
Add Examples in the NCMP openapi | Closed | Lee Anjella Macabuhay | |
5.
|
Add examples for parameters, request and response in openapi yaml for cps-core | Closed | lukegleeson | |
6.
|
Add examples for parameters, request and response in openapi yaml for cps-temporal | Closed | Lee Anjella Macabuhay | |
7.
|
Add examples to DMI-Plugin API Spec | Closed | lukegleeson |