summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Ramsay <jramsay@gitlab.com>2019-04-15 19:35:20 -0400
committerJames Ramsay <jramsay@gitlab.com>2019-04-15 19:36:16 -0400
commit09caaed40333b12a3cd86759fd094ee04fa9083b (patch)
tree9ecd4a0e6244cfffa59f868a1e0f77bf26be1a6a
parent8c10e99de29f3c6f0d17ebde5af14324956dc109 (diff)
downloadgitlab-ce-09caaed40333b12a3cd86759fd094ee04fa9083b.tar.gz
Add pagination to notes and discussions docs
-rw-r--r--doc/api/discussions.md7
-rw-r--r--doc/api/notes.md7
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/discussions.md b/doc/api/discussions.md
index 7d68d0ae744..3f575f432d0 100644
--- a/doc/api/discussions.md
+++ b/doc/api/discussions.md
@@ -2,6 +2,13 @@
Discussions are set of related notes on snippets, issues, merge requests or commits.
+## Discussions pagination
+
+By default, `GET` requests return 20 results at a time because the API results
+are paginated.
+
+Read more on [pagination](README.md#pagination).
+
## Issues
### List project issue discussions
diff --git a/doc/api/notes.md b/doc/api/notes.md
index dd4e18b14e6..c351ee13d9a 100644
--- a/doc/api/notes.md
+++ b/doc/api/notes.md
@@ -2,6 +2,13 @@
Notes are comments on snippets, issues or merge requests.
+## Notes pagination
+
+By default, `GET` requests return 20 results at a time because the API results
+are paginated.
+
+Read more on [pagination](README.md#pagination).
+
## Issues
### List project issue notes