common.yaml unnecessarily list ErrorInfo properties as required.

[gmuratk]

Problem description

Assuming the language in API Design Guidelines is normative, CAMARA_common.yaml ErrorInfo format is incorrectly/unnencessarily requiring all the properties of ErrorInfo schema.

ErrorInfo:
   type: object
   required:
    - message
    - status
    - code
   properties:
    message:
     type: string
     description: A human readable description of what the event represent
    status:
     type: integer
     description: HTTP response status code
    code:
     type: string
     description: Friendly Code to describe the error

Expected behavior

Per DG, no field should be listed as required.

Alternative solution

Explicitly state which fields, if any, are required in Design Guideline and update, as necessary, the CAMARA_common.yaml to match definition.

Additional context

[PedroDiez]

Hi all,

@gmuratk I think (at least per my understanding) that "status quo" regarding ErrorInfo is that the 3 properties are required. That is the agreement/consensus and what it has been applied in every WG.

Let's see any case from other Operators.

In this context, what it would be needed to avoid any ambiguity is just to reflect this in the DG, https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#6-error-responses

to indicate the 3 are required/mandatory

[gmuratk]

@PedroDiez as discussed in the meeting, it makes sense to have the DG to be normative reference and have the required designations for these fields. While I'm still not sure why the 'message' field should be required, it may be good for DG to provide insights to the reasons or how it is intended to be used.