apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

Browse Source 
* Update markdown

* Update swagger
pull/49421/head
Sofia Papagiannaki 3 years ago committed by GitHub
parent 01ef899753
commit 060af782df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 337 additions and 295 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 30
      docs/sources/developers/http_api/data_source.md
  2. 68
      pkg/api/docs/definitions/datasources.go
  3. 267
      public/api-merged.json
  4. 267
      public/api-spec.json

30
docs/sources/developers/http_api/data_source.md
Unescape 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.

68
pkg/api/docs/definitions/datasources.go
Unescape View File

@ -37,7 +37,7 @@ import (
// 409: conflictError
// 500: internalServerError
// swagger:route PUT /datasources/{datasource_id} datasources updateDatasourceByID
// swagger:route PUT /datasources/{id} datasources updateDatasourceByID
//
// Update an existing data source by its sequential ID.
//
@ -58,7 +58,7 @@ import (
// 403: forbiddenError
// 500: internalServerError
// swagger:route PUT /datasources/uid/{datasource_uid} datasources updateDatasourceByUID
// swagger:route PUT /datasources/uid/{uid} datasources updateDatasourceByUID
//
// Update an existing data source.
//
@ -75,12 +75,16 @@ import (
// 403: forbiddenError
// 500: internalServerError
// swagger:route DELETE /datasources/{datasource_id} datasources deleteDatasourceByID
// swagger:route DELETE /datasources/{id} datasources deleteDatasourceByID
//
// Delete an existing data source by id.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).
// you need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).
//
// Please refer to [updated API](#/datasources/deleteDatasourceByUID) instead
//
// Deprecated: true
//
// Responses:
// 200: okResponse
@ -89,7 +93,7 @@ import (
// 403: forbiddenError
// 500: internalServerError
// swagger:route DELETE /datasources/uid/{datasource_uid} datasources deleteDatasourceByUID
// swagger:route DELETE /datasources/uid/{uid} datasources deleteDatasourceByUID
//
// Delete an existing data source by UID.
//
@ -103,7 +107,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route DELETE /datasources/name/{datasource_name} datasources deleteDatasourceByName
// swagger:route DELETE /datasources/name/{name} datasources deleteDatasourceByName
//
// Delete an existing data source by name.
//
@ -117,12 +121,16 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route GET /datasources/{datasource_id} datasources getDatasourceByID
// swagger:route GET /datasources/{id} datasources getDatasourceByID
//
// Get a single data source by Id.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).
// you need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).
//
// Please refer to [updated API](#/datasources/getDatasourceByUID) instead
//
// Deprecated: true
//
// Responses:
// 200: getDatasourceResponse
@ -132,7 +140,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route GET /datasources/uid/{datasource_uid} datasources getDatasourceByUID
// swagger:route GET /datasources/uid/{uid} datasources getDatasourceByUID
//
// Get a single data source by UID.
//
@ -147,7 +155,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route GET /datasources/{datasource_id}/health datasources checkDatasourceHealthByID
// swagger:route GET /datasources/{id}/health datasources checkDatasourceHealthByID
//
// Check data source health by Id.
//
@ -162,7 +170,7 @@ import (
// 403: forbiddenError
// 500: internalServerError
// swagger:route GET /datasources/uid/{datasource_uid}/health datasources checkDatasourceHealth
// swagger:route GET /datasources/uid/{uid}/health datasources checkDatasourceHealth
//
// Check data source health by Id.
//
@ -173,7 +181,7 @@ import (
// 403: forbiddenError
// 500: internalServerError
// swagger:route GET /datasources/{datasource_id}/resources/{datasource_proxy_route} datasources fetchDatasourceResourcesByID
// swagger:route GET /datasources/{id}/resources/{datasource_proxy_route} datasources fetchDatasourceResourcesByID
//
// Fetch data source resources by Id.
//
@ -189,7 +197,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route GET /datasources/uid/{datasource_uid}/resources/{datasource_proxy_route} datasources fetchDatasourceResources
// swagger:route GET /datasources/uid/{uid}/resources/{datasource_proxy_route} datasources fetchDatasourceResources
//
// Fetch data source resources.
//
@ -201,7 +209,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route GET /datasources/name/{datasource_name} datasources getDatasourceByName
// swagger:route GET /datasources/name/{name} datasources getDatasourceByName
//
// Get a single data source by Name.
//
@ -214,7 +222,7 @@ import (
// 403: forbiddenError
// 500: internalServerError
// swagger:route GET /datasources/id/{datasource_name} datasources getDatasourceIdByName
// swagger:route GET /datasources/id/{name} datasources getDatasourceIdByName
//
// Get data source Id by Name.
//
@ -228,12 +236,16 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route GET /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyGETcalls
// swagger:route GET /datasources/proxy/{id}/{datasource_proxy_route} datasources datasourceProxyGETcalls
//
// Data source proxy GET calls.
//
// Proxies all calls to the actual data source.
//
// Please refer to [updated API](#/datasources/datasourceProxyGETByUIDcalls) instead
//
// Deprecated: true
//
// Responses:
// 200:
// 400: badRequestError
@ -242,7 +254,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route GET /datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route} datasources datasourceProxyGETByUIDcalls
// swagger:route GET /datasources/proxy/uid/{uid}/{datasource_proxy_route} datasources datasourceProxyGETByUIDcalls
//
// Data source proxy GET calls.
//
@ -256,12 +268,16 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route POST /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyPOSTcalls
// swagger:route POST /datasources/proxy/{id}/{datasource_proxy_route} datasources datasourceProxyPOSTcalls
//
// Data source proxy POST calls.
//
// Proxies all calls to the actual data source. The data source should support POST methods for the specific path and role as defined
//
// Please refer to [updated API](#/datasources/datasourceProxyPOSTByUIDcalls) instead
//
// Deprecated: true
//
// Responses:
// 201:
// 202:
@ -271,7 +287,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route POST /datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route} datasources datasourceProxyPOSTByUIDcalls
// swagger:route POST /datasources/proxy/uid/{uid}/{datasource_proxy_route} datasources datasourceProxyPOSTByUIDcalls
//
// Data source proxy POST calls.
//
@ -286,12 +302,16 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route DELETE /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyDELETEcalls
// swagger:route DELETE /datasources/proxy/{id}/{datasource_proxy_route} datasources datasourceProxyDELETEcalls
//
// Data source proxy DELETE calls.
//
// Proxies all calls to the actual data source.
//
// Please refer to [updated API](#/datasources/datasourceProxyDELETEByUIDcalls) instead
//
// Deprecated: true
//
// Responses:
// 202:
// 400: badRequestError
@ -300,7 +320,7 @@ import (
// 404: notFoundError
// 500: internalServerError
// swagger:route DELETE /datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route} datasources datasourceProxyDELETEByUIDcalls
// swagger:route DELETE /datasources/proxy/uid/{uid}/{datasource_proxy_route} datasources datasourceProxyDELETEByUIDcalls
//
// Data source proxy DELETE calls.
//
@ -343,7 +363,7 @@ import (
type DatasourceID struct {
// in:path
// required:true
DatasourceID string `json:"datasource_id"`
DatasourceID string `json:"id"`
}
// swagger:parameters updateDatasourceByUID deleteDatasourceByUID getDatasourceByUID datasourceProxyGETByUIDcalls datasourceProxyPOSTByUIDcalls datasourceProxyDELETEByUIDcalls
@ -351,14 +371,14 @@ type DatasourceID struct {
type DatasourceUID struct {
// in:path
// required:true
DatasourceUID string `json:"datasource_uid"`
DatasourceUID string `json:"uid"`
}
// swagger:parameters getDatasourceByName deleteDatasourceByName getDatasourceIdByName
type DatasourceName struct {
// in:path
// required:true
DatasourceName string `json:"datasource_name"`
DatasourceName string `json:"name"`
}
// swagger:parameters datasourceProxyGETcalls datasourceProxyPOSTcalls datasourceProxyDELETEcalls datasourceProxyGETByUIDcalls

267
public/api-merged.json
Unescape View File

@ -506,6 +506,14 @@
"summary": "Add a user role assignment.",
"operationId": "addUserRole",
"parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
},
{
"x-go-name": "Body",
"name": "body",
@ -514,14 +522,6 @@
"schema": {
"$ref": "#/definitions/AddUserRoleCommand"
}
},
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
@ -547,6 +547,14 @@
"summary": "Remove a user role assignment.",
"operationId": "removeUserRole",
"parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "RoleUID",
@ -560,14 +568,6 @@
"description": "A flag indicating if the assignment is global or not. If set to false, the default org ID of the authenticated user will be used from the request to remove assignment.",
"name": "global",
"in": "query"
},
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
@ -4195,7 +4195,7 @@
}
}
},
"/datasources/id/{datasource_name}": {
"/datasources/id/{name}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:name:*` and `datasources:name:test_datasource` (single data source).",
"tags": ["datasources"],
@ -4205,7 +4205,7 @@
{
"type": "string",
"x-go-name": "DatasourceName",
"name": "datasource_name",
"name": "name",
"in": "path",
"required": true
}
@ -4229,7 +4229,7 @@
}
}
},
"/datasources/name/{datasource_name}": {
"/datasources/name/{name}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:name:*` and `datasources:name:test_datasource` (single data source).",
"tags": ["datasources"],
@ -4239,7 +4239,7 @@
{
"type": "string",
"x-go-name": "DatasourceName",
"name": "datasource_name",
"name": "name",
"in": "path",
"required": true
}
@ -4268,7 +4268,7 @@
{
"type": "string",
"x-go-name": "DatasourceName",
"name": "datasource_name",
"name": "name",
"in": "path",
"required": true
}
@ -4292,7 +4292,7 @@
}
}
},
"/datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route}": {
"/datasources/proxy/uid/{uid}/{datasource_proxy_route}": {
"get": {
"description": "Proxies all calls to the actual data source.",
"tags": ["datasources"],
@ -4302,7 +4302,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -4344,7 +4344,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -4389,7 +4389,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -4423,17 +4423,18 @@
}
}
},
"/datasources/proxy/{datasource_id}/{datasource_proxy_route}": {
"/datasources/proxy/{id}/{datasource_proxy_route}": {
"get": {
"description": "Proxies all calls to the actual data source.",
"description": "Proxies all calls to the actual data source.\n\nPlease refer to [updated API](#/datasources/datasourceProxyGETByUIDcalls) instead",
"tags": ["datasources"],
"summary": "Data source proxy GET calls.",
"operationId": "datasourceProxyGETcalls",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
@ -4467,15 +4468,16 @@
}
},
"post": {
"description": "Proxies all calls to the actual data source. The data source should support POST methods for the specific path and role as defined",
"description": "Proxies all calls to the actual data source. The data source should support POST methods for the specific path and role as defined\n\nPlease refer to [updated API](#/datasources/datasourceProxyPOSTByUIDcalls) instead",
"tags": ["datasources"],
"summary": "Data source proxy POST calls.",
"operationId": "datasourceProxyPOSTcalls",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
@ -4520,15 +4522,16 @@
}
},
"delete": {
"description": "Proxies all calls to the actual data source.",
"description": "Proxies all calls to the actual data source.\n\nPlease refer to [updated API](#/datasources/datasourceProxyDELETEByUIDcalls) instead",
"tags": ["datasources"],
"summary": "Data source proxy DELETE calls.",
"operationId": "datasourceProxyDELETEcalls",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
@ -4562,7 +4565,7 @@
}
}
},
"/datasources/uid/{datasource_uid}": {
"/datasources/uid/{uid}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:kLtEtcRGk` (single data source).",
"tags": ["datasources"],
@ -4572,7 +4575,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
}
@ -4607,7 +4610,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -4644,7 +4647,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
}
@ -4668,7 +4671,7 @@
}
}
},
"/datasources/uid/{datasource_uid}/health": {
"/datasources/uid/{uid}/health": {
"get": {
"tags": ["datasources"],
"summary": "Check data source health by Id.",
@ -4677,7 +4680,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
}
@ -4701,7 +4704,7 @@
}
}
},
"/datasources/uid/{datasource_uid}/resources/{datasource_proxy_route}": {
"/datasources/uid/{uid}/resources/{datasource_proxy_route}": {
"get": {
"tags": ["datasources"],
"summary": "Fetch data source resources.",
@ -4710,7 +4713,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -4744,24 +4747,24 @@
}
}
},
"/datasources/{datasource_id}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags": ["datasources"],
"summary": "Get a single data source by Id.",
"operationId": "getDatasourceByID",
"/datasources/{datasource_id}/disable-permissions": {
"post": {
"description": "Disables permissions for the data source with the given id. All existing permissions will be removed and anyone will be able to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Disable permissions for a data source.",
"operationId": "disablePermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/getDatasourceResponse"
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
@ -4779,62 +4782,63 @@
"$ref": "#/responses/internalServerError"
}
}
},
"put": {
"description": "Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/updateDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Update an existing data source by its sequential ID.",
"operationId": "updateDatasourceByID",
"deprecated": true,
}
},
"/datasources/{datasource_id}/enable-permissions": {
"post": {
"description": "Enables permissions for the data source with the given id.\nNo one except Org Admins will be able to query the data source until permissions have been added\nwhich permit certain users or teams to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Enable permissions for a data source.",
"operationId": "enablePermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
{
"name": "Body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateDataSourceCommand"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"403": {
"$ref": "#/responses/forbiddenError"
},
"404": {
"$ref": "#/responses/notFoundError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
},
"delete": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags": ["datasources"],
"summary": "Delete an existing data source by id.",
"operationId": "deleteDatasourceByID",
}
},
"/datasources/{datasource_id}/permissions": {
"get": {
"description": "Gets all existing permissions for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:read` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Get permissions for a data source.",
"operationId": "getPermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/okResponse"
"$ref": "#/responses/getPermissionseResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -4851,27 +4855,31 @@
}
}
},
"/datasources/{datasource_id}/disable-permissions": {
"post": {
"description": "Disables permissions for the data source with the given id. All existing permissions will be removed and anyone will be able to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"/datasources/{datasource_id}/permissions/{permissionId}": {
"delete": {
"description": "Removes the permission with the given permissionId for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:delete` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Disable permissions for a data source.",
"operationId": "disablePermissions",
"summary": "Remove permission for a data source.",
"operationId": "deletePermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "PermissionID",
"name": "permissionId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
"$ref": "#/responses/okResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -4888,24 +4896,25 @@
}
}
},
"/datasources/{datasource_id}/enable-permissions": {
"post": {
"description": "Enables permissions for the data source with the given id.\nNo one except Org Admins will be able to query the data source until permissions have been added\nwhich permit certain users or teams to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Enable permissions for a data source.",
"operationId": "enablePermissions",
"/datasources/{id}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/getDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Get a single data source by Id.",
"operationId": "getDatasourceByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/createOrUpdateDatasourceResponse"
"$ref": "#/responses/getDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
@ -4923,30 +4932,33 @@
"$ref": "#/responses/internalServerError"
}
}
}
},
"/datasources/{datasource_id}/health": {
"get": {
"description": "Please refer to [updated API](#/datasources/checkDatasourceHealth) instead",
},
"put": {
"description": "Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/updateDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Check data source health by Id.",
"operationId": "checkDatasourceHealthByID",
"summary": "Update an existing data source by its sequential ID.",
"operationId": "updateDatasourceByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
{
"name": "Body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateDataSourceCommand"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/okResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -4958,26 +4970,25 @@
"$ref": "#/responses/internalServerError"
}
}
}
},
"/datasources/{datasource_id}/permissions": {
"get": {
"description": "Gets all existing permissions for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:read` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Get permissions for a data source.",
"operationId": "getPermissions",
},
"delete": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/deleteDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Delete an existing data source by id.",
"operationId": "deleteDatasourceByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/getPermissionseResponse"
"$ref": "#/responses/okResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -4994,24 +5005,18 @@
}
}
},
"/datasources/{datasource_id}/permissions/{permissionId}": {
"delete": {
"description": "Removes the permission with the given permissionId for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:delete` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Remove permission for a data source.",
"operationId": "deletePermissions",
"/datasources/{id}/health": {
"get": {
"description": "Please refer to [updated API](#/datasources/checkDatasourceHealth) instead",
"tags": ["datasources"],
"summary": "Check data source health by Id.",
"operationId": "checkDatasourceHealthByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "PermissionID",
"name": "permissionId",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
@ -5020,22 +5025,22 @@
"200": {
"$ref": "#/responses/okResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"403": {
"$ref": "#/responses/forbiddenError"
},
"404": {
"$ref": "#/responses/notFoundError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
}
},
"/datasources/{datasource_id}/resources/{datasource_proxy_route}": {
"/datasources/{id}/resources/{datasource_proxy_route}": {
"get": {
"description": "Please refer to [updated API](#/datasources/fetchDatasourceResources) instead",
"tags": ["datasources"],
@ -5046,7 +5051,7 @@
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},

267
public/api-spec.json
Unescape View File

@ -506,6 +506,14 @@
"summary": "Add a user role assignment.",
"operationId": "addUserRole",
"parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
},
{
"x-go-name": "Body",
"name": "body",
@ -514,14 +522,6 @@
"schema": {
"$ref": "#/definitions/AddUserRoleCommand"
}
},
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
@ -547,6 +547,14 @@
"summary": "Remove a user role assignment.",
"operationId": "removeUserRole",
"parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "RoleUID",
@ -560,14 +568,6 @@
"description": "A flag indicating if the assignment is global or not. If set to false, the default org ID of the authenticated user will be used from the request to remove assignment.",
"name": "global",
"in": "query"
},
{
"type": "integer",
"format": "int64",
"x-go-name": "UserID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
@ -3257,7 +3257,7 @@
}
}
},
"/datasources/id/{datasource_name}": {
"/datasources/id/{name}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:name:*` and `datasources:name:test_datasource` (single data source).",
"tags": ["datasources"],
@ -3267,7 +3267,7 @@
{
"type": "string",
"x-go-name": "DatasourceName",
"name": "datasource_name",
"name": "name",
"in": "path",
"required": true
}
@ -3291,7 +3291,7 @@
}
}
},
"/datasources/name/{datasource_name}": {
"/datasources/name/{name}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:name:*` and `datasources:name:test_datasource` (single data source).",
"tags": ["datasources"],
@ -3301,7 +3301,7 @@
{
"type": "string",
"x-go-name": "DatasourceName",
"name": "datasource_name",
"name": "name",
"in": "path",
"required": true
}
@ -3330,7 +3330,7 @@
{
"type": "string",
"x-go-name": "DatasourceName",
"name": "datasource_name",
"name": "name",
"in": "path",
"required": true
}
@ -3354,7 +3354,7 @@
}
}
},
"/datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route}": {
"/datasources/proxy/uid/{uid}/{datasource_proxy_route}": {
"get": {
"description": "Proxies all calls to the actual data source.",
"tags": ["datasources"],
@ -3364,7 +3364,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -3406,7 +3406,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -3451,7 +3451,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -3485,17 +3485,18 @@
}
}
},
"/datasources/proxy/{datasource_id}/{datasource_proxy_route}": {
"/datasources/proxy/{id}/{datasource_proxy_route}": {
"get": {
"description": "Proxies all calls to the actual data source.",
"description": "Proxies all calls to the actual data source.\n\nPlease refer to [updated API](#/datasources/datasourceProxyGETByUIDcalls) instead",
"tags": ["datasources"],
"summary": "Data source proxy GET calls.",
"operationId": "datasourceProxyGETcalls",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
@ -3529,15 +3530,16 @@
}
},
"post": {
"description": "Proxies all calls to the actual data source. The data source should support POST methods for the specific path and role as defined",
"description": "Proxies all calls to the actual data source. The data source should support POST methods for the specific path and role as defined\n\nPlease refer to [updated API](#/datasources/datasourceProxyPOSTByUIDcalls) instead",
"tags": ["datasources"],
"summary": "Data source proxy POST calls.",
"operationId": "datasourceProxyPOSTcalls",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
@ -3582,15 +3584,16 @@
}
},
"delete": {
"description": "Proxies all calls to the actual data source.",
"description": "Proxies all calls to the actual data source.\n\nPlease refer to [updated API](#/datasources/datasourceProxyDELETEByUIDcalls) instead",
"tags": ["datasources"],
"summary": "Data source proxy DELETE calls.",
"operationId": "datasourceProxyDELETEcalls",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
@ -3624,7 +3627,7 @@
}
}
},
"/datasources/uid/{datasource_uid}": {
"/datasources/uid/{uid}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:kLtEtcRGk` (single data source).",
"tags": ["datasources"],
@ -3634,7 +3637,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
}
@ -3669,7 +3672,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -3706,7 +3709,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
}
@ -3730,7 +3733,7 @@
}
}
},
"/datasources/uid/{datasource_uid}/health": {
"/datasources/uid/{uid}/health": {
"get": {
"tags": ["datasources"],
"summary": "Check data source health by Id.",
@ -3739,7 +3742,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
}
@ -3763,7 +3766,7 @@
}
}
},
"/datasources/uid/{datasource_uid}/resources/{datasource_proxy_route}": {
"/datasources/uid/{uid}/resources/{datasource_proxy_route}": {
"get": {
"tags": ["datasources"],
"summary": "Fetch data source resources.",
@ -3772,7 +3775,7 @@
{
"type": "string",
"x-go-name": "DatasourceUID",
"name": "datasource_uid",
"name": "uid",
"in": "path",
"required": true
},
@ -3806,24 +3809,24 @@
}
}
},
"/datasources/{datasource_id}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags": ["datasources"],
"summary": "Get a single data source by Id.",
"operationId": "getDatasourceByID",
"/datasources/{datasource_id}/disable-permissions": {
"post": {
"description": "Disables permissions for the data source with the given id. All existing permissions will be removed and anyone will be able to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Disable permissions for a data source.",
"operationId": "disablePermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/getDatasourceResponse"
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
@ -3841,62 +3844,63 @@
"$ref": "#/responses/internalServerError"
}
}
},
"put": {
"description": "Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/updateDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Update an existing data source by its sequential ID.",
"operationId": "updateDatasourceByID",
"deprecated": true,
}
},
"/datasources/{datasource_id}/enable-permissions": {
"post": {
"description": "Enables permissions for the data source with the given id.\nNo one except Org Admins will be able to query the data source until permissions have been added\nwhich permit certain users or teams to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Enable permissions for a data source.",
"operationId": "enablePermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
{
"name": "Body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateDataSourceCommand"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"403": {
"$ref": "#/responses/forbiddenError"
},
"404": {
"$ref": "#/responses/notFoundError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
},
"delete": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags": ["datasources"],
"summary": "Delete an existing data source by id.",
"operationId": "deleteDatasourceByID",
}
},
"/datasources/{datasource_id}/permissions": {
"get": {
"description": "Gets all existing permissions for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:read` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Get permissions for a data source.",
"operationId": "getPermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/okResponse"
"$ref": "#/responses/getPermissionseResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -3913,27 +3917,31 @@
}
}
},
"/datasources/{datasource_id}/disable-permissions": {
"post": {
"description": "Disables permissions for the data source with the given id. All existing permissions will be removed and anyone will be able to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"/datasources/{datasource_id}/permissions/{permissionId}": {
"delete": {
"description": "Removes the permission with the given permissionId for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:delete` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Disable permissions for a data source.",
"operationId": "disablePermissions",
"summary": "Remove permission for a data source.",
"operationId": "deletePermissions",
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "PermissionID",
"name": "permissionId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
"$ref": "#/responses/okResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -3950,24 +3958,25 @@
}
}
},
"/datasources/{datasource_id}/enable-permissions": {
"post": {
"description": "Enables permissions for the data source with the given id.\nNo one except Org Admins will be able to query the data source until permissions have been added\nwhich permit certain users or teams to query the data source.\n\nYou need to have a permission with action `datasources.permissions:toggle` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Enable permissions for a data source.",
"operationId": "enablePermissions",
"/datasources/{id}": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/getDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Get a single data source by Id.",
"operationId": "getDatasourceByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/createOrUpdateDatasourceResponse"
"$ref": "#/responses/getDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
@ -3985,30 +3994,33 @@
"$ref": "#/responses/internalServerError"
}
}
}
},
"/datasources/{datasource_id}/health": {
"get": {
"description": "Please refer to [updated API](#/datasources/checkDatasourceHealth) instead",
},
"put": {
"description": "Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/updateDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Check data source health by Id.",
"operationId": "checkDatasourceHealthByID",
"summary": "Update an existing data source by its sequential ID.",
"operationId": "updateDatasourceByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},
{
"name": "Body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateDataSourceCommand"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/okResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
"$ref": "#/responses/createOrUpdateDatasourceResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -4020,26 +4032,25 @@
"$ref": "#/responses/internalServerError"
}
}
}
},
"/datasources/{datasource_id}/permissions": {
"get": {
"description": "Gets all existing permissions for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:read` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Get permissions for a data source.",
"operationId": "getPermissions",
},
"delete": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).\n\nPlease refer to [updated API](#/datasources/deleteDatasourceByUID) instead",
"tags": ["datasources"],
"summary": "Delete an existing data source by id.",
"operationId": "deleteDatasourceByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/getPermissionseResponse"
"$ref": "#/responses/okResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -4056,24 +4067,18 @@
}
}
},
"/datasources/{datasource_id}/permissions/{permissionId}": {
"delete": {
"description": "Removes the permission with the given permissionId for the data source with the given id.\n\nYou need to have a permission with action `datasources.permissions:delete` and scopes `datasources:*`, `datasources:id:*`, `datasources:id:1` (single data source).",
"tags": ["datasource_permissions", "enterprise"],
"summary": "Remove permission for a data source.",
"operationId": "deletePermissions",
"/datasources/{id}/health": {
"get": {
"description": "Please refer to [updated API](#/datasources/checkDatasourceHealth) instead",
"tags": ["datasources"],
"summary": "Check data source health by Id.",
"operationId": "checkDatasourceHealthByID",
"deprecated": true,
"parameters": [
{
"type": "string",
"x-go-name": "PermissionID",
"name": "permissionId",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
}
@ -4082,22 +4087,22 @@
"200": {
"$ref": "#/responses/okResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"403": {
"$ref": "#/responses/forbiddenError"
},
"404": {
"$ref": "#/responses/notFoundError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
}
},
"/datasources/{datasource_id}/resources/{datasource_proxy_route}": {
"/datasources/{id}/resources/{datasource_proxy_route}": {
"get": {
"description": "Please refer to [updated API](#/datasources/fetchDatasourceResources) instead",
"tags": ["datasources"],
@ -4108,7 +4113,7 @@
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"name": "id",
"in": "path",
"required": true
},

Write Preview
Loading…
Cancel
Save