Skip to content

SK-2706: fix README/samples gaps and add API reference doc - #196

Merged
saileshwar-skyflow merged 1 commit into
mainfrom
saileshwar/SK-2706-fix-readme-samples-gaps
Jun 10, 2026
Merged

saileshwar-skyflow merged 1 commit into
mainfrom
saileshwar/SK-2706-fix-readme-samples-gaps

Conversation

@saileshwar-skyflow

@saileshwar-skyflow saileshwar-skyflow commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Why

  • README fixes: Correct DetokenizeRequest, UpdateRequest, and GetRequest/GetOptions code blocks to match actual struct definitions; fix WithVaultConfigWithVaults in the custom headers example
  • README additions: Add field tables for InsertOptions, DetokenizeOptions, GetOptions; add Client management section (13 Skyflow instance methods); add SkyflowError methods table; add MaskingMethod and DetectOutputTranscriptions enum docs
  • Sample fix: signed_token_generation.go — pass credString (not filePath) to GenerateSignedDataTokensFromCreds
  • New doc: docs/api_reference.md — full Go SDK v2 API reference covering client methods, config classes, all request/response/options structs, helper types, enums, service account utilities, and error handling; mirrors the Java SDK's docs/api_reference.md structure

- Fix DetokenizeRequest code blocks to use DetokenizeData struct
- Fix UpdateRequest to use Data map instead of Id/Values
- Fix GetRequest/GetOptions: move ColumnName/ColumnValues to GetOptions
- Fix WithVaultConfig → WithVaults in custom headers example
- Add InsertOptions, DetokenizeOptions, GetOptions field tables
- Add Client management section with all 13 Skyflow instance methods
- Add SkyflowError methods table and MaskingMethod/Transcription enums
- Fix signed_token_generation.go: pass credString not filePath to GenerateSignedDataTokensFromCreds
- Add docs/api_reference.md covering full Go SDK v2 public API surface

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown

GoSec Findings: No issues found, Good to merge.

@github-actions

github-actions Bot commented Jun 9, 2026

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.

@saileshwar-skyflow
saileshwar-skyflow merged commit c121ec3 into main Jun 10, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants