Mercurial > p > roundup > code
comparison doc/rest.txt @ 7973:ab3506b9e315
doc: add /rest/data/user/roles ignores query options
So you can add ?@verbose=2 etc. for compatibility with a real
collection endpoint, but it ignores them.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 21 May 2024 17:07:16 -0400 |
| parents | 425dd9854e34 |
| children | 372517700dad |
comparison
equal
deleted
inserted
replaced
| 7972:425dd9854e34 | 7973:ab3506b9e315 |
|---|---|
| 1118 } | 1118 } |
| 1119 | 1119 |
| 1120 to mimic a class collection. | 1120 to mimic a class collection. |
| 1121 | 1121 |
| 1122 Unlike a real class collection endpoint, ``@total_size`` is not | 1122 Unlike a real class collection endpoint, ``@total_size`` is not |
| 1123 returned. Also it does not support any query options like: filtering, | 1123 returned. Also it does not support and ignores any query options like: |
| 1124 `@sort`, `@group`, `@verbose` etc. Note that the ``id`` property is | 1124 filtering, `@sort`, `@group`, `@verbose` etc. Note that the ``id`` |
| 1125 not numeric. | 1125 property is not numeric. |
| 1126 | 1126 |
| 1127 This endpoint was introduced in release 2.4.0 to support a roles | 1127 This endpoint was introduced in release 2.4.0 to support a roles |
| 1128 select/dropdown in the web component classhelper. This lets the web | 1128 select/dropdown in the web component classhelper. This lets the web |
| 1129 component helper implement the same function in the classic user class | 1129 component helper implement the same function in the classic user class |
| 1130 classhelper. | 1130 classhelper. |