influxdata / influxdata/openapi

api/v2/write has unintuitive ID vs name parameters

Open
#56 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

  1. orgID and org are both parameters, but org will interpret a 16 character hex value as an ID instead of a name, so badfee0000000001 counts as an ID always, never as a name.

  2. bucket works like org to prefer an ID and also fall back to trying the value given as a name, but there is no corresponding bucketID. Also this is not documented.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the OpenAPI specification for the api/v2/write endpoint and inspect how orgID, org, and bucket are defined. Determine the intended distinction between IDs and names, including the missing bucketID behavior, then update the specification and its documentation so the parameter semantics are explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.