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

Error Response Structure - Does it contain "description" or "detail"? #392

Closed deboraelkin2 closed 3 years ago

deboraelkin2 commented 3 years ago

Description

In v1.10 of the standards the error response structure has been changed. The Error Codes section specifies that the Error response structure should contain:

detail field MUST be present: holds a human readable description of this specific error

However all examples provided include a "description" field instead

Area Affected

Error Codes

Change Proposed

Please clarify whether the field should be named "detail" or "description" and modify Error Response Structure section or examples, accordingly.

CDR-API-Stream commented 3 years ago

Thank you @deboraelkin2, the field is detail. The documentation will be fixed to refer to the detail field so it is not ambiguous in meaning.

CDR-API-Stream commented 3 years ago

The fix to correct the documentation has been made and is available for review here: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.11.0...maintenance/392

CDR-API-Stream commented 3 years ago

The outcome of this issue has been approved by the Data Standards Chair and is included in v1.11.0. A change to the data standards was recommended.

This issue will be closed accordingly.