| Jira |
|---|
| server | ONAP Jira |
|---|
| columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
|---|
| columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | CPS-679 |
|---|
|
| Jira |
|---|
| server | ONAP Jira |
|---|
| columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
|---|
| columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | CPS-678 |
|---|
|
# | Open Issues | Notes | Decision |
|---|
| 1 | Which option to choose from the below solutions? To resolve | Jira |
|---|
| server | ONAP Jira |
|---|
| columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
|---|
| columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | CPS-679 |
|---|
|
| - Need for OpenAPi contract-first description of interfaces is a priority
- Likeliness to RESTConf is nice but no firm decision or requirement on this for ORAN interfaces
- OpenAPI does not support slashes in path parameters (researched and confirmed through testing)
| - In meeting 29 Sept 2021 with Kieran McCarty and Oskar Malm and CPS Team agreed on option #1 below: resourceIdentifier will become a query parameter
- This will affect all NCMP (and DMI interface) operations with a 'resourceIdentifier'
- resourceIdentifier (for now) wil be a 'compulsory' parameter (this might change when support root or queries across the network)
|
| 2 | For solution no.1, should fields/depth be known parameters or part of an unknown parameter-map like 'query'? To resolve | Jira |
|---|
| server | ONAP Jira |
|---|
| serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
|---|
| key | CPS-678 |
|---|
|
| - For Pass-trough scenarios any parameters can be supported depending the DMI implementation
- NCMP does not support any parameter just passes-it-through for passthrough use cases
- Depth and fields could become 'known' parameters for non-passthrough scenarios. but that does not affect the suggestion solution of just a map of unknown optional parameters
| - In meeting 29 Sept 2021 with Kieran McCarty and Oskar Malm and CPS Team agreed that passthrough scenarios will just support (an optional) query parameter called 'options' with key-value map of 'unknown' parameters
- NCMP wil do no validation it only acts a as a proxy for the DMI plugin
- both passthrough read and write operations can have these 'option' but ONAP DMI plugin will only use them for read use-cases
(technically they could be passed on for write operations too, this could allow any future optional field for write operation in RESTConf. Validation would be left then to the node. as is now anyway and the DMI plugin would just respond with the error (or positive) it gets from the node
Additional Note 29 Sept. CPS Development team agreed to pass on any 'options' to SDN-C.
|
Description of the bug
CPS-679
Currently, NCMP does NOT support / slashes in the resource identifier as the OpenAPI definition would regard that as separate REST paths ie. a different rest endpoint
Slashes are currently not supported by open API for path params - https://github.com/OAI/OpenAPI-Specification/issues/892#issuecomment-281170254
CPS-679
Likewise OpenAPI does NOT support any list of unknown parameters. The name (key) of each parameter must be defined in the OpenApi. Currently CPS-NCMP and DMI plugin are hardcode to accept parameters 'fields' and 'depth' only. This need to be replaced with a more flexible generic solution
Currently supported
| Code Block |
|---|
/v1/ch/node1/data/ds/ncmp-datastore:passthrough-operational/turing-machine:turing-machine?fields=transition-function?depth=3 |
...
