Skip to content

Commit

Permalink
doc(readme): add foxglove_layouts to api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillaumebeuzeboc committed Feb 22, 2024
1 parent 41e316a commit 92a580e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ requiring to access the device database.

> | name | type | data type | description |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | None | required | {"uid": "string", "address": "string", "grafana_dashboards"(optional): "list(grafana_json_dashboards)"} | Unique ID and IP address of the device. Grafana dashboards is an optional list of Grafana JSON dashboards |
> | None | required | {"uid": "string", "address": "string", "grafana_dashboards"(optional): "list(grafana_json_dashboards)", "foxglove_layouts"(optional): "dict( "layout_name": {grafana_json_layouts})"} | Unique ID and IP address of the device. `grafana_dashboards` is an optional list of Grafana JSON dashboards. `foxglove_layouts` is an optional dict of layout names and the associated Foxlglove JSON layout. |

##### Responses
Expand Down Expand Up @@ -109,7 +109,7 @@ requiring to access the device database.

> | name | type | data type | description |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | None | required | {"field: "value"} | Field to modify. Can be: address and grafana_dashboards |
> | None | required | {"field: "value"} | Field to modify. Can be: address, grafana_dashboards or and foxglove_layouts |

##### Responses
Expand Down

0 comments on commit 92a580e

Please sign in to comment.