[Groonga-commit] droonga/droonga.org at 2a5c51a [gh-pages] Add notes about response statuses of Groonga compatible commands

Back to archive index

YUKI Hiroshi null+****@clear*****
Wed Dec 25 18:47:55 JST 2013


YUKI Hiroshi	2013-12-25 18:47:55 +0900 (Wed, 25 Dec 2013)

  New Revision: 2a5c51ad576699ceb21ab02d7ac759ab4d57be2f
  https://github.com/droonga/droonga.org/commit/2a5c51ad576699ceb21ab02d7ac759ab4d57be2f

  Message:
    Add notes about response statuses of Groonga compatible commands

  Modified files:
    reference/commands/add/index.md
    reference/commands/column-create/index.md
    reference/commands/select/index.md
    reference/commands/table-create/index.md

  Modified: reference/commands/add/index.md (+1 -1)
===================================================================
--- reference/commands/add/index.md    2013-12-25 18:47:34 +0900 (b768dd1)
+++ reference/commands/add/index.md    2013-12-25 18:47:55 +0900 (742fe5d)
@@ -195,7 +195,7 @@ Value of unspecified columns will not be changed.
 
 ## Responses {#response}
 
-This returns an array including a boolean value which means the operation was successfully done or not.
+This returns an array including a boolean value which means the operation was successfully done or not, as the `body`.
 
  * `[true]`:The record was successfully added or updated.
  * `[false]`:Failed to add or update a record.

  Modified: reference/commands/column-create/index.md (+4 -2)
===================================================================
--- reference/commands/column-create/index.md    2013-12-25 18:47:34 +0900 (ab47811)
+++ reference/commands/column-create/index.md    2013-12-25 18:47:55 +0900 (0a8a8e7)
@@ -39,7 +39,7 @@ They are compatible to [the parameters of the `column_create` command of the Gro
 
 ## Resposnes {#response}
 
-This returns an array meaning the result of the operation.
+This returns an array meaning the result of the operation, as the `body`.
 
     [
       [
@@ -50,7 +50,9 @@ This returns an array meaning the result of the operation.
       <Column is successfully created or not>
     ]
 
-Details:
+This command always returns a response with `200` as its `statusCode`, because this is a Groonga compatible command and errors of this command must be handled in the way same to Groonga's one.
+
+Response body's details:
 
 Status code
 : An integer meaning the operation's result. Possible values are:

  Modified: reference/commands/select/index.md (+1 -0)
===================================================================
--- reference/commands/select/index.md    2013-12-25 18:47:34 +0900 (f3185be)
+++ reference/commands/select/index.md    2013-12-25 18:47:55 +0900 (1f7a722)
@@ -69,3 +69,4 @@ This returns an array including search results.
 
 The structure of the returned array is compatible to [the returned value of the Groonga's `select` command](http://groonga.org/docs/reference/commands/select.html#id6). See the linked document for more details.
 
+This command always returns a response with `200` as its `statusCode`, because this is a Groonga compatible command and errors of this command must be handled in the way same to Groonga's one.

  Modified: reference/commands/table-create/index.md (+4 -2)
===================================================================
--- reference/commands/table-create/index.md    2013-12-25 18:47:34 +0900 (e7eb406)
+++ reference/commands/table-create/index.md    2013-12-25 18:47:55 +0900 (d676850)
@@ -40,7 +40,7 @@ They are compatible to [the parameters of the `table_create` command of the Groo
 
 ## Responses {#response}
 
-This returns an array meaning the result of the operation.
+This returns an array meaning the result of the operation, as the `body`.
 
     [
       [
@@ -51,7 +51,9 @@ This returns an array meaning the result of the operation.
       <Table is successfully created or not>
     ]
 
-Details:
+This command always returns a response with `200` as its `statusCode`, because this is a Groonga compatible command and errors of this command must be handled in the way same to Groonga's one.
+
+Response body's details:
 
 Status code
 : An integer which means the operation's result. Possible values are:
-------------- next part --------------
HTML����������������������������...
Descargar 



More information about the Groonga-commit mailing list
Back to archive index