docs: automated updates for api_change#1088
Open
jessiemongeon1 wants to merge 1 commit into
Open
Conversation
…1082 Automated update based on: genAddressSeed now throws an error if the key claim name, value, or aud contains a backslash, double-quote, or control character (< 0x20), rejecting inputs that reveal JSON escaping. This is a behavioral change to a public zkLogin utility function.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
|
Contributor
Author
Style Guide AuditAll 1 file(s) pass the style guide audit. |
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
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.
Summary
Automated documentation updates triggered by recent release notes.
Changes
Triggered by MystenLabs/ts-sdks#1082: zklogin: reject claim inputs with JSON escapes in genAddressSeed
packages/docs/content/sui/zklogin.mdxReview details
packages/docs/content/sui/zklogin.mdxThe documentation page needs updating to document the new input validation behavior of
genAddressSeed.What needs updating
The page references
genAddressSeedin the "Legacy addresses" section but never documents it independently or describes its input constraints.Missing information
The
genAddressSeedfunction now throws an error if theclaimName,claimValue, oraudparameters contain a backslash (\), double-quote ("), or control character (codepoint < 0x20). This validation rejects inputs that reveal JSON escaping, and it's a behavioral change users need to be aware of since previously-accepted inputs will now throw.Suggested update
Add a section (or a note near the existing usage of
genAddressSeed) that documents this function and its validation behavior. For example, after thecomputeZkLoginAddressexample and before the "Legacy addresses" section, something like:Suggested addition:
A new subsection or paragraph:
The
claimName,claimValue, andaudparameters must not contain backslashes (\), double-quotes ("), or control characters (codepoints below0x20).genAddressSeedwill throw an error if any of these characters are present, as they indicate improperly escaped JSON values. Ensure you pass the raw, unescaped claim values (e.g., as decoded from the JWT payload), not JSON-encoded strings.