Merge pull request #268 from auth0/feature-pagination-docs

Adding pagination docs for clients/connections

src/management/ClientsManager.js

@@ -86,12 +86,26 @@ utils.wrapPropertyMethod(ClientsManager, 'create', 'resource.create');
  * @method    getAll
  * @memberOf  module:management.ClientsManager.prototype
  *
- * @example
+ * @example <caption>
+ *   This method takes an optional object as first argument that may be used to
+ *   specify pagination settings. If pagination options are not present,
+ *   the first page of a limited number of results will be returned.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ *   per_page: 10,
+ *   page: 2
+ * };
+ *
  * management.clients.getAll(function (err, clients) {
  *   console.log(clients.length);
  * });
  *
- * @param   {Function}  [cb]    Callback function.
+ * @param   {Object}    [params]          Clients params.
+ * @param   {Number}    [params.per_page] Number of clients per page.
+ * @param   {Number}    [params.page]     Page number.
+ * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}
  */

src/management/ConnectionsManager.js

@@ -80,12 +80,26 @@ utils.wrapPropertyMethod(ConnectionsManager, 'create', 'resource.create');
  * @method    getAll
  * @memberOf  module:management.ConnectionsManager.prototype
  *
- * @example
+ * @example <caption>
+ *   This method takes an optional object as first argument that may be used to
+ *   specify pagination settings. If pagination options are not present,
+ *   the first page of a limited number of results will be returned.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ *   per_page: 10,
+ *   page: 2
+ * };
+ *
  * management.connections.getAll(function (err, connections) {
  *   console.log(connections.length);
  * });
  *
- * @param   {Function}  [cb]    Callback function.
+ * @param   {Object}    [params]          Connections params.
+ * @param   {Number}    [params.per_page] Number of connections per page.
+ * @param   {Number}    [params.page]     Page number.
+ * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}
  */

src/management/UsersManager.js

@@ -144,7 +144,8 @@ UsersManager.prototype.create = function(data, cb) {
  *
  * @example <caption>
  *   This method takes an optional object as first argument that may be used to
- *   specify pagination settings and the search query.
+ *   specify pagination settings and the search query. If pagination options are
+ *   not present, the first page of a limited number of results will be returned.
  * </caption>
  *
  * // Pagination settings.