diff options
| author | Andrew Donnellan <andrew.donnellan@au1.ibm.com> | 2017-05-25 18:05:10 +1000 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2017-05-26 11:16:08 +0100 |
| commit | 105f79041a08f1c557b364b07518b4b2a683909a (patch) | |
| tree | f0652d1ee9d421f554c0f4ffb45d3a9d79f8e611 /docs/api | |
| parent | 3285634ab37eb1f1f6dd95e671281ad7c6beca54 (diff) | |
| download | patchwork-105f79041a08f1c557b364b07518b4b2a683909a.tar patchwork-105f79041a08f1c557b364b07518b4b2a683909a.tar.gz | |
docs/api: change POST to PATCH in REST API parameters example
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>
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/rest.rst | 2 |
1 files changed, 1 insertions, 1 deletions
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 |