influxdata / influxdata/influxdb
Update AuthPassV1 parameter description
- Dominant language
- Rust
- Stars
- 31.7k
- Forks
- 3.7k
- Avg merge
- 13h 37m
- Merged PRs (30d)
- 8
Description
[Issue reported](https://github.com/influxdata/docs-v2/issues/2100) in docs repo that requires an update in the [swaggerV1Compat.yml](https://github.com/influxdata/influxdb/blob/master/http/swaggerV1Compat.yml) file
for the **AuthPassV1** parameter, the description currently states **User token**:
- For OSS, the v1 API expects the v1 password, so this description should be **v1 password**
- For Cloud, with no v1 auth compatibility, how do we want to manage in the swagger doc?
Contributor guide
Research direction
Start in http/swaggerV1Compat.yml at the AuthPassV1 parameter description, and review the linked documentation issue for context. Confirm the intended wording for OSS and resolve how the Cloud case should be represented in the Swagger document; done means the description accurately distinguishes the supported authentication behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100