Fix `create token --admin` name in frontmatter
Improve schedule trigger docs with more detail:
1. Core API documentation
(/api-docs/influxdb3/core/v3/ref.yml):
- Added missing duration units (weeks, months, years)
- Added "Maximum interval: 1 year"
2. Enterprise API documentation
(/api-docs/influxdb3/enterprise/v3/ref.yml):
- Added missing duration units (weeks, months, years)
- Added "Maximum interval: 1 year"
3. CLI reference documentation
(/content/shared/influxdb3-cli/create/trigger.md):
- Added complete list of supported duration units
- Added "Maximum interval is 1 year" note
All documentation now consistently reflects:
- The complete set of supported duration units for
every triggers
- The 1-year maximum limit for interval-based
scheduling
- Clear examples showing the syntax
- Adds missing examples for v1-compatible /query
- Fixes curl params in examples
- Removes unsupported async option from examples
- Updates terms for consistency with branding and influxdb3 docs
- Copies the missing POST /query operation from swaggerv1compat to the v2 ref.yml
- Effectively removes the separate v1-compat spec, and adds redirects and tags for v1-compat endpoints in v2/ref.yml
- Updates affected links
Resolves issue #6161 with InfluxDB 3.2 API reference updates.
## API Reference Updates
- Add `hard_delete_at` parameter to database and table deletion endpoints for scheduled hard deletion
- Add update database and update table endpoints with retention period configuration
- Add license endpoint response schema
- Fix request trigger specification format from `path:` to `request:` in Core API
- Fix OpenAPI schema validation error in Enterprise API by removing conflicting type declaration
## Processing Engine Documentation Fixes
- Standardize terminology across documentation:
- "Data write" (not "WAL flush" or "On WAL flush")
- "Scheduled" (not "On Schedule")
- "HTTP request" (not "On Request")
- Fix placeholder inconsistencies: use REQUEST_PATH instead of ENDPOINT_PATH
- Add Enterprise-specific warnings about request trigger format differences
- Update trigger specification format in Enterprise API to use JSON object format
- Add proper table of contents with consistent structure
- Improve distributed cluster configuration documentation
## Enterprise Request Trigger Bug Documentation
Due to a bug in InfluxDB 3 Enterprise, the request trigger specification format differs between CLI and API:
- CLI: `request:<REQUEST_PATH>` (same as Core CLI and API)
- Enterprise API: `{"request_path": {"path": "<REQUEST_PATH>"}}`
This difference is now properly documented with warnings in all relevant sections.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Due to a bug in InfluxDB 3 Enterprise, the request trigger specification
format diverges from InfluxDB 3 Core. Enterprise requires a JSON object
format: {"request_path": {"path": "path-name"}} instead of the simpler
"request:path-name" format used in Core.
This commit updates:
- API examples to use the correct JSON object format
- Documentation to clearly show the required format
- Schema validation to accept both string and object formats
- Added clarifying note about the format difference
Related to influxdata/influxdb#6171 which will address this in the 3.2.1 release.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Update trigger-spec syntax for schedule triggers
- Specify that cron only supports extended cron format
- Provide examples and pattern validation for trigger-specs
- Update response status
- Cleanup use
- Misc. updates and cleanup
- Add test plugins
- OSS v2 supports partial writes and returns a 422 that describes rejected points, depending on the problem.
- Update API spec
- Move file to content/shared for Cloud
This commit fixes the link by removing `/enterprise/` in the URL for creating admin token in enterprise
Both core and enterprise share the same endpoints mounted at the root
level for managing admin/operator token. Only enterprise specific
features are mounted on `/enterprise`.
- Add Admin UI instructions for creating a table
- Moves database and table instructions for custom partitioning to separate tab groups
- Revise custom partitioning instructions for consistency.
- Add descriptions and links to Management API ref
- Add token management endpoints
- Update auth traitTag content
- Revise tags
- Add cache information
- Add Cache data tag group
- Remove Data I/O tag group
- Add Query data and Write data tags
- For small devices, positions the Ask AI button up above the Redoc menu button.
- I'd prefer to move the Redoc menu button up instead, but their docs don't mention position settings.
- Ensures AskAI is loaded after DOMContentLoaded.
- Fix broken links reported by the e2e link checker.
- Add an e2e test for checking internal and external links in API reference docs. Low effort, big win.
- Adds the widget script to template.hbs.
- Copies branding color and font styles from js/ask-ai.js
- Copies position and some sizes from the configuration docs.
- This will be replaced when the API uplift is completed and using the same layouts as the rest of the site.
- Add a custom x-influxdata-short-description field that replaces the previous non-standard summary field used by Redocly.
- Double quote the title and description vars to preserve the entire value when passing them to the CLI
- Adds InfluxDB 3 Core API reference
- Updates scripts
- Removes non-valid info.summary field from specs, replaces with description in metadata
- Simplifies frontmatter generation for HTML template
- Reorg of file structure to mirror the content structure.
- Moves OSS v2 into v2/v2/ref.yml to follow the same pattern as others
- Replaces isDefault API config field with specific aliases.
- Misc. fixes.
- Remove generated HTML files.
- Adds basic support for core and enterprise in getswagger.sh
- Adds custom OpenAPI info for Core and Enterprise
- Validates as OpenAPI 3.0 (using Spectral)
- operationId
- tags
- Revises use of Legacy, v2
- TODO: need to check and validate in UI, adjust tags if nec.
- Add and remove components
- Update parameters
- Add examples
- Add tests for Core
Continue refactoring JavaScript into a component pattern and ESM.
Replaces some jQuery with native DOM API.
chore(ai): reference documentation and instructions for training AI
chore(ai): implement Kapa AI chat widget
- Move script tag to HTML template to make it obvious.
- Cleanup javascript to make it more component-like
- Set Kapa attributes, support setting userid
chore(js): add JS dependencies, previously referenced in script tags, to package.json for JS builds.
fix(api): indents
chore(js): package Mermaid diagram library
chore(js): refactor JS for AIChat and Theme as examples of using the component pattern for HTML/CSS/JS
chore(js): Use the new local-storage API in refactored module code and in code not yet ported. Cleanup syntax in local-storage and make functions available from window.LocalStorageAPI.
fix(js): theme.js name-change
chore(js): fix ai-chat.js file name
fix(js): refactor:
- componentNames are snakecase in HTML
- replace DOM selection method and jQuery eventhandler assignment
- remove old theme.js references
chore(ai): configure chat window overlay, size, and position:
- removes overlay and scroll lock
- positions chat to the right and bottom
- expands sample question width to 12 cols
chore(ai): edit disclaimer
fix(ai): size and position
chore(js): make ai-chat specific to configuration and and setting userid (for testing and future use).
fix(js): copy referrerHost variable to v3-wayfinding instead of relying on influxdb-url to assign it.
chore(ai): add a footer div at page bottom to contain modal triggers for custom-time and ask-ai. Still needs some CSS help. Moves tooltip text from CSS to HTML data attribute.
chore(ai): dynamically load AI script tag after DOMContentLoaded to avoid race conditions. Call initialization from the modal trigger module and pass the show trigger function to the onload handler.
fix(ai): fix modal triggers to viewport
fix(modal-triggers): stack the triggers into a single column.
restyle footer widgets
updated time selector modal to use correct storage term
minor style update
WIP(ai-chat): get product data
chore(js): Factor out pageContext module from influxdb-url.js
chore(js): Refactor helpers.js out of inflluxdb-url.js
WIP: refactor influxdburl - minimal changes for module conversions
feat(ai): Custom AI chat example questions product and version.
Ask AI example questions:
- Adds support for customizing example Ask AI questions per product or version.
- Configure questions in site `data/products.yml`; otherwise, it uses default questions from `ask-ai.js`
Context, page, and product data:
- Adds sample URLs for remaining versions in influxdb_urls
- `page-context.js` consolidates and exports constants for page context (protocol, host, path, referrer) and path-to-data mappings for product and influxdb_url site data
Module refactor:
- Refactors some JavaScript into ES6 modules, and refactors some of those further into a Component pattern--just vanilla JS and no shadow DOM stuff. The Component pattern that uses data attributes to "bind" JavaScript modules with CSS and HTML is a popular approach in modern web development. This pattern enhances modularity, reusability, and maintainability by associating behavior (JavaScript), structure (HTML), and style (CSS) through the use of data attributes.
- `assets/main.js` is the entrypoint
- Passes pageParams from the Hugo page to modules that import `@params`.
- Moves most external dependencies out of `script` tags and into package.json to be managed with `yarn`.
- Adds `eslint`.
- For modules that aren't yet components, wraps execution statements inside an `initialize()` function and calls the function from `main.js` on `DOMContentLoaded`.
- For components, if the page contains the `data-component="<component-name>"`, the matching element is passed to the component function on `DOMContentLoaded`.
- I tried to avoid changing logic where it wasn't necessary.
Update DOC_GPT_PROFILE.md
customize ai chat modal styles
fix(influxdb-url): Rename to cloud_dedicated in influxdb_urls.yml, remove newly added placeholder URL and use the extant default, refactor
- Rename to in influxdb_urls.yml
- Fix influxdb-url.js and data provision in local-storage.js to use the new name, mapping it to to retain the existing local storage key
chore(api-lib): Use local-storage import instead of window global
chore(js): cleanup
fix(js): Ensure feature-callout initializes on page load
fix(theme): Load preferred theme before making the page visible. Execute a predefined function by specifying the function name in data-theme-callback
fix(search-toggle): Restores toggling the search field when sidebar is collapsed. Moves the event handler to a new search-button component
fix(ai): Fix custom attribute assignment. Rename property to ai_example_questions
Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive). Fix TOC links.
Fixes#5781
fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content
fix(api-ref): Update getswagger.sh destination paths to use the new directory structure when fetching spec files. Update the redocly plugin module path.
hotfix: fix hlevel bug in children shortcode
Remove underline from custom time widget
add color to custom time widget styling
* docs: correct description of status codes
* Update api-docs/cloud-dedicated/v2/ref.yml
Co-authored-by: Fraser Savage <fraser@savage.engineer>
* Update api-docs/cloud-dedicated/v2/ref.yml
Co-authored-by: Fraser Savage <fraser@savage.engineer>
* Apply suggestions from code review
Co-authored-by: Fraser Savage <fraser@savage.engineer>
---------
Co-authored-by: Fraser Savage <fraser@savage.engineer>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Partial writes are the only mode of operation on serverless clusters.
This means that any requests where all points are outside the retention
policy of a bucket receive a 400 bad request.
This updates the Cloud Dedicated Management API spec to use the `int64`
format for the `ClusterDatabaseRetentionPeriod` schema, which matches
the corresponding type in IOx's namespace API.
- Adds a custom short title field in OpenAPI info.
- Uses the new field for nav menu item names.
- Adds identifiers to avoid duplicate name warnings.
- Cleans up variation in frontmatter.
* feature(v3): Write: partial writes write good lines and reject bad lines #5160
- Documents the proposed partial writes feature for Serverless and Dedicated.
- Updates Troubleshoot writes and API docs.
* chore(v3): update write status codes (#5160)
* Update content/influxdb/cloud-serverless/write-data/troubleshoot.md
* chore(v3): cleanup partial write descriptions in API ref and troubleshooting guide
meelahme
Jason Stirnaman
Jason Stirnaman
Praveen Kumar
Peter Barnett
Paul Dix
Scott Anderson
Ben Tasker
Fraser Savage
Fraser Savage
Jacob Marble
Dustin Eaton
Abdullah Sabaa Allil