It should be able to query all cm handles with a given set of public cm handle properties.
Requirements
A/C:
Issue | Notes | Decision | |||
---|---|---|---|---|---|
1 | Does request body need to declare "publicCmHandleProperties"? | Do we need to explicitly declare "publicCmHandleProperties"? Will there be another possible variation to this in the future?
| Yes | ||
2 | Are public properties always stored (in postgress) in the format of "name" : x, "value": y? (does NOT affect implementation) | In the fragment table there are example that follow this format
| Yes. But all this is hidden when using CpsPath type query | ||
3 | Will there only ever be 1 KV pairs in public properties (in the DB)? | Yes, as each property is stored in a separate list-item Fragment But all this is hidden when using CpsPath type query | |||
4 | Does the order matter? | Does
==
| No But all this is hidden when using CpsPath type query | ||
5 | Should search be case sensitive? | depend on CPSPath functionality - may be case-sensitive https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html | Yes, that is the currently implement as such CpsPath type query. Given it is mostly machine-to-machine type queries this is good enough and performs better | ||
6 | What format should the response take? | We have two options currently:
2. Return CM Handle Objects
Contact Tony Finnerty & kieran mccarthy regarding this. | It has been decided to implement this using a list of cm handles | ||
7 | what if we have valid entries and one entry is empty? | We would return all cm handles and others that match would be included in this list anyway. → To avoid this should we first check the entries int map for empty entries as further processing is unnecessary in this case. | Discussed with Toine Siebelink and implementation changes are required for handling edges cases. we will handle empty and unknown properties separately. | ||
8 | Regarding empty/missing property in request e.g. { "publicCmHandleProperties": { | Do we want to throw an exception if there is an empty property? Do we silently ignore them and move on? should we send two lists back... one with matching cm handles and one with those that failed processing? | We will throw a DataValidationException if an entry contains an empty property |
High level Jiras:
Possible High-Level Implementation Steps:
Match all xpaths using CPS Path Query
Iterate over the list and retrieve all attributes
# | URI | Design Notes | Comment(s) | ||
---|---|---|---|---|---|
1 | POST /ncmp/v1/data/ch/searches | Scenario : Request received to return all cm handles matching properties given Request Body
Response Body Example 1
|
Below is a sample yaml for OpenAPI.
executeSearchForMatchingPublicProperties: post: description: Execute search to get all cm handles for the given public properties tags: - network-cm-proxy summary: Execute cm handle search using operationId: executeSearchForMatchingPublicProperties requestBody: required: true content: application/json: schema: $ref: 'components.yaml#/components/schemas/PublicProperties' responses: 200: description: OK content: application/json: schema: type: array items: type: string 400: $ref: 'components.yaml#/components/responses/BadRequest' 401: $ref: 'components.yaml#/components/responses/Unauthorized' 403: $ref: 'components.yaml#/components/responses/Forbidden' 404: $ref: 'components.yaml#/components/responses/NotFound' 500: $ref: 'components.yaml#/components/responses/InternalServerError' |
https://gerrit.onap.org/r/c/cps/+/127541
# | xpath | attributes |
---|---|---|
1 | /dmi-registry/cm-handles[@id='PNFDemo']/public-properties[@name='Contact2'] | {"name": "Contact2", "value": "storeemail2@bookstore.com"} |
2 | /dmi-registry/cm-handles[@id='PNFDemo']/public-properties[@name='Contact'] | {"name": "Contact", "value": "newemailforstore@bookstore.com"} |
3 | /dmi-registry/cm-handles[@id='Bookstore5']/public-properties[@name='color'] | {"name": "color", "value": "won't match"} |
4 | /dmi-registry/cm-handles[@id='Bookstore4']/public-properties[@name='color'] | {"name": "color", "value": ""} |
5 | /dmi-registry/cm-handles[@id='Bookstore3']/public-properties[@name='color'] | {"name": "color", "value": "red"} |
6 | /dmi-registry/cm-handles[@id='Bookstore2']/public-properties[@name='Contact'] | {"name": "Contact", "value": "newemailforstore2@bookstore.com"} |
7 | /dmi-registry/cm-handles[@id='Bookstore1']/public-properties[@name='Contact'] | {"name": "Contact", "value": "newemailforstore@bookstore.com"} |
8 | /dmi-registry/cm-handles[@id='Bookstore6']/public-properties[@name='color'] | {"name": "color", "value": "12345"} |
9 | /dmi-registry/cm-handles[@id='Bookstore7']/public-properties[@name='color'] | {"name": "color", "value": "12345"} |
10 | /dmi-registry/cm-handles[@id='Bookstore8']/public-properties[@name='size'] | {"name": "size", "value": "large"} |
11 | /dmi-registry/cm-handles[@id='Bookstore8']/public-properties[@name='color'] | {"name": "color", "value": "red"} |
{ "dmiPlugin": "http://172.24.170.77:8783", "createdCmHandles": [ { "cmHandle": "Bookstore1", "publicCmHandleProperties": { "Contact": "newemailforstore@bookstore.com" } }, { "cmHandle": "Bookstore2", "publicCmHandleProperties": { "Contact": "newemailforstore2@bookstore.com" } }, { "cmHandle": "Bookstore3", "publicCmHandleProperties": { "color": "red" } }, { "cmHandle": "Bookstore4", "publicCmHandleProperties": { "color": "" } }, { "cmHandle": "Bookstore5", "publicCmHandleProperties": { "color": "won't match" } }, { "cmHandle": "Bookstore6", "publicCmHandleProperties": { "color": 12345 } }, { "cmHandle": "Bookstore7", "publicCmHandleProperties": { "color": "12345" } }, { "cmHandle": "Bookstore8", "publicCmHandleProperties": { "color": "red", "size": "large" } } ] } |
URL Used for all Requessts
http://localhost:8883/ncmp/v1/data/ch/searches
# | Scenario | Request | Response | Notes/Decisions |
---|---|---|---|---|
1 | Both properties match (Return CM Handles that Match) | { | [ | |
2 | Multiple Entries - both properties match (Return CM Handles that Match) | { | [ | |
3 | No properties given (Return All CM Handles which contain public properties) | { "publicCmHandleProperties": { | [ |
# | Scenario | Request | Response | Notes/Decisions | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
1 | Value doesn't match (Return Empty Response) | { | [ ] | ||||||||
2 | Unknown properties given (Return Empty Response) | { | [ ] | ||||||||
3 | Empty value (valid) (Return CM Handles Returned that Match) | { "publicCmHandleProperties": { | [ | ||||||||
4 | Empty property (invalid) (BAD_REQUEST) | { "publicCmHandleProperties": { | { | ||||||||
5 | Multiple entries with one empty property (invalid) (BAD_REQUEST) | { | { | ||||||||
6 | |||||||||||
7 | Apostrophe in cm handle (Exception) *** CPS can create a cm handle with a public property value that has an apostrophe but throws exception when queried *** | { | { | Will handle this as and when it arises | |||||||
8 | CPS stores Integers as Strings. | Given the public properties below
When stored in CPS Integers are stored as Strings.
Therefore the two requests below return both cm handles regardless of wanting Integer or String. { { | [ "Bookstore6", "Bookstore7" ] |
POST /ncmp/v1/data/ch/searches
{ "publicCmHandleProperties" : { "publicPropertyName-1" : "publicPropertyValue-1", "publicPropertyName-2" : "publicPropertyValue-2" }, "modules": [ { "moduleName": "", (Mandatory) "revision": "" (Optional) } ] } |
Modules in the example are to demonstrate future intentions but is out of scope for this user story.
CPS Swagger: http://localhost:8883/swagger-ui/index.html?configUrl=%2Fv3%2Fapi-docs%2Fswagger-config
https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
https://www.freeformatter.com/xpath-tester.html#ad-output
//public-properties[@name='Contact' and @value='xyz']/ancestor::cm-handles
org.onap.cps.spi.impl.CpsDataPersistenceQueryDataNodeSpec#Query for attribute by cps path of type ancestor with #scenario.