]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
docs/api: change POST to PATCH in REST API parameters example
authorAndrew Donnellan <andrew.donnellan@au1.ibm.com>
Thu, 25 May 2017 08:05:10 +0000 (18:05 +1000)
committerStephen Finucane <stephen@that.guru>
Fri, 26 May 2017 10:16:08 +0000 (11:16 +0100)
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@au1.ibm.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
docs/api/rest.rst

index 17509134eabcd37b9f336b814f73b49fab6e7d25..8c8fd9594199e402bafc3f9efc72be4d5e119ab9 100644 (file)
@@ -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