Mercurial > p > roundup > code
comparison doc/rest.txt @ 5901:a592e3156134
Added more verbage on "Rest Access" permission and reworked search docs.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 06 Oct 2019 18:21:37 -0400 |
| parents | be8524335bfa |
| children | fa661043fc5b |
comparison
equal
deleted
inserted
replaced
| 5900:e9cc002cbe40 | 5901:a592e3156134 |
|---|---|
| 29 | 29 |
| 30 db.security.addPermissionToRole('User', 'Rest Access') | 30 db.security.addPermissionToRole('User', 'Rest Access') |
| 31 | 31 |
| 32 This is usually included near where other permissions like "Web Access" | 32 This is usually included near where other permissions like "Web Access" |
| 33 or "Email Access" are assigned. | 33 or "Email Access" are assigned. |
| 34 | |
| 35 You could also create a new role "rest" and assign the "Rest Access" | |
| 36 permission to that role and then just add the "rest" permissions to | |
| 37 those users who should have access. | |
| 34 | 38 |
| 35 The REST api is reached via the ``/rest/`` endpoint of the tracker | 39 The REST api is reached via the ``/rest/`` endpoint of the tracker |
| 36 URL. Partial URLs paths below (not starting with https) will have | 40 URL. Partial URLs paths below (not starting with https) will have |
| 37 /rest removed for brevity. | 41 /rest removed for brevity. |
| 38 | 42 |
| 331 the ``closed`` status has ID 3). Note that even though the symbolic | 335 the ``closed`` status has ID 3). Note that even though the symbolic |
| 332 name is a string, in this case it is also a key value. As a result it | 336 name is a string, in this case it is also a key value. As a result it |
| 333 only does an exact match. | 337 only does an exact match. |
| 334 | 338 |
| 335 Searching for strings (e.g. the issue title, or a keyword name) | 339 Searching for strings (e.g. the issue title, or a keyword name) |
| 336 performs a case-insensitive substring search, so searching for | 340 performs a case-insensitive substring search. Searching for |
| 337 ``title=Something`` (or in long form title~=Something) will find all | 341 ``title=Something`` (or in long form title~=Something) will find all |
| 338 issues with "Something" or "someThing", etc. in the title. Changing | 342 issues with "Something" or "someThing", etc. in the title. |
| 339 the search to ``title:=Something`` (note the `:`) an exact | 343 |
| 340 case-sensitive string match for exactly one word ``Something`` with a | 344 Changing the search to ``title:=Something`` (note the `:`) performs an |
| 341 capital ``S``. Another example is: | 345 exact case-sensitive string match for exactly one word ``Something`` |
| 346 with a capital ``S``. Another example is: | |
| 342 ``title:=test+that+nosy+actually+works.`` where the + signs are spaces | 347 ``title:=test+that+nosy+actually+works.`` where the + signs are spaces |
| 343 in the string. Replacing `+` with the `URL encoding`_ for space | 348 in the string. Replacing ``+`` with the `URL encoding`_ for space |
| 344 ``%20`` will also work. Note that you must match the spaces when | 349 ``%20`` will also work. Note that you must match the spaces when |
| 345 performing exact matches. So `title:=test++that+nosy+actually+works.`` | 350 performing exact matches. So `title:=test++that+nosy+actually+works.`` |
| 346 matches the word test with two spaces after ``test`` in the title. | 351 matches the word ``test`` with two spaces bewteen ``test`` and |
| 352 ``that`` in the title. | |
| 347 | 353 |
| 348 To make this clear, searching | 354 To make this clear, searching |
| 349 ``https://.../rest/data/issue?keyword=Foo`` will not work unless there | 355 ``https://.../rest/data/issue?keyword=Foo`` will not work unless there |
| 350 is a keyword with a (case sensitive) name field of ``Foo`` which is | 356 is a keyword with a (case sensitive) name field of ``Foo`` which is |
| 351 the key field of the keyword. However searching the text property | 357 the key field of the keyword. However searching the text property |