Skip to content

API standard success & error responses

Christopher Schinnerl requested to merge vw-api-standard-responses into master

Created by: VoidingWarranties

This PR changes the standard success & error responses as described in #1243 (closed).

The APIError type is meant to provide descriptive, useful errors to API clients. Simply returning an error string is often not useful. An error string is the minimum, but other information such as which parameter caused the request to fail should also be included. Only the message field has been implemented in this commit as the other fields are non-trivial to implement. Additional fields can be added to APIError type in the future without breaking compatibility.

Merge request reports