Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing "required" labels in the InfluxDB OSS API docs #572

Open
k3yi0 opened this issue Aug 24, 2022 · 3 comments · May be fixed by #594
Open

Missing "required" labels in the InfluxDB OSS API docs #572

k3yi0 opened this issue Aug 24, 2022 · 3 comments · May be fixed by #594

Comments

@k3yi0
Copy link

k3yi0 commented Aug 24, 2022

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.

@jstirnaman
Copy link
Contributor

@k3yi0 I agree - this belongs in openapi. Thanks for the nudge!

@jstirnaman jstirnaman transferred this issue from influxdata/docs-v2 Oct 13, 2022
@k3yi0
Copy link
Author

k3yi0 commented Oct 25, 2022

Additional things I've found:

  • ping response header X-Influxdb-Version is a string, not an integer.
  • replace cells in a dashboard response doesn't contain name and orgID

@alespour
Copy link
Contributor

alespour commented Nov 1, 2022

every is required to add a new notification rule

  • when either status or every is missing, server panics (panic has occurred: /api/v2/notificationRules: runtime error: invalid memory address or nil pointer dereference

@alespour alespour linked a pull request Nov 1, 2022 that will close this issue
@ivankudibal ivankudibal moved this to In Progress in openAPI project Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

3 participants