docs(core-sdk): document AncoreClient.createWallet and AncoreClient.refreshSessionKeyTtl (closes #1272) - #1389
Open
rupesh-kumar-sah wants to merge 1 commit into
Conversation
…efreshSessionKeyTtl (closes ancore-org#1272) - Add AncoreClient.createWallet documentation with parameter types, return values, and usage example - Add AncoreClient.refreshSessionKeyTtl documentation with validation rules, error table, and examples - Add standalone createWallet and refreshSessionKeyTtl sections to docs/sdk-wrappers.md - Add AncoreClient.createWallet and AncoreClient.refreshSessionKeyTtl to docs/api-reference.yaml
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
2 participants
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
Closes #1272
This PR documents the two exported
AncoreClientmethods that were missing fromdocs/sdk-wrappers.mdanddocs/api-reference.yaml:AncoreClient.createWallet(params?: CreateWalletParams): Promise<CreateWalletResult>AncoreClient.refreshSessionKeyTtl(params: RefreshSessionKeyTtlParams, options?: RefreshSessionKeyTtlOptions): InvocationArgs | Promise<RefreshSessionKeyTtlResult>Changes
client.createWalletandclient.refreshSessionKeyTtlunderAncoreClientindocs/sdk-wrappers.mdfollowing the exact pattern ofclient.addSessionKeyandclient.revokeSessionKey.createWalletandrefreshSessionKeyTtl.CreateWalletParams,CreateWalletResult,RefreshSessionKeyTtlParams,RefreshSessionKeyTtlOptions,RefreshSessionKeyTtlResult), validation rules, error tables, and TypeScript code examples.docs/api-reference.yamlmachine-readable spec with the method definitions.Verification
node scripts/validate-doc-links.js: Passed with 0 errors.node scripts/check-docs-repo-structure.mjs: In sync.