balanced / balanced-api

Balanced API specification.
220 stars 72 forks source link

Document the additional field for exceptions #635

Open mjallday opened 10 years ago

mjallday commented 10 years ago

Inspired by https://github.com/balanced/balanced-java/issues/78.

The spec has the additional field included but does not provide any additional information.

It's use is as a key/value map where the key is the field that has the issue and the value is a description of the issue. This is much easier to programmatically parse instead of finding the name of the field from the error message.

Let's document it and then officially support it in the client libraries.