Merge pull request #199 from ember-nexus/github-issue/189

Add parameters `page` and `pageSize` to documentation of collection e…

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Add documentation and automatic example generation for healthcheck command, closes [#184].
 - Add 401 error case for the GET /me endpoint, closes [#190].
+- Add parameters `page` and `pageSize` to documentation of collection endpoints, closes #189.
 ### Changed
 - Rename `_PartialUnifiedCollection` to `_PartialElementCollection`, closes #187.
 

docs/api-endpoints/element/get-children.md

@@ -6,6 +6,13 @@
 Returns all children of the specified node.  
 Returned data is paginated, and each page contains all relations between the parent and the returned children.
 
+## Request Parameters
+
+- `page`: Integer, number of the page to be returned. The first page is `1`, which is also the default if not explicitly
+  set.
+- `pageSize`: Integer, is the upper limit of nodes to be returned. Limited by the APIs instance configuration. By
+  default, 25 and can be set between 5 and 100.
+
 ## Request Example
 
 ```bash

docs/api-endpoints/element/get-index.md

@@ -5,6 +5,13 @@
 
 Returns all top-level elements to which the current user has direct access.
 
+## Request Parameters
+
+- `page`: Integer, number of the page to be returned. The first page is `1`, which is also the default if not explicitly
+  set.
+- `pageSize`: Integer, is the upper limit of nodes to be returned. Limited by the APIs instance configuration. By
+  default, 25 and can be set between 5 and 100.
+
 ## Request Example
 
 ```bash

docs/api-endpoints/element/get-parents.md

@@ -8,6 +8,13 @@ Returned data is paginated; each page contains all relations between the node an
 
 !> **Note**: Usually, a node only has one parent, although the security system allows multiple owners.
 
+## Request Parameters
+
+- `page`: Integer, number of the page to be returned. The first page is `1`, which is also the default if not explicitly
+  set.
+- `pageSize`: Integer, is the upper limit of nodes to be returned. Limited by the APIs instance configuration. By
+  default, 25 and can be set between 5 and 100.
+
 ## Request Example
 
 ```bash

docs/api-endpoints/element/get-related.md

@@ -7,6 +7,13 @@ Returns all nodes related to the current node.
 Returned data is paginated, and each page contains all relations between the node and the returned nodes. Includes
 parents and children.
 
+## Request Parameters
+
+- `page`: Integer, number of the page to be returned. The first page is `1`, which is also the default if not explicitly
+  set.
+- `pageSize`: Integer, is the upper limit of nodes to be returned. Limited by the APIs instance configuration. By
+  default, 25 and can be set between 5 and 100.
+
 ## Request Example
 
 ```bash

docs/api-endpoints/search/post-search.md

@@ -12,6 +12,13 @@ return found elements.
 As there is no logical difference between found nodes and found relations, both types are merged in a single elements
 response.
 
+## Request Parameters
+
+- `page`: Integer, number of the page to be returned. The first page is `1`, which is also the default if not explicitly
+  set.
+- `pageSize`: Integer, is the upper limit of elements to be returned. Limited by the APIs instance configuration. By
+  default, 25 and can be set between 5 and 100.
+
 ## Available Request Properties
 
 The posted request must be a valid JSON document.