docs: list major data of list_canister_snapshots returns #3833
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
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.
Motivation
When I added support for snapshots in Juno, I was confused about the
sizeinformation returned bylist_canister_snapshots. I wasn’t sure if it was measured in bytes or another unit, as the Candid file only specifies a byte array and there were no additional references in the documentation.This is why I submit this PR to clarify that the size is measured in bytes and to mention that the result includes a unique ID.
Note that I explicitly omitted the timestamp because the sentence structure I provided here ensures maintainability—meaning we wouldn’t need to update the description every time new self-explanatory fields are added.