chore: remove references to cursor based pagination in rpc documentation #8086
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
candida-d
reviewed
Apr 5, 2023
| @@ -1018,7 +1018,7 @@ func tradesToProto(trades []entities.Trade) []*vega.Trade { | |||
| return protoTrades | |||
| } | |||
|
|
|||
| // ListTrades lists trades by using a cursor based pagination model. | |||
| // ListTrades lists trades by. | |||
There was a problem hiding this comment.
Suggested change
| // ListTrades lists trades by. | |
| // ListTrades lists trades. |
This is a pretty useless description now though. How about "List all trades" and if there are filters, mentioning that they can be filtered?
candida-d
reviewed
Apr 5, 2023
| @@ -1137,7 +1137,7 @@ func (t *TradingDataServiceV2) ListMarkets(ctx context.Context, req *v2.ListMark | |||
| }, nil | |||
| } | |||
|
|
|||
| // List all Positions using a cursor based pagination model. | |||
| // List all Positions. | |||
There was a problem hiding this comment.
Suggested change
| // List all Positions. | |
| // List all positions. |
| @@ -1103,7 +1103,7 @@ func (t *TradingDataServiceV2) GetMarket(ctx context.Context, req *v2.GetMarketR | |||
| }, nil | |||
| } | |||
|
|
|||
| // ListMarkets lists all markets using a cursor based pagination model. | |||
| // ListMarkets lists all markets. | |||
There was a problem hiding this comment.
Suggested change
| // ListMarkets lists all markets. | |
| // List all markets. |
| @@ -1171,7 +1171,7 @@ func (t *TradingDataServiceV2) ListPositions(ctx context.Context, req *v2.ListPo | |||
| }, nil | |||
| } | |||
|
|
|||
| // ListAllPositions lists all positions using a cursor based pagination model. | |||
| // ListAllPositions lists all positions. | |||
There was a problem hiding this comment.
Suggested change
| // ListAllPositions lists all positions. | |
| // Lists all positions. |
| @@ -1335,7 +1335,7 @@ func (t *TradingDataServiceV2) GetParty(ctx context.Context, req *v2.GetPartyReq | |||
| }, nil | |||
| } | |||
|
|
|||
| // ListParties lists Parties using a cursor based pagination model. | |||
| // ListParties lists Parties. | |||
There was a problem hiding this comment.
Suggested change
| // ListParties lists Parties. | |
| // List parties. |
| @@ -1364,7 +1364,7 @@ func (t *TradingDataServiceV2) ListParties(ctx context.Context, req *v2.ListPart | |||
| }, nil | |||
| } | |||
|
|
|||
| // ListMarginLevels lists MarginLevels using a cursor based pagination model. | |||
| // ListMarginLevels lists MarginLevels. | |||
There was a problem hiding this comment.
Suggested change
| // ListMarginLevels lists MarginLevels. | |
| // Lists margin levels. |
for a given market, for all markets?
| @@ -1417,7 +1417,7 @@ func (t *TradingDataServiceV2) ObserveMarginLevels(req *v2.ObserveMarginLevelsRe | |||
| }) | |||
| } | |||
|
|
|||
| // ListRewards lists Rewards using a cursor based pagination model. | |||
| // ListRewards lists Rewards. | |||
There was a problem hiding this comment.
Suggested change
| // ListRewards lists Rewards. | |
| // List rewards. |
received? funded?
| @@ -1962,7 +1962,7 @@ func (t *TradingDataServiceV2) getVotesByProposal(ctx context.Context, proposalI | |||
| return | |||
| } | |||
|
|
|||
| // ListVotes gets all Votes using a cursor based pagination model. | |||
| // ListVotes gets all Votes. | |||
There was a problem hiding this comment.
Suggested change
| // ListVotes gets all Votes. | |
| // Lists all votes. |
Signed-off-by: Jeremy Letang <me@jeremyletang.com>
Co-authored-by: candida-d <62548908+candida-d@users.noreply.github.com>
Signed-off-by: Jeremy Letang <me@jeremyletang.com>
candida-d
approved these changes
Apr 5, 2023
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.
close #7989