Repository navigation
docs: Fix Node SDK README and guide samples that fail to compile or run - #350
Open
promptless[bot] wants to merge 1 commit into
Open
promptless[bot] wants to merge 1 commit into
promptless[bot] wants to merge 1 commit 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. |
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
Several Node SDK code samples have syntax errors or call constructors the wrong way, so they fail to compile or throw at runtime. Some links point at a long-stale
v2branch whose code has since diverged frommain(for example, renamed credential fields), instead of the current default branch.Goal
docs/advanced_initialization.md: fix a multi-vault credentials example that failsvalidateSkyflowCredentials.README.mdanddocs/api_reference.md: fix the argument shape forGetDetectRunRequest. Fix syntax errors in thedeidentifyFileandgetDetectRuncode blocks and add a missingRedactionTypeimport.v2branch tomainand fix a mislabeled sample link, correct theDetokenizeRequestdescription and thesetSkyflowIdrequirement, and set the minimum Node.js version to v18 everywhere. The docs gave two different values, and v18 is what the dependencies inpackage-lock.jsonrequire.docs/migrate_to_v2.md: add the V1 end-of-life date (October 31, 2026) already stated in the README, correct theInsertRequestparameter names, and put the stray credential-option comments into rendered text.detokenzie-records.tsand the duplicatedocs/auth_credentials.md.Testing
maincommit. Review comments on this PR link each correction to the source line that supports it.Trigger Events