Commit Graph

214 Commits (b64e83a44ef54d2aee8424d147c876cdaeb3f3a4)

Author SHA1 Message Date
Jason Stirnaman c9e04946f8
Merge branch 'master' into feat-influxdb3-cli-updates 2025-07-08 15:30:43 -05:00
Jason Stirnaman aacef0a06a Add missing CLI options\
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
2025-07-08 13:24:52 -05:00
Jason Stirnaman 8101629bdb
Update api-docs/influxdb3/core/v3/ref.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-07-08 09:15:47 -05:00
Jason Stirnaman 48380fd168 fix(influxdb3): Auth schemes in 3core, 3ent, cloud-dedicated, and clustered:Explains compatibility for different schemasProvides more auth examplesFills missing schemes in API refFixes placeholdersShows that username is optional 2025-07-07 23:10:37 -05:00
Jason Stirnaman a930272769 fix(ossv2): duplicated description 2025-07-07 15:03:24 -05:00
Jason Stirnaman c738dfd82f chore(v2): OSS v2 query API: add, fix, cleanup:
- 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
2025-07-07 14:09:47 -05:00
Jason Stirnaman c457493fc4 chore(influxdb3): v3.2.1 fixes request trigger spec in 3Ent. Remove Core-Ent divergence notes. 2025-07-06 16:43:54 -05:00
Jason Stirnaman 4a800fc7be
Merge branch 'master' into staging/jts-api-distributed 2025-07-02 09:56:24 -05:00
Jason Stirnaman 1db8550462 fix(influxdb3): Update API reference and fix processing engine documentation for 3.2 release
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>
2025-06-30 13:33:52 -05:00
Jason Stirnaman 5a44f6c10e fix(influxdb3): Update request trigger specification format for Enterprise
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>
2025-06-30 08:59:47 -05:00
Jason Stirnaman 9588022ceb fix(ent3): Update Ent3 API reference request trigger_specification syntax to string request:<REQUEST_PATH> 2025-06-30 08:29:15 -05:00
Jason Stirnaman 687b8343b7 chore(mono): /api/v3 processing engine request parameters:
- 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
2025-06-06 17:16:20 -05:00
Jason Stirnaman 36e65a663e
Merge branch 'master' into 6071-chore-v2-partial-writes 2025-05-22 16:38:56 -05:00
Jason Stirnaman 8d0d4acf55 fix(oss2): Troubleshoot partial writes for v2 and Cloud
- 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
2025-05-22 16:30:41 -05:00
Jason Stirnaman 18b90035a4 fix: broken links and formatting, missing Management API ReDoc security section for auth types 2025-05-19 14:09:38 -05:00
Jason Stirnaman 1dce052e56 fix(JS): Rename CommonJS scripts to .cjs extension, keep type: module as the project default. Update and fix ESLint configuration.
- Renames JavaScript files in flux-build-scripts and api-docs/openapi/plugins to .cjs file extension to declare them as CommonJS module syntax.
2025-05-19 11:34:42 -05:00
Jason Stirnaman dce91b9692 hotfix(ent3): API ref: Remove admin token enterprise-only note and rebuild with previous fix. 2025-05-15 09:22:50 -05:00
Praveen Kumar db1b750cde
fix: url fixes in API reference section
- removes extra `/enterprise` in 'create admin token' section
- removes extra `/enterprise` in 'regenerate admin token' section
2025-05-15 12:13:31 +01:00
Praveen Kumar b816dbbfb6
fix: incorrect enterprise admin token creation link
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`.
2025-05-14 14:46:06 +01:00
Jason Stirnaman 815514c53b
Apply suggestions from code review 2025-05-09 10:24:58 -05:00
Jason Stirnaman 585490b983
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-05-09 10:22:47 -05:00
Jason Stirnaman 504e7b3d1c feat(dedicated): Admin UI: Add create table, revise create database and custom partitioning
- 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
2025-05-08 16:24:29 -05:00
Jason Stirnaman c4d4efc121 fix(influxdb3): unresolved product-name shortcode in frontmatter title, broken links to non-existent Core and Enterprise compatibility guides, alias api/v1 and api/v2 paths as api/v3. 2025-05-01 11:17:10 -05:00
Jason Stirnaman 49acdbabd7 fix(influxdb3): Apply corrections from code review 2025-04-21 15:41:03 -05:00
Jason Stirnaman 487a6d046b feat(influxdb3): Core and Enterprise: update API references:
- 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
2025-04-21 13:49:49 -05:00
Jason Stirnaman c8bc364b49 chore(influxdb3): API ref: Add auth information and token regenerate endpoints 2025-04-21 09:57:26 -05:00
Jason Stirnaman f135ce60f1
Merge branch 'master' into staging/jts-api-distributed 2025-04-15 16:24:10 -05:00
Jason Stirnaman c259a01937 fix(api): replace alpha with beta 2025-04-09 11:05:38 -05:00
Jason Stirnaman 0b9b1e189e
Update api-docs/influxdb3/cloud-dedicated/management/content/tag-groups.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-03-31 16:52:12 -05:00
Jason Stirnaman e4bed73904 feat(clustered): add missing Management API reference (unlike Cloud Dedicated) (Closes #5838)
- Retrieve Graphite API spec for Clustered
- Remove ACCOUNT_ID and CLUSTER_ID references and requirements not used for Clustered
2025-03-31 16:45:21 -05:00
Jason Stirnaman 49355acece fix(dedicated): Specify Dedicated requires account_id and cluster_id 2025-03-31 16:00:17 -05:00
Jason Stirnaman 5a9f04bd5b fix(dedicated): Update Cloud Dedicated API reference (part of #5943) to include token expiration 2025-03-31 15:42:47 -05:00
Jason Stirnaman 15cda93d28 fix(api-docs): Ask AI hides menu toggle at 800px
Increase the mediaQuery breakpoint for AskAI to avoid covering the menu toggle.
2025-03-17 13:12:11 -05:00
Jason Stirnaman 9932ea84e5 fix(api): don't ignore .config.yml files inside of api-docs 2025-03-17 12:10:13 -05:00
Jason Stirnaman 6b82aa2e62
Merge pull request #5898 from influxdata/jts/update-examples-and-pe-cache
Jts/update examples and pe cache
2025-03-17 08:21:16 -05:00
Jason Stirnaman 081a5ed02e
Merge pull request #5895 from influxdata/pbarnett/update-examples-and-pe-cache
Updates for new cluster configurations in Enterprise and new in-memory cache
2025-03-17 01:42:28 -05:00
Jason Stirnaman 3bf5f48cf8 fix(monolith): Core and Enterprise Beta fixes and cleanup 2025-03-17 01:38:49 -05:00
Jason Stirnaman 16567e2a1f fix(api): Ask AI button obstructs Redoc toggle:
- 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.
2025-03-16 22:44:39 -05:00
Peter Barnett ef40b6ae0f update: adjust for new parameters, cluster configuration, modes, and some grammar 2025-03-16 22:05:33 -05:00
Jason Stirnaman 3d4f78f5c4 fix(cloudv2): Doesn't support environment references in templates 2025-03-14 18:11:16 -05:00
Jason Stirnaman d53330d503 hotfix: whitespace in generated files 2025-03-06 12:05:44 -06:00
Jason Stirnaman 09c3701912 fix(v3): influxdb3/core/api, influxdb3/enterprise/api Port data flow steps:
Apply suggestions from @hiltontj.
List data flow steps ported from 0fdd0efa0.
Use enum for field column types.
2025-03-06 11:34:21 -06:00
Jason Stirnaman 632878d945
Update api-docs/influxdb3/core/v3/ref.yml 2025-03-05 16:49:48 -06:00
Jason Stirnaman 7502ede123
Update api-docs/influxdb3/core/v3/ref.yml 2025-03-05 16:49:42 -06:00
Jason Stirnaman 7a1ad401d0
Update api-docs/influxdb3/core/v3/ref.yml 2025-03-05 16:49:27 -06:00
Jason Stirnaman cb953b9f63
Apply suggestions from code review
Co-authored-by: Trevor Hilton <trevor.hilton@gmail.com>
2025-03-05 16:49:05 -06:00
Jason Stirnaman 0b4d4a466e
Update api-docs/influxdb3/core/v3/ref.yml
Co-authored-by: Trevor Hilton <trevor.hilton@gmail.com>
2025-03-05 14:56:01 -06:00
Jason Stirnaman ed42c1e082
Update api-docs/influxdb3/core/v3/content/info.yml 2025-03-04 16:34:57 -06:00
Jason Stirnaman 5c196480f9
Update api-docs/influxdb3/enterprise/v3/ref.yml 2025-03-04 16:34:51 -06:00
Jason Stirnaman 40d2e0f938
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-03-04 16:34:27 -06:00