Skip to content

Commit 54e77f1

Browse files
committed
Add warning about collection size limit as anti-DOS mechanism.
1 parent 488f74a commit 54e77f1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/rest.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,12 @@ https://.../rest/data/issue returns::
293293
Collection endpoints support a number of features as seen in the next
294294
sections.
295295

296+
A server may implement a default maximum number of items in the
297+
collection. This can be used to prevent denial of service (DOS). As
298+
a result all clients must be programmed to expect pagination
299+
decorations in the response. See the section on pagination below for
300+
details.
301+
296302
Searching
297303
^^^^^^^^^
298304

@@ -459,6 +465,10 @@ relation to move to the previous page. Also we have a self relation
459465
(which is missing the @page_index, hence we are at page 1) that can be
460466
used to get the same page again.
461467

468+
Note that the server may choose to limit the number of returned
469+
entries in the collection as a DOS prevention measure. As a result
470+
clients must be prepared to handle the incomplete response and request
471+
the next URL to retrieve all of the entries.
462472

463473
Field embedding and verbose output
464474
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)