You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ga...@apache.org on 2019/12/05 12:55:20 UTC

[couchdb-documentation] branch master updated: Update POST for view (#459)

This is an automated email from the ASF dual-hosted git repository.

garren 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 f9bb181  Update POST for view (#459)
f9bb181 is described below

commit f9bb181a8d11dfa58e6e13bc1fefc379a0f10cd1
Author: Bessenyei Balázs Donát <be...@users.noreply.github.com>
AuthorDate: Thu Dec 5 13:55:11 2019 +0100

    Update POST for view (#459)
    
    * Update POST for view
    
    In https://github.com/apache/couchdb/pull/2338 the way POST view works is altered so that the same functionality is available as in GET view.
    
    This commit updates the POST view documentation to reflect this new behavior.
    
    
    Co-Authored-By: Jonathan Hall <fl...@flimzy.com>
---
 src/api/ddoc/views.rst | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/src/api/ddoc/views.rst b/src/api/ddoc/views.rst
index e069551..9520f5a 100644
--- a/src/api/ddoc/views.rst
+++ b/src/api/ddoc/views.rst
@@ -157,14 +157,13 @@
     transfer size for attachments.
 
 .. http:post:: /{db}/_design/{ddoc}/_view/{view}
-    :synopsis: Returns certain rows for the specified stored view
+    :synopsis: Returns results for the specified view
 
     Executes the specified view function from the specified design document.
-    Unlike :get:`/{db}/_design/{ddoc}/_view/{view}` for accessing views, the
-    :method:`POST` method supports the specification
-    of explicit keys to be retrieved from the view results. The remainder of
-    the :method:`POST` view functionality is identical to the
-    :get:`/{db}/_design/{ddoc}/_view/{view}` API.
+    :method:`POST` view functionality supports identical parameters and behavior
+    as specified in the :get:`/{db}/_design/{ddoc}/_view/{view}` API but allows for the
+    query string parameters to be supplied as keys in a JSON object in the body
+    of the `POST` request.
 
     **Request**: