Jira Ref. CPS-277 - Getting issue details... STATUS
Analyze all API GET calls listed on this page: https://wiki.onap.org/display/DW/CPS+APIs
(#2 and #21 have already been analyzed and required queries been identified)
- Ensure use case is clear using given model and data example
- Find out required (new) query functionality in CPS (several API calls might need the same CPS functionality)to 'find' the required data given the provided parameters (request payload) and model.
- One (Slicing) API call might require more than one CPS-Core call, indicate in the report if this is the case
- One API call might need to access more than one model (report!)
- Distinguish between NCMP (ran network data) and CPS-Core access for NW Slicing specific data.
A/C
- Wiki Page with the conclusion for each API call
- Add new query functionality if needed to https://wiki.onap.org/display/DW/CPS-235%3A+Overview+of+%28early%29+CPS+Query+and+Update+Scenarios
- Review with the full team
To be noted: Dataspace name is fixed to NFP-Operational.
No | API endpoint | HTTP Method | Description | CPS Path Query | Comments |
|---|---|---|---|---|---|
| 1. | /api/sdnc-config-db/v4/nearrtric-list/{trackingArea} | GET | Get complete details associated with a list of NearRT RIC's and corresponding managed elements | xpath : /cps-ran-schema/NearRTRIC[@idNearRTRIC="22"]/GNBDUFunction[@idGNBDUFunction="6"]/NRCellDU[@idNRCellDU="15548"]/ attributes : {"nRPCI": 12, "nRTAC": 310, "cellLocalId": 15548} Proposed cps query; Retrieve all unique list based on xpath prefix and attribute key and value A. /cps-ran-schema/NearRTRIC[?]/GNBDUFunction[?]/NRCellDU[@nRTAC=310] B. //NRCellDU[@nRTAC=310] XPath ends with NRCellDU[?] and attributes contain nRTAC=310 nRTAC is not the key getByAnchorAndXpathAndLeafAttributes will resolve option B.Option A is more difficult to implement. Options for getting ancestor A. //book[@name="Feersum Endjinn"]/ancestor::*[position()=3] B. //book[@name="Chapters"]/ancestor::bookstore | e.g. /dataspace/"NFP-Operational"/anchor/"ran-slicing" From our discussion with Ruslan Kashapov and Niamh Core, we came to an understanding that we would require a special query mechanism that can retrieve the parent from its attribute values. |
| 2. | /api/sdnc-config-db/v4/cell-list/{trackingArea} | GET | Get a list of cells that correspond to a specific tracking area | Done | |
| 9. | /api/sdnc-config-db/v4/du-list/{sNSSAI} | GET | Fetch the DU functions for sNSSAI | cps-ran-schema/NearRTRIC/GNBDUFunction/NRCellDU/attributes/pLMNInfoList/sNSSAIList/sNssai Query - get ancestor GNBDUFunctionbased on the sNSSAI. 9,10 and 12 belong to the cps ran schema model //sNSSAIList[@sNssai=1]/ancestor::GNBDUFunction | Needs clarification from the network slicing team |
| 10. | /api/sdnc-config-db/v4/du-cell-list/{sNSSAI} | GET | Fetch DU Cells for sNSSAI | cps-ran-schema/NearRTRIC/GNBDUFunction/NRCellDU/attributes/pLMNInfoList/sNSSAIList/sNssai Query - get ancestor NRCellDU based on the sNSSAI. //sNSSAIList[@sNssai=1]/ancestor::NRCellDU | Needs clarification from the network slicing team |
| 11. | /api/sdnc-config-db/v4/profile-config/{sNSSAI} | GET | Fetch slice profile configuration for a sNSSAI | Not Needed | Ignore this API |
| 12. | /api/sdnc-config-db/v4/slice-config/{sNSSAI} | GET | Fetch NearRTRIC configuration for a sNSSAI | cps-ran-schema/NearRTRIC/attributes/pLMNInfoList/sNSSAIList/sNssai Query - get a sibling value based on the given sNSSAI. Get the sibling configData of sNSSAI from the sNSSAIList. //sNSSAIList[@sNssai=1] This will use API 2 CPS-235: Overview of (early) CPS Query and Update Scenarios | Needs clarification from the network slicing team |
| 13. | /api/sdnc-config-db/v4/subscriber-details/{sNSSAI} | GET | Fetch subscriber details | Ignore this API | |
| 19. | api/sdnc-config-db/v4/nearrtric/{ranNFNSSIId} | GET | Fetches the NearRTRICs for the RANNFNSSI | The RANNFNSSI is stored within the ranNFNSSIIdList. Query - We need a query that will get the immediate parent (NearRTRICs) based on attribute values from the list of ranNFNSSIIdList (child). We may need to add a new cps query CPS-235: Overview of (early) CPS Query and Update Scenarios to get a parent value based on the ranNFNSSIId value //ranNFNSSIIdList[@RANNFNSSI =1]/ancestor::NearRTRICs | For team review |
| 20. | /api/sdnc-config-db/v4/plmn/{sliceProfileId} | GET | Returns PLMN id for the sliceProfile | The ran inventory model was used for this study. | For team review |
| 21. | /api/sdnc-config-db/v4/ta-list/{mcc}/{mnc}/{coverageArea} /api/sdnc-config-db/v4/ta-list/{PLMNId}/{coverageArea} | GET | Returns List of a tracking area (coverageAreaTAList) of the specified coverage area | Done |
| Question | Comment | |
|---|---|---|
| 1 | API 9 & 10: There are multiple placeholders for it in the same ancestor of DU, RTRIC, CUUP and CUCP NFs. For DU-list we have identified: cps-ran-schema/GNBDUFunction/attributes/RRMPolicyRatio/attributes/sNSSAI For the DU list, we can also use the sNSSAI from cell-list which comes under DU. For cell-list we have identified: cps-ran-schema/NRCellDU/attributes/pLMNInfoList/sNSSAIList/sNSSAI Would you please guide us as to what would be the right attributes to be considered in the search for these GET APIs? | From: ahila.pandaram@wipro.com <ahila.pandaram@wipro.com> As per the current SDN-R implementation, sNSSAI is configured in NRCellDU, NRCellCU & gNBCUUP. NearRTRIC is configured only in closed loop scenarios. So please make use of this for the APIs (9) & (10). cps-ran-schema/GNBDUFunction/NRCellDU/attributes/pLMNInfoList/sNSSAIList/sNssai |
| 2 | API 12: We did not identify the slice config attribute for API#12 to be mapped in the Network Slicing. Kindly provide us with the right model and data. | From: ahila.pandaram@wipro.com <ahila.pandaram@wipro.com> API (12) can make use of this: cps-ran-schema/NearRTRIC/attributes/pLMNInfoList/sNSSAIList/sNssai |