Jira Ticket:
...
Note 3. This does not yet cover authorization.
| Topic Area | # | Operation | Payload | Description |
|---|---|---|---|---|
Modelling storage (Create/Read modules) Dataspace is a group (CPS term) | 1 | POST /dataspaces/{dataspace-id}/modules | File | Create (and validate) a module set (upload a model file) for the given dataspace. Payload is a file containing 1 or more yang modules. This operation will also create a dataspace. |
| 2 | GET /dataspaces/{dataspace-id}/modules | Read all modules in the store for the given dataspace | ||
| 3 | GET /dataspaces/{dataspace-id}/modules?namespace="namespace-id" | Read all modules in the store for the given dataspace and namespace | ||
| 4 | GET /dataspaces/{dataspace-id}/modules?namespace="namespace-id"&revision="revision" | Read all modules in the store for the given dataspace, namespace and revision | ||
| 5 | DELETE /dataspaces/{dataspace-id}/ | Delete the given dataspace | ||
Anchor persistence (Internal to CPS, associate data relates to a model set to an anchor. Associate data w/ models that give rules when someone queries it). | 6 | POST /dataspaces/{dataspace-id}/anchors | Json Object | Create a new anchor in the given dataspace (payload includes anchor name, module namespace and revision) |
| 7 | GET /dataspaces/{dataspace-id}/anchors/{anchor-id} | Read an anchor and the associated attributes given a anchor ID and a dataspace. | ||
| 8 | DELETE /dataspaces/{dataspace-id}/anchors/{anchor-id} | Delete an anchor given a anchor ID and a dataspace. This will delete the whole tree | ||
| 9 | GET /dataspaces/{dataspace-id}/anchors | Read all anchors in the given a dataspace. | ||
Node persistence (Create/Read of Node Instance Data) Yang Node. | 10 | POST /dataspaces/{dataspace-id}/nodes | File | Create a (root) node for a given anchor for the given dataspace, the node can have children. Their children will also be persisted as separate nodes in the system. |
| 11 | GET /dataspaces/{dataspace-id}/anchors/{anchor-id}/nodes | Request body: { xpath: { xpath specification }} | Get a node given an anchor for the given dataspace (return just one level with just xpath references to its children) | |
| 12 | GET /dataspaces/{dataspace-id}/nodes | Request body: { xpath: { xpath specification }} | Get a node (under any anchor) given a Xpath expression for the given dataspace | |
| 13 | GET /dataspaces/{dataspace-id}/nodes | Request body: { schema_node_identifier: { schema_node_identifierspecification }} | Get all the relevant nodes given a schema node identifier for the given dataspace |
...