Skip to content

common.yaml unnecessarily list ErrorInfo properties as required. #162

@gmuratk

Description

@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

Metadata

Metadata

Assignees

No one assigned

    Labels

    correctioncorrection in documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions