SK-2813: Fix and clean up SDK sample files#243
Open
saileshwar-skyflow wants to merge 1 commit into
Open
Conversation
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
1 participant
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.
Why:
The sample files had several issues that would confuse or break a developer following them:
'SKYFLOW_ID2'instead of'<SKYFLOW_ID2>'), making them look like real values.deidentify_file.pyhad a file handle resource leak —open()was called without a context manager, leaving the handle open if the API call threw an error.credentials_options.pyhad a mismatched vault ID —.vault('YOUR_VAULT_ID')didn't match the configured primary vault ID'YOUR_VAULT_ID1'.signed_token_generation_example.pyhad incorrect API usage — unpackinggenerate_signed_data_tokensastoken, signed = ...only works for one token, but the example passed two tokens.deidentify_file_async.pyhad extra indentation on two parameters inside the request constructor.Outcome:
All six sample files are corrected, consistent, and copy-pasteable. A developer following any sample will get working code without silent failures or confusing placeholder formats. No README changes were needed — it was already accurate.