influxdata / influxdata/openapi

/dashboards/{dashboardID}/cells PUT - property viewID in Cell schema seems to be ignored

Open
#622 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

In the common schema `Cell` is a property `viewID`. I've tried to set erroneous values to this property and send it as part of a requestBody, however it seems to be ignored by the server. Does it still serve a purpose? Or since views are now handled by the `../cells/${cellID}/views` context, can it be removed?

src/common/schemas/Cell.yml

```
type: object
properties:
id:
type: string
links:
type: object
properties:
self:
type: string
view:
type: string
x:
type: integer
format: int32
"y": # Quoted to prevent YAML parser from interpreting y as shorthand for true.
type: integer
format: int32
w:
type: integer
format: int32
h:
type: integer
format: int32
viewID:
type: string
description: The reference to a view from the views API.

```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with src/common/schemas/Cell.yml and the PUT /dashboards/{dashboardID}/cells endpoint, then compare the Cell viewID property with the ../cells/${cellID}/views API context. Confirm whether viewID is consumed or ignored, and document or implement the schema change needed so the specification matches the API behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, yaml
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.