From b8959ca82bb8c4752d4e639e4e35048d8ba0a55b Mon Sep 17 00:00:00 2001
From: Daniel Roethlisberger <daniel@roe.ch>
Date: Tue, 27 Nov 2018 11:34:55 +0100
Subject: [PATCH] Document pagination options for /events/restSearch

Reference: https://github.com/MISP/MISP/issues/2426#issuecomment-431657077
---
 automation/README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/automation/README.md b/automation/README.md
index 733cfb6..d510b3e 100644
--- a/automation/README.md
+++ b/automation/README.md
@@ -1407,6 +1407,10 @@ https://<misp url>/events/restSearch/download/null/null/null/null/tag1&&tag2&&!t
 <dd>Include the attachments/encrypted samples in the export</dd>
 <dt>metadata</dt>
 <dd>Only fetch the event metadata (event data, tags, relations) and skip the attributes</dd>
+<dt>limit</dt>
+<dd>Limit the number of results returned; use together with page.</dd>
+<dt>page</dt>
+<dd>If a limit is set, sets the page to be returned, starting at 1; page 3, limit 100 will return records 201->300). When requesting a page beyond the number of available pages, the returned results list will be empty.</dd>
 </dl>
 
 The keywords false or null should be used for optional empty parameters in the URL.