influxdata / influxdata/influxdb

confusing REST API schema

Open
#26,232 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
31.7k
Forks
3.7k
Avg merge
13h 37m
Merged PRs (30d)
8

Description

The REST API documentation has a visual conflict for some of the important schema fields.

https://docs.influxdata.com/influxdb/v2/api/v2/#operation/PostWrite

Specifically, the English language description on the right side indicates that _either_ org or orgID are required, whereas the left side indicates that org is always required and orgID is optional.

Can we please update the API docs to reflect the required vs optional information more accurately? I wonder if Swagger/OpenAPI now supports enumerative/monadic style data types there.

Contributor guide

Open the contributing guide

Research direction

Start with the linked PostWrite operation in the REST API documentation and locate the OpenAPI schema that drives its parameter display. Compare the org and orgID required/optional metadata in the source with both rendered panels, then verify the generated documentation consistently shows the intended relationship.

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
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.