Skip to content

Commit 87e06ae

Browse files
committed
Added more verbage on "Rest Access" permission and reworked search docs.
1 parent 8d3b5b4 commit 87e06ae

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

doc/rest.txt

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ schema.py to add::
3232
This is usually included near where other permissions like "Web Access"
3333
or "Email Access" are assigned.
3434

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.
38+
3539
The REST api is reached via the ``/rest/`` endpoint of the tracker
3640
URL. Partial URLs paths below (not starting with https) will have
3741
/rest removed for brevity.
@@ -333,17 +337,19 @@ name is a string, in this case it is also a key value. As a result it
333337
only does an exact match.
334338

335339
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
337341
``title=Something`` (or in long form title~=Something) will find all
338-
issues with "Something" or "someThing", etc. in the title. Changing
339-
the search to ``title:=Something`` (note the `:`) an exact
340-
case-sensitive string match for exactly one word ``Something`` with a
341-
capital ``S``. Another example is:
342+
issues with "Something" or "someThing", etc. in the title.
343+
344+
Changing the search to ``title:=Something`` (note the `:`) performs an
345+
exact case-sensitive string match for exactly one word ``Something``
346+
with a capital ``S``. Another example is:
342347
``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
344349
``%20`` will also work. Note that you must match the spaces when
345350
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.
347353

348354
To make this clear, searching
349355
``https://.../rest/data/issue?keyword=Foo`` will not work unless there

0 commit comments

Comments
 (0)