Skip to content

Commit f500bb2

Browse files
Add coverage badge and documentation
1 parent 906dfec commit f500bb2

File tree

2 files changed

+27
-6
lines changed

2 files changed

+27
-6
lines changed

docs/content/grafana_api/model.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
* [FindAnnotationObject](#grafana_api.model.FindAnnotationObject)
2121
* [AnnotationObject](#grafana_api.model.AnnotationObject)
2222
* [AnnotationGraphiteObject](#grafana_api.model.AnnotationGraphiteObject)
23+
* [GlobalUser](#grafana_api.model.GlobalUser)
2324

2425
<a id="grafana_api.model"></a>
2526

@@ -354,3 +355,21 @@ The class includes all necessary variables to generate a Graphite annotation obj
354355
- `when` _int_ - Specify the optional time as number in milliseconds
355356
- `data` _str_ - Specify the optional annotation description message
356357

358+
<a id="grafana_api.model.GlobalUser"></a>
359+
360+
## GlobalUser Objects
361+
362+
```python
363+
class GlobalUser(NamedTuple)
364+
```
365+
366+
The class includes all necessary variables to generate a global user object
367+
368+
**Arguments**:
369+
370+
- `name` _str_ - Specify the name of the user
371+
- `email` _str_ - Specify the email of the user
372+
- `login` _str_ - Specify the login type of the user
373+
- `password` _str_ - Specify the password of the user
374+
- `org_id` _int_ - Specify the optional org id of the user (default None)
375+

docs/content/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ The repository includes an SDK for the Grafana API. It's possible to communicate
55

66
The following list describes the currently supported features of the Grafana API functionality.
77

8-
- [ ] [Admin HTTP API](https://grafana.com/docs/grafana/latest/http_api/admin/)
8+
- [x] [Admin HTTP API](https://grafana.com/docs/grafana/latest/http_api/admin/)
99
- [x] [Legacy Alerting HTTP API](https://grafana.com/docs/grafana/latest/http_api/alerting/)
1010
- [x] [Alerting HTTP API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json)
1111
- [x] [Alerting Notification Channels HTTP API](https://grafana.com/docs/grafana/latest/http_api/alerting_notification_channels/)
12-
- [ ] [Annotations HTTP API](https://grafana.com/docs/grafana/latest/http_api/annotations/)
13-
- [ ] [Authentication HTTP API](https://grafana.com/docs/grafana/latest/http_api/auth/)
12+
- [x] [Annotations HTTP API](https://grafana.com/docs/grafana/latest/http_api/annotations/)
13+
- [x] [Authentication HTTP API](https://grafana.com/docs/grafana/latest/http_api/auth/)
1414
- [x] [Data source HTTP API](https://grafana.com/docs/grafana/latest/http_api/data_source/)
1515
- [x] [Datasource Permissions HTTP API](https://grafana.com/docs/grafana/latest/http_api/datasource_permissions/)
1616
- [x] [Folder HTTP API](https://grafana.com/docs/grafana/v7.5/http_api/folder/)
1717
- [x] [Folder Permissions HTTP API](https://grafana.com/docs/grafana/v7.5/http_api/folder_permissions/)
1818
- [x] [Search HTTP API](https://grafana.com/docs/grafana/v7.5/http_api/folder_dashboard_search/)
19-
- [ ] [External Group Sync HTTP API](https://grafana.com/docs/grafana/latest/http_api/external_group_sync/)
20-
- [ ] [Fine-grained access control HTTP API](https://grafana.com/docs/grafana/latest/http_api/access_control/)
21-
- [ ] [HTTP Preferences API](https://grafana.com/docs/grafana/latest/http_api/preferences/)
19+
- [x] [External Group Sync HTTP API](https://grafana.com/docs/grafana/latest/http_api/external_group_sync/)
20+
- [ ] [Access control HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/access_control/)
21+
- [x] [HTTP Preferences API](https://grafana.com/docs/grafana/latest/http_api/preferences/)
2222
- [x] [HTTP Snapshot API](https://grafana.com/docs/grafana/latest/http_api/snapshot/)
2323
- [ ] [Library Element HTTP API](https://grafana.com/docs/grafana/latest/http_api/library_element/)
2424
- [x] [Query History API](https://grafana.com/docs/grafana/latest/http_api/query_history/)
@@ -30,6 +30,8 @@ The following list describes the currently supported features of the Grafana API
3030
- [x] [Short URL HTTP API](https://grafana.com/docs/grafana/latest/http_api/short_url/)
3131
- [x] [Team HTTP API](https://grafana.com/docs/grafana/latest/http_api/team/)
3232
- [x] [User HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/)
33+
- [ ] [Service Account HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/)
34+
- [ ] [Alerting Provisioning HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/)
3335

3436
## Installation
3537

0 commit comments

Comments
 (0)