influxdata / influxdata/openapi

Telegrafs - TelegrafPluginRequest and TelegrafRequest have no required properties

Open
#610 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Looking into TelegrafPluginRequest and TelegrafRequest I see there are no properties listed as _Required_. I would think, that as with other resources an `orgID` would be required in a request. Also I cannot imagine a use case for a TelegrafPlugin without a `name` or a `config`.

src/common/schemas/TelegrafPluginRequest.yml
```yml
# This defines the 'legacy' `TelegrafConfigDecode` type in the api.
type: object
properties:
name:
type: string
description:
type: string
plugins:
type: array
items:
type: object
properties:
type:
type: string
name:
type: string
alias:
type: string
description:
type: string
config:
type: string
metadata:
type: object
properties:
buckets:
type: array
items:
type: string
config:
type: string
orgID:
type: string
```
src/common/schemas/TelegrafRequest.yml
```yml
type: object
properties:
name:
type: string
description:
type: string
metadata:
type: object
properties:
buckets:
type: array
items:
type: string
config:
type: string
orgID:
type: string
```
Inspecting opeanapi repository with latest commit at:
```
commit 9d31f38d457c9ddd4fb66a4bdb4ff40f402961ad (HEAD -> master, origin/master, origin/docs-release/influxdb-oss, origin/HEAD)
Author: Jason Stirnaman
Date: Tue Nov 8 11:50:47 2022 -0600

```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with src/common/schemas/TelegrafPluginRequest.yml and src/common/schemas/TelegrafRequest.yml, then compare their property definitions with the issue's stated request requirements. Add the appropriate required declarations for orgID, name, and config, and confirm both schemas represent the intended required fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.