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.

Sign up for GitHub

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

Jump to bottom

Add data type hints to column and entry descriptions #50

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add data type hints to column and entry descriptions #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 43 additions & 37 deletions API.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1871,31 +1871,47 @@ components:
description: Tags for the entire line
type: integer
format: int32
ColumnHeaderEntry:
DataType:
type: object
properties:
id:
description: Unique id to identify this column in the backend.
type: integer
format: int32
name:
description: Displayed name for this column
type: string
description:
description: Description of the column
unit:
description: The units used for this data, to be appended to the data
type: string
type:
description: Type of data associated to this column
dataType:
description: Type of data a value represents. Gives a hint on the formatting to give to the data
type: string
enum:
- NUMBER
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add some description on what each type means and can be used for? Also, if omitted it's a assumed a type string.

- BINARY_NUMBER
- TIMESTAMP
- DURATION
- STRING
ColumnHeaderEntry:
allOf:
- type: object
properties:
id:
description: Unique id to identify this column in the backend.
type: integer
format: int32
name:
description: Displayed name for this column
type: string
description:
description: Description of the column
type: string
- $ref: '#/components/schemas/DataType'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data type is optional, right? Can you add the list of mandatory and optional properties?

EntryHeader:
type: object
properties:
name:
description: Displayed name for this header
type: string
tooltip:
description: Displayed tooltip for this header. Optional, no tooltip is applied if absent.
type: string
allOf:
- type: object
properties:
name:
description: Displayed name for this header
type: string
tooltip:
description: Displayed tooltip for this header. Optional, no tooltip is applied if absent.
type: string
- $ref: '#/components/schemas/DataType'
required:
- name
XYModel:
Expand Down Expand Up @@ -1954,23 +1970,13 @@ components:
- xValues
- yValues
XYAxis:
type: object
properties:
label:
description: Label to apply to the axis
type: string
unit:
description: The units used for this axis, to be appended to the data
type: string
dataType:
description: Type of data this series represents. Gives a hint on the formatting to give to the data
type: string
enum:
- NUMBER
- BINARY_NUMBER
- TIMESTAMP
- DURATION
- STRING
allOf:
- type: object
properties:
label:
description: Label to apply to the axis
type: string
- $ref: '#/components/schemas/DataType'
TimeGraphModel:
type: object
properties:
Expand Down