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.

Sign up for GitHub

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

Jump to bottom

API v2 Updates #2841

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

API v2 Updates #2841

wants to merge 4 commits into from

Conversation

oeggert
Copy link
Collaborator

@oeggert oeggert commented Nov 5, 2024

Code samples updates will be included in a separate PR.

@oeggert oeggert added the content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts label Nov 5, 2024
@oeggert oeggert self-assigned this Nov 5, 2024
@socket-security Socket Security
Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/[email protected] Transitive: environment, network +5 30.5 MB gamote
npm/[email protected] None 0 4.35 MB ichernev
npm/[email protected] network 0 107 kB node-fetch-bot
npm/[email protected] environment 0 5.15 kB alexeyraspopov
npm/[email protected] Transitive: environment +11 6.69 MB schiehll
npm/[email protected] environment +2 339 kB react-bot
npm/[email protected] eval 0 402 kB yysuni
npm/[email protected] Transitive: environment, filesystem +13 4.15 MB sassbot
npm/[email protected] None 0 97.3 kB cyyynthia
npm/[email protected] environment, filesystem, unsafe +15 2 MB blakeembrey
npm/[email protected] None 0 21.9 MB typescript-bot
npm/[email protected] Transitive: environment, network +8 9.54 MB pbeshai
npm/[email protected] network 0 9.08 MB khancode_

🚮 Removed packages: npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@esbuild/[email protected], npm/@jridgewell/[email protected], npm/@noble/[email protected], npm/@rollup/[email protected], npm/@rollup/[email protected], npm/@scure/[email protected], npm/@scure/[email protected], npm/@scure/[email protected], npm/@types/[email protected], npm/@xrplf/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

amarantha-k
amarantha-k requested changes Nov 8, 2024
View reviewed changes
Copy link
Collaborator

@amarantha-k amarantha-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than one comment requesting clarification on the API versions used, the updates look good.

docs/references/http-websocket-apis/index.md

Currently, there are two API versions: `1` and `2` {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %}. The server reports the range of supported API versions in the `version` API method. <!-- STYLE_OVERRIDE: will --> <!-- TODO: add a link when `version` method is documented. -->

Separate API requests can use different API versions even on the same persistent connection. For example, if you connect through WebSocket to a server that supports API versions 1 and 2, you can make an `account_tx` request using API version 2 and then make another `account_tx` request using API version 1 from the same connection.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be helpful to clarify a few things:

  • The default API versions used when requests are made through websockets (vs others like SDKs).
  • One can specify the API version you want to use for a specific request.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved the table up so the info about default API version used is more obvious. Also added a line about specifying version.

@tequdev tequdev added the needs japanese translation PRs with English changes that need to be added/updated in the Japanese translation of the site label Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mDuo13 mDuo13 Awaiting requested review from mDuo13

@amarantha-k amarantha-k Awaiting requested review from amarantha-k

Requested changes must be addressed to merge this pull request.

Assignees

@oeggert oeggert

Labels
content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts needs japanese translation PRs with English changes that need to be added/updated in the Japanese translation of the site
Projects
XRPL Docs
Status: In Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@oeggert @amarantha-k @tequdev