/
CPS-2504: Update packaged postman collection to include all rest endpoints

CPS-2504: Update packaged postman collection to include all rest endpoints

CPS-2504: Update packaged postman collection to include all rest endpointsClosed

Assumptions

Assumption

Notes

Assumption

Notes

1

CPS core endpoints will use bookstore example data to demonstrate functionality

 

2

NCMP endpoints will use ‘realistic’ data found in CPS-2339 to demonstrate functionality

 

Issues & Decisions

Issue

Notes 

Decision

Issue

Notes 

Decision

1

 

 

 

2

 

 

 

3

 

 

 

Endpoints

CPS

CPS-Admin

URI

Rest Method

Description

Notes 

URI

Rest Method

Description

Notes 

1

/v1/dataspaces

POST

*DEPRECATED* Create a new dataspace

 

2

/{apiVersion}/dataspaces

DELETE

Delete a dataspace

 

3

/v2/dataspaces

POST

Create a new dataspace

 

4

/{apiVersion}/admin/dataspaces

GET

Read all dataspaces

 

5

/{apiVersion}/admin/dataspaces/{dataspace-name}

GET

Read a dataspace given a dataspace name

 

6

/v1/dataspaces/{dataspace-name}/anchors

POST

*DEPRECATED* Create a new anchor in the given dataspace

 

7

/v2/dataspaces/{dataspace-name}/anchors

POST

Create a new anchor in the given dataspace

 

8

/{apiVersion}/dataspaces/{dataspace-name}/anchors

GET

Read all anchors, given a dataspace

 

9

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}

DELETE

Delete an anchor given an anchor name and a dataspace

 

10

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}

GET

Read an anchor given an anchor name and a dataspace

 

11

/v1/dataspaces/{dataspace-name}/schema-sets

POST

*DEPRECATED* Create a new schema set in the given dataspace

 

12

/v2/dataspaces/{dataspace-name}/schema-sets

POST

Create a new schema set in the given dataspace

 

13

/{apiVersion}/dataspaces/{dataspace-name}/schema-sets

GET

Read all schema sets, given a dataspace

 

14

/{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}

DELETE

Delete a schema set given a schema set name and a dataspace

 

15

/{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}

GET

Read a schema set given a schema set name and a dataspace

 

CPS-Data

URI

Rest Method

Description

Notes 

URI

Rest Method

Description

Notes 

1

/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node

GET

*DEPRECATED* Get a node with an option to retrieve all the children for a given anchor and dataspace

 

2

/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node

GET

Get a node with an option to retrieve all the children for a given anchor and dataspace

 

3

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes

DELETE

Delete a datanode for a given dataspace and anchor given a node xpath.

 

4

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes

PATCH

Update a data node leaves for a given dataspace and anchor and a parent node xpath. This operation is currently supported for one top level data node only.

 

5

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes

POST

Create a node for a given anchor and dataspace

 

6

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes

PUT

Replace a node with descendants for a given dataspace, anchor and a parent node xpath

 

7

/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes

DELETE

*DEPRECATED* Delete one or all list element(s) for a given anchor and dataspace

 

8

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes

POST

Add list element(s) to a list for a given anchor and dataspace

 

9

/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes

PUT

Replace list content under a given parent, anchor and dataspace

 

10

/v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta

GET

Get delta between two anchors within a given dataspace

 

11

/v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta

POST

Get delta between an anchor in a dataspace and JSON payload

 

CPS-Query

URI

Rest Method

Description

Notes 

URI

Rest Method

Description

Notes 

1

/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query

GET

*DEPRECATED* Query data nodes for the given dataspace and anchor using CPS path

 

2

/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query

GET

Query data nodes for the given dataspace and anchor using CPS path

 

3

/v2/dataspaces/{dataspace-name}/nodes/query

GET

Query data nodes for the given dataspace across anchors using CPS path

 

NCMP 

URI

Rest Method

Description

Notes 

URI

Rest Method

Description

Notes 

1

/v1/ch/{cm-handle}/data/ds/{datastore-name}

DELETE

Delete resource data from pass-through running for a given cm handle

 

2

/v1/ch/{cm-handle}/data/ds/{datastore-name}

GET

Get resource data for given cm handle

 

3

/v1/ch/{cm-handle}/data/ds/{datastore-name}

PATCH

Patch resource data from pass-through running for the given cm handle

 

4

/v1/ch/{cm-handle}/data/ds/{datastore-name}

POST

create resource data from pass-through running for given cm handle

 

5

/v1/ch/{cm-handle}/data/ds/{datastore-name}

PUT

Update resource data from pass-through running for the given cm handle

 

6

/v1/data

POST

Execute a data operation for group of cm handle ids

 

7

/v1/ch/{cm-handle}/data/ds/{datastore-name}/query

GET

Query resource data for a given cm handle

 

8

/v1/ch/{cm-handle}/modules

GET

fetch all module references (name and revision) for a given cm handle

 

9

/v1/ch/{cm-handle}/modules/definitions

GET

Get module definitions (module name, revision, yang resource) with options to filter on module name and revision

 

10

/v1/ch/searches

POST

Execute cm handle query search and return a list of cm handle details.

 

11

/v1/ch/{cm-handle}

GET

Retrieve CM handle details and properties by cm handle id

 

12

/v1/ch/{cm-handle}/properties

GET

Get CM handle properties by cm handle id

 

13

/v1/ch/id-searches

POST

Execute cm handle query search and return a list of cm handle ids.

 

14

/v1/ch/{cm-handle}/data-sync

PUT

Set the data sync enabled flag to true or false for a specified Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and NONE_REQUESTED respectfully.

 

15

v1/ch/{cm-handle}/state 

GET

Get CM handle state by cm handle id. (Not event driven, moved out of CPS-E-08.e)

 

NCMP-Inventory

URI

Rest Method

Description

Notes 

URI

Rest Method

Description

Notes 

1

/ncmpInventory/v1/ch

POST

Register a DMI Plugin with any new, updated or removed CM Handles

 

2

/ncmpInventory/v1/ch/cmHandles

GET

Get all cm handle IDs for a registered DMI plugin

 

3

/ncmpInventory/v1/ch/searches

POST

Query and get CM Handle Ids for additional properties, public properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin).

 

DMI-Stub 

URI

Rest Method

Description

Notes

URI

Rest Method

Description

Notes

1

/dmi/v1/ch/{cmHandle}/modules

POST

Get all modules for given cm handle

 

2

/dmi/v1/ch/{cmHandle}/moduleResources

POST

Retrieve module resources for one or more modules

 

3

/dmi/v1/inventory/cmHandles

POST

register given list of cm handles (internal use only)

 

4

/dmi/v1/ch/{cmHandle}/data/ds/{datastore-name}

POST

Get resource data from passthrough operational or running for a cm handle

 

5

/dmi/v1/data

 

POST

Execute a data operation for group of cm handle ids by supplied operation details