You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by va...@apache.org on 2017/03/17 01:34:47 UTC
[couchdb-documentation] branch master updated: Flesh out the
documentation for POST /{db}/_all_docs
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
The following commit(s) were added to refs/heads/master by this push:
new 676251c Flesh out the documentation for POST /{db}/_all_docs
676251c is described below
commit 676251cb6ae1efa2910044420c494884f7f5f52a
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Thu Mar 16 10:22:28 2017 +0100
Flesh out the documentation for POST /{db}/_all_docs
---
src/api/database/bulk-api.rst | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/src/api/database/bulk-api.rst b/src/api/database/bulk-api.rst
index ddbc579..201d0e1 100644
--- a/src/api/database/bulk-api.rst
+++ b/src/api/database/bulk-api.rst
@@ -143,8 +143,14 @@
documents in a single request, in place of multiple :get:`/{db}/{docid}`
requests.
- The request body should contain a list of the keys to be returned as an
- array to a ``keys`` object. For example:
+ :param db: Database name
+ :<header Content-Type: :mimetype:`application/json`
+ :<json array keys: Return only documents that match the specified keys.
+ *Optional*
+ :>header Content-Type: - :mimetype:`application/json`
+ :code 200: Request completed successfully
+
+ **Request**:
.. code-block:: http
@@ -161,8 +167,7 @@
]
}
- The returned JSON is the all documents structure, but with only the
- selected keys in the output:
+ **Response**:
.. code-block:: javascript
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].