summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2019-04-16 07:47:53 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2019-04-16 07:47:53 +0000
commitb754fb888891abcf24d8547d7f7b4d3f02c55d76 (patch)
treeae244b429c31849f8321285505a88c108500a8c7
parent78a50fd30cda9e7f255d2cc0cdbd92a08f77d7c6 (diff)
parent09caaed40333b12a3cd86759fd094ee04fa9083b (diff)
downloadgitlab-ce-b754fb888891abcf24d8547d7f7b4d3f02c55d76.tar.gz
Merge branch 'jramsay/notes-api-pagination-docs' into 'master'
Add pagination to notes and discussions docs Closes #51616 See merge request gitlab-org/gitlab-ce!27401
-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