influxdata / influxdata/influxdb
Add intro to API docs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 31.7k
- Forks
- 3.7k
- Avg merge
- 13h 37m
- Merged PRs (30d)
- 8
Description
__Proposal:__
Add preface or introductory material at the beginning of the swagger API docs.
__Current behavior:__
On the main [API docs page](https://docs.influxdata.com/influxdb/v2.0/api/), we don't find any overview content to get started.
__Desired behavior:__
Give folks an overview of the basics/where to start. Accepted request body formats, return response formats, response codes used, errors, how authentication works.
__Use case:__
This info is important for developers using our API.
cc @stephanie-engel @rhajek @influxdata/docs-team
Contributor guide
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 at the main API docs page linked in the issue and review how its current Swagger content is organized. Add introductory coverage for where to start, accepted request and response formats, response codes, errors, and authentication; the API docs should provide the requested overview for developers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100