Document websocket update success response format#900
Open
8bitpal wants to merge 2 commits into
Open
Conversation
…page The auto-generated page only showed the error branch of the Either_JsCantonError_JsGetUpdatesResponse oneOf. Adds the missing success format (JsGetUpdatesResponse with its Update variants: Transaction, OffsetCheckpoint, Reassignment, TopologyTransaction) with an example JSON payload. Closes #878 Signed-off-by: 8bitpal <eliashaase@gmail.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
/v2/updatessubscribe page only showed the error variant ofEither_JsCantonError_JsGetUpdatesResponse. The success format (JsGetUpdatesResponse) was completely absent.Adds documentation of the success format above the existing error docs:
{ "update": <Update> }wrapperUpdatevariants (Transaction, OffsetCheckpoint, Reassignment, TopologyTransaction) in a tableTransactionpayloadCloses #878