Versions Compared

Old Version 4

changes.mady.by.user Joseph Keenan

Saved on

compared with

New Version 5

changes.mady.by.user Joseph Keenan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#IssueNotesDecision
1



Analysis

...

High level steps:

  • Update openapi specification for new endpoint
  • Update Controller for new endpoint
  • Add new SQL query to return data
    • If no data found return all cm handles 
    • else return data
  • Implement 400 if request does not follow structure


Below is the implementation proposal for this story.

...

#URIDesign NotesComment
1POST /ncmp/v1/data/ch/searches

Sample Request Payload:

Code Block
languageyml
{
  "publicCmHandleProperties" : {
          "Name-1" : "some-value",
          "Name-2" : "other-value"
   }
}
_____________________________________________________________________
Scenario :
Method : POST
URI :

Scenario :  Request received to return all cmhandles matching properties given
Method   : POST
URI          : {ncmpRoot}/ncmp/v1/data/ch/searches 


Header

:

    : Content-Type:

application/json

Request Body

Code Block
languageyml
{
  "publicCmHandleProperties" : {           
        "module1": "revision1",
		"module2": "revision2"    }
}


Response Body

Code Block
languageyml
[{
		"cmHandle": "cmHandle001",
		"cmHandleProperties": {
			"module1": "revision1",
			"module2": "revision2"
		}
	},
	{
		"cmHandle": "cmHandle002",
		"cmHandleProperties": {
			"module1": "revision1",
			"module2": "revision2"
		}
	}
]



...