Repository navigation
sync(api): update InfluxDB Cloud v2 spec - #7841
Closed
github-actions[bot] wants to merge 43 commits into
Closed
github-actions[bot] wants to merge 43 commits into
github-actions[bot] wants to merge 43 commits into
Conversation
github-actions
Bot
added
product:v2-cloud
github-actions
Bot
requested review from
jstirnaman
and removed request for
a team
October 5, 2026 07:11
github-actions
Bot
added
product:v2-cloud
Merged
1 of 3 tasks
What changed: the documented default of `--compaction-cleanup-wait` is now `1h` instead of `10m`. Why: InfluxDB 3 Enterprise changed the default from `10m` to `1h` in v3.4.2 (influxdata/influxdb_pro#1300), and every release since uses `1h`. The docs still showed the old value, so anyone who copies the documented default runs with a much shorter wait than the product uses. The wait is the time query nodes have to move to newly compacted files before the compactor deletes the files they replace. Impact: documentation only. Verification: checked the `default_value` of `--compaction-cleanup-wait` in influxdb_pro at v3.4.2, v3.5.0 to v3.12.0 and main (`1h`), and at v3.0.3 to v3.4.1 (`10m`).
…ning example What changed: the "Tune compaction parameters" example in the clustering guide no longer sets `--compaction-cleanup-wait=10m`. Why: the cleanup wait does not change how compaction runs or what it costs. It only sets how long the compactor keeps the files a compaction replaced before it deletes them. A shorter wait gives query nodes less time to move to the new files, so a query node that falls behind can fail queries with "file not found" errors. It does not belong in an example about balancing compaction performance and resource usage, and `10m` is a sixth of the `1h` default. Impact: documentation only. Verification: the example's last line no longer ends with a line continuation.
…loud
What changed: The Cloud influx setup note now explains the reason. Every Cloud account already has a user and organization, so GET /api/v2/setup returns {"allowed": false}, and the command exits with "instance has already been set up". The note links to the Cloud setup endpoint.
Why: The note said only that the command doesn't work with Cloud, and the Cloud API reference documents the setup endpoint
without a caveat.
Impact: The InfluxDB Cloud influx setup page only.
Verification: GET /api/v2/setup on a production Cloud 2 org returned {"allowed": false}. influx-cli clients/setup/setup.go checks this endpoint first and returns ErrAlreadySetUp. Code-block lint and link checks pass.
jstirnaman
marked this pull request as draft
October 9, 2026 16:36
Adds installation and startup scripts to prepare cloud environments for web UI development. Add sourceable shell configuration with persistent dependency, Cypress, and Hugo caches, plus installation and readiness scripts. Add a Hugo preview on port 1315 and local and HTTPS Chromium smoke checks that retain certificate verification and browser web security. Add a proxy CA import script and check that Chromium can write to its NSS database. Keep the allowlist JSON as a manual reference. Document host discovery, publishing, and verification in a new session. Record live submission and conversation history testing lessons in the README and the openai-cloud-ui skill.
github-actions
Bot
force-pushed
the
sync/openapi-cloud-v2-spec
branch
from
October 12, 2026 07:14
031097b to
f66f120
Compare
What changed: Rewrite root-relative anchors after preview builds, validate internal link paths, and prefix the format selector's generated MCP link. Add CLI regression tests and Cypress browser coverage. Why: Root-relative links bypass Hugo's baseURL subpath and leave the PR preview when followed. Impact: Preview content and navigation links stay within their PR path. Production builds keep their existing behavior. Verification: Full production Hugo build with the preview baseURL passed. Validated 2,576,979 internal links across 6,136 HTML files. Nine CLI tests passed. Chromium verified 443 internal links and content navigation. Cypress execution was blocked by missing Xvfb in the local environment.
…7877) What changed: Clarify watcher-only stub touches in canonical agent instructions and contributor guidance. Why: Shared body edits need no stub changes for fresh builds or CI; preserve consumer review and correct docs edit claims. Impact: Documentation only. Generated adapters remain pending at the user's request. Verification: git diff --check passed; changed-file verifier plan reviewed. Required adapter, lint, and link checks remain pending due to missing dependencies. Refs #7863
State that customers cannot access or use the InfluxDB 3 Cloud operator token in the token overview and CLI reference. Verification: git diff --check passed; reviewed both changes. Local code-block lint, Vale, Hugo, and link checks remain unavailable because dependencies or tools are missing.
What changed: - Retire a plugin only when every published registry version has yanked: true. - Omit retired plugins from generated data and prune their shared page and Core and Enterprise stubs, with dry-run previews and per-file summary details. - Use the same retirement decision for coverage and record the rationale in an execution plan. - Add registry classification and full-sync CLI regression tests. Why: - A missing README can indicate an incomplete upstream checkout. The registry's all-versions-yanked status expresses the retirement intent proposed in #7854. Checking every version prevents a yanked latest release from retiring a plugin that still has an active older release.
- create token --admin: describe --host and --token for a Cloud instance instead of a local server with a 127.0.0.1:8181 default - setup: point to the Admin UI at console.influxdata.com - users: document changing a user's roles and removing a user, replacing the TODO Co-Authored-By: Claude
* docs(influxdb3-cloud): reconcile console token and CLI guidance What changed: Apply the Cloud documentation draft patch across token management, user management, the administrator token CLI reference, and setup guidance. Why: Align related pages with the console capabilities introduced in PR #7874 and clarify Cloud host and OAuth prerequisites. Impact: Document the instance Tokens page and role restriction, correct user-table columns, and clarify the removal confirmation. Verification: git apply --check and git diff --check pass. Hugo rendering and live Cloud UI/CLI/API verification have not run for this commit. * docs(influxdb3-cloud): preserve original file endings Remove extra trailing blank lines introduced while applying the draft patch. Verification: compare the resulting file contents with the patch applied to the original PR files.
## What changed Adds v3.12.1, v3.11.7, and v3.11.6 entries to the shared Core and Enterprise release notes, and updates the reference docs to match: - `config-options.md` and `storage-engine-config-options.md`: the `--file-cache-size` hard limit note now starts at v3.11.6, and says that before v3.12.1 JSON, JSON Lines, and CSV responses return 200 and end early instead of returning 429. - `config-options.md`: from v3.12.1, only query-mode nodes load the compacted data file index. - `storage-engine-config-options.md`: adds `--compactor-import-batch-size`. - `query-system-data`: `system.pt_ingest_files` lists only the newest manifest's files after a restart from v3.12.1. - v3.12.0 entry: fixes the `--datafusion-config` override example, which takes `key:value`, not `key=value`. ## Why Sources in influxdb_pro: - v3.11.6: `v3.11.5..v3.11.6`, tagged 2026-10-05 in influxdb_pro and influxdata/influxdb. - v3.11.7: `v3.11.6..origin/3.11` through 0bb9ab5e1c. Not tagged yet. - v3.12.1: `v3.12.0..origin/3.12` through f52d35fadb. Not tagged yet. v3.11.6 and v3.12.0 fail to load catalogs with repeated automatically generated field family names, written by Core before v3.10.0 or Enterprise before v3.9.0. v3.11.7 and v3.12.1 fix it. Left out of the notes: the operator socket on Core (hidden, feature-gated flag), the token display panic fix (no shipped release writes an unknown system resource identifier), the `TrackedBytes` performance change, the `/metrics` scrape panic, and WAL size logging. `influxdb3 debug catalog repair` and the distinct value cache `max_age` fix are in v3.11.6 but not on the 3.12 branch, so v3.12.1 does not claim them. ## Impact `latest_patch` stays at 3.12.0 for Core and Enterprise until v3.12.1 tags exist. The v3.12.1 and v3.11.7 dates (2026-10-12) assume release on that day. ## Verification Each bullet was checked against source at the previous tag and the release ref, then reviewed adversarially by two independent passes. A 37-marker presence check across v3.11.5, v3.11.6, origin/3.11, v3.12.0, and origin/3.12 confirmed the version each change belongs to. `yarn lint-codeblocks` could not run locally (ERR_MODULE_NOT_FOUND); no code blocks were added. No Hugo build or link check was run. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015vgYzDBv5Cuz6s6Q9y9wY6
What changed: apply repository formatting to the resumable ToC checkpoint and pending handoff test. Why: retain formatter output in the pushed branch. Impact: behavior and pending verification remain unchanged. Verification: Markdown formatting checked with the pinned Remark tool; staged hooks run on this commit.
What changed: Add shared article/API navigation, the composer and unified widget lifecycle, and a scoped nonmodal desktop adapter. Why: Keep article navigation usable beside chat and preserve drafts across widget failures. Impact: Desktop chat reserves a separate column; narrow layouts retain modal behavior. Preserve widget configuration and API anchors. Verification: Production Hugo build, 15 Cypress tests, three native browser tests, TypeScript, and targeted ESLint pass. Real answer and retained history checks are deferred to a new environment session.
What changed: Add theme colors, rounded corners, a chevron, hover and focus states, and a subtle drawer border and shadow. Why: The default browser button and uncolored border clash with the site UI. Impact: Styles only; heading navigation and responsive behavior stay intact. Verification: Hugo testing build passed. Chromium checks passed in light and dark themes for hover, keyboard focus, toggle, Escape, narrow-screen overflow, and desktop visibility. Screenshots reviewed at the reported tablet width.
What changed: Give the header Ask AI button independent flex alignment. Preserve right alignment in the narrow-screen column layout. Why: Opening the product selector stretched the button to the menu height. Impact: Header alignment only; product selection and chat behavior are unchanged. Verification: Reproduced 32px to 800px growth before the fix. Hugo rebuilt successfully. Chromium checks passed on home and article pages at 375px, 1032px, and 1440px in both themes; button height stays 27px or 32px.
What changed: Replace the two navigation and Ask AI plan files with ADR 0008. Update the product spec status and decision-record link. Why: Preserve the major decisions and turning points without stale execution steps, checkpoint logs, or duplicated plans. Impact: Documentation only; the product spec remains the behavior reference. Verification: Prettier, relative file links, and whitespace checks pass. Vale reports no errors and one spelling warning for the vendor name Kapa.
What changed: Keep the selected ToC entry active while the page scrolls to it. The component pins the clicked fragment until the page arrives and releases it as soon as the page moves away from the target or settles short of it. Render the narrow-screen toggle in the page-toc partial with a Lucide panel-right-open icon, shown alone in the collapsed state below 600px, and extract the Lucide SVG rendering from the shortcode into a cached partial. Below 1280px the fixed rail follows the page scroll up to a 2rem floor: CSS owns the per-breakpoint start offsets and the clamp, and the component publishes the scroll offset. Restyle the rail and its toggle with an uppercase label, body background, softer border and shadow, and an indicator bar on the active entry. Widen the article padding and radius, pin a gradient Ask AI button to the header on phones, and comment out the Feature Board sidebar link for InfluxDB 3 Core and Enterprise. Add a visually-hidden mixin behind .sr-only and the collapsed label. Why: The active entry flapped between headings during the click's smooth scroll. The collapsed toggle read as a second left-nav hamburger and covered article text on long reads. The rail and article styling needed to match the current design direction. Impact: Article and API pages below 1280px gain the scroll-following rail, and below 600px the collapsed toggle is icon-only. Desktop layout widths now derive from content rather than fixed pixel variables. The Lucide shortcode output is unchanged. The Feature Board link is hidden for InfluxDB 3 Core and Enterprise. Verification: Puppeteer unit tests cover the pinned entry, the rail's published offset, and the template toggle, and pass on repeated runs. Chromium checks against the dev server at 500px confirm the icon-only toggle, the rail reaching 32px after scrolling, and the drawer expanding. Full Hugo build, ESLint, Prettier, and tsc pass. The new Cypress case for the phone toggle runs in CI; it was not run locally. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
What changed: Track composer height for mobile widget placement and bottom content clearance. Hide footer controls during narrow modal chat and restore them on desktop or close. Restore the saved date picker selection and cancel stale modal animations before showing only the requested panel. Why: The timestamp widget overlapped the composer on phones, and rapid modal reopening could hide the date picker or leave two modal panels visible. Impact: Preserve timestamp replacement, saved preferences, and code controls. No shared-content eligibility change is needed. Verification: Add six Cypress tests for date replacement, repeated changes, copying updated code, reload persistence, modal switching, themes, textarea resizing, chat transitions, and pages without timestamp controls. All six pass. The existing five chat, 16 code-control, and 12 URL-selector tests pass on their latest runs. One initial chat test failed during announcement dismissal and passed on rerun. Hugo builds, TypeScript, formatting, and whitespace checks pass. ESLint has no errors and one existing long-comment warning. Browser screenshots and actual modal switching were checked with normal TLS and web security.
What changed: Wrap all write_lp precision examples in custom-timestamps. Replace fixed 2022 timestamp matching with per-wrapper calendar-day shifts. Use integer arithmetic to preserve seconds through nanoseconds, fractions, and relative dates. Exclude decimal fields and preserve component markup. Why: The Milliseconds tab was outside the date updater, and newer sample dates in the request body did not match the fixed seed list. The same gap affected all four precision tabs across Enterprise, Core, and Cloud. Impact: Date selections update every precision tab and the request-body sample without changing measurement values, placeholders, or samples outside wrappers. Verification: Reproduced failures on all three shared-page consumers. All ten widget Cypress tests, 12 rendering checks, and seven precision-value tests pass. Coverage includes all four tabs, repeated selections, result-table dates, unchanged long decimals, and exact microsecond/nanosecond fractions. Hugo, TypeScript, ESLint, formatting, code-block lint, and whitespace checks pass. The link-checker binary is unavailable; this change adds no links.
What changed: Remove the first-party composer and its spacing. Open the existing widget through the header, keyboard shortcuts, and prefill links. Preserve retry, source groups, navigation restoration, and focus, including narrow ToC keyboard entry. Update tests, the live probe, the specification, and ADR. Why: Preview feedback selected the header button as the chat entry point. The vendor widget already owns question entry and submission. Impact: Timestamp controls return to their usual corner. Page entry points do not submit questions and retain one widget instance for close and reopen. Verification: 45 Cypress checks and 9 unit tests pass. TypeScript, ESLint, formatting, and the production Hugo build and artifact checks pass. Live answer completion and history acceptance remain pending on required reCAPTCHA network access.
What changed: Move live widget layout and conversation checks into an opt-in Cypress spec. Add a dedicated command and remove the standalone Puppeteer probe. Why: The repository already uses Cypress for browser checks. One runner simplifies how we maintain the live and mocked coverage. Impact: The live spec checks Kapa's responsive layout, theme, question submission, answer completion, and retained history. It stays outside routine CI. Verification: ESLint, Node syntax, Prettier, and git diff checks pass. The live spec could not run because this environment blocks reCAPTCHA resources.
What changed: - Shift each custom-timestamps block from its most common day instead of its earliest day. - Format picked and default dates in local time with the date picker formatter instead of toISOString(). - Add unit tests for the anchor and repeated selections, and a Cypress test for the Cloud Serverless Telegraf block. Why: - Telegraf log lines dated 2023-05-31 anchored the Cloud Serverless Telegraf block, so its 2024-07-02 sample data landed about 398 days after the selected date and missed the tutorial's query range. - toISOString() converted local midnight to UTC, so readers east of UTC saved the day before the one they picked. Impact: - Sample data lands on the selected day when unrelated dates share a block. Log lines keep their offset from the data. Verification: - node --test custom-timestamp-values.test.mjs: 9 pass. - Playwright against hugo server (testing): the Telegraf block shows the selected day in UTC and Asia/Tokyo, and Tokyo saves the clicked day. Without the fix, the block misses the selected day and Tokyo saves the previous day. The Cypress binary could not be downloaded here, so the new Cypress test has not run. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018NiFuxdSqYvtMpAhNfWBbM
What changed: - Remove comments from the custom timestamp module, its value helpers, and their unit tests. - Rename sampleDay to earliestMostCommonDay and make the tie-break an explicit sort. - Rename formatDate to formatLocalDate, updateTimestamps to shiftTimestampsTo, and the start-date helpers to sample-date names. - Extract createDatePicker and toggleDateModal, and name the submit handler applySelectedDate. - Split the Telegraf fixture into a log line and sample data, and assert each separately. Why: - The comments restated or patched over names that didn't describe the behavior. Impact: - No behavior change. Saving the default date now checks for a missing saved date, which is equivalent to the previous yesterday comparison. Verification: - node --test custom-timestamp-values.test.mjs: 9 pass. ESLint passes. - Playwright against hugo server (testing): the Telegraf block shifts to the selected day in UTC and Asia/Tokyo, the selection survives reload, and a first visit saves yesterday with no page errors. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018NiFuxdSqYvtMpAhNfWBbM
…ples What changed: - Move the Cloud Dedicated and Clustered Go and Node.js write examples from 1641124000 to the home sample series that starts at 1641024000. - Move the Cloud Serverless CLI, Telegraf, Python, Go, Node.js, C#, and Java write examples from July and June 2024 to the same 2022-01-01 series that its prose, v1 and v2 API examples, and query page use. - Correct the inner-query start time in the InfluxQL subqueries example from 2022-07-19 to 2022-01-01. - Add content tests for custom-timestamps blocks: one most common day per block, sample dates within a day of that day (log lines excluded), and matching home sample timestamps across each get-started write page. - Add yarn test:custom-timestamps for the unit and content tests. - Change the Serverless Cypress test to check that every write example moves to the selected day. - Replace py code fences with python on the three get-started pages, which the commit hook requires. Why: - The mismatched series wrote data outside the 08:00-20:00 query window, even after the date picker shifted them. - A tie for the most common day would anchor a block on an unrelated date. The content test blocks that before it ships. Impact: - Every get-started write tab on Cloud Dedicated, Cloud Serverless, and Clustered writes the same 13 hourly points, and the date picker moves them all to 08:00-20:00 on the selected day. Verification: - New content tests failed on the old content and pass now; the tie test fails on a temporary tied block. yarn test:custom-timestamps: 12 pass. - Each page's 220 home rows map to the same fields per room and time. - yarn lint-codeblocks passes on the changed pages. - Playwright against hugo server (testing): all 10 sample blocks on each page show 08:00 and 20:00 on the selected day. Cypress could not be installed here, so the Cypress test has not run. Vale is not installed here; CI runs it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018NiFuxdSqYvtMpAhNfWBbM
What changed: - Change the Go client library InfluxQL examples from time >= 1641124000s to time >= 1641024000s on the shared client library reference and the Cloud Dedicated, Cloud Serverless, and Clustered query and reference pages. Each query keeps its 8h window. - Recognize InfluxQL epoch literals with a matching unit suffix (10 digits with s, 13 with ms, 19 with ns) as sample timestamps. - Add tests: suffixed epochs shift, unsigned field values (u suffix) and suffixed durations don't, and InfluxQL queries of home sample data start on a sample hour. Why: - 1641124000s is 2022-01-02 11:46:40 UTC, outside the 2022-01-01 08:00-20:00 home sample data, so the queries returned nothing. - The new timestamp pattern skipped digits followed by a unit suffix, so the date picker no longer moved InfluxQL epoch literals. The previous implementation replaced them. Impact: - The Go query examples read the sample data. On the query pages, the date picker moves them to 08:00 on the selected day. Verification: - New tests failed before the fixes. yarn test:custom-timestamps: 15 pass. - yarn lint-codeblocks passes on the changed pages. - Playwright against hugo server (testing): the three query pages show the selected day's 08:00 epoch; the reference pages, which have no custom-timestamps block, show 1641024000. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018NiFuxdSqYvtMpAhNfWBbM
…ched pages
What changed:
- Add IgnoredScopes = code, tt, text.frontmatter.list_code_example to
the root and product Vale configs, so Vale skips the code samples
stored in list_code_example front matter. Title and description stay
linted.
- Add TokenIgnores patterns for function calls (client.Close() and the
like) and Go pointer types (*influxql.VarRef) in prose.
- Fix anchors on the get-started write and Go query pages:
- glossary #timestamp-precision to #precision
- Cloud Dedicated tokens #database-token(s) to the database tokens page
- Serverless v1 API #retention-policy-and-dbrp-mapping to
#map-v1-databases-and-retention-policies-to-buckets
Why:
- Vale and the link checker lint whole changed files. Editing these
pages surfaced existing Google.Spacing errors in Go front matter
samples (client.Close, client.Query, context.Background) and seven
broken fragments, which failed this PR's Vale and link checks.
Impact:
- Go code samples in front matter no longer fail Vale. A missing space
after a period in prose (sentence.Then) is still an error.
Verification:
- Vale 3.24.0 with .github/scripts/vale-check.sh on this PR's changed
content files: 9 errors before, 0 after.
- A probe file confirmed Vale still flags description front matter and
prose typos, and skips list_code_example.
- hugo server (testing): #precision exists on the three glossaries, the
Cloud Dedicated database tokens page returns 200, and the Serverless
v1 anchor exists.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018NiFuxdSqYvtMpAhNfWBbM
What changed: Add a conditional cloud UI skill pointer in AGENTS.md and clarify that sourcing setup and running maintenance install nothing. Why: Browser verification should reuse the prepared environment and route readiness failures through its documented recovery procedure. Impact: Only docs-v2 browser work is affected. Environment tools stay in their current location. Verification: Diff whitespace and referenced repository paths checked. Instruction generator and validator could not run because gray-matter is unavailable in this session. No dependencies were installed.
Contributor
Author
Vale Style Check Results
✅ Check passed |
Contributor
Author
Release version check
Action needed
💡 Badge new features with the versionDocumenting a new feature? Add a version badge in the page frontmatter — the
For inline version text, use |
Contributor
Author
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/enterprise_influxdb/v1/introduction/installation/single-server/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v1/introduction/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v2/install/_index.md |
https://docs.docker.com/engine/reference/run/#detached-vs-foreground | Cannot find fragment: Cannot find fragment |
content/influxdb/v2/install/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/install/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/core/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/telegraf/v1/install/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/telegraf/v1/install/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/telegraf/v1/install/_index.md |
https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell… | Cannot find fragment: Cannot find fragment |
Full details: workflow run summary and artifact. Last updated: 2026-10-14 16:14:55 UTC
5 of 8 tasks
Contributor
|
Superseded by the v2.10 spec resync on the release branch (7554e80, #7907). That resync fetched both specs from influxdata/openapi master and includes influxdata/openapi#658, #661, and #663. |
jstirnaman
added a commit
that referenced
this pull request
Oct 15, 2026
What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes #7699, #7841, and #7286.
jstirnaman
added a commit
that referenced
this pull request
Oct 15, 2026
* sync(api): update InfluxDB OSS v2 and Cloud v2 specs for v2.10 What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes #7699, #7841, and #7286. * chore(influxdb): bump InfluxDB OSS v2 latest to v2.10.0 Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10. * feat(api): exclude schema properties that InfluxDB Cloud doesn't return What changed: - post-process-specs.ts applies a new content/exclude.yml overlay that removes listed schema properties from the published spec. Stale entries log a warning and don't fail the build. - The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't return: backup, plugins, restore, scrapers, setup, sources, swagger, and system. - The Cloud Setup tag now explains that Cloud doesn't support initial setup: GET /api/v2/setup always returns {"allowed": false}. - Documented exclude.yml in the API docs README, and added test 16. Why: The upstream influxdata/openapi contract shares the Routes schema between OSS and Cloud, so the Cloud reference listed routes that Cloud doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal clients might rely on the full contract, so docs-v2 filters at publish time instead of asking upstream to remove the keys. Impact: The published InfluxDB Cloud v2 API reference only. The committed spec stays a raw upstream mirror. Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08) doesn't return the excluded keys. post-process-specs tests pass (57 of 57). Running the script on influxdb/cloud removes 3 properties from the current spec; the other 5 arrive with influxdata/openapi#658. * test(api): drop redundant exit-code assertion from exclude overlay test A failed run writes no build spec, so the readYaml call that follows already fails the test. * docs(influxdb): add v2.10.0 release notes Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
jstirnaman
added a commit
that referenced
this pull request
Oct 16, 2026
…paction throughput (#7867) * docs(influxdb): document InfluxDB OSS v2.10 options, metrics, and compaction throughput * docs(influxdb): link compaction throughput options and lead metrics with version What changed: Cross-link storage-compact-throughput and storage-compact-throughput-burst. Move the v2.10 availability note to the first paragraph of the per-user query and write bytes metric sections. Why: Review feedback. Readers can jump between related options, and see version availability before the description. Impact: Two v2 reference pages; no behavior change. Verification: Pre-commit hooks. * docs(influxdb): document v2.10 health options, exit codes, and max-time-range errors What changed: - Add health-auth-mode and startup-error-linger to the config options reference, and explain how hardening-enabled restricts /health and /ready details. - Document that influxql-max-time-range errors return HTTP 200 with the error in results[].error, and that a query with no lower time bound exceeds any non-zero limit. - Add an exit codes section to the influxd reference, with a systemd RestartPreventExitStatus example. - Add a restricted health check details section to the enable-hardening page. - Link the new options and exit codes from the v2.10 release notes. - Add the six v2.10 flags to data/influxd_flags.yml. Why: influxdata/DAR#800 acceptance criteria. The behavior was verified against a local build of main-2.x (310ee146d9). Impact: InfluxDB OSS v2 reference, admin, and release notes pages only. Verification: Ran a live influxd for the max-time-range, startup failure, linger, and health-auth-mode cases. Confirmed the environment variable names with print-config. Code-block lint and link checks pass, and the pages render on a local Hugo server. * docs(influxdb): add v2.10.0 release notes (#7911) * sync(api): update InfluxDB OSS v2 and Cloud v2 specs for v2.10 What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes #7699, #7841, and #7286. * chore(influxdb): bump InfluxDB OSS v2 latest to v2.10.0 Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10. * feat(api): exclude schema properties that InfluxDB Cloud doesn't return What changed: - post-process-specs.ts applies a new content/exclude.yml overlay that removes listed schema properties from the published spec. Stale entries log a warning and don't fail the build. - The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't return: backup, plugins, restore, scrapers, setup, sources, swagger, and system. - The Cloud Setup tag now explains that Cloud doesn't support initial setup: GET /api/v2/setup always returns {"allowed": false}. - Documented exclude.yml in the API docs README, and added test 16. Why: The upstream influxdata/openapi contract shares the Routes schema between OSS and Cloud, so the Cloud reference listed routes that Cloud doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal clients might rely on the full contract, so docs-v2 filters at publish time instead of asking upstream to remove the keys. Impact: The published InfluxDB Cloud v2 API reference only. The committed spec stays a raw upstream mirror. Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08) doesn't return the excluded keys. post-process-specs tests pass (57 of 57). Running the script on influxdb/cloud removes 3 properties from the current spec; the other 5 arrive with influxdata/openapi#658. * test(api): drop redundant exit-code assertion from exclude overlay test A failed run writes no build spec, so the readYaml call that follows already fails the test. * docs(influxdb): add v2.10.0 release notes Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
dhoard
pushed a commit
to dhoard/docs-v2
that referenced
this pull request
Oct 21, 2026
What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes influxdata#7699, influxdata#7841, and influxdata#7286.
dhoard
pushed a commit
to dhoard/docs-v2
that referenced
this pull request
Oct 21, 2026
…paction throughput (influxdata#7867) * docs(influxdb): document InfluxDB OSS v2.10 options, metrics, and compaction throughput * docs(influxdb): link compaction throughput options and lead metrics with version What changed: Cross-link storage-compact-throughput and storage-compact-throughput-burst. Move the v2.10 availability note to the first paragraph of the per-user query and write bytes metric sections. Why: Review feedback. Readers can jump between related options, and see version availability before the description. Impact: Two v2 reference pages; no behavior change. Verification: Pre-commit hooks. * docs(influxdb): document v2.10 health options, exit codes, and max-time-range errors What changed: - Add health-auth-mode and startup-error-linger to the config options reference, and explain how hardening-enabled restricts /health and /ready details. - Document that influxql-max-time-range errors return HTTP 200 with the error in results[].error, and that a query with no lower time bound exceeds any non-zero limit. - Add an exit codes section to the influxd reference, with a systemd RestartPreventExitStatus example. - Add a restricted health check details section to the enable-hardening page. - Link the new options and exit codes from the v2.10 release notes. - Add the six v2.10 flags to data/influxd_flags.yml. Why: influxdata/DAR#800 acceptance criteria. The behavior was verified against a local build of main-2.x (310ee146d9). Impact: InfluxDB OSS v2 reference, admin, and release notes pages only. Verification: Ran a live influxd for the max-time-range, startup failure, linger, and health-auth-mode cases. Confirmed the environment variable names with print-config. Code-block lint and link checks pass, and the pages render on a local Hugo server. * docs(influxdb): add v2.10.0 release notes (influxdata#7911) * sync(api): update InfluxDB OSS v2 and Cloud v2 specs for v2.10 What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes influxdata#7699, influxdata#7841, and influxdata#7286. * chore(influxdb): bump InfluxDB OSS v2 latest to v2.10.0 Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10. * feat(api): exclude schema properties that InfluxDB Cloud doesn't return What changed: - post-process-specs.ts applies a new content/exclude.yml overlay that removes listed schema properties from the published spec. Stale entries log a warning and don't fail the build. - The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't return: backup, plugins, restore, scrapers, setup, sources, swagger, and system. - The Cloud Setup tag now explains that Cloud doesn't support initial setup: GET /api/v2/setup always returns {"allowed": false}. - Documented exclude.yml in the API docs README, and added test 16. Why: The upstream influxdata/openapi contract shares the Routes schema between OSS and Cloud, so the Cloud reference listed routes that Cloud doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal clients might rely on the full contract, so docs-v2 filters at publish time instead of asking upstream to remove the keys. Impact: The published InfluxDB Cloud v2 API reference only. The committed spec stays a raw upstream mirror. Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08) doesn't return the excluded keys. post-process-specs tests pass (57 of 57). Running the script on influxdb/cloud removes 3 properties from the current spec; the other 5 arrive with influxdata/openapi#658. * test(api): drop redundant exit-code assertion from exclude overlay test A failed run writes no build spec, so the readYaml call that follows already fails the test. * docs(influxdb): add v2.10.0 release notes Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
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.
Automated weekly sync from
influxdata/openapirevision733b5254fa360097509aab25d2492976d1748d81.Before merging, confirm that the API changes are available in
InfluxDB Cloud and inspect the rendered API reference:
Review coordination
Apply
waiting:engineeringif deployment needs confirmation.Apply
release:pendinguntil the changes are available, thenreplace it with
release:ready.Link the relevant OpenAPI PRs and Cloud deployment, release, or
engineering tracking records in this PR.