influxdata / influxdata/openapi

/dashboards - POST - able to create dashboard without name property in the request

Open
#619 0 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

Looking at the schema `src/common/schemas/CreateDashboardRequest.yml` ...

```
properties:
orgID:
type: string
description: The ID of the organization that owns the dashboard.
name:
type: string
description: The user-facing name of the dashboard.
description:
type: string
description: The user-facing description of the dashboard.
required:
- orgID
- name
```
... I see that the name property is __required__.

However when testing the `/dashboards` endpoint for `POST` against the latest influxdb implementation. I am able to create a dashboard with the `name` property missing from the request.

Is this definition up to date? Or is this an issue in influxdb?

Testing against K8S-IDPE remocal. Latest commit.

```
commit 36edfae0f1409f79490e31e43846c9e258329e2c (HEAD -> master, origin/master, origin/HEAD)
Author: Cannon Palms
Date: Mon Nov 28 21:23:47 2022 -0500

```

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 src/common/schemas/CreateDashboardRequest.yml and reproduce the POST /dashboards request against the referenced latest InfluxDB implementation, omitting name. Compare the observed behavior with the schema's required properties; done means the discrepancy is confirmed and the schema or endpoint behavior is aligned.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
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.