You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
rartych
changed the title
common.yaml unnecessily list ErrorInfo properties as required.
common.yaml unnencessarily list ErrorInfo properties as required.
Mar 11, 2024
hdamker
changed the title
common.yaml unnencessarily list ErrorInfo properties as required.
common.yaml unnecessarily list ErrorInfo properties as required.
Mar 11, 2024
@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.
@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.
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.
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
The text was updated successfully, but these errors were encountered: