Create pagination doc #441
Merged
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
omeshp
approved these changes
Jun 11, 2018
| Important fields explained: | ||
| - `endpointUrl` : Standard context here. The url that you intend to call. | ||
| - `callbackContextTemplate` : This is the set of parameters that we will need to call this API again. Generally, this will be derived from the response of the previous call. It's supposed to be a set of key-value pairs. | ||
| - `callbackRequiredTemplate` : This is basically a boolean flag which identifies whether further call to API is needed. It does so based on the response of the previous call. |
There was a problem hiding this comment.
Add that recalling the API needs to be handled by the client. In our case it will be task editor UI.
| Depending on the kind of pagination supported by the underlying API, the logic to determine the value of "callbackRequiredTemplate" can be anything. | ||
| We expect both "callbackContextTemplate" and "callbackRequiredTemplate" to be provided as mustache templates. Examples follow: | ||
|
|
||
| ### Sample Data Source |
There was a problem hiding this comment.
Add examples of how 2 well know formats can be supported?
There was a problem hiding this comment.
I will just add the link of the doc which explains this. Explaining that here would be redundant I think.
GitHubSriramB
approved these changes
Jun 11, 2018
| ``` | ||
| { | ||
| "endpointUrl": “someUrl” | ||
| "callbackContextTemplate": "" //set of parameters that need to be used in the next call |
There was a problem hiding this comment.
remove comments as you are explaining these fields down below
| @@ -0,0 +1,41 @@ | |||
| # Pagination | |||
| The support of pagination is data sources is given by following template: | |||
There was a problem hiding this comment.
typo - … pagination in data source bindings ...
| ### Sample Data Source | ||
| ``` | ||
| { | ||
| "endpointUrl": "{{endpoint.url}}/{{project}}/_apis/****/****?&$top=500&continuationToken={{{continuationToken}}}", |
There was a problem hiding this comment.
give a real world example here.
also, have reference to some tasks that you have edited to support pagination from here.
GitHubSriramB
approved these changes
Jun 13, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
No description provided.