...
# | Open Issues | Notes | Decision |
|---|
| 1 | Which option to choose from the below solutions? | - 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:
| resoureceIdentifier - resourceIdentifier will become a query parameter
- This will affect all NCMP (and DMI interface) operations with a 'resourceIdentifier'
| resourceIdentiefer - 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'? | - 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 uses them for read use-cases
(technically they could be passed on for writer 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
|
Description of the bu
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
...
