Skip to content

Commit b307f89

Browse files
docs: Adjust the documentation (#50)
* docs: Adjust the documentation * docs: Update the documentation --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 74edc3a commit b307f89

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Grafana API SDK ![Coverage report](https://github.com/ZPascal/grafana_api_sdk/blob/main/docs/coverage.svg)
2-
The repository includes an SDK for the Grafana API. It's possible to interact with all public available Grafana HTTP API endpoints.
2+
The repository includes an SDK for the Grafana API. It's possible to interact with all publicly available Grafana HTTP API endpoints.
33

44
## Differences between [grafana-client](https://github.com/panodata/grafana-client), [grafana_api](https://github.com/m0nhawk/grafana_api/) and the [grafana_api_sdk](https://github.com/ZPascal/grafana_api_sdk)
5-
The grafana-client is only a fork of the non-maintained grafana_api repository. In general, the grafana-client project started at the same time, as I started this project. The corresponding SDK is a completely new project and based on non-other project and include a few features that are currently not implemented inside the grafana-client.
5+
The grafana-client is only a fork of the non-maintained grafana_api repository. In general, the grafana-client project started at the same time, as I started this project. The corresponding SDK is a completely new project based on nonother projects and includes a few features that are currently not implemented inside the grafana-client.
66

77
The core features that are implemented inside this library:
88

99
- All public Grafana API (HTTP) endpoints are supported
10-
- Full API support for Grafana legacy alerting, current alerting, alerting channels and alert provisioning
10+
- Full API support for Grafana legacy alerting, current alerting, alerting channels, and alert provisioning
1111
- Possibility to specify custom and self-signed certificates
1212
- HTTP/2 support
1313

14-
In general my focus inside this project is to implement and deliver old and new features from the Grafana API, to document all features and functionality clear and to increase the overall test coverage of the project.
14+
In general, my focus on this project is to implement and deliver old and new features from the Grafana API, to document all features and functionality clear,ly and to increase the overall test coverage of the project.
1515

1616
## Currently, supported features
1717

docs/content/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Grafana API SDK
2-
The repository includes an SDK for the Grafana API. It's possible to interact with all public available Grafana HTTP API endpoints.
2+
The repository includes an SDK for the Grafana API. It's possible to interact with all publicly available Grafana HTTP API endpoints.
33

44
The core features that are implemented inside this SDK:
55

66
- All public Grafana API (HTTP) endpoints are supported
7-
- Full API support for Grafana legacy alerting, current alerting, alerting channels and alert provisioning
7+
- Full API support for Grafana legacy alerting, current alerting, alerting channels, and alert provisioning
88
- Possibility to specify custom and self-signed certificates
99
- HTTP/2 support
1010

@@ -138,4 +138,4 @@ model: APIModel = APIModel(host="test", token="test", ssl_context=ssl_ctx)
138138
```
139139

140140
## Templating
141-
If you want to template your JSON document based on a predefined folder structure you can check out one of my other [project](https://github.com/ZPascal/grafana_dashboard_templater) and integrate the functionality inside your code.
141+
If you want to template your JSON document based on a predefined folder structure you can check out one of my other [project](https://github.com/ZPascal/grafana_dashboard_templater) and integrate the functionality inside your code.

docs/grafana_api_sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Grafana API SDK
2-
The repository includes an SDK for the Grafana API. It's possible to interact with all public available Grafana HTTP API endpoints.
2+
The repository includes an SDK for the Grafana API. It's possible to interact with all publicly available Grafana HTTP API endpoints.
33

44
The core features that are implemented inside this SDK:
55

66
- All public Grafana API (HTTP) endpoints are supported
7-
- Full API support for Grafana legacy alerting, current alerting, alerting channels and alert provisioning
7+
- Full API support for Grafana legacy alerting, current alerting, alerting channels, and alert provisioning
88
- Possibility to specify custom and self-signed certificates
99
- HTTP/2 support
1010

@@ -138,4 +138,4 @@ model: APIModel = APIModel(host="test", token="test", ssl_context=ssl_ctx)
138138
```
139139

140140
## Templating
141-
If you want to template your JSON document based on a predefined folder structure you can check out one of my other [project](https://github.com/ZPascal/grafana_dashboard_templater) and integrate the functionality inside your code.
141+
If you want to template your JSON document based on a predefined folder structure you can check out one of my other [project](https://github.com/ZPascal/grafana_dashboard_templater) and integrate the functionality inside your code.

0 commit comments

Comments
 (0)