Skip to content

docs: Fix Java SDK broken sample links, stale version, and samples README - #441

Open
promptless[bot] wants to merge 2 commits into
mainfrom
promptless/sdk-docs-review
Open

promptless[bot] wants to merge 2 commits into
mainfrom
promptless/sdk-docs-review

Conversation

@promptless

@promptless promptless Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Open in Promptless

Why

Splitting the repo into common/, skyvault/, and flowvault/ (b3cf737) left many links pointing at root-level samples/, src/, and README.md paths that no longer exist. The install snippet also pins an old version.

Goal

  • skyvault/README.md: point 24 broken sample and source links at their current skyvault/ and common/ paths. Change the install version from 2.0.0 to 2.1.1 to match skyvault/pom.xml and add a Maven Central pointer.
  • docs/api_reference.md and docs/migrate_to_v2.md: link to skyvault/README.md instead of the root README, which is now a package picker.
  • skyvault/samples/README.md: rewrite it to describe the samples that exist now.
  • flowvault/README.md: add a minimal bulkInsert call to the Quickstart, which previously built a client and never used it.
  • Not in this PR: the InsertRequest.homogeneous default versus its behavior on batch requests needs a product decision, and the SDK versions in the samples' pom.xml files are stale.

Testing

  • Every corrected identifier, signature, default, version, and link target was checked against the SDK source, build files, and samples in this repository at the current main commit. Review comments on this PR link each correction to the source line that supports it.
  • No SDK code, samples, or build files changed. Builds, tests, and installers were not run.
  • Vale prose checks report no new findings in the changed passages.

Trigger Events

Comment thread docs/migrate_to_v2.md
@github-actions

Copy link
Copy Markdown

✅ Gitleaks Findings: No secrets detected. Safe to proceed!

Comment thread docs/api_reference.md
Comment thread skyvault/README.md
Comment thread skyvault/README.md
@github-actions

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.

@codecov

codecov Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.00%. Comparing base (e210d03) to head (58e55bf).

Additional details and impacted files
@@            Coverage Diff             @@
##               main     #441    +/-   ##
==========================================
  Coverage     91.00%   91.00%            
- Complexity        0      545   +545     
==========================================
  Files           174      174            
  Lines          7350     7350            
  Branches       1013     1013            
==========================================
  Hits           6689     6689            
  Misses          437      437            
  Partials        224      224            
Flag Coverage Δ
common 89.45% <ø> (ø)
flowvault 87.93% <ø> (ø)
skyvault 94.85% <ø> (ø)
unittests-flowvault 89.45% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
Module: common 89.45% <ø> (ø)
Module: skyvault 94.85% <ø> (ø)
Module: flowvault 87.93% <ø> (ø)
Service Account 87.36% <ø> (ø)
Vault Data 90.81% <ø> (ø)
Vault Tokens 99.03% <ø> (ø)
Vault Connection 100.00% <ø> (ø)
Vault Controller 82.75% <ø> (ø)
Detect 100.00% <ø> (ø)
Audit 100.00% <ø> (ø)
BIN Lookup 100.00% <ø> (ø)
Config 96.26% <ø> (ø)
Utils 90.41% <ø> (ø)
Errors 100.00% <ø> (ø)
Enums 100.00% <ø> (ø)
Logs 95.60% <ø> (ø)

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e210d03...58e55bf. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

Copy link
Copy Markdown

✅ Gitleaks Findings: No secrets detected. Safe to proceed!

Comment thread skyvault/README.md
@github-actions

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.

Comment thread skyvault/README.md
Comment thread skyvault/README.md
Comment thread skyvault/README.md
Comment thread flowvault/README.md
Comment thread skyvault/samples/README.md
Comment thread skyvault/samples/README.md
Comment thread skyvault/samples/README.md
Comment thread skyvault/samples/README.md
Comment thread skyvault/samples/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants