aadarsh-st/SK-2812: Public Interface Cleanup#309
Merged
Conversation
removeComments:true stripped @deprecated/@internal JSDoc from .d.ts files, so api-extractor couldn't read them — generating a report that differed from the committed snapshot. Set removeComments:false so JSDoc annotations are preserved in compiled output and api-extractor produces a consistent report across local and CI builds. Also update test to match enumerable:true on the request_ID deprecated alias. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Previous snapshot was generated with removeComments:false, causing CI mismatch. Regenerated with removeComments:true to match CI build output. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
skyflow-bharti
approved these changes
May 20, 2026
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
2 participants
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.
Summary
SK-2812: Public interface cleanup — standardizes naming conventions, adds deprecation warnings for renamed APIs, and improves internal code quality.
Naming convention changes (camelCase standardization)
Deprecated (old) | New -- | -- request_ID | requestId skyflow_id (response) | skyflowId clientID | clientId keyID | keyId tokenURI | tokenUri roleIDs | roleIds setDownloadURL() / getDownloadURL() | setDownloadUrl() / getDownloadUrl()All old names still work but emit a
[DEPRECATED]warning at runtime. Will be removed in v3.FileUpload API change
FileUploadRequest(table, skyflowId, columnName)constructor deprecated — useFileUploadRequest(table, columnName)+FileUploadOptions.setSkyflowId(skyflowId)instead.Other improvements
service-accountJWT generation: usesclientId,keyId,tokenUriconsistently; addednormalizeTokenOptionsfor backward compatwarn-onceutility to suppress repeated deprecation log spamvalidateInsertInput,validateDetokenizeInput