Adding doc for pagination (everything but openAPI json definition file) #23
Conversation
This file contains hidden or 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
Contributor
agaperste
commented
Feb 13, 2024
agaperste
commented
- added a new pagination page to describe expected request and response, together with other gotcha's
- updated relevant endpoints to reference back to this pagination page
- minor update for rate limit and json file
…adding some info explainer on partial results; updated the rest of the doc to link back to pagination page.
RichardKeo
reviewed
Feb 13, 2024
Comment on lines
192
to
193
| ```json | ||
| "execution_id": "01HPF1299EV69Z08DBKW1B6MJR", |
Contributor
There was a problem hiding this comment.
Suggested change
| ```json | |
| "execution_id": "01HPF1299EV69Z08DBKW1B6MJR", | |
| ```json | |
| { | |
| "execution_id": "01HPF1299EV69Z08DBKW1B6MJR", |
The indentation doesn't look right too
Contributor
Author
|
@RichardKeo Thanks for ur comments, think I've resolved them all. Plz lmk :) |
RichardKeo
approved these changes
Feb 13, 2024
Contributor
RichardKeo
left a comment
RichardKeo
left a comment
There was a problem hiding this comment.
Looks good. I've left one more comment to correct the pagination explanation on JSON results.
Contributor
Author
|
@RichardKeo updated :) |
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.