Repository navigation
SK-3223 Add Flow Vault Go SDK README and update v2 Env docs - #206
Draft
promptless[bot] wants to merge 2 commits into
Draft
promptless[bot] wants to merge 2 commits into
promptless[bot] wants to merge 2 commits into
Conversation
Author
|
I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed. |
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.
Open in Promptless
Adds the reference README for the Flow Vault Go SDK introduced in #205 (stacked on #203), and updates the v2 docs for the shared
Envchange in that PR.Why
flowvaultmodule with nine operations, but its only docs are the samples README. The PR listsflowvault/README.mdas a follow-up.common/config.Envnow starts at 1, so the zero value means "not set" and resolves toPROD.UpdateVaultConfignow keeps the currentEnvwhen an update doesn't set one.Goal
flowvault/README.md: install (including the localreplaceuntil the module is published), quickstart, credentials, client and vault configuration, one section per operation (Insert, Update, Get, Delete, Detokenize, GetTokens, Query, UploadFiles, DeleteFiles), timeouts and retries, per-call headers throughInterceptor, client management, and per-record and whole-call error handling. The structure follows the Python Flow Vault README.samples/flowvault/README.md: links to the new README.README.mdanddocs/api_reference.md(v2):UpdateVaultConfigchanges only theClusterId,Env, andCredentialsyou set. An unsetEnvresolves toPROD, and the README no longer callsDEVthe default.Testing
main, so they resolve only after the stack merges.Trigger Events