Telegrafs - TelegrafPluginRequest and TelegrafRequest have no required properties

Open

#610 opened on Nov 10, 2022 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 2/5
Estimated time: 1-3 hours
Newbie friendliness: 52/100

Issue type: Bug
Clarity: Clearly specified
Activity status: Stale
Tech stack: openapi
Domain: api

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.

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

# 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

  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 <jstirnaman@influxdata.com>
Date:   Tue Nov 8 11:50:47 2022 -0600

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

Contributor guide

No contributing guide indexed for this repository

First steps

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

Similar issues

Bob Shell support Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 65/100

rossoctl/cortex#1119 · Opened Sep 24, 2026
bench: run.sh's skip-update message always cites bench/skips.txt Open

tooling

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

svandragt/vivace#313 · Opened Sep 24, 2026
set CHECKED_HASH mode for compiled python assets Open

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

openSUSE/python-rpm-macros#219 · Opened Sep 24, 2026
Problem with the get_network_interface function Open

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

YunoHost-Apps/adguardhome_ynh#258 · Opened Sep 24, 2026
steam-short-session-tracker: incorrect registry backup path resets settings during automatic repair Open

Difficulty 2/5 1-3 hours Newbie friendliness 80/100

ValveSoftware/SteamOS#2829 · Opened Sep 24, 2026

More Shell/Bash issues