Brian Wilkins created COUCHDB-3262:
--------------------------------------

             Summary: Document how the parameters of POST /{db}/_changes must 
be passed.
                 Key: COUCHDB-3262
                 URL: https://issues.apache.org/jira/browse/COUCHDB-3262
             Project: CouchDB
          Issue Type: Documentation
          Components: Documentation
            Reporter: Brian Wilkins


It is documented at
 http://docs.couchdb.org/en/stable/api/database/changes.html  
---  
 POST /{db}/_changes

    Requests the database changes feed in the same way as GET /{db}/_changes 
does, but is widely used with ?filter=_doc_ids query parameter and allows one 
to pass a larger list of document IDs to filter. 
---

That does not explain how the parameters must be passed.
Reading it one might assume that all parameters should be passed in the request 
body, but that is not in fact the case.
In fact, the doc_ids parameter and selector are taken from the request body, 
but all other parameters are taken from the URL.

So I propose that something like the following text should be appended to the 
above documentation to clarify:

"
To pass the doc_ids parameter or a selector, include them in the request body. 
All other parameters must be passed in the request URL.
"


I have also created
 https://issues.apache.org/jira/browse/COUCHDB-3260    
to request that for POST /{db}/_changes all parameters should be able to be 
passed in the request body.





--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to