Skip to content

Add API reference examples to Influxdb3 #5949

Open
@MeelahMe

Description

@MeelahMe

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

Metadata

Metadata

Assignees

Labels

APIInfluxDB v3InfluxDB v3.0 (platforms using IOx)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions