YUKI Hiroshi
null+****@clear*****
Thu Dec 26 18:07:10 JST 2013
YUKI Hiroshi 2013-12-26 18:07:10 +0900 (Thu, 26 Dec 2013) New Revision: dacc968bbc94e40c4fe6d5e249640f8415a066eb https://github.com/droonga/droonga.org/commit/dacc968bbc94e40c4fe6d5e249640f8415a066eb Message: Put error types under error body section Modified files: reference/message/index.md Modified: reference/message/index.md (+14 -12) =================================================================== --- reference/message/index.md 2013-12-26 17:59:45 +0900 (582f4a0) +++ reference/message/index.md 2013-12-26 18:07:10 +0900 (ce35d59) @@ -139,9 +139,21 @@ Status codes of error responses are similar to HTTP's one. Possible values: `500` and other `5xx` statuses : An internal error of the Droonga Engine. -### Error types {#error-type} +### Body of error responses {#error-body} + +The basic format of the body of an error response is like following: + + { + "name" : "<Type of the error>", + "message" : "<Human readable details of the error>", + "detail" : <Other extra information for the error, in various formats> + } + +If there is no detail, `detial` can be missing. + +#### Error types {#error-type} -There are some error types for any command. +There are some general error types for any command. `MissingDatasetParameter` : Means you've forgotten to specify the `dataset`. The status code is `400`. @@ -151,13 +163,3 @@ There are some error types for any command. `UnknownCommand` : Means there is no adapter or handler for the command given as the `type`. The status code is `400`. - -### Body of error responses {#error-body} - -The basic format of the body of an error response is like following: - - { - "name" : "<Type of the error>", - "message" : "<Human readable details of the error>", - "detail" : <Other extra information for the error, in various formats> - } -------------- next part -------------- HTML����������������������������...Download