You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »


CPS-731 - Getting issue details... STATUS

Scope

It should be able to query all cm handles with a given set of public cm handle properties.

Requirements

  • We want all cm-Handles where both things are true.
  • Those properties also need to exist.
  • If query body does not follow supported structure return 400.
  • Empty query will return all cm-Handles.

A/C:

  1. Demo - with "and" behavior
  2. CI Test - two attributes


Issues/Decisions


IssueNotesDecision
1Does request body need to declare "publicCmHandleProperties"?

Do we need to explcitly declare "publicCmHandleProperties"? 

Will there be another possible variation to this in the future?

{
  "publicCmHandleProperties" : {
          "Name-1" : "some-value",
          "Name-2" : "other-value"
   }
}
Not another variation but there will be "modules" included in future implementations.
2Do we need to consider if cm handle exists?

3Are public properties always be in the format of "name" : x, "value": y?

In the fragment table there are example that follow this format 

{
	"name": "Contact",
	"value": "newemailforstore@bookstore.com"
}

Yes.


4Will there only ever be 2 kv pairs in public properties?
Yes
5Does the order matter?

Does

{
  "publicCmHandleProperties" : {
          "Name-1" : "some-value",
          "Name-2" : "other-value"
   }
}

==

{
  "publicCmHandleProperties" : {
          "Name-2" : "other-value",
          "Name-1" : "some-value"
   }
}
No, they are independent but they however will need to in this order in the database.
6Should search be case sensitive?


Analysis/Implementation Proposal

High level Jiras:

  1. CPS-901 - Getting issue details... STATUS
  2. CPS-902 - Getting issue details... STATUS
  3. CPS-903 - Getting issue details... STATUS
  4. CPS-904 - Getting issue details... STATUS


Possible High-Level Implementation Steps:

  1. Match all xpaths that contain "public"  in fragment table

    SELECT xpath, attributes #>> '{}' 
FROM fragment 
WHERE fragment.xpath LIKE '%public%';

  2. Iterate over the list and retrieve all attributes

  3. Iterate over the attributes and collect those instances that match
  4. Return collected list of cm handles

Interface Proposal

#URIDesign NotesComment(s)
1POST /ncmp/v1/data/ch/searches

Scenario :  Request received to return all cm handles matching properties given
Method   : POST
URI          : {ncmpRoot}/ncmp/v1/data/ch/searches 
Header    : Content-Type: application/json

Request Body

{
  "publicCmHandleProperties" : {
          "Name-1" : "some-value",
          "Name-2" : "other-value"
   }
}


Response Body

[
	"cmHandle1",
	"cmHandle2",
	...,
	"cmHandleN"
]

Below is a sample yaml for OpenAPI.

Sample OpenAPI yAML 
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'

Public Properties are stored in the fragment table in CPS as seen below:

PoC Gerrit Review

A PoC has been coded and can be found here: https://gerrit.onap.org/r/c/cps/+/127541

Future Example (Out-of-scope)


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.

References


CPS Swagger: http://localhost:8883/swagger-ui/index.html?configUrl=%2Fv3%2Fapi-docs%2Fswagger-config


  • No labels