...
| JSON Viewer |
|---|
|
{
"dmiPlugin": "my-dmi-plugin",
"dmiDataPlugin": "my-dmi-data-plugin",
"dmiModelPlugin": "my-dmi-model-plugin",
"createdCmHandles": [
{
"cmHandle": "my-cm-handle",
"cmHandleProperties": {
"additionalProp1": "my-property",
"additionalProp2": "my-property",
"additionalProp3": "my-property"
},
"publicCmHandleProperties": {
"additionalProp1": "my-property",
"additionalProp2": "my-property",
"additionalProp3": "my-property"
}
}
],
"updatedCmHandles": {
"cmHandle": "my-cm-handle",
"cmHandleProperties": {
"add-my-property": "add-property",
"update-my-property": "updated-property",
"delete-my-property": null
},
"publicCmHandleProperties": {
"add-my-property": "add-property",
"update-my-property": "updated-property",
"delete-my-property": null
}
},
"removedCmHandles": [
"[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]"
]
} |
Proposed Changes
| Scenario | Endpoint | Current Response Code | Proposed Response Code | Comments |
|---|
| Create CM Handle | POST /v1/ch | 201 (Created) |
200 OK | NO_CONTENT ) |
|
| Update CM Handle | POST /v1/ch | 201 (Created) |
200 ( OK ) | Remove CM Handle | 204 ( NO_CONTENT ) |
|
| Remove CM Handle | POST /v1/ch | 201 (Created) | 204 ( NO_CONTENT ) |
|
| Create ,Update or Remove CM Handle in the same request | POST /v1/ch | 201 (Created) |
200 OK
As we are using a common payload to handle the Create , Update and Remove operation hence there is a need to change the response code.streamline the response code in case of successful execution of the request.
For other scenarios , please refer to the page for the exceptions and response codes which will remain as is.
Code Change
| Code Block |
|---|
| language | java |
|---|
| title | NetworkCmProxyInventoryController |
|---|
| linenumbers | true |
|---|
|
@Override
public ResponseEntity<Void> updateDmiPluginRegistration(
final @Valid RestDmiPluginRegistration restDmiPluginRegistration) {
final DmiPluginRegistration dmiPluginRegistration = convertRestObjectToJavaApiObject(restDmiPluginRegistration);
networkCmProxyDataService.updateDmiRegistrationAndSyncModule(dmiPluginRegistration);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
} |
