influxdata / influxdata/docs-v2
Add influxdb3 `/metrics` endpoint guides/reference
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
# Problem
The `GET /metrics` operation is only and barely described in https://docs.influxdata.com/influxdb3/enterprise/api/v3/#operation/GetMetrics.
# Tasks
1. Add `/metrics` operation description and response schema in Core and Enterprise OpenAPI specs
2. Add `/metrics` examples, use cases, and output in:
- https://docs.influxdata.com/influxdb3/enterprise/admin/
- https://docs.influxdata.com/influxdb3/core/admin/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing GET /metrics entry in the InfluxDB 3 Enterprise API reference, then compare the Core and Enterprise OpenAPI specs. Review the Enterprise and Core admin pages for their current structure and examples. Done means both specs describe the operation and response schema, and both admin sections include /metrics examples, use cases, and output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100