Versions Compared

Key

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

...

RESTful API Design Specification

Issues and Decisions

#IssueNotesDecision
1How will hostname and port be provided when dmiPlugin register itself and its list of cmHandles with NCMP

The team thinks that the information should instead be provided in the form of a ‘host-name’ and a ‘port’  (there was some debate on service-name v. host-name but it was settled on host-name)


e.g. "dmiPlugin" : { <host-name>,  <port> }


Where the host-name is unique. (the DB might assign an internal unique ID for each entry but that is just for indexing and x-referencing in a relation DB and this ID is not to be used/ exposed externally)

Instead of using ‘host-names’ and ‘ports’ parameters between java applications when in the cloud all we need is ‘service-names’ . The mapping of service-names to hosts and ports is done as part of the cloud configuration, in our case Kubernetes. And these are dynamic! The client application can then use a simple dns-lookup to connect to an instance of the service.

Using service names also allows any plugin to use implement scaling as they see fit e.g. partitioning


For the ONAP DMI Plugin which initial have only 1 instance we can simply hard-code the service-name and us the same name in the Kubernetes configuration e.g. “onap.cps.dmiPlugin"
2Additional information in request body duplicates cmHandleId this is redundant informationSuggested to remove from request body to avoid possible error scenarios.Only the one with the additionalInformation is needed and remove body
3No need for Sync method, this is basic standard read operation at the root level for that cmHandle

4Use include 'location' property when request yang-module sourcesSuggestion: do include it in the request but allow dmiPlugin to decide to use it or now. Location (this leaf is called schema in older RFC7895) is not mandatory to support in YANG library and nodes may not include it. Another alternative presumably used also by ODL itself is the <get-schema> RPC. The key difference is that the YANG module definition is sent directly over the NETCONF channel, not requiring separate file servers and clients. So this is maybe one more reason that the ONAP DMI plugin currently doesn’t need the location attribute.

Location is not needed for any plugin and could only lead to ambiguity therefore will NOT be included in this request

DMI URI

DMI URI format to follow below pattern Sandeep Shah

<OP>dmi/<v{vNumber}>/ch/<cmHandle>/<data|operations|dmiAction>/ds/{datastore}/[rp:]<resourcePath>?<query>

...

5Inconsistent use of "Operation" and/or HTTP Methods to distinguish write operationsCurrently this page proposes to use "Operation=update" request body parameter for restconf "Replace" and "Patch" operations and use the HTTP (RESTFul) operation to distinguish between them. It also proposes to use PUT  HTTP for Read and Delete operations (sad) Basically a very confusing an unintuitive use of HTTP operations to distinguish ambiguous operations that instead easily could be defined by just using the 'operation' field in the request body.

Proposal Toine: For Consistent (restful) design I would suggest to think as the operation to DMI-Plugin (always with body) as "creating a new order to do something" toward DMI-Plugin. Ie always a HTTP POST (or PUT?) operation. The "operation " in the body can simple be extended to include both "update" and "patch" as required. If the 'operation' is NOT supplied "read" wil be assumed as the default operation

See also CPS-NCMP - DMI - SDNC Request and Response Mapping


Proposal agreed by stakeholders in meeting  

  • Only 'POST' method needs to be supported
  • use term 'Update' instead of 'replace'

DMI URI

Below table shows the proposed interface, actual implementation might deviate from this but can be accessed from

DMI URI format to follow below pattern

<OP>dmi/<v{vNumber}>/ch/<cmHandle>/<data|operations|dmiAction>/ds/<datastore>/[rp:]<resourcePath>?<query>

URIMandatory or OptionalDescription
<OP>mandatorythe HTTP method
dmimandatorythe dmi root resource
<v{vNumber}>mandatoryversion of the dmi interface is the target resource URI is the query parameter list
<cmHandle>mandatoryunique (string) identifier of a yang tree instance.
<data|operations|dmiAction>mandatoryyang data, rpc operation or a (non-modeled) dmi action
{datastore}mandatorymandatory datastore
<resourcePath>optionalthe path expression identifying the resource that is
being accessed by the operation. If this field is not
present, then the target resource is the API itself.
<query>optionalthe set of parameters associated with the RESTCONF message;
see Section 3.4 of [RFC3986]. RESTCONF parameters have 
the familiar form of "name=value" pairs. Most query parameters are
optional to implement by the server and optional to use by the client. Each optional query parameter is identified by a URI

NCPS-NCMP - DMI Plugin Write Request Flow

See CPS-NCMP - DMI - SDNC Request and Response Mapping

Datastore

If the cmhandle metadata indicates that data is not synched in CPS then the request is forwarded to the dmiPlugin

RESTCONF/NETCONF relationship

Image Added



REST Data API

The DMI APIs for data access are similar to corresponding NCMP APIs. The following list is a summary of the main differences:

  1. The URI prefix is /dmi instead of /ncmp.
  2. For non-passthrough datastores, the resource path will be converted from cpsPath to RESTConfPath
  3. The body for each request will contain additional information and any data provided on the NCMP interface (write operations) will be embedded in a larger JSON structure as described in example below.

  4. Since all requests will have a message body, in some cases the HTTP method will be different to allow passing data. Thus POST can be used, the actual operation will be read from the body.

Excerpt

Request Format for Data Access

Code Block
languagexml
titlerequest body
{
  “operation”: “<operation>”,         // Valid operations are: “create”, “read”, “update”, “patch” and “delete”.
                                      
  "dataType": "<dataType>",           // e.g. "application/yang.data"

    “data”: {                           // Embedded data as a String.
    <data>                            // required for create and update operations. Optional filter-data for read-operations
  },

  “cmHandleProperties”: {           // Additional properties for CM handle previously added by DMI plugin and stored in NCMP.
    <properties>
  }
}




Expand
titleAPI details

Below table shows the proposed interface, actual implementation might deviate from this but can be accessed from


UsecaseREST MethodURI
1Add a data resource for a cmHandlePOST

{dmiRoot}/dmi/v1/ch/<cmhandle>/data/ds/ncmp-datastore:running/{parentDataResourceIdentifier}

{
<new-yang-data-resource>
}

Content-Type: application/json

"data" payload : yang-data+json

2Delete a data resource for a cmHandlePUT{dmiRoot

Datastore

If the cmhandle metadata indicates that data is not synched in CPS then the request is forwarded to the dmiPlugin

RESTCONF/NETCONF relationship

Image Removed

REST Data API

The DMI APIs for data access are similar to corresponding NCMP APIs. The following list is a summary of the main differences:

  1. The URI prefix is /dmi instead of /ncmp.
  2. For non-passthrough datastores, the resource path will be converted from cpsPath to RESTConfPath
  3. The body for each request will contain additional information and any data provided on the NCMP interface (write operations) will be embedded in a larger JSON structure as described in example below.

  4. Since all requests will have a message body, in some cases the HTTP method will be different to allow passing data. Thus PUT is used instead of GET and DELETE.

Request Format for Data Access

Code Block
languagexml
titlerequest body
{
  “operation”: “<operation>”,         // Valid operations are: “create”, “read”, “update” and “delete”.
                                      // For update, replace and patch is distinguished by the HTTP method (PUT or PATCH).

  “dataType”: “<mimeType>”,          // Indicates format for the embedded data.
                                      // Shall use MIME type syntax, e g “application/yang-data+json”.
                                      // required for create and update operations. Optional filter-data for read-operations

  “data”: {                           // Embedded data. Must be valid JSON object.
    <data>                            // required for create and update operations. Optional filter-data for read-operations
  },

  “additionalProperties”: {           // Additional properties for CM handle previously added by DMI plugin and stored in NCMP.
    <properties>
  }
}
Expand
titleAPI details

{dmiRoot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:running/{resourceIdentifier}

Content-Type: application/json

"data" payload : yang-patch+json

{dmiRoot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:operational/{resourceIdentifier}/{action}

input: {
         "param1Name" :"param1Value”,
          "param2Name" : "param2Value”

}

Note : If the "action" statement has no "input" section, the request message MUST NOT include a message-body

UsecaseREST MethodURI
1Add a data resource for a cmHandlePOST

{dmiRoot}/dmi/v1/ch/<cmhandle>/data/ds/ncmp-datastore:running/{parentDataResourceIdentifier}

{
<new-yang-data-resource>
}

Content-Type: application/json

"data" payload : yang-data+json

2Delete a data resource for a cmHandlePUT{dmiRoot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:running/{resourceIdentifier}
3Patch a data resource for a cmHandlePATCH

{dmiRoot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:running/{resourceIdentifier}

{
<yang-data-for-merging>
}

Content-Type: application/json

"data" payload : yang-data+json

4Patch multiple child resources for a single cmHandlePATCH5Execute a yang action on a cmhandle instancePOST
6Execute an rpc operationPOST

{dmiRoot}/dmi/v1/operations/ch/<cmHandle>/ds/ncmp-datastore:operational/ {module-name}:{action}

{ input: {
            "param1Name" : "param1Value”,
             "param2Name" : "param2Value”
} }

Note: If there is no "input" section, the request MUST NOT include a message-body

7Read a filtered set of data under a data resource for a cmHandlePUT{dmiroot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:operationalrunning/{resourceIdentifier}?fields={fields-expression}
OptionDescription
fieldsRequest a subset of the target
resource contents
8
3Patch a Read data resources with specified fields under a given data resource for a given cmHandlePUTPATCH

{dmiRoot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:operationalrunning/{resourceIdentifier}?fields={fields-expression}

OptionDescription
fieldsRequest a subset of the target
resource contents
9Get data resource with 'fileds' for a cmhandle with a given scope condition

{
<yang-data-for-merging>
}

Content-Type: application/json

"data" payload : yang-data+json

4Patch multiple child resources for a single cmHandlePATCHPUT

{dmiRoot}/dmi/v1/ch/

{cmHandle}

<cmHandle>/data/ds/

ncmp-datastore:operational/{resourcepath}?fields={fields}&scope={scope}
10Read descendant nodes to a given depth for a given cmHandle

<dsName>/{resourceIdentifier}


Content-Type: application/json

"data" payload : yang-patch+json

5Execute a yang action on a cmhandle instancePOSTPUT

{dmiRoot}/dmi/v1/ch/{cmHandle}<cmHandle>/data/ds/ncmp-datastore:operational/{resourceIdentifier}?depth=/{levelaction}

OptionDescription
depthRequest limited sub-tree depth in
the reply content
If '1' then only immediate resource
is retrieved
If '2' then resource plus next level
resources are retrieved


input: {
         "param1Name" :"param1Value”,
          "param2Name" : "param2Value”

}


Note : If the "action" statement has no "input" section, the request message MUST NOT include a message-body

6Execute an rpc operationPOST11Replace data for a CMHandlePUT

{dmiRoot}/dmi/v1/operations/ch/<cmHandle>/data/ds/ncmp-datastore:runningoperational/ {resourceIdentifier}{data : {module-name}:{action}

{ input: {
            .... the complete tree config to be replaced

      }}

DMI Inventory, Model & Data Sync API

View file
nameDMI NCMP Model Sync.pptx
height150
 This presentation illustrates the API methods #1, #3 and #4 detailed below

"param1Name" : "param1Value”,
             "param2Name" : "param2Value”
} }

Note: If there is no "input" section, the request MUST NOT include a message-body

7Read a filtered set of data under a data resource for a cmHandlePUT

{dmiroot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:operational/{resourceIdentifier}?fields={fields-expression}

OptionDescription
fieldsRequest a subset of the target
resource contents


8Read data resources with specified fields under a given data resource for a given cmHandlePUT

{dmiRoot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:operational/{resourceIdentifier}?fields={fields-expression}


OptionDescription
fieldsRequest a subset of the target
resource contents


9Get data resource with 'fileds' for a cmhandle with a given scope conditionPUT{dmiRoot}/dmi/v1/ch/{cmHandle}/data/ds/ncmp-datastore:operational/{resourcepath}?fields={fields}&scope={scope}
10Read descendant nodes to a given depth for a given cmHandlePUT

{dmiRoot}/dmi/v1/ch/{cmHandle}/data/ds/ncmp-datastore:operational/{resourceIdentifier}?depth={level}


OptionDescription
depthRequest limited sub-tree depth in
the reply content
If '1' then only immediate resource
is retrieved
If '2' then resource plus next level
resources are retrieved


11Replace data for a CMHandlePUT

{dmiRoot}/dmi/v1/ch/<cmHandle>/data/ds/ncmp-datastore:running/{resourceIdentifier}

{data : {

            .... the complete tree config to be replaced

      }}


DMI Inventory, Model & Data Sync API

View file
nameDMI NCMP Model Sync.pptx
height150
 This presentation illustrates the API methods #1, #3 and #4 detailed below


Scenario : Get all cmhandles from NCMP for a given dmiPlugin. May be used
for conciliation
Method : GET
URI : {ncmpRoot}/ncmpDmi/v1/dmiPlugins/{dmiPlugin}/ch
Header :
Content-Type: application/json
Expand
titleAPI Details

Below table shows the proposed interface, actual implementation might deviate from this but can be accessed from

*For response output, where applicable the yang-library format and conventions are used 'as is'  or extended

#Use CaseRest MethodURIExample*
1

Get module set for a cmhandle


POST
Expand
titleAPI Details

*For response output, where applicable the yang-library format and conventions are used 'as is'  or extended

Scenario : DMI notifies NCMP of new cmhandles
Method : POST
URI : {ncmpRoot}/ncmpDmi/v1/ch/
Header :
Content-Type: application/json
#Use CaseRest MethodServiceURIExample*
1DMI notifies NCMP of new , deleted or changed cmhandles DMI Plugin NCMP. Including initial registration

POST for creating.

For update, replace and patch is distinguished by the HTTP method (PUT or PATCH).

json attributes:

  • "dmiPlugin" resolvable servicename
  • "created-cmHandles" used for initial cm handle registrations or subsequent
    cmhandle creations
  • "updated-cmHandles"
    Used for updates to cmhandles. Same structure as for create handles
  • "removed-cmHandles"  array of cmhandles that have been deleted
    from the network (no additional properties
NCMP

{ncmpRoot}/ncmpDmi/v1/ch/

Code Block
languagexml
titleRequest Body
Request Body : {
      "dmiPlugin" : "onap.dmi.plugin", 
      "createdCmHandles" : [ {   "cmHandle" : "rf4er5454",
                                 "additionalProperties" :
                                   { "subSystemId" : "system-001" }
                             }, {..} ],
      "updatedCmHandles" : [ .. ],
      "removedCmHandles" : [ "node-1", "node-2" , ... ]
  }
2Get all the registered cmhandles for a given pluginGETNCMP{ncmpRoot}/ncmpDmi/v1/dmiPlugins/{pluginId}/ch
Code Block
languagexml
titleResponse Body
Success Response :
    HTTP/1.1 200 Ok
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
  { "cmHandles" : [ {
          "cmHandle" : "node-1",
          "additionalProperties" : { "subSystem" : "system-001" }
       } ]
   }
3

Get module set for a cmhandle

POSTdmiPlugin{dmiRoot}/dmi/v1/ch/cmhandle-001/modules

Header :
Content-Type: application/json

Code Block
languagexml
titleRequest Body
{
  "operation": "read",
    "additionalProperties": {
      "subSystemId": "system-001"
    }
  }
}
Code Block
languagexml
titleResponse Body

Response:
 {
  "schemas": {
    "schema": [
      {
        "identifier": "nc-notifications",
        "version": "2008-07-14",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:netmod:notification",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-tls-server",
        "version": "2016-11-02",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-tls-server",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-ssh-server",
        "version": "2016-11-02",
        "format": "ietf-netconf-monitoring:yin",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-ssh-server",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "turing-machine",
        "version": "2013-12-27",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "http://example.net/turing-machine",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-yang-metadata",
        "version": "2016-08-05",
        "format": "ietf-netconf-monitoring:yin",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-metadata",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "iana-crypt-hash",
        "version": "2014-08-06",
        "format": "ietf-netconf-monitoring:yin",
        "namespace": "urn:ietf:params:xml:ns:yang:iana-crypt-hash",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-datastores",
        "version": "2017-08-17",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-datastores",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-keystore",
        "version": "2016-10-31",
        "format": "ietf-netconf-monitoring:yin",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-keystore",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-x509-cert-to-name",
        "version": "2014-12-10",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-netconf-with-defaults",
        "version": "2011-06-01",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-netconf",
        "version": "2011-06-01",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:netconf:base:1.0",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-yang-metadata",
        "version": "2016-08-05",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-metadata",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-yang-library",
        "version": "2019-01-04",
        "format": "ietf-netconf-monitoring:yin",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-netconf-acm",
        "version": "2018-02-14",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-netconf-acm",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-keystore",
        "version": "2016-10-31",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-keystore",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "ietf-netconf-with-defaults",
        "version": "2011-06-01",
        "format": "ietf-netconf-monitoring:yin",
        "namespace": "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults",
        "location": [
          "NETCONF"
        ]
      },
      {
        "identifier": "mynetconf",
        "version": "2019-03-01",
        "format": "ietf-netconf-monitoring:yang",
        "namespace": "urn:mynetconf:test",
        "location": [
          "NETCONF"
        ]
      }

        ]
  }
}
4Get yang module source for a list of modulesPOSTdmiPlugin{dmiRoot}/dmi/v1/ch/<cmHandle>cmhandle-001/modules

DMI Plugin will make multiple requests to xNF and combine the result in a list

Header :
Content-Type: application/json


Code Block
languagexml
titleRequest Body
{
  "operation": "read
Code Block
languagexml
titleRequest Body
{ "operation": "read", "dataType": "application/json", "data": { "modules": [ { "namespace": "urn:3gpp:sa5:_3gpp-nr-nrm-nrnetwork-nrsectorcarrier
",
    "cmHandleProperties ": {
      "
name
subSystemId": "
_3gpp-nr-nrm-nrsectorcarrier",
system-001"
    
"revision": "2020-12-09"
}
  }
}

Code Block
languagexml
titleResponse Body
Response:  
     
}
"schemas": [
      
]
    
},
    
"additionalProperties":
 
{
     
"subSystemId": "system-001"
{
    
} }Response:
 
a
 
list
 
yang
 
module
 
references
 
and
 
source
 
for each
Code Block
languagexml
titleResponse Body
{
 
[ { "name"
         "moduleName": "example-identifier",
                      "revision": "example-version",
                      "namespace": "example-namespace"
                    },
					{
						...
					}
                  ]
                }

2Get yang module source for a list of modulesPOST

{dmiRoot}/dmi/v1/ch/<cmHandle>/moduleResources


DMI Plugin will make multiple requests to xNF and combine the result in a list


Code Block
languagexml
titleRequest Body
{
  "operation": "read",
	"dataType": "application/json",
    "data": {
       "modules": [
        {
          "name": "pnf-sw-upgrade",
          "revision": "2019-12-03"
        }
      ]
    },
    "cmHandleProperties": {
      "subSystemId": "system-001"
    }
}


Response: a list yang module references and source for each

Code Block
languagexml
titleResponse Body
[ {
"name" : "pnf-sw-upgrade",
"revision" : "2019-12-03",
"yang-source": "some-source"
: "_3gpp-nr-nrm-nrsectorcarrier", "revision" : "2020-12-09", "namespace": "urn:3gpp:sa5:_3gpp-nr-nrm-nrnetwork-nrsectorcarrier" }, "yang-source": "module pnf-sw-upgrade {\n namespace \"http://onap.org/pnf-sw-upgrade\";\n prefix upgrade;\n\n import ietf-yang-types {\n prefix yang;\n } \n\n revision 2019-12-03 {\n description\n \"initial version\";\n }\n\n container software-upgrade {\n list upgrade-package {\n key \"id\";\n leaf id {\n type string;\n } \n\n leaf current-status {\n type enumeration {\n enum \"CREATED\";\n enum \"INITIALIZED\";\n enum \"DOWNLOAD_IN_PROGRESS\";\n enum \"DOWNLOAD_COMPLETED\";\n enum \"ACTIVATION_IN_PROGRESS\";\n enum \"ACTIVATION_COMPLETED\";\n }\n description\n \"List of possible states of the upgrade\";\n }\n\n leaf state-change-time {\n type yang:date-and-time;\n mandatory false;\n description\n \"Date and time of the last state change.\";\n }\n\n leaf action {\n type enumeration {\n enum \"NONE\";\n enum \"PRE_CHECK\";\n enum \"DOWNLOAD_NE_SW\";\n enum \"ACTIVATE_NE_SW\";\n enum \"CANCEL\";\n }\n mandatory false;\n description\n \"List of possible actions for the upgrade\";\n }\n\n leaf software-version {\n type string;\n description\n \"Possible name or release version of the UP\";\n } \n\n leaf uri {\n type string;\n description\n \"A URI that points to the directory where the UP can be found.\";\n }\n\n leaf user {\n type string;\n description\n \"Indicates the user.\";\n }\n\n leaf password {\n type string;\n description\n \"Indicates the password.\";\n }\n\n leaf user-label {\n type string;\n description\n \"Free-text description of the UP.\";\n }\n\n leaf node-health {\n type string;\n description\n \"Reflect Node Health Status\";\n }\n }\n }\n}" }
, {...} ]
}



GET Request with body


The HTTP libraries of certain languages (notably JavaScript) don’t allow GET requests to have a request body. In fact, some users are surprised that GET requests are ever allowed to have a body.

...