Skip to content

Commit d239813

Browse files
Add coverage badge and documentation
1 parent 427f039 commit d239813

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/content/grafana_api/model.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
* [AlertmanagerConfig](#grafana_api.model.AlertmanagerConfig)
1212
* [AlertmanagerReceivers](#grafana_api.model.AlertmanagerReceivers)
1313
* [RulerRule](#grafana_api.model.RulerRule)
14+
* [UserObject](#grafana_api.model.UserObject)
1415

1516
<a id="grafana_api.model"></a>
1617

@@ -189,3 +190,20 @@ The class includes all necessary variables to generate a Ruler rule object that
189190
- `record` _str_ - Specify recode value of the rule
190191
- `for_id` _int_ - Specify the id of the rule if you update an existing rule (default 0)
191192

193+
<a id="grafana_api.model.UserObject"></a>
194+
195+
## UserObject Objects
196+
197+
```python
198+
class UserObject(NamedTuple)
199+
```
200+
201+
The class includes all necessary variables to generate a User object that is necessary to update a Grafana User
202+
203+
**Arguments**:
204+
205+
- `email` _str_ - Specify the name of the rule
206+
- `name` _str_ - Specify the annotations of the rule
207+
- `login` _str_ - Specify the expression of the rule
208+
- `theme` _str_ - Specify the Grafana alert of the rule
209+

0 commit comments

Comments
 (0)