Improve /block/transaction description regarding pagination
#32
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
|
@AlanVerbner would you mind running |
api.yaml
Outdated
| @@ -162,6 +162,9 @@ paths: | |||
| Fetching a transaction by hash is considered an Explorer Method | |||
| (which is classified under the Future Work section). | |||
|
|
|||
| This method can be used to let consumers to paginate results when the | |||
| block trasactions count is too big to be returned in a single [BlockResponse](#/components/schemas/BlockResponse). | |||
There was a problem hiding this comment.
Suggested change
| block trasactions count is too big to be returned in a single [BlockResponse](#/components/schemas/BlockResponse). | |
| block trasactions count is too big to be returned in a single BlockResponse. |
Links in the descriptions break the formatting 😢 Hopefully, we can fix this issue and do one large pass on adding links in the future.
AlanVerbner
force-pushed
the
feature/block-transaction-pagination
branch
from
076a2db to
cbd7909
Compare
|
@patrick-ogrady I addressed all your comments 😄 |
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.
Motivation
The only way to paginate transactions in case the
BlockResponsemight get too big if returning all of them, is to just return the metadata and useBlockTransactionRequestto do so.See https://community.rosetta-api.org/t/how-to-return-data-without-being-able-to-paginate/98/4?u=alan.verbner
Solution
Just added a brief description
Open questions
N/A