Document the current behavior POST /{db}/_design/{ddoc}/_update/{func}/{docid}

[ecerulm]

Summary

The current documentation for 1.5.14. /{db}/_design/{ddoc}/_update/{func}/{docid} only mentions PUT method although POST also works

curl -v -n --json 'love'  http:https://couchdb.localhost:5984/hello-world/_design/recipe/_update/ingredients/SpaghettiWithMeatballs       
...
> POST /hello-world/_design/recipe/_update/ingredients/SpaghettiWithMeatballs HTTP/1.1
> Host: couchdb.localhost:5984
...
< HTTP/1.1 201 Created
...
< 
{"status":"ok"}

PUT is probably the preferred way, but I guess that POST should be also documented and probably deprecated too as @nickva mentioned in #4628 (comment).

Desired Behaviour

Document POST /{db}/_design/{ddoc}/_update/{func}/{docid} with a deprecation note for next version.

Possible Solution

Additional context

This is just confusing for people like me that are new to CouchDB and like to go to the documentation as primary source.

If you see a code example somewhere in the internet using POST Document POST /{db}/_design/{ddoc}/_update/{func}/{docid}` and you go to the documentation to try to understand what is the purpose of that API call, you wouldn't find it. You would need to guess that probably POST and PUT do the same thing in this case.

Related

• Fix typo POST -> PUT #4628