Versions Compared

Key

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

...

#Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeComments
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)DataNodeNotFoundException

  • 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:

  • Keep only one of 400 or 404 when dataspace is not found.
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 ?
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 ?
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

Implementation:

  • Wondering about data node not found here ...
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


CPS-NCMP

(commit id 8c9b4a24b4841154a2d08f506e2f7beca4f6fc31)

#Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeCommentsBody
1Data

HTTP: GET - /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational

NetworkCmProxyApi.getResourceDataOperationalForCmHandle()

Get resource data from pass-through operational for given cm handle

200

400

401

403

404

200 (ok)

500

2Data
  • for success

500 (internal server error)

  • for error when parsing provided dmi request to json (NcmpException)
  • for dmi response code different from 2xx (NcmpException)
  • for unexpected system errors

Specification:

  • Remove 404

Implementation:

  • Parsing error for dmi request should be a 400 client error

2Data

GET

GET - /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running

NetworkCmProxyApi.getResourceDataRunningForCmHandle()

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

200

400

401

403

404

200

500

3Data

PUT - /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running

NetworkCmProxyApi.updateResourceDataRunningForCmHandlegetResourceDataRunningForCmHandle()

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

200

400

401

403

404

200 (ok)

  • for success

500 (internal server error)

  • for error when parsing provided dmi request to json (NcmpException)
  • for dmi response code different from 2xx (NcmpException)
  • for unexpected system errors

Specification:

  • Remove 404

Implementation:

  • Parsing error for dmi request should be a 400 client error

3Data

PUT

4Data

POST - /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running

NetworkCmProxyApi.createResourceDataRunningForCmHandleupdateResourceDataRunningForCmHandle()

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

201200

400

401

403

404201

200 (ok)

  • for success

500

5Data

(internal server error)

  • for error when parsing provided dmi request to json (NcmpException)
  • for dmi response code different from 2xx (NcmpException)
  • for unexpected system errors

Specification:

  • Remove 404

Implementation:

  • Parsing error for dmi request should be a 400 client error

4Data

POST PATCH - /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running

NetworkCmProxyApi.patchResourceDataRunningForCmHandlecreateResourceDataRunningForCmHandle()

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

200201

400

401

403

404200

201 (created)

  • for success

500 (internal server error)

  • for error when parsing provided dmi request to json (NcmpException)
  • for dmi response code different from 2xx (NcmpException)
  • for unexpected system errors

Specification:

  • Remove 404

Implementation:

  • Parsing error for dmi request should be a 400 client error

5Data

PATCH

6Model

GET - /v1/ch/{cm-handle}/modules/data/ds/ncmp-datastore:passthrough-running

NetworkCmProxyApi.getModuleReferencesByCmHandleFetch all module references (name and revision) for a patchResourceDataRunningForCmHandle()

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

200

400

401

403

404

200 (ok)

  • for success

500 (internal server error)

  • for error when parsing provided dmi request to json (NcmpException)
  • for dmi response code different from 2xx (NcmpException)
  • for unexpected system errors

Specification:

  • Remove 404

Implementation:

  • Parsing error for dmi request should be a 400 client error

6Model

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

NetworkCmProxyApi.getModuleReferencesByCmHandle

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

7Model

POST - /v1/ch/searches

NetworkCmProxyApi.executeCmHandleSearch

Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names

200

400

401

403

404

200 (ok)

500

Implementation:

  • Currently 500 is returned when no matches found. This should be changed to a 4xx response
  • for success

500 (internal server error)

  • for unexpected system errors

Specification:

  • Remove 400, 404

7Model

POST -

8Inventory

POST /v1/ch/searches

NetworkCmProxyInventoryApiNetworkCmProxyApi.updateDmiPluginRegistration()

Register, update or remove cm handles

executeCmHandleSearch

Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names

200201

400

401

403

201

500

Specification:

  • Should success always be 200 (general ok) instead of 201 (created) that might look confusing for updates and removals ?

Implementation:

  • Invalid requests should return 4xx with an explanation message instead of 500 without information (ex: Invalid combination of plugin service names, URI is not absolute, ...)

DMI-Plugin

POST - /v1/inventory/cmHandles

DmiPluginInternalApi.registerCmHandles()

Register given list of cm handles (internal use only)

400 (bad request)

  • for empty cm handles list from input
parsing error when converting provided cm handles into JSON (DmiException)for any response code from NCMP that is different form 201 (CmHandleRegistrationException

200 (ok)

  • for success

500 (internal server error)

  • for no yang resources found for provided module (ModuleNamesNotFoundException)
  • for unexpected system errors

Implementation:

  • Currently, 500 is returned when no matches found. This should be changed to a 4xx response
  • Invalid body payload struture format returns 500 with the system error message, not really useful for the client. Should also returns 400.

8Inventory

POST /v1/ch

NetworkCmProxyInventoryApi.updateDmiPluginRegistration()

Register, update or remove cm handles
#Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeComments
1DMI Plugin Internal

201

400

401

403

201 (created)

  • for success

500 (internal server error)

  • for
  • dmi plugin service name not provided (NcmpException)
  • for invalid combination of dmi plugin service names (NcmpException)
  • for parsing error while processing dmi plugin registration (DataValidationException)
  • for unexpected system errors

Implementation

  • Input cm handle conversion error should return a 4xx client error
2DMI Plugin

POST - /v1/ch/{cmHandle}/modules

DmiPluginApi.getModuleReferences()

Get all modules for given cm handle

200

400

401

403

200 (ok)

  • for success

404 (not found)

  • for SDNC returning no modules for given cm handle (ModulesNotFoundException)

500 (internal server error)

  • for SDNC response JSON format or processing failure (SdncException)
  • for unexpected system errors

Specification:

  • Should success always be 200 (general ok) instead of 201 (created) that might look confusing for updates and removals ?

Implementation:

  • Invalid requests should return 4xx with an explanation message instead of 500 without information (ex: Invalid combination of plugin service names, URI is not absolute, ...)
  • What should be the error code related to dmi connectivity issues ? Could be either 400 (the client provided an invalid url) or 500 (the url provided by the client is valid, but the connection failed because of a system error)
  • Current information logged when dmi plugin service is not reachable is not enough to support and investigate.

DMI-Plugin

(commit id 1954daa5d31b537a8838d1e11cb41cd6f40b58d9)

200200 ok404 not found module resource not found from SDNC for the given cm handle (ModuleResourceNotFoundException)
  • for error occurred when trying to parse the response body from SDNC (ModuleResourceNotFoundException)
  • JSON creating the module request from the given module reference SDNC from 200 or 404:
    • SDNC errors are not really consistent (404 and 500)
    • Error related to the given module reference should be 4xx ?
    4
    #Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeComments
    1DMI Plugin Internal

    POST - /v1/inventory/cmHandles

    DmiPluginInternalApi.registerCmHandles()



    Register given list of cm handles (internal use only)

    201

    3DMI Plugin

    POST - /v1/ch/{cmHandle}/moduleResources

    DmiPluginApi.retrieveModuleResources()

    Retrieve module resources for one or more modules

    400

    401

    403

    201 (

    created)

    • for success

    400 (

    bad request)

    • for
    • empty cm handles list from input

    500 (internal server error)

    • for
    • parsing error when
    • converting provided cm handles into JSON (DmiException)
    • for any
    • response code from NCMP that is different
    • form 201 (CmHandleRegistrationException)
    • for unexpected system errors

    Implementation

    • Input cm handle conversion error should return a 4xx client error
    2DMI Plugin

    POST - /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operationalmodules

    DmiPluginApi.dataAccessPassthroughOperationalgetModuleReferences()

    Get resource data from passthrough-operational for cm handle. Will support read operations only.all modules for given cm handle

    200

    400

    401

    403

    200 (ok)

    • for success

    400 404 (bad requestnot found)

    • for input operation that is different from readSDNC returning no modules for given cm handle (ModulesNotFoundException)

    500 (internal server error)

    • for any SDNC response code that is different from 200 (ResourceDataNotFoundJSON format or processing failure (SdncException)
    • for unexpected system errors

    ImplementationSpecification:

    • The exception ResourceDataNotFound is missing the Exception suffix
    • Remove 400
    • Add 404
    35DMI Plugin

    POST - /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-runningmoduleResources

    DmiPluginApi.dataAccessPassthroughRunningretrieveModuleResources()

    Post request to Get, Create or to Update resource data for a cm-handle. Since all requests need to include additional information in a request body HTTP Post is used for all use cases and the actual operation is defined in the request body instead.Retrieve module resources for one or more modules

    200

    400

    401

    201

    400

    401

    403

    200 (ok)

    • for success with read or update requested operation. Response body is SDNC body response.

    201 (created)

    • for success with create requested operation. Response body is SDNC body response.

    204 (no content)

    • for success with delete requested operation. Response body is SDNC body response.

    400 (bad request)

    404 (not found)

    • for module resource not found from SDNC for the given cm handle (ModuleResourceNotFoundException)
    • for error occurred when trying to parse the response body from SDNC (ModuleResourceNotFoundException)for requested operation that is different from create, read, update or delete. Response body is SDNC body response.

    500 (internal server error)

    • for any SDNC response code that is different from 2xx when writing data JSON parsing error when creating the module request from the given module reference (DmiException)
    • for any SDNC response code that is different from 200 when getting data (ResourceDataNotFound)or 404
    • for unexpected system errors

    Specification

    • Should success always be 200 (general ok) instead of 201 (created) ?

    Implementation

    • It does not seem consistent to return 404 with SDNC body response when operation is different from create, read update or delete.
    • SDNC response codes are handled differently for getting and writing data

    CPS-Temporal

    Get anchor data by name data validation errorsGET dataspacesdataspace-nameanchors/historyCpsTemporalQueryApi.getAnchorsDataByFilter200

    400 (bad request)

    • for input data validation errors

    500 (internal server error)

    • for unexpected system errors

    Implementation:

    • SDNC errors are not really consistent (404 and 500)
    • Error related to the given module reference should be 4xx ?
    4DMI Plugin

    POST - /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational

    DmiPluginApi.dataAccessPassthroughOperational()

    Get resource data from passthrough-operational for cm handle. Will support read operations only.
    #Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeComments
    1Query

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

    CpsTemporalQueryApi.getAnchorDataByName()

    200

    400

    401

    403

    200 (ok)

    • for success

    400 (bad request)

    • for input
    • operation that is different from read

    500 (internal server error)

    • for any SDNC response code that is different from 200 (ResourceDataNotFound)
    • for unexpected system errors

    (tick)

    2Query

    Implementation:

    • The exception ResourceDataNotFound is missing the Exception suffix
    5DMI Plugin

    POST - /v1/

    ch/{

    cmHandle}/

    data/ds/ncmp-datastore:passthrough-running

    DmiPluginApi.dataAccessPassthroughRunning()

    Get anchors data based on filter criteriaPost request to Get, Create or to Update resource data for a cm-handle. Since all requests need to include additional information in a request body HTTP Post is used for all use cases and the actual operation is defined in the request body instead.

    201

    400

    401

    403

    200 (ok)

    • for success

    (tick)

    General comments for all endpoints

    ...

    • with read or update requested operation. Response body is SDNC body response.

    201 (created)

    • for success with create requested operation. Response body is SDNC body response.

    204 (no content)

    • for success with delete requested operation. Response body is SDNC body response.

    400 (bad request)

    • for requested operation that is different from create, read, update or delete. Response body is SDNC body response.

    500 (internal server error)

    • for any SDNC response code that is different from 2xx when writing data (DmiException)
    • for any SDNC response code that is different from 200 when getting data (ResourceDataNotFound)
    • for unexpected system errors

    Specification

    • Should success always be 200 (general ok) instead of 201 (created) ?

    Implementation

    • It does not seem consistent to return 404 with SDNC body response when operation is different from create, read update or delete.
    • SDNC response codes are handled differently for getting and writing data


    CPS-Temporal

    (commit id 13483eacf395cae83239dd0f17114986b9476d19)

    #Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeComments
    1Query

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

    CpsTemporalQueryApi.getAnchorDataByName()

    Get anchor data by name

    200

    400

    401

    403

    200 (ok)

    • for success

    400 (bad request)

    • for input data validation errors

    500 (internal server error)

    • for unexpected system errors

    (tick)

    2Query

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

    CpsTemporalQueryApi.getAnchorsDataByFilter()


    Get anchors data based on filter criteria

    200

    400

    401

    403

    200 (ok)

    • for success

    400 (bad request)

    • for input data validation errors

    500 (internal server error)

    • for unexpected system errors

    (tick)

    General comments for all endpoints

    Specification

    2xx: Success - The action was successfully received, understood, and accepted

    4xx: Client Error - The request contains bad syntax or cannot be fulfilled

    5xx: Server Error - The server failed to fulfill an apparently valid request

    • Always ensure that client request related errors return 4xx along with a clear explanation provided to the client about the reason for the error. When 4xx errors occur, the system itself is behaving as expected.
    • 500 response codes should only correspond to unexpected errors that require support investigation and effort in order to be fixed (ex: network communication issue, dependent component or system down, corrupted data, application bug, ...). For 500 errors no details are really expected in the response for the client, all the information to investigate the problem should be available in the logs.
    • Review 401 and 403 responses code from specification that are not implemented yet.
    • 500 needs to be added to the specification for all endpoints

    ...