apigovau / national-api-design-standards

Australian National API Design Standards
35 stars 15 forks source link

Error Handling - Allow stakeholders to extend the error schema #41

Open TimGoodwill opened 4 years ago

TimGoodwill commented 4 years ago

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. A minor edit is suggested to allow stakeholders to extend the error schema as required.

Suggested addition: The error schema may be extended as required to meet specific business or enterprise requirements.