@@ -72,41 +72,41 @@ A list of the available methods and URL paths are provided below:
7272 - :mimetype: `text/plain `
7373 :query boolean conflicts: Includes `conflicts ` information in response.
7474 Ignored if `include_docs ` isn't ``true ``. Default is ``false ``.
75- :query boolean descending: Return the design documents in descending by
75+ :query boolean descending: Return the local documents in descending by
7676 key order. Default is ``false ``.
7777 :query string endkey: Stop returning records when the specified key is
7878 reached. *Optional *.
7979 :query string end_key: Alias for `endkey ` param.
8080 :query string endkey_docid: Stop returning records when the specified
81- design document ID is reached. *Optional *.
81+ local document ID is reached. *Optional *.
8282 :query string end_key_doc_id: Alias for `endkey_docid ` param.
83- :query boolean include_docs: Include the full content of the design
83+ :query boolean include_docs: Include the full content of the local
8484 documents in the return. Default is ``false ``.
8585 :query boolean inclusive_end: Specifies whether the specified end key
8686 should be included in the result. Default is ``true ``.
87- :query string key: Return only design documents that match the specified
87+ :query string key: Return only local documents that match the specified
8888 key. *Optional *.
89- :query string keys: Return only design documents that match the specified
89+ :query string keys: Return only local documents that match the specified
9090 keys. *Optional *.
91- :query number limit: Limit the number of the returned design documents to
91+ :query number limit: Limit the number of the returned local documents to
9292 the specified number. *Optional *.
9393 :query number skip: Skip this number of records before starting to return
9494 the results. Default is ``0 ``.
9595 :query string startkey: Return records starting with the specified key.
9696 *Optional *.
9797 :query string start_key: Alias for `startkey ` param.
9898 :query string startkey_docid: Return records starting with the specified
99- design document ID. *Optional *.
99+ local document ID. *Optional *.
100100 :query string start_key_doc_id: Alias for `startkey_docid ` param.
101101 :query boolean update_seq: Response includes an ``update_seq `` value
102102 indicating which sequence id of the underlying database the view
103103 reflects. Default is ``false ``.
104104 :>header Content-Type: - :mimetype: `application/json `
105105 - :mimetype: `text/plain; charset=utf-8 `
106- :>json number offset: Offset where the design document list started
106+ :>json number offset: Offset where the local document list started
107107 :>json array rows: Array of view row objects. By default the information
108- returned contains only the design document ID and revision.
109- :>json number total_rows: Number of design documents in the database. Note
108+ returned contains only the local document ID and revision.
109+ :>json number total_rows: Number of local documents in the database. Note
110110 that this is not the number of rows returned in the actual query.
111111 :>json number update_seq: Current update sequence for the database
112112 :code 200: Request completed successfully
@@ -173,16 +173,14 @@ A list of the available methods and URL paths are provided below:
173173 }
174174
175175 .. http :post :: /{db}/_local_docs
176- :synopsis: Returns certain rows from the built-in view of all local
177- documents
176+ :synopsis: Returns a built-in view of all local (non-replicating) documents
177+ in this database
178178
179- The ``POST `` to ``_local_docs `` allows to specify multiple keys to be
180- selected from the database. This enables you to request multiple
181- local documents in a single request, in place of multiple
182- :get: `/{db}/_local/{docid} ` requests.
179+ :method: `POST ` `_design_docs ` functionality supports identical parameters and behavior
180+ as specified in the :get: `/{db}/_design_docs ` API but allows for the query string parameters
181+ to be supplied as keys in a JSON object in the body of the `POST ` request.
183182
184- The request body should contain a list of the keys to be returned as an
185- array to a ``keys `` object. For example:
183+ **Request **:
186184
187185 .. code-block :: http
188186
0 commit comments