You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi.
I was unsure if I should add this query under issue “Error Handling - Allow stakeholders to extend the error schema #41” – that issue seems to be in the process of being accepted?
I’m working in the ATO on a project that will be provisioning many APIs over the next couple of years. These APIs will be returning various errors, however we also have scenarios where some of our APIs would be returning responses that are actually informational or warning in nature.
The current Error handling standard https://api.gov.au/standards/national_api_standards/error-handling.html
talks explicitly about ‘error objects’ being returned as a collection – and the sample shows this under an ‘errors’ collection name -- "errors": [{ etc.
With a requirement to return error, informational and/or warning objects, was the expected outcome to just return these objects under the ‘errors’ collection? I’m not sure if there was any thought on perhaps using a more generic label for this error collection? EG: messages.
Or would we just be returning these response objects under the errors collection?
Any advice would be greatly appreciated.
For completeness, we are also looking to include for each ‘error object’ a Severity attribute – or perhaps messageType - with expected values equating to error, informational, warning to support consumers determining, well, the severity of the message. This is where issue #41 comes into play.
Thank you.
Kelly.
The text was updated successfully, but these errors were encountered:
TimGoodwill
added a commit
to TimGoodwill/national-api-design-standards
that referenced
this issue
May 17, 2021
Hi.
I was unsure if I should add this query under issue “Error Handling - Allow stakeholders to extend the error schema #41” – that issue seems to be in the process of being accepted?
I’m working in the ATO on a project that will be provisioning many APIs over the next couple of years. These APIs will be returning various errors, however we also have scenarios where some of our APIs would be returning responses that are actually informational or warning in nature.
The current Error handling standard https://api.gov.au/standards/national_api_standards/error-handling.html
talks explicitly about ‘error objects’ being returned as a collection – and the sample shows this under an ‘errors’ collection name -- "errors": [{ etc.
With a requirement to return error, informational and/or warning objects, was the expected outcome to just return these objects under the ‘errors’ collection? I’m not sure if there was any thought on perhaps using a more generic label for this error collection? EG: messages.
Or would we just be returning these response objects under the errors collection?
Any advice would be greatly appreciated.
For completeness, we are also looking to include for each ‘error object’ a Severity attribute – or perhaps messageType - with expected values equating to error, informational, warning to support consumers determining, well, the severity of the message. This is where issue #41 comes into play.
Thank you.
Kelly.
The text was updated successfully, but these errors were encountered: