influxdata / influxdata/openapi

Missing "required" labels in the InfluxDB OSS API docs

Open
#572 3 comments 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

There are missing required labels in the InfluxDB OSS API docs.

status is required to add a new check
orgID is required to add a new notification endpoint
every is required to add a new notification rule
orgID and bucketID are required to create a new scraper target
orgID si required to create a source
orgID or/and org is required to create a task - it might be worth noting that it only works like this for the OSS InfluxDB version. When it comes to the cloud InfluxDB there is no need for either orgID or org. I believe the Create a Task orgID and org should be described as they are for deleting data.
orgID is required to create a Telegraf configuration
orgID is required to create a new stack
orgID is required to apply or dry-run a template
orgID within orgIDs is required to export a new template

There is also one excessive "required" in create a dashboard where the name IS NOT a required parameter to create a new dashboard.

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 with the linked InfluxDB OSS API operation entries and compare each parameter's required label with the requirements listed in the issue. Check the create-dashboard entry for the excessive name label and account for the OSS-specific task behavior. Done means the listed parameters are marked correctly and the dashboard name is no longer marked required.

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.