Fix pagination documentation for stellar-rpc #1363
Conversation
|
Something went wrong with PR preview build please check |
|
Something went wrong with PR preview build please check |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
| @@ -39,7 +39,7 @@ | |||
| }, | |||
| "cursor": { | |||
| "type": "string", | |||
| "$ref": "#/components/schemas/GetEventsCursor" | |||
| "$ref": "#/components/schemas/Cursor" | |||
There was a problem hiding this comment.
Each event itself also has a cursor - I think that needs to be updated, too?
There was a problem hiding this comment.
in the event schema the field is still called pagingToken:
https://github.com/stellar/stellar-rpc/blob/main/protocol/get_events.go#L29-L30
There was a problem hiding this comment.
Oh oof, gotcha. That one is still useful for mid-page eventing, though, so idk if deprecated is the word? Then again they should use id for that.
|
Preview is available here: |
|
@Shaptic can you take another look? I updated the pr with the following changes:
|
Fixes #1309
This PR consolidates the documentation for pagination that is used for getEvents, getTransactions, and getLedgers. All those endpoints use a
cursorfield in the request / response in order to do pagination.The
cursorfield used to be calledpaging_tokenand this PR updates the documentation to referencecursorinstead ofpaging_token.Also, the
cursorfield was missing in the schema of thegetEventsandgetTransactionsresponses. This PR includes thecursorfields in those responses.