summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2016-12-09 12:13:21 +0100
committerMarcello Stanisci <marcello.stanisci@inria.fr>2016-12-09 12:13:21 +0100
commit0b26e16782eb414da8864d76ba925fccacae133d (patch)
treee70584396d20ba67dd0ee307a8d0d7caa80c5c16
parent3fba4892a5f4bdd032e86eabf13ce6ac04f1e649 (diff)
downloaddocs-0b26e16782eb414da8864d76ba925fccacae133d.tar.gz
docs-0b26e16782eb414da8864d76ba925fccacae133d.tar.bz2
docs-0b26e16782eb414da8864d76ba925fccacae133d.zip
'hint' among errors fields
-rw-r--r--api-common.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/api-common.rst b/api-common.rst
index d44e55e..b33284d 100644
--- a/api-common.rst
+++ b/api-common.rst
@@ -77,6 +77,9 @@ handle the error as if an internal error (500) had been returned.
// The other arguments are specific to the error value reported here.
error: string;
+ // Hint about error nature
+ hint?: string;
+
// Name of the parameter that was bogus (if applicable)
parameter?: string;