Skip to content

Review and fix documented error response codes #46

Description

@eric-murray

Problem description
Some of the documented error response codes are either invalid codes, or are valid codes that would not be returned by this API.

Invalid code - not defined by the Commonalities Design Guide:
422 UNIDENTIFIABLE_APPLICATION_PROFILE

Error response codes that do not appear to apply to this API:
400 OUT_OF_RANGE (for some endpoints)
403 INVALID_TOKEN_CONTEXT
404 IDENTIFIER_NOT_FOUND
404 NOT_FOUND (for some endpoints)
422 SERVICE_NOT_APPLICABLE

Expected behaviour
API specific error codes should be defined according to the Commonalities Design Guide. In this case, probably:
422 APPLICATION_ENDPOINT_REGISTRATION.UNIDENTIFIABLE_APPLICATION_PROFILE

But why is this not 404 NOT_FOUND? Please document.

Error response codes that cannot be returned should be removed from the API definition.

API specific conditions that trigger each documented error response should also be documented where these are not documented by Commonalities.

Alternative solution
None

Additional context
None

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions