-
Notifications
You must be signed in to change notification settings - Fork 295
Influxdb3: Core and list tokens #6026
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…uxdb3 CLI help output. This is better than manually creating docs, but still needs improvement. Run it from the docs-v2 root and it uses whatever influxdb3 is in your global PATH.
…dmin and resource tokens.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the InfluxDB 3 documentation by adding and updating reference guides and examples for listing and creating tokens via the CLI and HTTP API for both Core and Enterprise editions. Key updates include:
- New pages and examples for the "show tokens" and "create token" CLI commands with various output formats and detailed SQL query usage.
- Updates to admin and resource token documentation to improve clarity and consistency in token permission examples.
- Minor textual and formatting fixes throughout the documentation to align with the new token syntax and usage guidelines.
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
content/shared/v3-enterprise-get-started/_index.md | Updated example explanations for system token permissions. |
content/shared/influxdb3-cli/* | Added and updated examples for listing tokens and databases, including output to Parquet. |
content/influxdb3/enterprise/* | Updated and expanded examples for creating tokens with fine-grained permissions and listing tokens via CLI and HTTP API. |
content/influxdb3/core/* | Introduced new reference pages mirroring the enterprise guides for the Core edition. |
Comments suppressed due to low confidence (2)
content/shared/influxdb3-cli/create/token.md:9
- [nitpick] Consider clarifying the placeholder '' to indicate the available subcommands (e.g., '--admin', '--permission') so that users understand what to replace it with.
influxdb3 create token <COMMAND> [OPTIONS]
content/influxdb3/enterprise/create/token.md:29
- [nitpick] Ensure that the token variable name 'AUTH_TOKEN' is used consistently across all examples; if an admin token is required in some examples, update the description accordingly.
--header "Authorization: Bearer AUTH_TOKEN"
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]> Co-authored-by: Copilot <[email protected]>
Closes #6022 #6021
Part of #5966
Add reference and guides for listing tokens using CLI and API
Update ref and guides for resource token syntax
Add examples, placeholders
Misc. fixes
WIP: added node.js script to generate docs from
influxdb3
CLI help output. Partially works - not for all commands due to differences in help structure and headings.