Skip to content

Commit c6bcfc4

Browse files
author
Davide Schiera
committed
Fixed formatting.
1 parent 7117a7f commit c6bcfc4

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -85,29 +85,36 @@ A dictionary describing the just created alert, with the format described at [th
8585
[examples/create_alert.py](examples/create_alert.py).
8686

8787
#### `create_dashboard(self, name)`
88-
**Description**
88+
**Description**
8989
Creates an empty dashboard. You can then add panels by using `add_dashboard_panel`.
90-
**Arguments**
90+
91+
**Arguments**
9192
- **name**: the name of the dashboard that will be created.
92-
**Success Return Value**
93+
94+
**Success Return Value**
9395
A dictionary showing the details of the new dashboard.
94-
**Example**
96+
97+
**Example**
9598
[examples/dashboard.py](examples/dashboard.py).
9699

97100
#### `find_dashboard_by(self, name)`
98-
**Description**
101+
**Description**
99102
Finds dashboards with the specified name. You can then delete the dashboard (with `delete_dashboard`) or edit panels (with `add_dashboard_panel` and `remove_dashboard_panel`)
100-
**Arguments**
103+
104+
**Arguments**
101105
- **name**: the name of the dashboards to find.
102-
**Success Return Value**
106+
107+
**Success Return Value**
103108
A list of dictionaries of dashboards matching the specified name.
104-
**Example**
109+
110+
**Example**
105111
[examples/dashboard.py](examples/dashboard.py).
106112

107113
#### `add_dashboard_panel(self, dashboard, name, type, metrics, scope=None, layout=None, sort_by=None, paging=None)`
108-
**Description**
114+
**Description**
109115
Adds a panel to the dashboard. A panel can be a time series, or a top chart (i.e. bar chart), or a number panel.
110-
**Arguments**
116+
117+
**Arguments**
111118
- **dashboard**: dashboard to edit
112119
- **name**: name of the new panel
113120
- **type**: type of the new panel. Valid values are: `timeSeries`, `top`, `number`
@@ -116,19 +123,24 @@ Adds a panel to the dashboard. A panel can be a time series, or a top chart (i.e
116123
- **sort_by**: Data sorting; The parameter is optional and it's a dictionary of `metric` and `mode` (it can be `desc` or `asc`)
117124
- **paging**: Data pagination; The parameter is optional and limits the data points returned. The parameter is a dictionary of `from` and `to` with the index of the first and last point respectively
118125
- **layout**: Size and position of the panel
119-
**Success Return Value**
126+
127+
**Success Return Value**
120128
A dictionary showing the details of the edited dashboard.
121-
**Example**
129+
130+
**Example**
122131
[examples/dashboard.py](examples/dashboard.py).
123132

124133
#### `remove_dashboard_panel(self, dashboard, panel_name)`
125-
**Description**
134+
**Description**
126135
Removes a panel from the dashboard. The panel to remove is identified by the specified `name`.
127-
**Arguments**
136+
137+
**Arguments**
128138
- **name**: name of the panel to find and remove
129-
**Success Return Value**
139+
140+
**Success Return Value**
130141
A dictionary showing the details of the edited dashboard.
131-
**Example**
142+
143+
**Example**
132144
[examples/dashboard.py](examples/dashboard.py).
133145

134146
#### `create_dashboard_from_dashboard(self, newdashname, templatename, filter)`

0 commit comments

Comments
 (0)