You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

Resources

Assumptions

#Description
1Yang namespaces are globally unique (except for multiple revisions)

Open Issues/Decisions

#DescriptionDetailsDecisions
1How to differentiatie GET queries with different parameters. If we dont have named parameters how best to know what is meant

Alternatives

  1. GET /anchorpoint/dataspace/{dataspace} versus /anchor-point/name/{dataspace}
  2. GET /anchorpoint?dataspace={dataspace} versus /anchor-point?name={dataspace}
  3. GET /dataspace/{dataspace-id}/anchorpoint versus /anchor-point/{name}
  4. GET /dataspace/{dataspace-id}/anchorpoint versus /anchor-point/name/{name}
  5. GET /dataspace/{dataspace-id}/anchorpoint versus /name/{name}/anchor-point
  6. etc.

Team meeting Flavio,Tony,Toine,Bruno,Niamh, Rishi 8 Oct 2020:

Use hierarchical resource urls including the concept of 'dataspaces' and 'anchors'. 'Fragments' will be replaced by 'Nodes'

e.g.

GET /dataspaces/{dataspace_id}/anchors → returns Anchor-points

GET /dataspaces/{dataspace_id}/anchors/{anchor-id}/nodes?xpath="..."  → returns Node(s)

GET /dataspaces/{dataspace_id}/anchors/{anchor-id}/nodes?schema_node_identifier="..."  → returns Node(s)

GET /dataspaces/{dataspace_id}/nodes&xpath="..." → returns Node(s)

GET /dataspaces/{dataspace_id}/modules → returns Modules


2Advance queries v Simple Queries (gets) for data fragments. Do we want/need differentiatie on UTL?
  1. GET /fragment/query/{xpath}
  2. GET/fragment/{xpath}  
  3. GET /query/{xpath}

Note . The xpath could be a full unambiguous xpath returning one object or it could be partial path using wildcards etc allowing for more advanced queries return 0 or more fragments (developed over many iterations)

Team meeting Flavio,Tony,Toine,Bruno,Niamh, Rishi 8 Oct 2020:

Advanced queries will implemented as advanced xpath' (and or schema node identifiers) no need for separate URLs

3We have no modules sets!model files just arbitrarily group a few modules, is there a need to persist this grouping (We do have the concept of a dataspace as well)Team meeting Flavio,Tony,Toine,Bruno,Niamh, Rishi 8 Oct 2020:
The way modules are delivered i.e. grouped in files is not relevant for the CPS application. What needs to be stored for each 'anchor'  is the namespace and revision of the model that describes the 'root' of that  instance

API definitions

Note. All urls in below table will be prefixed with something like : <server>/cps/v1/

Group#OperationPayloadDescription

Modelling storage

1PUT /dataspaces/{dataspace-id}/modulesFileCreate/Update (and validate) a module set (upload a model file) for the given dataspace.
2GET /dataspaces/{dataspace-id}/modules
Read all modules in the store for the given dataspace
3GET /dataspaces/{dataspace-id}/modules/{namespace}
Read all modules in the store for the given dataspace and namespace
4GET /dataspaces/{dataspace-id}/modules/{namespace}/{revision}
Read all modules in the store for the given dataspace, namespace and revision

Anchor persistence

5PUT /dataspaces/{dataspace-id}/anchorsJson Object 

Create an anchor given a name and a dataspace and module (payload includes anchor ID, namespace and revision)

6GET /dataspaces/{dataspace-id}/anchors/{anchor-id}
Read an anchor and the associated attributes given a anchor ID and a dataspace.
7DELETE /dataspaces/{dataspace-id}/anchors/{anchor-id}

Delete an anchor given a anchor ID and a dataspace. (will delete whole tree)

8GET /dataspaces/{dataspace-id}/anchors

Read all anchors in the system given a dataspace.

Node persistence

9PUT /dataspaces/{dataspace-id}/nodesFileCreate 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.

10GET /dataspaces/{dataspace-id}/anchors/{anchor-id}/nodes?xpath="..."
Get a node given an anchor for the given dataspace (return just one level with just xpath references to its children)
11GET /dataspaces/{dataspace-id}/nodes&xpath="..."
Get a node (under any anchor) given a Xpath expression for the given dataspace
12GET /dataspaces/{dataspace-id}/nodes?schema_node_identifier="..."
Get all the relevant nodes given a schema node identifier for the given dataspace
(not need to specify dataspace is schema-node-identifier is globally unique)
  • No labels