Commit Graph

81 Commits (master)

Author SHA1 Message Date
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
Jonathan Coates 288b1a395c
Add .no-shorthand to `create token --admin` options (#6189)
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-07-07 09:27:58 -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 a40220091c Merge remote-tracking branch 'origin/jts-6161-3-2-api-ref' into core-ent-3.2 2025-06-30 14:40: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 52e6eeca8a feat: Update InfluxDB 3 CLI documentation for v3.2.0 features
- Add influxdb3 show license command documentation for Enterprise
- Update create database command with --retention-period option
- Update create table command with Enterprise --retention-period option
- Update delete database/table commands with --hard-delete options
- Update CLI command index to include license command
- Update planning documentation for CLI sync process
- Closes #6160
2025-06-26 16:59:21 -05:00
Scott Anderson 4d22388bd9 WIP monolith get started, enterprise multi-node, file index docs 2025-06-17 17:12:42 -06:00
Jason Stirnaman 7bf799c3d0 fix(mono): Update descriptions to be more operator-specific 2025-05-28 23:39:50 -05:00
Jason Stirnaman fd6bd6a6ff fix(mono): formatting 2025-05-28 22:47:41 -05:00
Jason Stirnaman 2318cf7ac7 feat(mono): 3.1 admin tokens:
- Updates get-started and admin guides, CLI references
- Adds admin token CLI reference page
- Operator token (_admin) - system-generated, non-expiring
- Named admin tokens - user-defined with expiration support
- Resource tokens (Enterprise only) - database and system tokens
- Core vs Enterprise token limits properly documented
- Create the initial operator token
2025-05-28 22:41:03 -05:00
Jason Stirnaman 630002bed1
Update content/shared/influxdb3-cli/create/trigger.md 2025-05-21 10:48:34 -05:00
peterbarnett03 e8e69d9804
fix: clarify that a plugin filename is needed 2025-05-21 09:14:22 -04:00
Jason Stirnaman 9da9b8570e
Apply suggestions from code review 2025-05-19 12:40:19 -05:00
Jameelah Mercer 59dca83f14
Update content/shared/influxdb3-cli/create/token.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:33:35 -07:00
Jameelah Mercer adb3264f4d
Update content/shared/influxdb3-cli/create/token.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:33:18 -07:00
Jameelah Mercer 2540cee9cf
Update content/shared/influxdb3-cli/create/token.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:33:01 -07:00
Jameelah Mercer f245785139
Update content/shared/influxdb3-cli/create/table.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:32:44 -07:00
Jameelah Mercer 02035d2f52
Update content/shared/influxdb3-cli/create/table.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:32:25 -07:00
Jameelah Mercer 185c2faaa9
Update content/shared/influxdb3-cli/create/distinct_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:31:56 -07:00
Jameelah Mercer 9adda3e659
Update content/shared/influxdb3-cli/create/distinct_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:31:44 -07:00
Jameelah Mercer d16c2264d6
Update content/shared/influxdb3-cli/create/distinct_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:31:30 -07:00
Jameelah Mercer 138decaf3f
Update content/shared/influxdb3-cli/create/distinct_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:31:17 -07:00
Jameelah Mercer e0564330a2
Update content/shared/influxdb3-cli/create/distinct_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-19 10:30:55 -07:00
meelahme b3b087bf45 Clarify token usage instructions and reinforce one-time visibility 2025-05-16 21:07:13 -07:00
meelahme 74039f1919 resolving lint check warning 2025-05-16 20:52:38 -07:00
meelahme 83d800be46 minor update to table.md 2025-05-16 20:50:53 -07:00
meelahme c60766be3e updating verification example to be more precise 2025-05-16 20:47:05 -07:00
meelahme fa8e6114f9 Fix pytest.mark.skip rendering issue in SHOW TABLES example output block 2025-05-16 20:38:32 -07:00
meelahme d8e043e193 Clarify table creation behavior in CLI docs; add note about automatic creation on write 2025-05-16 20:10:56 -07:00
Jameelah Mercer ed3aa1ff30
Update content/shared/influxdb3-cli/create/token.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 19:39:13 -07:00
Jameelah Mercer 7f1a3b6cec
Update trigger.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:21:36 -07:00
Jameelah Mercer 69170973f8
Update trigger.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:21:25 -07:00
Jameelah Mercer cf87936e97
Update trigger.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:21:18 -07:00
Jameelah Mercer a2145f0f98
Update trigger.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:21:12 -07:00
Jameelah Mercer ef239efffa
Update token.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:21:05 -07:00
Jameelah Mercer 3a39a927df
Update token.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:20:57 -07:00
Jameelah Mercer 7a390620d1
Update table.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:20:41 -07:00
Jameelah Mercer 2c3b3f8dad
Update table.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:19:59 -07:00
Jameelah Mercer af999045f2
Update table.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:19:53 -07:00
Jameelah Mercer 2ae9d67475
Update table.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:19:45 -07:00
Jameelah Mercer df24a224f8
Update last_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:19:14 -07:00
Jameelah Mercer dd8369b50b
Update last_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:19:07 -07:00
Jameelah Mercer 9834fab278
Update distinct_cache.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:19:00 -07:00
Jameelah Mercer 3edf4e7cc0
Update database.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:18:55 -07:00
Jameelah Mercer 21588fefd8
Update database.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:18:48 -07:00
Jameelah Mercer b46033898e
Update database.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:18:39 -07:00
Jameelah Mercer 8847d6777e
Update database.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-05-16 14:18:19 -07:00
meelahme 18a4413933 docs(cli): add editable placeholders for database, table, and token in and examples 2025-05-15 12:28:30 -07:00
meelahme 5a843f5d9a docs(cli): improve distinct_cache structure 2025-05-15 11:09:46 -07:00
meelahme 0cbfade147 revising structure 2025-05-15 10:38:28 -07:00