SK-3028: address review feedback on FlowVault README - #190
Merged
saileshwar-skyflow merged 1 commit intoJul 31, 2026
Merged
Conversation
- Rebuild Table of Contents with all sections + subsections (numbered) - Add Quick Start (collect + reveal round trip), mirroring iOS structure - Add Reporting a Vulnerability section (was missing) - Fix init/initialize inconsistency: all samples now use Skyflow.init - Installation: fix typos, add note explaining why a GitHub PAT is needed - Correct getAccessToken -> getBearerToken in TokenProvider prose - Collect: mark tableName/column as required (SDK enforces both), 8 types (was 5), "parameters" -> "fields" - Fix Kotlin colon-in-value bugs in collect/composable/reveal examples (required: true -> required = true, Options(logLevel: ...) -> =, etc.) - Rewrite reveal RevealElementOptions examples: remove Swift leaks (let/input:), use valid Kotlin - Add UpdateType.REPLACE worked example for full-row overwrite - Fix context = Context -> context = this across all create() samples Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
saileshwar-skyflow
force-pushed
the
saileshwar/SK-3028-update-flow-vault-readme
branch
from
July 31, 2026 11:22
d0581cc to
dffe170
Compare
saileshwar-skyflow
changed the title
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
1 participant
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
Addresses the PM's inline review comments on the FlowVault README (Confluence draft). All changes are documentation-only (
README.md).initvsinitialize— all samples now useSkyflow.init(the actual SDK function);initializedoesn't existgetAccessToken→getBearerToken(matched the code sample + iOS)tableName/columnmarked required (the SDK throwsMISSING_TABLE_IN_ELEMENT/MISSING_COLUMNotherwise); "8 types" (was "5"); "parameters" → "fields"required: true→required = true,Options(logLevel: …)→=) that wouldn't compile if copy-pastedlet element = …,input:) and rewrote as valid KotlinUpdateType.REPLACE— added a worked full-row-overwrite example (only.UPDATEwas shown)context = Context→context = thisacross allcreate()samplesNote on stacking
This branch is stacked on top of the SK-3004 SDK work (
table→tableNamerename + CVV mock, PR #189) because the README'stableNamedocumentation depends on that rename. Until #189 merges intorelease/26.7.0, this PR's diff will also show those 2 commits. Merge #189 first, then this shows README-only.Not changed (by decision)
<REDACTION_TYPE>left as a free-form string placeholder — Android takes aString, not an enum (unlike iOS)🤖 Generated with Claude Code