WIP: CPS-896: CMHandle Registration Response structure

CPS-896 - Getting issue details... STATUS

NCMP CMhandle registration endpoint receives multiple operations to create, update or delete cm-handles in a single request. As there are multiple operations, the endpoint response structure should be able to provide the status of all operations separately with consistent error-code to allow users to retrigger failed operations programmatically if possible.

Questions:

Response Structure

HttpStatus

Response Body

The response body should give enough information for each failed operation to retry them programmatically. For each failed operation we should send the below information 

The response body can be formed in three ways

Group by operation type 

The interface is generic and if we need to send the status of all operations in the future it can be achieved without any breaking change.

{
    "createdCmHandles": [ 
		{
 			"cmHandle": "cmHandle-1",
    		"status": "FAILURE", // Extra field to indicate the status
    		"error-code": "01",
			"error-text" : "cmhandle already exist"
		}
	],
	"updatedCmHandles": [ 
		{
 			"cmHandle": "cmHandle-2",
    		"status": "FAILURE" ,
    		"error-code": "02" ,
			"error-text" : "cmhandle does not exist" 
		}
	],
 	"faileddeletedCmHandles": [ 
		{
 			"cmHandle": "cmHandle-3",
    		"status": "FAILURE" ,
    		"error-code": "02" ,
			"error-text" : "cmhandle does not exist"
		}
	]
}

Group by operation type but only for failed operations

This approach meets the current requirement and has a smaller payload size (no extra field for the status).

{
    "failedCreatedCmHandles": [ 
		{
 			"cmHandle": "cmHandle-1",
    		"error-code": "01",
			"error-text" : "cmhandle already exist"
		}
	],
	"failedUpdatedCmHandles": [ 
		{
 			"cmHandle": "cmHandle-2",
    		"error-code": "02" ,
			"error-text" : "cmhandle does not exist" 
		}
	],
 	"deletedCmHandles": [ 
		{
 			"cmHandle": "cmHandle-3",
    		"error-code": "02" ,
			"error-text" : "cmhandle does not exist"
		}
	]
}

Error handling

Input Issues

1. Multiple operations for a single cm-handle. 
2. Input is not in the correct format: For example, if the user has not defined the "cm-handle"

Create CMHandles

1. cm-handle already exist
2. unknown-error

Update CMHandles

1. cm-handle does not exist
2. unknown-error

Remove CMHandles

1. cm-handle does not exist: No error 
2. unknown-error

Should we indicate  if something can be fixed with retry ?

Notes
^* remove will ignore non-existing cm handles (not an error, assume already deleted)
** suggested future error (for illustration purposes)