1
0
Fork 0

added "silent" attribute to HTTP documentation

This commit is contained in:
Jan Steemann 2016-10-26 10:46:14 +02:00
parent 27618a48a1
commit b450dfd0f1
4 changed files with 38 additions and 18 deletions

View File

@ -23,9 +23,14 @@ the recommended way is to specify the collection in the URL path.
Wait until document has been synced to disk.
@RESTQUERYPARAM{returnNew,boolean,optional}
Return additionally the complete new document under the attribute *new*
Additionally return the complete new document under the attribute *new*
in the result.
@RESTQUERYPARAM{silent,boolean,optional}
If set to *true*, an empty object will be returned as response. No meta-data
will be returned for the created document. This option can be used to
save some network traffic.
@RESTDESCRIPTION
Creates a new document from the document given in the body, unless there
is already a document with the *_key* given. If no *_key* is given, a new
@ -47,8 +52,8 @@ contains the path to the newly created document. The *ETag* header field
contains the revision of the document. Both are only set in the single
document case.
The body of the response contains a JSON object (single document case)
with the following attributes:
If *silent* is not set to *true*, the body of the response contains a
JSON object (single document case) with the following attributes:
- *_id* contains the document handle of the newly created document
- *_key* contains the document key

View File

@ -17,6 +17,11 @@ Wait until deletion operation has been synced to disk.
Return additionally the complete previous revision of the changed
document under the attribute *old* in the result.
@RESTQUERYPARAM{silent,boolean,optional}
If set to *true*, an empty object will be returned as response. No meta-data
will be returned for the removed document. This option can be used to
save some network traffic.
@RESTHEADERPARAMETERS
@RESTHEADERPARAM{If-Match,string,optional}
@ -24,11 +29,11 @@ You can conditionally remove a document based on a target revision id by
using the *if-match* HTTP header.
@RESTDESCRIPTION
The body of the response contains a JSON object with the information
about the handle and the revision. The attribute *_id* contains the
known *document-handle* of the removed document, *_key* contains the
key which uniquely identifies a document in a given collection, and
the attribute *_rev* contains the document revision.
If *silent* is not set to *true*, the body of the response contains a JSON
object with the information about the handle and the revision. The attribute
*_id* contains the known *document-handle* of the removed document, *_key*
contains the key which uniquely identifies a document in a given collection,
and the attribute *_rev* contains the document revision.
If the *waitForSync* parameter is not specified or set to *false*,
then the collection's default *waitForSync* behavior is applied.

View File

@ -32,6 +32,11 @@ document under the attribute *old* in the result.
Return additionally the complete new document under the attribute *new*
in the result.
@RESTQUERYPARAM{silent,boolean,optional}
If set to *true*, an empty object will be returned as response. No meta-data
will be returned for the replaced document. This option can be used to
save some network traffic.
@RESTHEADERPARAMETERS
@RESTHEADERPARAM{If-Match,string,optional}
@ -71,11 +76,11 @@ applied. The *waitForSync* query parameter cannot be used to disable
synchronization for collections that have a default *waitForSync* value
of *true*.
The body of the response contains a JSON object with the information
about the handle and the revision. The attribute *_id* contains the
known *document-handle* of the updated document, *_key* contains the
key which uniquely identifies a document in a given collection, and
the attribute *_rev* contains the new document revision.
If *silent* is not set to *true*, the body of the response contains a JSON
object with the information about the handle and the revision. The attribute
*_id* contains the known *document-handle* of the updated document, *_key*
contains the key which uniquely identifies a document in a given collection,
and the attribute *_rev* contains the new document revision.
If the query parameter *returnOld* is *true*, then
the complete previous revision of the document

View File

@ -46,6 +46,11 @@ document under the attribute *old* in the result.
Return additionally the complete new document under the attribute *new*
in the result.
@RESTQUERYPARAM{silent,boolean,optional}
If set to *true*, an empty object will be returned as response. No meta-data
will be returned for the updated document. This option can be used to
save some network traffic.
@RESTHEADERPARAMETERS
@RESTHEADERPARAM{If-Match,string,optional}
@ -91,11 +96,11 @@ applied. The *waitForSync* query parameter cannot be used to disable
synchronization for collections that have a default *waitForSync* value
of *true*.
The body of the response contains a JSON object with the information
about the handle and the revision. The attribute *_id* contains the
known *document-handle* of the updated document, *_key* contains the
key which uniquely identifies a document in a given collection, and
the attribute *_rev* contains the new document revision.
If *silent* is not set to *true*, the body of the response contains a JSON
object with the information about the handle and the revision. The attribute
*_id* contains the known *document-handle* of the updated document, *_key*
contains the key which uniquely identifies a document in a given collection,
and the attribute *_rev* contains the new document revision.
If the query parameter *returnOld* is *true*, then
the complete previous revision of the document