| 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. | we should mainly support yang-data/json controlled by "accept-header" |
| 3 | In the URI will we distinguish between data and operations (RFC calls) as part of the path? | | This only applies to pass-through yes, we will distinguish between data and operation |
| 4 | Which query parameters will NCMP support? |
| Parent data resource identifier can handle any path using the same query parameter - cpsPath
- RESTConf Path (pass-through)
- Proprietary Path (pass-through)
|
| 5 | Yml should include return types and examples of the payload |
| Legacy and new API documentation needs to include output examples. Task created, see | Jira |
|---|
| server | ONAP JIRA |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | CPS-401 |
|---|
|
|
| 6 | camel case or dash in URI |
| We will use a dash for param names e.g. cmHandle (although it has since been agreed we use 'ch' in this particular case) See no.3 https://restfulapi.net/resource-naming/ |
| 7 | Insert /resourcePath in front of the resource path to prevent ambiguous paths | <OP>/ncmp/<v{vNumber}>/ch/<cmHandle>/<data|operations|{ncmp-operation}>/ds/{datastore}/[rp:]{resourcePath}?{query} | Optionally insert the resource path ('rp:') if it clashes with the current |
| 8 | Granularity of update scenarios (and priority) | - Add child and its descendants (supported in cps core)
- Add all list elements (supported in cps core)
- Replace child and its descendants (supported in cps core)
- Replace all list elements (pending in cps core)
- Update single leaf (new)
- Add list entry (new)
| Priority is pass-through only so it depends on the RETSConf protocol that is supported. In Jakarta or if required by other projects more fine-grained 'operation' datastore update options can be implemented |
| 9 | Fallback option for datastore in release I |
| No, explicit datastore options will be used in Istanbul |
| 10 | fields is a rest conf option, investigate is it fully supported by onap |
| Supported in pass-through for ONAP DMI plugin but depending on the support by the actual target. The intention is to increase support 'fields' in future requirements following RFC-8040 for operational datastore etc. |
| 11 | Agree on URI syntax | Proposed syntax by CPS team <OP>/ncmp/<v{vNumber}>/ch/<cmHandle>/<data|operations|{ncmp-operation}>/ds/{datastore}/[rp:]{resourcePath}?{query} | review completed and proposed URI agreed |
| 12 | Will we combine query capabilities with update capabilities? |
| We have decided not to combine query capabilities with update capabilities |
| 13 | Description of header limitations |
| HTTP Header Limitations
Some servers put size limitations on HTTP headers, making them unsuitable for storing cmHandle information. LIMITATION NOTE: server implementations put size limits on the headers meaning header contents should be designed carefully :
Apache - 8K
Nginx - 4K-8K
IIS - 8K-16K
Tomcat - 8K – 48K |
| 14 | Will NCMP support paths for pass-through:running |
| The plugin will not do transformation or validation of paths in the case of pass-through:running |
| 15 | Specification of path per cm handle |
| DMI Plugin can take cps paths or restconf paths and it needs to specify that per cm handle when cm handle is created |
| 16 | What is the default path for NCMP |
| In NCMP default will always be cps path and depending on the adapter we can change it as needed per cm handle |
| 17 | Fields parameter for ncmp/operational? |
| The fields parameter is ignored in ncmp/operational (in Istanbul release) |
| 18 | Is specifying the datastore mandatory? |
| Datastore is mandatory in Istanbul release |
| 19 | Register a DMI plugin with NCMP |
| DMI plugin is a part of cm handle registration. The rest endpoint on NCMP can be multiple calls |
| 20 | Retrieve list of modules (names) for a cmHandle |
| Retrieve a list of module names for cm handle - this will be used by ncmp to get the models. - assuming ncmp model discovery is complete and it is stored in cps core, this will come from cached information |
| 21 | Where will sync be implemented? |
| Implement sync in the dmi plugin and then have ncmp be able to pass on the request. This is not a bulk operation |
| 22 | Config-true only support (filter out config-false data) |
| Use datastore 'running' to select this but filtering not supported in I for cached data |
| 23 | Enable NCMP to convert cpsPath to mutliple options(RESTConf, netConf, leave as cpsPath) | When other DMI-Plugins are realized they might need a different conversion then the default from cspPath to RESTConf. This could be configured by using a known property for each cmHandle | Not required in Istanbul. But DB model can easily be updated to cater for this when needed |
| 24 | Datastore conversion in NCMP or DMI-Plugin | DMI-Plugin will know best how to convert. This will also reduce future impacts on NCMP for new options. | NCMP will do now conversion of datastore names |
| 25 | What datastore/s (name/s) is/are supported by NCMP to referred to the cached data. 'Operational' or 'running' | 'operational' would imply RO and config=false data is included. 'To also support 'running' using the same data a filter would have to be applied | see supported datastore in I : 103416823Datastores |
| 26 | Consider fallback option when user specifies ncmp/operational but data is NOT synced |
| NCMP will forward requests for un-synced cmHandles to the DMI Plugin
(Including required transformation of resource path etc.) |
| 27 | Support for &fields parameter when using cached data | - not supported (ignored, not rejects, nice for future compatibility)
- treat as 'no descendants' (low cost)
- use to filter cached data
| &Fields parameter will be ignored for 'cached' data in Istanbul timeframe long term expectation is to have support following RESTConf/ODL behavior as much as possible |
| 28 | Support for &fields parameter when forwarding to plugin for non-synced cmHandles | - not supported (ignored, not rejects, nice for future compatibility)
- treat as 'no descendants' (low cost)
- translate (insert module names) and forward
| A spike | Jira |
|---|
| server | ONAP Jira |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | CPS-455 |
|---|
|
will be executed to determine the feasibility of option 3 and decide if it can make Istanbul scope |
| 29 | Response for Data Sync request (in Istanbul timeframe) | The action is blocking synchronous through whole stack (in I) so response could include the data returned by the node. However this seem incorrect for an 'action' so maybe the response should just be just an acknowledgment it is 'done' | No need to return data, just HTTP Code 200 (OK) will suffice |
