Harmonization of HTTP response codes

[kmohr-soprasteria]

The response codes defined in the ApplicationPattern shall be copied into the openAPI specification and become part of the implementation.

Also:

• Where necessary the implementation would need to be changed (separate issue)
• in the previous release(s) there were no fixed prescriptions for the error messages to be returned by MWDI in specific error cases. This shall be done now.
• standard responseCodes should return the standard message (e.g. 429: too many parallel requests) instead of custom messages

[kmohr-soprasteria]

All of the responses from the "List of internally defined response codes" are added to the components section. However:

• not all response codes are relevant for the MWDI at all
• some may be relevant for specific services only, but not for all services

[kmohr-soprasteria]

additional error codes to be added:

• 471: similar to 470, but not for devices: "parent object/ressource missing" (for links or other future topology info)

• 533: a ressource is not found on the Controller (relevant for regard-device-object-creation/deletion; the Controller itself will return another responseCode)

• responseCode 429: not to be used in MWDI

• ressource paths:

  • cache:
  • 460, 470: not applicable here, because the device nameis part of the service path (path parameter) and ressources are also part of the path, hence if the device is not found, then it's a 404 instead (if other apps retrieve MWDI data using these paths, then in the apps that are served by the MWDI the 460 or 470 should be used)
  • no additional 5xx, as errors here are on client (MWDI) side, not from the controller (5xx) (theoretically, we would not even need the 500, but this is listed as default for all services)
  • live: 502, 530, 531, 532

• special case: link-port service (/core-model-1-4:network-control-domain=cache/link={uuid}/link-port={localId}):

  • what if the link (uuid) does not exist in the cache?
  • get/delete: just return 404, not found
  • put: the response should somehow indicate that the parent object (link) does not exist, so we cannot put the linkport. assign 471 (similar to 470, but links are not device data) -> also add to the responseCode list (https://github.com/openBackhaul/ApplicationPattern/blob/develop/doc/SpecifyingApplications/HowToDefineErrorMessages/HowToDefineErrorMessages.md); to keep it generic use a description like "parent object not existing" rather than explicitly stating that the link is not there (this might also be useful for future MWNI services)