ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Review Register error code documentation #665

Open nils-work opened 2 months ago

nils-work commented 2 months ago

Description

As noted in the Future improvements section, the Register error responses are currently inconsistent with the errors defined for other endpoints.

The changes may only require documentation updates, but the specification may need to be reviewed against the implementation to clarify whether the changes would cause a breaking change.

Intention and Value of Change

To provide accurate and consistent error handling documentation.

Area Affected

Error responses for endpoints in the Register APIs section.

Change Proposed

Resolve the details in the Future improvements section.

The Register endpoints should be changed from the generic error details - image

to the format of other endpoints, for example - image