Skip to content

Commit a4a6bc3

Browse files
committed
Need to fix spelling.
1 parent 52bf8b7 commit a4a6bc3

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

doc/rest.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Also if the user has exceeded the rate limit, this header is added:
118118
General Guidelines
119119
==================
120120

121-
Performing a ``GET`` on an item or property of an item will rethrn an
121+
Performing a ``GET`` on an item or property of an item will return an
122122
ETag header or an @etag property. This needs to be submitted with
123123
``DELETE``, ``PUT`` and ``PATCH`` operations on the item using an
124124
``If-Match`` header or an ``"@etag`` property in the data payload if
@@ -142,7 +142,7 @@ well as a ``collections`` list of objects::
142142
{ "data": {
143143
"meta data field1": "value",
144144
"meta data field2": "value",
145-
"collecton": [
145+
"collection": [
146146
{ "link": "url to item",
147147
"id": "internal identifier for item" },
148148
{ "link": "url to second item",
@@ -159,7 +159,7 @@ well as a ``collections`` list of objects::
159159
}
160160
}
161161

162-
available meta data is described in the documention for the
162+
available meta data is described in the documentation for the
163163
collections endpoint.
164164

165165
The ``link`` fields implement HATEOS by supplying a url for the
@@ -189,7 +189,7 @@ the issue. Example::
189189
{ "data": {
190190
"meta data field1": "value",
191191
"type": "type of item, issue, user ..."
192-
"link": "link to retreive item",
192+
"link": "link to retrieve item",
193193
"attributes": {
194194
"title": "title of issue",
195195
"nosy": [
@@ -204,13 +204,13 @@ the issue. Example::
204204
Using a property endpoint (e.g. title or nosy list for an issue) the
205205
``data`` wrapper has a ``data`` subfield that represents the value of
206206
the property. This ``data`` subfield may be a simple string (all types
207-
except mutlilink) or a list of strings (multilink
207+
except multilink) or a list of strings (multilink
208208
properties). Example::
209209

210210
{ "data": {
211211
"type": "description of class",
212212
"@etag": "\"f15e6942f00a41960de45f9413684591\"",
213-
"link": "link to retreive property",
213+
"link": "link to retrieve property",
214214
"id": "id for object with this property",
215215
"data": "value of property"
216216
}
@@ -221,7 +221,7 @@ Special Endpoints
221221
=================
222222

223223
There are a few special endpoints that provide some additional data.
224-
Tracker admiinstrators can add new endpoints. See
224+
Tracker administrators can add new endpoints. See
225225
"Programming the REST API"_ below.
226226

227227
/summary
@@ -338,7 +338,7 @@ class not issue class) will return matches for ``foo``, ``foobar``,
338338
``foo taz`` etc.
339339

340340
In all cases the field ``@total_size`` is reported which is the total
341-
number of items available if you were to retreive all of them.
341+
number of items available if you were to retrieve all of them.
342342

343343
Other data types: Date, Interval Integer, Number need examples and may
344344
need work to allow range searches. Full text search (e.g. over the
@@ -364,7 +364,7 @@ leading `@` to make the parameters distinguishable from field names.)
364364
- (which defaults to 1 if not given) specifies which page number
365365
of ``@page_size`` items is displayed.
366366

367-
Also when pagenation is enabled the returned data include pagenation
367+
Also when pagination is enabled the returned data include pagination
368368
links along side the collection data. This looks like::
369369

370370
{ "data":
@@ -415,7 +415,7 @@ operation on ``https://.../rest/data/issue``.
415415
- Explanation
416416
* - ``@verbose=0``
417417
- each item in the collection has its "id" property displayed
418-
and a link with the URL to retreive the item.
418+
and a link with the URL to retrieve the item.
419419
* - ``@verbose=1``
420420
- for collections this output is the same as ``@verbose=0``. This
421421
is the default.
@@ -484,7 +484,7 @@ database. It is a construct of the rest interface. This means that you
484484
can not set ``@fields=link`` and get the link property included in the
485485
output.
486486

487-
Also using ``@fields=@etag`` will not work to retreive the etag for
487+
Also using ``@fields=@etag`` will not work to retrieve the etag for
488488
items in the collection.
489489

490490
See the `Searches and selection`_ section for the use cases supported
@@ -662,7 +662,7 @@ memory and parsing time on the client side. By default protected
662662
properties (read only in the database) are not listed. Th
663663
is makes it easier to submit the attributes from a
664664
``@verbose=0`` query using PUT. To include protected properties
665-
in the output og a GET add the query parameter
665+
in the output of a GET add the query parameter
666666
``@protected=true`` to the query and attributes like: actor,
667667
created, creator and activity will be include in the result.
668668

@@ -961,7 +961,7 @@ The ``PATCH`` method can be applied to properties, e.g.,
961961
``@op=<method>`` where ``<method>`` is one of ``add``, ``replace``,
962962
``remove``. If no operator is specified, the default is ``replace``
963963
which is the same as performing a PUT on the field url. ``add`` and
964-
``remove`` allow ading and removing values from MultiLink
964+
``remove`` allow adding and removing values from MultiLink
965965
properties. This is easier than having to rewrite the entire value for
966966
the field using the ``replace`` operator or doing a PUT to the field.
967967
On success the returned value is the same as the respective ``GET``
@@ -980,7 +980,7 @@ Tunneling Methods via POST
980980

981981
If you are working through a proxy and unable to use http method like
982982
PUT, PATCH or DELETE you can use POST to perform the action. To tunnel
983-
an action throught POST, send the ``X-HTTP-METHOD-OVERRIDE`` header
983+
an action through POST, send the ``X-HTTP-METHOD-OVERRIDE`` header
984984
with a value of DELETE or other capitalized HTTP verb. The body of the
985985
POST should be what you would send if you were using the method
986986
without tunneling.

0 commit comments

Comments
 (0)