Skip to content

Review documented error response codes #72

Description

@eric-murray

Problem description
The API OAS definition documents error codes that either would never be returned, or should not be documented as they have no API-specific meaning.

For example:
400 OUT_OF_RANGE
403 INVALID_TOKEN_CONTEXT
404 IDENTIFIER_NOT_FOUND
500 INTERNAL
503 UNAVAILABLE

Expected action

  • Review the Commonalities Design Guide section on Standardized Use of CAMARA Error Responses
    • In particular, note:

      Error statuses 405, 406, 410, 412, 415, and 5xx: These error statuses are not documented by default in the API specification. However, they SHOULD be included if there is a relevant use case that justifies their documentation.

  • Remove error response codes that are not relevant to this API, or that do not need to be documented as they do not have any special meaning for this API

Additional context
None

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions