diff doc/rest.txt @ 5678:b8e8b1b3ec77

REST: Add key lookup E.g. /data/status/open or /data/status/name=open Also update documentation and tests
author Ralf Schlatterbeck <rsc@runtux.com>
date Thu, 28 Mar 2019 12:21:40 +0100
parents 1fa59181ce58
children 1b9ef04b9528
line wrap: on
line diff
--- a/doc/rest.txt	Tue Mar 26 23:29:35 2019 -0400
+++ b/doc/rest.txt	Thu Mar 28 12:21:40 2019 +0100
@@ -97,6 +97,17 @@
 is shown in json as a (possibly very long) string. Currently the json
 serializer cannot handle files not properly utf-8 encoded, so specifying
 @verbose=3 for files is currently discouraged.
+Note that if the class has a key attribute (like e.g., the 'status'
+class in the classic tracker), you can get an individual status by
+specifying the key-attribute e.g. ``/data/status/name=closed``. Note
+that ``name`` in this example must be the key-attribute of the class.
+A short-form (which might no longer be supported in future version of
+the API) is to specify only the value, e.g. ``/data/status/closed``.
+This short-form only works when you're sure that the key of the class is
+not numeric.
+The long-form (with ``=``) is different from a query-parameter like
+``/data/status?@name=closed`` which would find all stati that have
+``closed`` as a substring.
 
 A ``GET`` method on a property (e.g. ``/data/issue/42/title``) returns the
 link, an ``@etag``, the type of the property (e.g. "<type str>") the id

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