chore: add docs on Key Provider API Spec#209
Open
pranishnepal wants to merge 1 commit into
Open
Conversation
This commit adds documentation for the Key Provider API Spec, including details on the endpoints, request/response formats, and error handling. Additionally, updates the README.md to document how the SIGNING_MODE environment variable works. Ticket: WCN-399
Comment on lines
+249
to
+254
| solUserKey: | ||
| summary: Generate SOL user key (EdDSA) | ||
| value: | ||
| coin: 'sol' | ||
| source: 'user' | ||
| type: 'independent' |
Contributor
There was a problem hiding this comment.
this doesnt support mpc
| - Key Management | ||
| summary: Generate a key pair | ||
| description: | | ||
| Generate a new key pair in your KMS/HSM provider. |
Contributor
There was a problem hiding this comment.
imp to clarify this is for multisig keys only
| - Key Management | ||
| summary: Sign a transaction or message | ||
| description: | | ||
| Sign data using a private key stored in your KMS/HSM provider. |
Contributor
There was a problem hiding this comment.
lets clarify only applicable for multisig wallets
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.
What
This PR adds documentation for the Key Provider API Spec, including details on the endpoints, request/response formats.
Additionally, updates the README.md to document how the
SIGNING_MODEenvironment variable works.Ticket: WCN-399
Testing
npx @apidevtools/swagger-cli validate