Skip to content

fix(load-capture): correct docs and document file endpoints - #7919

Open
philjb wants to merge 3 commits into
masterfrom
pjb/fix-loadcap-docs-accuracy
Open

philjb wants to merge 3 commits into
masterfrom
pjb/fix-loadcap-docs-accuracy

Conversation

@philjb

@philjb philjb commented Oct 19, 2026

Copy link
Copy Markdown
Contributor
  • Corrected the anonymization claims on the Load Capture admin page: numeric and boolean query literals are preserved, not anonymized.
  • Fixed the prerequisites callout: load capture needs the upgraded storage engine, now the default for new clusters, not a --use-pacha-tree preview flag to enable.
  • Removed a dead link to a since-removed performance-preview page and a duplicate note that said the same thing twice.
  • Synced the OpenAPI descriptions for the load capture endpoints with the same storage-engine wording.
  • Added the two missing OpenAPI endpoints for listing a profile's files and downloading a single file by name.

The anonymization section said query literals get anonymized, but
numeric and boolean query literals are preserved, same as the
corresponding write-data values--the doc overstated what gets scrubbed.

The prerequisite callout described `--use-pacha-tree` as a preview flag
to enable. The upgraded storage engine load capture requires is now the
default for new clusters; older clusters migrate with
`--upgrade-pacha-tree`. Reworded the callout and dropped a duplicate,
already-correct note that said the same thing twice.

Also removed a dead link to a since-removed performance-preview page,
and synced the OpenAPI descriptions for the load capture endpoints with
the same storage-engine wording so the generated API reference agrees
with the admin page.
The load capture API reference covered list/start/preview/download/delete
but not the two endpoints that list a profile's files and download a
single file by name--both live and already used by the `loadcap files`
CLI command. Observed on the running server:

  GET /api/v3/loadcap/profiles/{profile_id}/files
  GET /api/v3/loadcap/profiles/{profile_id}/files/{filename}
@philjb
philjb requested a review from a team as a code owner October 19, 2026 19:09
@philjb
philjb requested review from jstirnaman and removed request for a team October 19, 2026 19:09
@github-actions

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 0

✅ Check passed

@github-actions github-actions Bot added the product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable) label Oct 19, 2026
@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

🔗 Link Check Results — Link Check Bot

✅ All links are valid

Metric Value
Files Checked 1
Total Links 509
Errors 0
Warnings 2
Success Rate 99.21414%
⚠️ 2 warning(s) (do not fail CI)
Source File URL Issue
content/influxdb3/enterprise/admin/load-capture/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb3/enterprise/api/load-capture File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb3/enterprise/admin/load-capture/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…

Full details: workflow run summary and artifact. Last updated: 2026-10-19 19:28:59 UTC

@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED (full site)
Preview View preview
Build time 110s
Last updated 2026-10-19 19:32:42 UTC
Changed pages (1)

Preview auto-deploys on push. Will be cleaned up when PR closes.
The preview's deployed-commit meta tag names GitHub's temporary merge commit for this PR, not a commit on the PR branch.

Dropped a sentence that only restated the "Inspect before you share"
section heading. Narrowed "the downloaded profile" to "the profile"--
the anonymization key is absent from the profile regardless of whether
it has been downloaded yet.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant