Allow all params to be passed via body for POST _all_docs #2343
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bessbd
pushed a commit
to bessbd/couchdb-documentation
that referenced
this pull request
Dec 6, 2019
In apache/couchdb#2343 the way POST _all_docs works is altered so that the same functionality is available as in GET _all_docs. This commit updates the POST _all_docs documentation to reflect this new behavior.
3 tasks
Member
Author
|
Link to the doc PR: apache/couchdb-documentation#462 |
davisp
requested changes
Dec 6, 2019
Member
davisp
left a comment
davisp
left a comment
There was a problem hiding this comment.
Nice work! Turned out quite a bit simpler than I expected but that parse_body_and_params is reused to good effect.
Couple minor changes to clear up before merging.
src/chttpd/src/chttpd_show.erl
Outdated
| {ok, VDoc} = ddoc_cache:open(DbName, <<"_design/", ViewDesignName/binary>>), | ||
| CB = fun list_cb/2, | ||
| QueryArgs = couch_mrview_http:parse_params(Req, Keys), | ||
| Args = couch_mrview_http:parse_body_and_query(Req, Keys), |
Member
There was a problem hiding this comment.
I'd not change the variable name here which will shorten the diff. I assume that was done because its now more than the query string. Though we refer to view reads as queries in multiple places so there's no harm leaving it as QueryArgs.
| parse_body_and_query(Req, Props, Keys); | ||
|
|
||
| parse_body_and_query(Req, Keys) -> | ||
| parse_params(chttpd:qs(Req), Keys, #mrargs{keys=Keys, group=undefined, group_level=undefined}, [keep_group_level]). |
Member
There was a problem hiding this comment.
Project style is to wrap lines at 80 columns.
Member
Author
|
Thank you for the review @davisp ! I'll push commits for the changes you've requested soon. |
Member
|
Go ahead and squash those fixup commits and then we'll wait for CI to come back. |
This change should allow users to supply all params in POST that can be supplied for GET now. This way we could avoid the ?key="foo" things that would probably cause a lot of pain for users.
As /{db}/_design_docs and /{db}/_local_docs are analogous to _all_docs, this change applies to all three of them.
bessbd
force-pushed
the
all-docs-post-all-params
branch
from
b025b2c to
7ae4a2f
Compare
garrensmith
pushed a commit
to apache/couchdb-documentation
that referenced
this pull request
Dec 9, 2019
Update POST for _all_docs In apache/couchdb#2343 the way POST _all_docs works is altered so that the same functionality is available as in GET _all_docs. This commit updates the POST _all_docs documentation to reflect this new behavior. Co-Authored-By: Jonathan Hall <flimzy@flimzy.com>
nickva
pushed a commit
to nickva/couchdb
that referenced
this pull request
Sep 7, 2022
Update POST for _all_docs In apache#2343 the way POST _all_docs works is altered so that the same functionality is available as in GET _all_docs. This commit updates the POST _all_docs documentation to reflect this new behavior. Co-Authored-By: Jonathan Hall <flimzy@flimzy.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This change should allow users to supply all params in POST that can be supplied for GET now. This way we could avoid the ?key="foo" things that would probably cause a lot of pain for users.
As
/{db}/_design_docsand/{db}/_local_docsare analogous to_all_docs, this change applies to all three of them.Testing recommendations
Just run the tests included with this PR.
Let me know if you need instructions for manual testing.
Related Issues or Pull Requests
apache/couchdb-documentation#462
Checklist
rel/overlay/etc/default.ini