[PATCH] docs/api: change POST to PATCH in REST API parameters example

Andrew Donnellan andrew.donnellan at au1.ibm.com
Thu May 25 18:05:10 AEST 2017


api/rest.rst gives an example of how to POST parameters to the PatchDetail
view at api/patches/<patch_id>. However, the endpoint in question doesn't
support POST - you need to use PUT or PATCH. Change it to PATCH.

Signed-off-by: Andrew Donnellan <andrew.donnellan at au1.ibm.com>

---

I have no idea whether it's *meant* to support POST...
---
 docs/api/rest.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/api/rest.rst b/docs/api/rest.rst
index 1750913..8c8fd95 100644
--- a/docs/api/rest.rst
+++ b/docs/api/rest.rst
@@ -155,7 +155,7 @@ parameters should be passed as form-encoded data:
 
 .. code-block:: shell
 
-    $ curl -X POST -F 'state=under-review' \
+    $ curl -X PATCH -F 'state=under-review' \
       'https://patchwork.example.com/api/patches/123'
 
 Authentication
-- 
Andrew Donnellan              OzLabs, ADL Canberra
andrew.donnellan at au1.ibm.com  IBM Australia Limited



More information about the Patchwork mailing list