[SDK-2666] Update endpoint methods to document allowance of 'from' and 'take' checkpoint pagination parameters #634
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evansims
added
documentation
evansims
commented
Jul 18, 2021
| @@ -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. | |||
There was a problem hiding this comment.
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.
davidpatrick
approved these changes
Jul 20, 2021
Merged
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR includes method documentation (docblock) updates to reflect the availability of checkpoint pagination parameters on supported endpoints. It does not add any new functionality or require new tests.
References
Testing
Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.
Checklist