Skip to content

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

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

promptless[bot] wants to merge 5 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 Resolved
@github-actions

Copy link
Copy Markdown

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

Comment thread docs/api_reference.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
@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 92.38%. Comparing base (04e1b9a) to head (e67ae6f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #441   +/-   ##
=======================================
  Coverage   92.38%   92.38%           
=======================================
  Files         249      249           
  Lines        8799     8799           
  Branches     1268     1268           
=======================================
  Hits         8129     8129           
  Misses        446      446           
  Partials      224      224           
Flag Coverage Δ
common 92.65% <ø> (ø)
flowvault 91.54% <ø> (ø)
skyvault 93.77% <ø> (ø)

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

Components Coverage Δ
Module: common 92.65% <ø> (ø)
Module: skyvault 93.77% <ø> (ø)
Module: flowvault 91.54% <ø> (ø)
Service Account 87.76% <ø> (ø)
Vault Data 92.89% <ø> (ø)
Vault Tokens 99.08% <ø> (ø)
Vault Connection 100.00% <ø> (ø)
Vault Controller 82.78% <ø> (ø)
Detect 99.42% <ø> (ø)
Audit 100.00% <ø> (ø)
BIN Lookup 100.00% <ø> (ø)
Config 96.26% <ø> (ø)
Utils 91.72% <ø> (ø)
Errors 100.00% <ø> (ø)
Enums 99.02% <ø> (ø)
Logs 100.00% <ø> (ø)

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 04e1b9a...e67ae6f. 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 Resolved
@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 Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread flowvault/README.md Resolved
Comment thread skyvault/samples/README.md Resolved
Comment thread skyvault/samples/README.md Resolved
Comment thread skyvault/samples/README.md Resolved
Comment thread skyvault/samples/README.md Resolved
Comment thread skyvault/samples/README.md Resolved
…eview

# Conflicts:
#	docs/api_reference.md
#	skyvault/README.md
#	skyvault/samples/README.md
@github-actions

Copy link
Copy Markdown

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

@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.

@promptless

promptless Bot commented Nov 11, 2026

Copy link
Copy Markdown
Author

I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed.

@github-actions

Copy link
Copy Markdown

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

@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.

@github-actions

Copy link
Copy Markdown

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

@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.

@promptless

promptless Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Author

Blocked — one thing needed from you

The Check Commit Message check failed on commit e67ae6f because of how this suggestion's commits were written, not because of the docs content or main. The check (.github/workflows/pr.yml) requires a Jira key such as SK-1234 in every commit message on the PR. Four Promptless commits don't have one, and neither does the PR title. Merge commits are allowed. No ticket is linked to this docs work, so we didn't pick one.

Need: The Jira ticket key this docs work should use. Reply in a comment on this PR.

Next: We'll add the key to the PR title, replace the branch history with a single commit that starts with the key, and force-push the branch. The file contents stay the same, and the check should pass after that.

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