Skip to content

docs: Fix Node SDK README and guide samples that fail to compile or run - #350

Open
promptless[bot] wants to merge 1 commit into
mainfrom
promptless/sdk-docs-review
Open

promptless[bot] wants to merge 1 commit into
mainfrom
promptless/sdk-docs-review

Conversation

@promptless

@promptless promptless Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

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 v2 branch whose code has since diverged from main (for example, renamed credential fields), instead of the current default branch.

Goal

  • docs/advanced_initialization.md: fix a multi-vault credentials example that fails validateSkyflowCredentials.
  • README.md and docs/api_reference.md: fix the argument shape for GetDetectRunRequest. Fix syntax errors in the deidentifyFile and getDetectRun code blocks and add a missing RedactionType import.
  • Repoint links from the stale v2 branch to main and fix a mislabeled sample link, correct the DetokenizeRequest description and the setSkyflowId requirement, and set the minimum Node.js version to v18 everywhere. The docs gave two different values, and v18 is what the dependencies in package-lock.json require.
  • docs/migrate_to_v2.md: add the V1 end-of-life date (October 31, 2026) already stated in the README, correct the InsertRequest parameter names, and put the stray credential-option comments into rendered text.
  • Not in this PR: the sample filename typo detokenzie-records.ts and the duplicate docs/auth_credentials.md.

Testing

  • Every corrected identifier, signature, default, version, and link target was checked against the SDK source, build files, and samples in this repository at the current main commit. Review comments on this PR link each correction to the source line that supports it.
  • No SDK code, samples, or build files changed. Builds, tests, and installers were not run.
  • Vale prose checks report no new findings in the changed passages.

Trigger Events

Comment thread README.md
@github-actions

Copy link
Copy Markdown

✅ Gitleaks Findings: No secrets detected. Safe to proceed!

Comment thread README.md
Comment thread samples/README.md
@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

Comment thread README.md
Comment thread README.md
Comment thread docs/advanced_initialization.md
Comment thread README.md
Comment thread docs/api_reference.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread docs/api_reference.md
Comment thread docs/migrate_to_v2.md
Comment thread docs/migrate_to_v2.md
Comment thread docs/migrate_to_v2.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants