public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Add deprecation notices for datasource endpoints (#49411)

Browse Source 
* Update markdown

* Update swagger
This commit is contained in:
Sofia Papagiannaki
2022-05-23 16:11:47 +02:00
committed by GitHub
parent 01ef899753
commit 060af782df
4 changed files with 474 additions and 432 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/data_source.md
+21 -9
View File
@@ -65,10 +65,12 @@ Content-Type: application/json
]
```
## Get a single data source by Id
## Get a single data source by id
`GET /api/datasources/:datasourceId`
> **Warning:** This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [API for getting a single data source by UID](#get-a-single-data-source-by-uid) or to the [API for getting a single data source by its name](#get-a-single-data-source-by-name).
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
@@ -121,7 +123,7 @@ Content-Type: application/json
}
```
## Get a single data source by UID
## Get a single data source by uid
`GET /api/datasources/uid/:uid`
@@ -177,7 +179,7 @@ Content-Type: application/json
}
```
## Get a single data source by Name
## Get a single data source by name
`GET /api/datasources/name/:name`
@@ -233,7 +235,7 @@ Content-Type: application/json
}
```
## Get data source Id by Name
## Get data source Id by name
`GET /api/datasources/id/:name`
@@ -584,6 +586,8 @@ Content-Type: application/json
`DELETE /api/datasources/:datasourceId`
> **Warning:** This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [API for deleting an existing data source by UID](#delete-an-existing-data-source-by-uid) or to the [API for deleting an existing data source by its name](#delete-an-existing-data-source-by-name)
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
@@ -612,7 +616,7 @@ Content-Type: application/json
{"message":"Data source deleted"}
```
## Delete an existing data source by UID
## Delete an existing data source by uid
`DELETE /api/datasources/uid/:uid`
@@ -682,11 +686,19 @@ Content-Type: application/json
}
```
## Data source proxy calls
## Data source proxy calls by id
> **Warning:** This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source API for proxying requests](#data-source-proxy-calls).
`GET /api/datasources/proxy/:datasourceId/*`
Proxies all calls to the actual data source.
Proxies all calls to the actual data source identified by the `datasourceId`.
## Data source proxy calls
`GET /api/datasources/proxy/uid/:uid/*`
Proxies all calls to the actual data source identified by the `uid`.
## Check data source health by id
@@ -945,9 +957,9 @@ In addition, specific properties of each data source should be added in a reques
The following resources have been deprecated. They will be removed in a future release.
### Query a data source by ID
### Query a data source by id
> **Warning:** This API is deprecated since Grafana v8.5.0 and will be removed in a future release. Refer to the [new data source query API](#query-a-data-source-by-id).
> **Warning:** This API is deprecated since Grafana v8.5.0 and will be removed in a future release. Refer to the [new data source query API](#query-a-data-source).
Queries a data source having a backend implementation.