Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

getTransactions incorrectly states startLedger as required #826

Open
janewang opened this issue Jul 25, 2024 · 1 comment
Open

getTransactions incorrectly states startLedger as required #826

janewang opened this issue Jul 25, 2024 · 1 comment
Assignees
Labels
bug Something isn't working dev-rel

Comments

@janewang
Copy link
Contributor

RPC Page: https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransactions

The documentation currently incorrectly indicates startLedger as always required. That is not correct.

startLedger and cursor cannot be sent at the same time. Either use startLedger or cursor. The docs should say something to this respect so it's clear how to data.

Maybe also add an example of using cursor instead of startLedger.

curl -X POST \
-H 'Content-Type: application/json' \
-d '{
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "getTransactions",
  "params": {
    "pagination": {
      "cursor": "3086346319040513",
      "limit": 5
    }
  }
}' \
https://soroban-testnet.stellar.org:443 | jq
@janewang janewang added the bug Something isn't working label Jul 25, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Dev Docs Jul 25, 2024
@janewang janewang changed the title getTransactions incorrectly list startLedger as required getTransactions incorrectly states startLedger as required Jul 25, 2024
@janewang janewang moved this from Backlog to To Do in Dev Docs Jul 25, 2024
@janewang
Copy link
Contributor Author

I think the same issue in documentation also exists on getEvents https://developers.stellar.org/docs/data/rpc/api-reference/methods/getEvents

cc @mollykarcher

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dev-rel
Projects
Status: To Do
Development

No branches or pull requests

4 participants
@janewang @ElliotFriend @briwylde08 and others