Skip to content

Commit

Permalink
Modification on how style endpoint works
Browse files Browse the repository at this point in the history
- Add StyleModel to the response, the model is basically
  a map where keys are arbitrary string and values are defined by
  StyleValues (bgColor, height, ...)
- Key for the styleModel are given by specific model like time
  graph states

Signed-off-by: Simon Delisle <simon.delisle@ericsson.com>
  • Loading branch information
delislesim committed Dec 21, 2018
1 parent 4d505c7 commit 563cd40
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions API.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1086,13 +1086,11 @@ paths:
type: string
responses:
200:
description: Style file that contain all the information necessary for this output (ex. states color and style)
description: Style model that can be use jointly with styleKey to retreive specific style values
content:
application/json:
schema:
description: Style file
type: string
format: binary
$ref: '#/components/schemas/StyleModel'
/filters:
get:
summary: Get the list of filters available.
Expand Down Expand Up @@ -1626,7 +1624,7 @@ components:
type: integer
format: int32
styleKey:
description: optional key to search for the style of this state
description: optional key to search for the style of this state. The style map can be obtained by using the style endpoint.
type: string
TimeGraphRow:
type: object
Expand Down Expand Up @@ -1660,7 +1658,7 @@ components:
type: integer
format: int64
styleKey:
description: optional key to search for the style of this arrow
description: optional key to search for the style of this arrow. The style map can be obtained by using the style endpoint.
type: string
Filter:
type: object
Expand Down Expand Up @@ -1753,3 +1751,25 @@ components:
type: array
items:
$ref: '#/components/schemas/EntryHeader'
StyleValue:
type: object
properties:
bgColor:
type: string
fgColor:
type: string
height:
type: integer
format: int32
font:
type: string
fontColor:
type: string
additionalProperties:
description: Additional properties can be used to add more style key for a specific output (ex. arrowHead, icons, ...)
type: object
StyleModel:
type: object
description: Map of style specific to an output where values gives hints on the style (ex. time graph state)
additionalProperties:
$ref: '#/components/schemas/StyleValue'

0 comments on commit 563cd40

Please sign in to comment.