Skip to content

SK-2709: Fix Gaps in readme and samples#336

Open
aadarsh-st wants to merge 2 commits into
mainfrom
aadarsh-st/SK-2709-fix-gaps-in-readme-and-samples
Open

SK-2709: Fix Gaps in readme and samples#336
aadarsh-st wants to merge 2 commits into
mainfrom
aadarsh-st/SK-2709-fix-gaps-in-readme-and-samples

Conversation

@aadarsh-st
Copy link
Copy Markdown
Collaborator

Summary

README.md Changes

New controller references (named + method tables)

  • VaultController — insert, detokenize, tokenize, get, update, delete, query, uploadFile
  • ConnectionController — invoke()
  • DetectController — deidentifyText, reidentifyText, deidentifyFile, getDetectRun

New response type references

  • DetokenizeRecordResponse — getToken(), getValue(), getType(), getError(), getRequestId() + iteration example
  • EntityInfo, TextIndex, FileEntityInfo, FileInfo — full method reference in new "Detect response types" section

New request/data type references

  • DetokenizeData — constructor variants + getToken(), getRedactionType()
  • ColumnValue — builder pattern + getValue(), getColumnGroup()
  • AudioBleep — builder pattern + frequency, gain, startPadding, stopPadding

New enum documentation

  • TokenType — VAULT_TOKEN, ENTITY_UNIQUE_COUNTER, ENTITY_ONLY with usage example
  • DeidentifyFileStatus — IN_PROGRESS, SUCCESS, FAILED, UNKNOWN with polling example
  • DetectOutputTranscriptions — TRANSCRIPTION, DIARIZED_TRANSCRIPTION, MEDICAL_TRANSCRIPTION, MEDICAL_DIARIZED_TRANSCRIPTION

New Client Management section

  • addVaultConfig, getVaultConfig, updateVaultConfig, removeVaultConfig
  • addConnectionConfig, getConnectionConfig, updateConnectionConfig, removeConnectionConfig
  • updateSkyflowCredentials, updateLogLevel, getLogLevel

Other

  • Credentials.setContext() — note added in Initialize client section (supports String and Map<String, Object>)
  • Table of Contents updated to reflect all new sections

samples/ Changes

  • detect/ReidentifyTextExample.java (NEW) — fixes broken README link; full example with plainTextEntities, maskedEntities, redactedEntities options
  • vault/DetokenizeExample.java (UPDATED) — added DetokenizeRecordResponse iteration pattern as commented example; all RedactionType variants documented
  • vault/GetExample.java (UPDATED) — split into 3 examples (by Skyflow ID / returning tokens / by column value); added commented options for fields, offset, limit, orderBy, returnTokens, downloadURL

Intentionally Excluded

AuditController, BinLookupController and their associated types (ListEventRequest, ListEventResponse, GetBinRequest, GetBinResponse) were flagged in the gap analysis but are not documented here.

Reason: These SDK wrapper classes are incomplete stubs — methods return null, request/response types have no fields, and neither controller is accessible through the main Skyflow client (no skyflowClient.vault().audit() or .binLookup() entry point exists). The underlying REST API is fully implemented in the auto-generated layer. Documentation will be added once the SDK wrappers are complete and wired into the client.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 2, 2026

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 2, 2026

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 3, 2026

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 3, 2026

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

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.

1 participant