Details
-
Story
-
Status: Closed
-
High
-
Resolution: Done
-
None
Description
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