Versions Compared

Old Version 13

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version Current

changes.mady.by.user Benjamin Cheung

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Jira Ticket:

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCCSDK-2870

Jira Backlog:

https://jira.onap.org/secure/RapidBoard.jspa?rapidView=223&view=planning.nodetail&selectedIssue=CCSDK-2912&issueLimit=100

Resources

Assumptions

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

Open Issues/Decisions

#DescriptionDetailsDecisions
1How to
differentiatie
differentiate GET queries with different parameters. If we
dont
don't 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
differentiate 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
4Treat operations with xpath and schema_node_identifier as 'queries' using POST?xpath and schema node identifiers aren't suitable for URLs. The suggestion is to create query URLs instead and pass this data in as part of the request body

Team meeting Niamh Core, Toine Siebelink and Rishi Chail10 Oct 2020

Agreed format, GET nodes resource with query details request body, applied for #11-#13 in the table below

API definitions

...

Note 1. This list of URL operations is not meant to be complete or final. It is mainly a starting point to establish a pattern and naming convention for the Configuration Persistence Service. 

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

Note 3. This does not yet cover authorization.


Topic Area
Group
#OperationPayloadDescription

Modelling storage

(Create/Read modules)

Dataspace is a group (CPS term)

1
PUT
POST /
module
dataspaces/{dataspace-id}/modulesFileCreate
/Update
(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.
2GET /
module/
dataspaces/{dataspace-id}/modules
Read all modules in the store
.
for the given dataspace
3GET /
module
dataspaces/{
namespace} (see assumption #1 and issue #1)
dataspace-id}/modules?namespace="namespace-id"
Read all modules in the store for the given dataspace and namespace
4

GET /

module

dataspaces/{

namespace

dataspace-id}/

{revision}

modules?namespace="namespace-id"&revision="revision"


Read all modules in the store for the given dataspace, namespace and revision
5
GET
DELETE /
module
dataspaces/{dataspace
} (see issue #1)Read all modules in the store for the given dataspace

Anchor Points persistence

6
-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).

6POST /dataspaces/{dataspace-id}/anchors
PUT /anchor-point/
Json Object 

Create

an

a new anchor

point given a name and a dataspace and module (

in the given dataspace (payload includes anchor name, module namespace and revision)

7GET /
anchor-point
dataspaces/{dataspace-id}/anchors/{
name
anchor-id}
/

Read an anchor
point
and the associated attributes given a
name
anchor ID and a dataspace.
8DELETE /
anchor-point
dataspaces/{dataspace-id}/anchors/{
name
anchor-id}

Delete an anchor

point

given a

name

anchor ID and a dataspace.

(

  This will delete the whole tree

)

9
GET 
GET /
anchor-point
dataspaces/{dataspace
} (see isue#1)
-id}/anchors

Read all

anchor points

anchors in the

system

given a dataspace.

10GET /module/{dataspace}/{anchor-point}/

Get a module (reference), given an anchor point 

11GET /anchor-point/fragment/{dataspace}/{xpath}/Get the anchor point of a fragment given a fragments xpath

Node persistence

(Create/Read of Node Instance Data)

Yang Node.

10

POST /dataspaces/{dataspace-id}/nodes

Fragment persistence

12PUT /fragment/{dataspace}/{name}/

File

Create a (root)

 fragment

node for a given anchor

point

 for the given dataspace, the

fragment

node can have children.

13

Their children will also be persisted as separate nodes in the system.

11GET /dataspaces/{dataspace-id}/anchors/{anchor
PUT /fragment/{parent-fragment
-id}/nodes
FileCreate a fragment given an ID relative to the parent14GET /fragment/{dataspace}/{name}/

Request body:

{ xpath: { xpath specification  }}

Get a node given an anchor for the given dataspace 

Get a fragment given a anchor point

(return just one level with just xpath references to its children)

15
12

GET /

fragment

dataspaces/{dataspace-id}/nodes

Request body:

{ xpath: { xpath specification  }}

/ (see isue#2)

Get a

fragment

node (under any anchor) given a Xpath

expression 16

expression for the given dataspace

13

GET /

fragments

dataspaces/{dataspace

}/{anchor

-

point

id}/

Get all the fragments under an anchor point given a anchor point (notice similarity with /fragment/{dataspace}/{anchor-point}/  (just one letter!)

nodes

Request body:

{ schema_node_identifier: { schema_node_identifierspecification  }}

17GET /fragment/{dataspace}/schema-node-identifier/{schema-node-identifier}/

Get all the relevant

fragments

nodes given a schema node identifier

 

 for the given dataspace
(not need to specify dataspace is schema-node-identifier is globally unique)