SK-2709: Fix Gaps in readme and samples#336
Open
aadarsh-st wants to merge 2 commits into
Open
Conversation
|
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
|
Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging. |
|
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
|
Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging. |
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
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
README.md Changes
New controller references (named + method tables)
New response type references
New request/data type references
New enum documentation
New Client Management section
Other
samples/ Changes
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.