Add API reference examples to Influxdb3 #5949

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.

Sign up for GitHub

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

Jump to bottom

Open

MeelahMe opened this issue Apr 2, 2025 · 0 comments · May be fixed by #6002

Assignees

Labels

API InfluxDB v3

Contributor

MeelahMe commented Apr 2, 2025 •

edited

Loading

Objective:

Improving the InfluxDB 3 API reference to ensure it includes clear, complete examples for all or most options

What the feature does and why it’s useful

Adds usage examples to the InfluxDB 3 API reference, focusing on parity with the CLI
Helps users understand how to correctly structure API requests and interpret responses
Reduces friction when working with the API directly by providing real-world, tested examples

Once added:

Users can consult the API reference to see example payloads and expected responses
Fields like triggerSpec will include tested formats
Supports developers who work API-first or are building integrations

part of #5857

MeelahMe added API InfluxDB v3 labels

MeelahMe self-assigned this

MeelahMe linked a pull request

that will close this issue

Adding adequate CLI examples for creating triggers #6002

Draft

MeelahMe linked a pull request

that will close this issue

Adding adequate CLI examples for creating triggers #6002

Draft

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment