Skip to content

feat: add colorMapping property type to the swagger definition #248

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

Merged
ChitlangeSahas merged 5 commits into from
Dec 20, 2021
Merged

feat: add colorMapping property type to the swagger definition #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
615fa7a
feat: add colorMapping property type to the swagger definition
ChitlangeSahas Dec 15, 2021
c9d0c5a
fix: lint yaml new line
ChitlangeSahas Dec 15, 2021
018d238
Merge branch 'master' into sahas-color-mapping
ChitlangeSahas Dec 17, 2021
b0c3996
chore: PR comments, better description and examples
ChitlangeSahas Dec 20, 2021
8f9c143
chore: lint new line
ChitlangeSahas Dec 20, 2021
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
10 changes: 10 additions & 0 deletions contracts/cloud-diff.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1406,6 +1406,16 @@ paths:
type: array
items:
$ref: '#/paths/~1dashboards/post/responses/201/content/application~1json/schema/oneOf/1/allOf/1/properties/cells/items/allOf/1/properties/properties/oneOf/0/properties/colors/items'
colorMapping:
description: An object that contains information about the color mapping
type: object
additionalProperties:
type: int
example:
series_id_1: 0
series_id_2: 1
measurement_birdmigration_europe: 0
configcat_deployments-autopromotionblocker: 0
shape:
type: string
enum:
Expand Down
17 changes: 17 additions & 0 deletions contracts/cloud.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13537,6 +13537,10 @@
"$ref": "#/components/schemas/DashboardColor"
}
},
"colorMapping": {
"description": "An object that contains information about the color mapping",
"$ref": "#/components/schemas/ColorMapping"
},
"shape": {
"type": "string",
"enum": [
Expand Down Expand Up @@ -17439,6 +17443,19 @@
"explicit"
]
},
"ColorMapping": {
"type": "object",
"description": "A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.",
"additionalProperties": {
"type": "int"
},
"example": {
"series_id_1": 0,
"series_id_2": 1,
"measurement_birdmigration_europe": 0,
"configcat_deployments-autopromotionblocker": 0
}
},
"DemoDataBucket": {
"properties": {
"links": {
Expand Down
13 changes: 13 additions & 0 deletions contracts/cloud.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8615,6 +8615,9 @@ components:
type: array
items:
$ref: '#/components/schemas/DashboardColor'
colorMapping:
description: An object that contains information about the color mapping
$ref: '#/components/schemas/ColorMapping'
shape:
type: string
enum:
Expand Down Expand Up @@ -11240,6 +11243,16 @@ components:
enum:
- implicit
- explicit
ColorMapping:
type: object
description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
additionalProperties:
type: int
example:
series_id_1: 0
series_id_2: 1
measurement_birdmigration_europe: 0
configcat_deployments-autopromotionblocker: 0
DemoDataBucket:
properties:
links:
Expand Down
13 changes: 13 additions & 0 deletions contracts/common.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7468,6 +7468,9 @@ components:
type: array
items:
$ref: '#/components/schemas/DashboardColor'
colorMapping:
description: An object that contains information about the color mapping
$ref: '#/components/schemas/ColorMapping'
shape:
type: string
enum:
Expand Down Expand Up @@ -10093,6 +10096,16 @@ components:
enum:
- implicit
- explicit
ColorMapping:
type: object
description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
additionalProperties:
type: int
example:
series_id_1: 0
series_id_2: 1
Copy link
Contributor

@hoorayimhelping hoorayimhelping Dec 15, 2021

Choose a reason for hiding this comment

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

this is a decent example, but it might be more illustrative if the series ids were more like how they'll be in real life using a common example that many people in the company would be familar with:

measurement_birdmigration_europe: 0

that isn't a very good example, but I'm sure you can find a more common example using sample data or something like that?

measurement_birdmigration_europe: 0
configcat_deployments-autopromotionblocker: 0
responses:
ServerError:
description: Non 2XX error response from server.
Expand Down
10 changes: 10 additions & 0 deletions contracts/oss-diff.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2363,6 +2363,16 @@ paths:
type: array
items:
$ref: '#/paths/~1dashboards/post/responses/201/content/application~1json/schema/oneOf/1/allOf/1/properties/cells/items/allOf/1/properties/properties/oneOf/0/properties/colors/items'
colorMapping:
description: An object that contains information about the color mapping
type: object
additionalProperties:
type: int
example:
series_id_1: 0
series_id_2: 1
measurement_birdmigration_europe: 0
configcat_deployments-autopromotionblocker: 0
shape:
type: string
enum:
Expand Down
17 changes: 17 additions & 0 deletions contracts/oss.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14880,6 +14880,10 @@
"$ref": "#/components/schemas/DashboardColor"
}
},
"colorMapping": {
"description": "An object that contains information about the color mapping",
"$ref": "#/components/schemas/ColorMapping"
},
"shape": {
"type": "string",
"enum": [
Expand Down Expand Up @@ -18782,6 +18786,19 @@
"explicit"
]
},
"ColorMapping": {
"type": "object",
"description": "A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.",
"additionalProperties": {
"type": "int"
},
"example": {
"series_id_1": 0,
"series_id_2": 1,
"measurement_birdmigration_europe": 0,
"configcat_deployments-autopromotionblocker": 0
}
},
"Authorization": {
"required": [
"orgID",
Expand Down
13 changes: 13 additions & 0 deletions contracts/oss.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9427,6 +9427,9 @@ components:
type: array
items:
$ref: '#/components/schemas/DashboardColor'
colorMapping:
description: An object that contains information about the color mapping
$ref: '#/components/schemas/ColorMapping'
shape:
type: string
enum:
Expand Down Expand Up @@ -12052,6 +12055,16 @@ components:
enum:
- implicit
- explicit
ColorMapping:
type: object
description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
additionalProperties:
type: int
example:
series_id_1: 0
series_id_2: 1
measurement_birdmigration_europe: 0
configcat_deployments-autopromotionblocker: 0
Authorization:
required:
- orgID
Expand Down
14 changes: 14 additions & 0 deletions contracts/ref/cloud.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,6 +723,17 @@ components:
type: array
links:
$ref: '#/components/schemas/Links'
ColorMapping:
additionalProperties:
type: int
description: A color mapping is an object that maps time series data to a UI
color scheme to allow the UI to render graphs consistent colors across reloads.
example:
configcat_deployments-autopromotionblocker: 0
measurement_birdmigration_europe: 0
series_id_1: 0
series_id_2: 1
type: object
ColumnDataType:
enum:
- integer
Expand Down Expand Up @@ -5764,6 +5775,9 @@ components:
properties:
axes:
$ref: '#/components/schemas/Axes'
colorMapping:
$ref: '#/components/schemas/ColorMapping'
description: An object that contains information about the color mapping
colors:
description: Colors define color encoding of data into a visualization
items:
Expand Down
14 changes: 14 additions & 0 deletions contracts/ref/oss.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,6 +788,17 @@ components:
type: array
links:
$ref: '#/components/schemas/Links'
ColorMapping:
additionalProperties:
type: int
description: A color mapping is an object that maps time series data to a UI
color scheme to allow the UI to render graphs consistent colors across reloads.
example:
configcat_deployments-autopromotionblocker: 0
measurement_birdmigration_europe: 0
series_id_1: 0
series_id_2: 1
type: object
ConditionalExpression:
description: Selects one of two expressions, `Alternate` or `Consequent`, depending
on a third boolean expression, `Test`
Expand Down Expand Up @@ -5687,6 +5698,9 @@ components:
properties:
axes:
$ref: '#/components/schemas/Axes'
colorMapping:
$ref: '#/components/schemas/ColorMapping'
description: An object that contains information about the color mapping
colors:
description: Colors define color encoding of data into a visualization
items:
Expand Down
2 changes: 2 additions & 0 deletions src/common/_schemas.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,3 +448,5 @@
$ref: "./common/schemas/DBRPGet.yml"
SchemaType:
$ref: "./common/schemas/SchemaType.yml"
ColorMapping:
$ref: "./common/schemas/ColorMapping.yml"
9 changes: 9 additions & 0 deletions src/common/schemas/ColorMapping.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
type: object
description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
additionalProperties:
type: int
example:
series_id_1: 0
series_id_2: 1
measurement_birdmigration_europe: 0
configcat_deployments-autopromotionblocker: 0
3 changes: 3 additions & 0 deletions src/common/schemas/XYViewProperties.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
type: array
items:
$ref: "./DashboardColor.yml"
colorMapping:
description: An object that contains information about the color mapping
$ref: "./ColorMapping.yml"
Comment on lines +27 to +29
Copy link
Contributor Author

@ChitlangeSahas ChitlangeSahas Dec 15, 2021

Choose a reason for hiding this comment

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

These changes are mine.

shape:
type: string
enum: ["chronograf-v2"]
Expand Down