Page History

...

Issue

Notes

Decision

1

Does request body need to declare "publicCmHandleProperties"?

Do we need to explcitly declare "publicCmHandleProperties"?

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

Code Block

language	yml

{
    "publicCmHandleProperties" : {           

           "module1Name-1" : "revision1some-value",
		"module2"          "Name-2" : "revision2other-value"
     }
}

Not another variation but there will be "modules" included in future implementations.

2

Do we need to consider if cm handle exists?

3

Analysis/Implementation Proposal

...

High level steps:

Update openapi specification for new endpoint
Update Controller for new endpoint
Add new SQL query to return data
1. If no data found return all cm handles
2. else return data
Implement 400 if request does not follow structure
Create CSIT test with two attributes
Demo functionality

...

Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-901
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-902
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-903
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-904

Interface Proposal

#

URI

SQL Query

Design Notes

Comment

1

POST /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

Code Block

language	yml

{
    "publicCmHandleProperties" : {  
         
        "module1""Name-1" : "revision1some-value",
		"module2"          "Name-2" : "revision2other-value"
     }
}

Response Body

Code Block

language	yml

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

...

Code Block

language	yml
title	Sample OpenAPI yAML
collapse	true

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:

Image Added

Code Block

language	sql
title	Sample SQL Query

<TBD>

Future Example (Out-of-scope)

...

Space shortcuts

Page tree

Versions Compared

Old Version 10

New Version 11

Key

Analysis/Implementation Proposal

Interface Proposal

Future Example (Out-of-scope)