influxdata / influxdata/influxdb
Move API client generation into influxdb
- Dominant language
- Rust
- Stars
- 31.7k
- Forks
- 3.7k
- Avg merge
- 13h 37m
- Merged PRs (30d)
- 8
Description
See [RFC](https://github.com/influxdata/idpe/pull/4116) for motivation.
- Generate an API client and types from the `http/swagger.yml` spec and [oats](https://github.com/chnn/oats)
- Replace all usages of the `@influxdata/influx` package to use this generated code
### Remaining work
- [ ] Use locally generate API utils
- [x] `client.auth` (https://github.com/influxdata/influxdb/pull/14611)
- [x] `client.authorizations` (https://github.com/influxdata/influxdb/pull/14831)
- [x] `client.buckets`
- [x] `client.dashboards` (https://github.com/influxdata/influxdb/pull/16438)
- [x] `client.labels` (https://github.com/influxdata/influxdb/pull/16361)
- [x] `client.links`
- [x] `client.organizations`
- [x] `client.queries`
- [ ] `client.scrapers`
- [ ] `client.setup`
- [x] `client.tasks` (https://github.com/influxdata/influxdb/pull/16353)
- [ ] `client.telegrafConfigs`
- [ ] `client.users`
- [x] `client.variables` (https://github.com/influxdata/influxdb/pull/16400)
- [x] `client.write`
- [ ] `client.templates`
- [x] `client.checks`
- [x] `client.notificationRules`
Contributor guide
Research direction
Start with http/swagger.yml and the linked RFC, then review the remaining client.scrapers, client.setup, client.telegrafConfigs, client.users, and client.templates entries. Done means these API utilities use locally generated code and remaining usages of @influxdata/influx have been replaced.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100