Skip to content

Commit 185233a

Browse files
committed
More typo fixes and verbatim blocks.
1 parent 74971e3 commit 185233a

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

doc/rest.txt

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ Retrieve item using key value
750750
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
751751

752752
If the class has a key attribute, e.g. the 'status' class in the
753-
classic tracker, it can be used to retried the item.
753+
classic tracker, it can be used to retrieve the item.
754754

755755
You can get an individual status by specifying the key-attribute value
756756
e.g. ``/data/status/name=closed``. Note that ``name`` in this example
@@ -855,7 +855,7 @@ work. So using::
855855
https://.../rest/data/issue/23?@pretty=false
856856

857857
doesn't have the desired effect. However it can be put in the data
858-
payload:
858+
payload::
859859

860860
curl -u admin:admin ...
861861
--data '{ "nosy": [ "4", "5" ], "title": "...", "@pretty": "false" }'
@@ -871,7 +871,7 @@ line.
871871
The method ``DELETE`` is allowed on items, e.g., ``/data/issue/42``
872872
and will retire (mark as deleted) the respective item. On success it
873873
will only return a status code. The item is still available if
874-
accessed directly by it's item url. The item will not show up in
874+
accessed directly by its item url. The item will not show up in
875875
searches where it would have been matched if not retired.
876876

877877
Finally the ``PATCH`` method can be applied to individual items, e.g.,
@@ -886,7 +886,7 @@ namely ``retire`` and ``restore``. The ``retire`` action on an item is
886886
the same as a ``DELETE`` method, it retires the item. The ``restore``
887887
action is the inverse of ``retire``, the item is again visible. On
888888
success the returned value is the same as the respective ``GET``
889-
method. An example to add a user to the nosy list of an item is:
889+
method. An example to add a user to the nosy list of an item is::
890890

891891
curl -u admin:admin -p -X PATCH \
892892
--header "Content-Type: application/x-www-form-urlencoded" \
@@ -1364,7 +1364,10 @@ that returns a list of users with the developer role::
13641364
# to get @verbose and other args supported.
13651365
return self.get_collection('user', input)
13661366

1367-
Calling this with: `curl 'http://example.com/demo/rest/data/@permission/Developer?@fields=realname&roles=Users&@verbose=2'`
1367+
Calling this with::
1368+
1369+
curl 'http://example.com/demo/rest/data/@permission/Developer?@fields=realname&roles=Users&@verbose=2'
1370+
13681371
produces output similar to::
13691372

13701373
{
@@ -1382,7 +1385,7 @@ produces output similar to::
13821385
}
13831386

13841387
assuming user 4 is the only user with the Developer role. Note that
1385-
the url passes the `roles=User` filter option which is silently
1388+
the url passes the ``roles=User`` filter option which is silently
13861389
ignored.
13871390

13881391
Changing Access Roles with JSON Web Tokens
@@ -1401,7 +1404,7 @@ your company's single sign on infrastructure.
14011404

14021405
So what we need is a way for this third part service to impersonate
14031406
you and have access to create a roundup timelog entry (see
1404-
`<customizing.html#adding-a-time-log-to-your-issues>`__). Then add it
1407+
`<customizing.html#adding-a-time-log-to-your-issues>`__ ). Then add it
14051408
to the associated issue. This should happen without sharing passwords
14061409
and without the third party service to see the issue (except the
14071410
``times`` property), user, or other information in the tracker.
@@ -1702,7 +1705,7 @@ the defaults from ``config.ini`` file are used.
17021705
Test Examples
17031706
^^^^^^^^^^^^^
17041707

1705-
Rate limit tests:
1708+
Rate limit tests::
17061709

17071710
seq 1 300 | xargs -P 20 -n 1 curl --head -si \
17081711
https://.../rest/data/status/new \# | grep Remaining

0 commit comments

Comments
 (0)