search

apigovau / national-api-design-standards

Australian National API Design Standards
35 stars 15 forks source link

error-handling extensibility #54

Closed TimGoodwill closed 3 years ago

TimGoodwill commented 4 years ago

Minor edit to explicitly allow the extension of the error response structure with additional optional fields pertinent to the business use-case.

A substantially similar error structure is used in the federal domain, however ‘extended’ to include additional data such as ‘helpUrl’ (more information on the error). A base schema across gov would be useful, however allowing extensions to the schema allows a degree of tailoring to the needs of a specific environment.

ghost commented 3 years ago

Approved for merge into v1.1.0 release.