Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK-2666] Update endpoint methods to document allowance of 'from' and 'take' checkpoint pagination parameters #634

Merged
merged 1 commit into from
Jul 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/management/LogsManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ var LogsManager = function(options) {
* @param {String} [params.fields] A comma separated list of fields to include or exclude
* @param {Boolean} [params.include_fields] true if the fields specified are to be included in the result, false otherwise.
* @param {Boolean} [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
* @param {String} [params.from] For checkpoint pagination, log event Id from which to start selection from.
* @param {Number} [params.take] When using the `from` parameter, the number of entries to retrieve. Default 50, max 100.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
Expand Down
4 changes: 4 additions & 0 deletions src/management/OrganizationsManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ utils.wrapPropertyMethod(OrganizationsManager, 'create', 'organizations.create')
* @param {Object} [params] Organizations parameters.
* @param {Number} [params.per_page] Number of results per page.
* @param {Number} [params.page] Page number, zero indexed.
* @param {String} [params.from] For checkpoint pagination, the Id from which to start selection from.
* @param {Number} [params.take] For checkpoint pagination, the number of entries to retrieve. Default 50.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
Expand Down Expand Up @@ -455,6 +457,8 @@ OrganizationsManager.prototype.updateEnabledConnection = function(params, data,
* });
*
* @param {String} [params.id] Organization ID
* @param {String} [params.from] For checkpoint pagination, the Id from which to start selection from.
* @param {Number} [params.take] For checkpoint pagination, the number of entries to retrieve. Default 50.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
Expand Down
4 changes: 2 additions & 2 deletions src/management/RolesManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -351,8 +351,8 @@ RolesManager.prototype.removePermissions = function(params, data, cb) {
* @param {String} [roleId] Id of the role
* @param {Number} [params.per_page] Number of results per page.
* @param {Number} [params.page] Page number, zero indexed.
* @param {String} [params.from] Optional id from which to start selection.
* @param {Number} [params.take] The total amount of entries to retrieve when using the from parameter. Defaults to 50.
Copy link
Member Author

@evansims evansims Jul 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This phrasing here was a bit misguiding; as 'from' is optional (and not used during the initial request w/ checkpoint pagination - aside from the unique log's endpoint method), take can and always will (for the first request) be used without from.

* @param {String} [params.from] For checkpoint pagination, the Id from which to start selection from.
* @param {Number} [params.take] For checkpoint pagination, the number of entries to retrieve. Default 50.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
Expand Down