Skip to content

Updated Ledger JSON API related docs after deletions of deprecated enpoints #1198

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

Open
tudor-da wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated Ledger JSON API related docs after deletions of deprecated enpoints #1198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-main/global-synchronizer/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Are there working examples of using the websocket version of the json api?

The `v2/updates/trees` JSON ledger api is deprecated so what is replacing it?

> A `v2/updates` is being added in 3.3 and will be available soon. In the interim, you can use `v2/updates/flat` which has the same behavior as `UpdateService.GetUpdates`.
> `v2/updates/trees` (along with `v2/updates/flats`) has been removed. Use `v2/updates` instead, which has the same behavior as `UpdateService.GetUpdates`. The `updateFormat` request field is now required: set `updateFormat.includeTransactions.transactionShape` to `TRANSACTION_SHAPE_LEDGER_EFFECTS` to get the tree-shaped transactions that `v2/updates/trees` previously returned.

</div>

Expand Down
2 changes: 1 addition & 1 deletion docs-main/global-synchronizer/reference/api-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ Configure the JSON API endpoint by adding the `server` parameter group.

## Websockets

The endpoints that result in large data sets (`/v2/commands/completions`, `/v2/state/active-contracts`, `/v2/updates`, `/v2/updates/flats`, and `/v2/updates/trees`) come in two flavors:
The endpoints that result in large data sets (`/v2/commands/completions`, `/v2/state/active-contracts`, `/v2/updates`) come in two flavors:

- a websocket capable of returning an arbitrarily long result set in a stream
- a HTTP post request returning a limited list of results
Expand Down
3 changes: 1 addition & 2 deletions docs-main/sdks-tools/api-reference/json-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ curl localhost:7575/v2/state/active-contracts \
},
"verbose": false
},
"verbose": false,
"activeAtOffset": 20
}'
```
Expand All @@ -105,7 +104,7 @@ curl localhost:7575/v2/state/active-contracts \

### Transaction Streaming

The JSON API supports both HTTP POST and WebSocket connections for streaming updates. Use `/v2/updates` or `/v2/updates/flats` for flat transaction streams, and `/v2/updates/trees` for transaction trees. WebSocket connections use the `daml.ws.auth` subprotocol.
The JSON API supports both HTTP POST and WebSocket connections for streaming updates on `/v2/updates`. WebSocket connections use the `daml.ws.auth` subprotocol.

### Ledger End

Expand Down