Versions Compared

Old Version 67

changes.mady.by.user Former user

Saved on

compared with

New Version 68

changes.mady.by.user Former user

Saved on

Key

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

Table of Contents

ONAP Guidelines

...

#Use caseScenarioDB (Spring) Response SPI ResponseJava APIREST API Response CodeResponse BodyError Object Message
1Add dataspacedataspace already existsDataIntegrityViolationExceptionDataspaceAlreadyDefinedExceptionDataspaceAlreadyDefinedException400 (bad request)json error objectdataspace xyz already defined
2Add schema set to dataspace

schema set with same name already exists

DataIntegrityViolationException

SchemaSetAlreadyDefinedException

SchemaSetAlreadyDefinedException400 (bad request)json error objectschema set xyz already defined for dataspace abc
3Add schema set to dataspacedataspacename does not existNo records (Optional, not present)DataspaceNotFoundExceptionDataspaceNotFoundException400 (bad request)json error objectTBD
4Add schema set to dataspace

the schema set throws a validation exception when parsed with ODL Yang Parser e.g.

  • No files (in zip)
  • Missing (import) files 
  • Incorrect yang in a module
  • Duplicate namespaces
N/AN/A

ModelValidationException (e casue)

details should contain cause message

400 (bad request)json error object

message and details from the original exception.

5List anchors for dataspace namedataspacename does not existNo records (Optional, not present)

DataspaceNotFoundException

DataspaceNotFoundException

400 (bad request)

json error objectdataspace xyz not found
6List anchors for dataspace nameno anchor records in DB0 recordsempty collectionempty collection200 (ok)

empty list


N/A
7Add a fragmentInsert a fragment that violates the unique constraint e.g. when trying to insert a fragment with the same property values(dataspace_id,anchor_id,xpath) as an existing fragment. DataIntegrityViolationException




8Remove schema setSchema set removal is requested from REST (or via API/SPI with explicitly defined option prohibiting removal of associated anchors and data if found) and there is (are) associated anchor record(s) in database.N/ASchemaSetInUseExceptionSchemaSetInUseException409 (Conflict)json error objectschama set abc in dataspace xyz is having anchor records associated.
9Get a fragment that does not existget fragment by xpath that does not existFragmentNotFoundExceptionDataNodeNotFoundExceptionDataNodeNotFoundException400 (bad request)json error objectdatanode with xpath xyz not found in dataspace xyz
10Invalid cps path

a cpsPath that cannot be parsed i.e. not recognized as a valid query

  • 2021-03-08T14:57:19.343Z|main|| o.onap.cps.rest.exceptions.CpsRestExceptionHandler - An error has occurred : Invalid cps path. Status: 400 BAD_REQUEST Details: Cannot interpret or parse cps path.
  • 2021-03-08 15:01:44.441 ERROR 21676 --- [ main] o.o.c.r.e.CpsRestExceptionHandler : An error has occurred : Unsupported leaf value. Status: 400 BAD_REQUEST Details: Unsupported leaf value in cps path.
CpsPathExceptionCpsPathExceptionCpsPathException400 (bad request)json error objectmessage and details from the original exception.
11Data node already existsCreate the same data node twice
DataIntegrityViolationException
DataNodeAlreadyDefinedDataNodeAlreadyDefined409 (Conflict)json error objectData node already defined for dataspace abc
12Unsupported update node leaves

Unsupported json data when 

  1. Conversion of a normalized node to a datanode within the datanode builder class.
private DataNode buildFromNormalizedNodeTree() {
    final Collection<DataNode> dataNodeCollection = buildCollectionFromNormalizedNodeTree();
        return dataNodeCollection.iterator().next(); }

2. Parsing list json data

  1. NoSuchElementException
  2. IllegalStateException
DataValidationException
DataValidationException
400json error object
"Unsupported json data: " + jsonData
13Delete dataspace with anchor/s

Delete dataspace that still contains 1 or more anchor


DataspaceInUseException

DataspaceInUseException

409

(Conflict)

json error object

dataspace contains anchor(s)

14Delete dataspace with schemaset/sDelete dataspace that still contains 1 or more schemaset
DataspaceInUseExceptionDataspaceInUseException

409

(Conflict)

json error objectdataspace contains schemaset(s)

...

#Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeCommentsChanges required
1Admin

POST - /v1/dataspaces

CpsAdminApi.createDataspace()

Create a new dataspace

201

400

401

403

201 (created)

  • for success

409 (conflict)

  • for data integrity violation when persisting (AlreadyDefinedException)

500 (internal server error)

  • for unexpected system errors

Specification:

  • Remove 400
  • Add 409
2Admin

DELETE - /v1/dataspaces

CpsAdminApi.deleteDataspace()

Delete a dataspace

204

400

401

403

409

204 (no content)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)

409 (conflict)

  • for dataspace having anchors or schema sets (DataspaceInUseException)

500 (internal server error)

  • for unexpected system errors

(tick)

3Admin

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

CpsAdminApi.getAnchors()

Read all anchors, given a dataspace

200

400

401

403

404

200 (ok)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)

500 (internal server error)

  • for unexpected system errors

Specification:

  • Remove 404
4Admin

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

CpsAdminApi.createAnchor()

Create a new anchor in the given dataspace

201

400

401

403

201 (created)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)
  • for schema set not found (SchemaSetNotFoundException)

409 (conflict)

  • for data integrity violation when persisting (AlreadyDefinedException)

500 (internal server error)

  • for unexpected system errors

Specification:

  • Add 409
5Admin

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

CpsAdminApi.getAnchor()

Read an anchor given an anchor name and a dataspace

200

400

401

403

404

200 (ok)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)

500 (internal server error)

  • for unexpected system errors

Specification:

  • Remove 404
6Admin

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

CpsAdminApi.deleteAnchor()

Delete an anchor given an anchor name and a dataspace

204

400

401

403

204 (no content)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)

500 (internal server error)

  • for unexpected system errors
(tick)
7Admin

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

CpsAdminApi.createSchemaSet()

Create a new schema set in the given dataspace

201

400

401

403

201 (created)

  • for success

400 (bad request)

  • for different errors related to input schema set file reading (CpsException)
  • for zip schema set file size exceeding defined limit (ModelValidationException)
  • for zip schema set file number entries exceeding defined limit (ModelValidationException)
  • for zip schema set file containing no yang files (ModelValidationException)
  • for multiple resources with same name contained in zip schema set file (ModelValidationException)
  • for schema set file name extension different from yang or zip (ModelValidationException)
  • for invalid Yang syntax (ModelValidationException)
  • for dataspace not found (DataspaceNotFoundException)

409 (conflict)

  • for data integrity violation when persisting (AlreadyDefinedException)

500 (internal server error)

  • for concurrency error when several clients are requesting to create the exact same resource at the same time and that the automatic retry keeps failing (DuplicatedYangResourceException)
  • for unexpected system errors

Specification:

  • Add 409

Implementation

  • Concurrency error is 500, but there is not much that can be done on the server side, the client would have to resend ... Should it be 400 instead ? => Decision made to keep 500
8Admin

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

CpsAdminApi.getSchemaSet()


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

200

400

401

403

404

200 (ok)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)
  • for schema set not found (SchemaSetNotFoundException)

500 (internal server error)

  • for unexpected system errors

Specification:

  • Remove 404
9Admin

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

CpsAdminApi.deleteSchemaSet()

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

204

400

401

403

409

204 (no content)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)
  • for schema set not found (SchemaSetNotFoundException)

409 (conflict)

  • for existence of anchors using the schema set (SchemaSetInUseException)

500 (internal server error)

  • for unexpected system errors
(tick)
10Data

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

CpsDataApi.getNodeByDataspaceAndAnchor()

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

200

400

401

403

404

200 (ok)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)

500 (internal server error)

  • for unexpected system errors

Specification:

  • Remove 404
11Data

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

CpsDataApi.replaceNode()

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

200

400

401

403

200 (ok)

  • for success

400 (bad request)

  • for error while parsing json data or not supported xpath (DataValidationException)
  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)
  • for data node not found (DataNodeNotFoundException)

500 (internal server error)

  • for concurrent transactions making data to be updated stale (ConcurrencyException)
  • for unexpected system errors

Implementation:

  • Concurrency error is 500, but there is not much that can be done on the server side, the client would have to resend ... Should it be 400 instead ? => Decision made to keep 500
12Data

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

CpsDataApi.createNode()

Create a node for a given anchor and dataspace

201

400

401

403

201 (created)

  • for success

400 (bad request)

  • for error while parsing json data or not supported xpath (DataValidationException)
  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)
  • for data node not found (DataNodeNotFoundException)

409 (conflict)

  • for data integrity violation when persisting (AlreadyDefinedException)

500 (internal server error)

  • for unexpected system errors

ImplementationSpecification:

  • Wondering about data node not found here ...Add 409
13Data

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

CpsDataApi.deleteDataNode()

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

204

400

401

403

204 (no content)

  • for success

400 (bad request)

  • for data node not found (DataNodeNotFoundException)

500 (internal server error)

  • for unexpected system errors
(tick)
14Data

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

CpsDataApi.updateNodeLeaves()

Update a data node leaves for a given dataspace and anchor and a parent node xpath

200

400

401

403

200 (ok)

  • for success

400 (bad request)

  • for error while parsing json data or not supported xpath (DataValidationException)
  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)
  • for data node not found (DataNodeNotFoundException)

500 (internal server error)

  • for unexpected system errors
(tick)
15Data

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

CpsDataApi.replaceListContent()

Replace list content under a given parent, anchor and dataspace

200

400

401

403

200 (ok)

  • for success

400 (bad request)

  • for error while parsing json data or not supported xpath (DataValidationException)
  • for no data nodes provided (DataValidationException)
  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)
  • for data node not found (DataNodeNotFoundException)

500 (internal server error)

  • for unexpected system errors
(tick)
16Data

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

CpsDataApi.addListElements()

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

201

400

401

403

201 (created)

  • for success

400 (bad request)

  • for error while parsing json data or not supported xpath (DataValidationException)
  • for no data nodes provided (DataValidationException)
  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)
  • for data node not found (DataNodeNotFoundException)

500 (internal server error)

  • for unexpected system errors
(tick)
17Data

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

CpsDataApi.deleteListOrListElement()

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

204

400

401

403

204 (no content)

  • for success

400 (bad request)

  • for targetprobably not a list (DataNodeNotFoundException)

500 (internal server error)

  • for unexpected system errors
Deprecated, ignored
18Query

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

CpsQueryApi.getNodesByDataspaceAndAnchorAndCpsPath()

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

200

400

401

403

404

200 (ok)

  • for success

400 (bad request)

  • for dataspace not found (DataspaceNotFoundException)
  • for anchor not found (AnchorNotFoundException)
  • for failure when parsing provided cps path (CpsPathException)
  • for failure when parsing retrieved fragment entity attributes (DataValidationException)

500 (internal server error)

  • for unexpected system errors

Implementation:

  • Failure to parse fragment entity should not be a client error ?
  • 404 not needed

...