Repository navigation
docs: Fix skyflow-js and flowvault-js README code samples and sample run steps - #742
Open
promptless[bot] wants to merge 2 commits into
Open
promptless[bot] wants to merge 2 commits into
promptless[bot] wants to merge 2 commits into
Conversation
|
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
|
Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging. |
…eview # Conflicts: # packages/skyflow-js/README.md
|
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
|
Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging. |
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
Why
The JS SDK READMEs have samples that throw or are silently ignored, invalid JSON response examples, and Flow vault parameters marked optional even though validation requires them.
Goal
packages/skyflow-js/README.md: fix 16 instances ofinputstylestoinputStyles, because the SDK silently ignores the lowercase key. Changeskyflow.*toskyflowClient.*in 5 calls that reference an undefined variable. Fix two broken code blocks and thedelete()example and response. Correct thesetError()signature. AddMULTI_FILE_INPUTto the element types.packages/skyflow-flowvault-js/README.md: marktableNameandcolumnas required in the four create-element sections, because the shared core validation requires them.packages/skyflow-js/samples/README.md: rewrite the broken "Using npm" run instructions from each sample'spackage.json.package.jsonfiles.Testing
maincommit. Review comments on this PR link each correction to the source line that supports it.Trigger Events