Skip to content
This repository was archived by the owner on Aug 4, 2025. It is now read-only.

Commit 72ab470

Browse files
committed
add health route to readme
1 parent c19e740 commit 72ab470

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,14 @@ for example, if you are using Grafana with containers, add:
3636

3737
You REST API application should return data in the following format:
3838

39+
### Fetch Graph
40+
41+
This route returns the graph which is intended to visualize.
42+
3943
endpoint: `/api/fetchgraph`
4044

45+
method: `GET`
46+
4147
content type: `application/json`
4248

4349
Data Format example:
@@ -48,13 +54,24 @@ Data Format example:
4854

4955
For more detail of the variables please visit [here](https://grafana.com/docs/grafana/latest/visualizations/node-graph/#data-api).
5056

57+
### Health
58+
59+
This route is for testing the health of the API which is used by the *Save & Test* action while adding the plugin.[(Part 2 of the Getting Started Section)](#getting-started).
60+
Currently, it only needs to return `200` status code in case of a success connection.
61+
62+
endpoint: `/api/health`
63+
64+
method: `GET`
65+
66+
success status code: `200`
67+
5168
## Compiling the data source by yourself
5269

5370
1. Install dependencies
5471

55-
```bash
56-
yarn install
57-
```
72+
```bash
73+
yarn install
74+
```
5875

5976
2. Build plugin in development mode or run in watch mode
6077

0 commit comments

Comments
 (0)