diff doc/rest.txt @ 5674:6dc4dba1c225

REST: Use If-Match header for incoming requests
author Ralf Schlatterbeck <rsc@runtux.com>
date Mon, 25 Mar 2019 21:23:52 +0100
parents a884698173ea
children 1fa59181ce58
line wrap: on
line diff
--- a/doc/rest.txt	Mon Mar 25 19:47:29 2019 +0100
+++ b/doc/rest.txt	Mon Mar 25 21:23:52 2019 +0100
@@ -133,6 +133,11 @@
 On success the returned value is the same as the respective ``GET``
 method.
 
+Note that the ``GET`` method on an item (e.g. ``/data/issue/43``)
+returns an ETag in the http header *and* the ``@etag`` value. When
+modifying the item via ``PUT`` or ``PATCH`` either a ``If-Match`` header
+or an ``@etag`` value in the form have to be provided.
+
 sample python client
 ====================
 
@@ -163,7 +168,7 @@
         >>> print("ETag: %s" % etag)
         >>> etag = r.json()['data']['@etag']
         >>> print("@etag: %s" % etag)
-        >>> h = dict(ETag = etag)
+        >>> h = {'If-Match': etag}
         >>> d = {'@op:'action', '@action_name':'retire'}
         >>> r = s.patch(u + 'issue/42', data = d, headers = h)
         >>> print(r.json())

Roundup Issue Tracker: http://roundup-tracker.org/