...
Open Issues & Decisions
Description | Notes | Decision | |
|---|---|---|---|
| 1 | Priority of async calls | In Istanbul, async calls are required only in pass-through cases. NCMP does not have to handle these requests | |
| 2 | Will we use the data node wrapper on GET rest operations? | Currently, we wrap the response of GET operations using the data node wrapper. | |
| 3 | In the URI will we distinguish between data and operations (RFC calls) as part of the path? | e.g. http://localhost:8080/cps/api/v1/data http://localhost:8080/cps/api/v1/operation | |
| 4 | Parent data resource identifier can handle any path using the same query parameter
| ||
| 5 | Yml should include return types and examples of the payload | ||
| 6 | camel case or dash in URI | ||
| 7 | Insert /resource-path in front of the resource path to prevent ambiguous paths | <OP>/ncmp /<v{v-number}>/cmhandle/<cm-handle>/<data|operations|{ncmp-action}>/ds/{datastore}/resource-path/<resource-path>?<query> | |
| 8 | Granularity of update scenarios (and priority) |
|
...
| 1 | ncmp-datastores:running (RW / config=true/false) | Read/Write to the CPS "intended" store (with validation). Then do subsequent write on DMI interface with ds ietf-datastores:running. |
| 2 | ncmp-datastores:operational (RO / config=true/false) | Read from the CPS "operational" store. |
| 3 | ncmp-datastores:passthrough-running (RW / config=true/false) | Read/Write to/from the live devices ietf-datastores:running (no local ncmp validation) |
...
Yang data resource actions and RPC operations are run directly on the 'device' meaning ncmp-datastores:passthrough-running is used for these request
Different defaults for read and write
e.g. ncmp-datastores:operational for read requests
| # | Usecase | NCMP Datastore | Path | ?fields | ?topic | Query | Time frame |
|---|---|---|---|---|---|---|---|
| 1 | Read | passthrough-running | RESTConf Path only | Implemented by SDNC/Node | Implemented by DMI Plugin | Not supported | Istanbul |
| 2 | Read | ncmp-datastores:operational | CPSPath only | TBD | TBD | Limited xpath functionality | Istanbul |
| 3 | Create | passthrough-running | RESTConf Path only | N/A | N/A | N/A | Istanbul |
| 4 | Create | ncmp-datastores:running | CPSPath only | N/A | N/A | N/A | > Istanbul |
| 5 | Delete | passthrough-running | RESTConf Path only | N/A | N/A | Not supported | Istanbul |
| 6 | Delete | ncmp-datastores:running | CPSPath only | N/A | N/A | Not supported | > Istanbul |
| 7 | Update | passthrough-running | RESTConf Path only | N/A | N/A | N/A | Istanbul |
| 8 | Update | ncmp-datastores:running | CPSPath only | N/A | N/A | N/A | > Istanbul |
| 9 | Patches | passthrough-running | RESTConf Path only | N/A | N/A | N/A | Istanbul |
| 10 | Patches | ncmp-datastores:running | CPSPath only | N/A | N/A | N/A | > Istanbul |
| 11 | Bulk | passthrough-running | RESTConf Path only | N/A | N/A | N/A | > Istanbul |
| 12 | Bulk | ncmp-datastores:running | CPSPath only | N/A | N/A | N/A | > Istanbul |
| 13 | Action | passthrough-running | RESTConf Path only | N/A | N/A | N/A | Istanbul? |
| 14 | Action | ncmp-datastores:running | CPSPath only | N/A | N/A | N/A | Istanbul? |
REST API
| Req/usecase | REST Method | URI / Payload | Header Parameters | Request/Response Example | Status | |
|---|---|---|---|---|---|---|
| 1 | ||||||
| 2 | ||||||
| 3 | ||||||
| 4 | ||||||
| 5 | ||||||
| 6 | ||||||
| 7 | ||||||
| 8 | ||||||
| 9 | ||||||
| 10 | ||||||
| 11 | ||||||
| 12 |
...