mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Swagger: update swagger for datasource proxy api (#47690)
* update the swagger for datasource proxy api * add enterprise spec changes
This commit is contained in:
parent
b43e9b50b4
commit
24468fdd67
@ -167,6 +167,20 @@ import (
|
|||||||
// 404: notFoundError
|
// 404: notFoundError
|
||||||
// 500: internalServerError
|
// 500: internalServerError
|
||||||
|
|
||||||
|
// swagger:route GET /datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route} datasources datasourceProxyGETByUIDcalls
|
||||||
|
//
|
||||||
|
// Data source proxy GET calls.
|
||||||
|
//
|
||||||
|
// Proxies all calls to the actual data source.
|
||||||
|
//
|
||||||
|
// Responses:
|
||||||
|
// 200:
|
||||||
|
// 400: badRequestError
|
||||||
|
// 401: unauthorisedError
|
||||||
|
// 403: forbiddenError
|
||||||
|
// 404: notFoundError
|
||||||
|
// 500: internalServerError
|
||||||
|
|
||||||
// swagger:route POST /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyPOSTcalls
|
// swagger:route POST /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyPOSTcalls
|
||||||
//
|
//
|
||||||
// Data source proxy POST calls.
|
// Data source proxy POST calls.
|
||||||
@ -182,6 +196,21 @@ import (
|
|||||||
// 404: notFoundError
|
// 404: notFoundError
|
||||||
// 500: internalServerError
|
// 500: internalServerError
|
||||||
|
|
||||||
|
// swagger:route POST /datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route} datasources datasourceProxyPOSTByUIDcalls
|
||||||
|
//
|
||||||
|
// 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
|
||||||
|
//
|
||||||
|
// Responses:
|
||||||
|
// 201:
|
||||||
|
// 202:
|
||||||
|
// 400: badRequestError
|
||||||
|
// 401: unauthorisedError
|
||||||
|
// 403: forbiddenError
|
||||||
|
// 404: notFoundError
|
||||||
|
// 500: internalServerError
|
||||||
|
|
||||||
// swagger:route DELETE /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyDELETEcalls
|
// swagger:route DELETE /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyDELETEcalls
|
||||||
//
|
//
|
||||||
// Data source proxy DELETE calls.
|
// Data source proxy DELETE calls.
|
||||||
@ -196,6 +225,20 @@ import (
|
|||||||
// 404: notFoundError
|
// 404: notFoundError
|
||||||
// 500: internalServerError
|
// 500: internalServerError
|
||||||
|
|
||||||
|
// swagger:route DELETE /datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route} datasources datasourceProxyDELETEByUIDcalls
|
||||||
|
//
|
||||||
|
// Data source proxy DELETE calls.
|
||||||
|
//
|
||||||
|
// Proxies all calls to the actual data source.
|
||||||
|
//
|
||||||
|
// Responses:
|
||||||
|
// 202:
|
||||||
|
// 400: badRequestError
|
||||||
|
// 401: unauthorisedError
|
||||||
|
// 403: forbiddenError
|
||||||
|
// 404: notFoundError
|
||||||
|
// 500: internalServerError
|
||||||
|
|
||||||
// swagger:route POST /tsdb/query datasources queryDatasource
|
// swagger:route POST /tsdb/query datasources queryDatasource
|
||||||
//
|
//
|
||||||
// Query metrics.
|
// Query metrics.
|
||||||
@ -227,7 +270,7 @@ type DatasourceID struct {
|
|||||||
DatasourceID string `json:"datasource_id"`
|
DatasourceID string `json:"datasource_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// swagger:parameters deleteDatasourceByUID getDatasourceByUID
|
// swagger:parameters deleteDatasourceByUID getDatasourceByUID datasourceProxyGETByUIDcalls datasourceProxyPOSTByUIDcalls datasourceProxyDELETEByUIDcalls
|
||||||
type DatasourceUID struct {
|
type DatasourceUID struct {
|
||||||
// in:path
|
// in:path
|
||||||
// required:true
|
// required:true
|
||||||
@ -241,7 +284,8 @@ type DatasourceName struct {
|
|||||||
DatasourceName string `json:"datasource_name"`
|
DatasourceName string `json:"datasource_name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// swagger:parameters datasourceProxyGETcalls datasourceProxyPOSTcalls datasourceProxyDELETEcalls
|
// swagger:parameters datasourceProxyGETcalls datasourceProxyPOSTcalls datasourceProxyDELETEcalls datasourceProxyGETByUIDcalls
|
||||||
|
// swagger:parameters datasourceProxyPOSTByUIDcalls datasourceProxyDELETEByUIDcalls
|
||||||
type DatasourceProxyRouteParam struct {
|
type DatasourceProxyRouteParam struct {
|
||||||
// in:path
|
// in:path
|
||||||
// required:true
|
// required:true
|
||||||
|
@ -506,6 +506,14 @@
|
|||||||
"summary": "Add a user role assignment.",
|
"summary": "Add a user role assignment.",
|
||||||
"operationId": "addUserRole",
|
"operationId": "addUserRole",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "UserID",
|
||||||
|
"name": "user_id",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"x-go-name": "Body",
|
"x-go-name": "Body",
|
||||||
"name": "body",
|
"name": "body",
|
||||||
@ -514,14 +522,6 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "#/definitions/AddUserRoleCommand"
|
"$ref": "#/definitions/AddUserRoleCommand"
|
||||||
}
|
}
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "UserID",
|
|
||||||
"name": "user_id",
|
|
||||||
"in": "path",
|
|
||||||
"required": true
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
@ -547,6 +547,14 @@
|
|||||||
"summary": "Remove a user role assignment.",
|
"summary": "Remove a user role assignment.",
|
||||||
"operationId": "removeUserRole",
|
"operationId": "removeUserRole",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "UserID",
|
||||||
|
"name": "user_id",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "RoleUID",
|
"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.",
|
"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",
|
"name": "global",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "UserID",
|
|
||||||
"name": "user_id",
|
|
||||||
"in": "path",
|
|
||||||
"required": true
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
@ -1025,7 +1025,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Delete global User.",
|
"summary": "Delete global User.",
|
||||||
"operationId": "deleteUser",
|
"operationId": "deleteUser",
|
||||||
@ -1065,7 +1065,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Return a list of all auth tokens (devices) that the user currently have logged in from.",
|
"summary": "Return a list of all auth tokens (devices) that the user currently have logged in from.",
|
||||||
"operationId": "getAuthTokens",
|
"operationId": "getAuthTokens",
|
||||||
@ -1102,7 +1102,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Disable user.",
|
"summary": "Disable user.",
|
||||||
"operationId": "disableUser",
|
"operationId": "disableUser",
|
||||||
@ -1142,7 +1142,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Enable user.",
|
"summary": "Enable user.",
|
||||||
"operationId": "enableUser",
|
"operationId": "enableUser",
|
||||||
@ -1182,7 +1182,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in and will be required to authenticate again upon next activity.",
|
"summary": "Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in and will be required to authenticate again upon next activity.",
|
||||||
"operationId": "logoutUser",
|
"operationId": "logoutUser",
|
||||||
@ -1225,7 +1225,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Set password for user.",
|
"summary": "Set password for user.",
|
||||||
"operationId": "setPassword",
|
"operationId": "setPassword",
|
||||||
@ -1269,7 +1269,7 @@
|
|||||||
},
|
},
|
||||||
"/admin/users/{user_id}/permissions": {
|
"/admin/users/{user_id}/permissions": {
|
||||||
"put": {
|
"put": {
|
||||||
"description": "Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global:users:*`.",
|
"description": "Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Set permissions for user.",
|
"summary": "Set permissions for user.",
|
||||||
"operationId": "setPermissions",
|
"operationId": "setPermissions",
|
||||||
@ -1318,7 +1318,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Fetch user quota.",
|
"summary": "Fetch user quota.",
|
||||||
"operationId": "getUserQuota",
|
"operationId": "getUserQuota",
|
||||||
@ -1358,7 +1358,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Update user quota.",
|
"summary": "Update user quota.",
|
||||||
"operationId": "updateUserQuota",
|
"operationId": "updateUserQuota",
|
||||||
@ -1414,7 +1414,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global:users:*`.",
|
"description": "Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Revoke auth token for user.",
|
"summary": "Revoke auth token for user.",
|
||||||
"operationId": "revokeAuthToken",
|
"operationId": "revokeAuthToken",
|
||||||
@ -3150,7 +3150,7 @@
|
|||||||
"in": "body",
|
"in": "body",
|
||||||
"required": true,
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "#/definitions/DeleteAnnotationsCmd"
|
"$ref": "#/definitions/MassDeleteAnnotationsCmd"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@ -4063,6 +4063,137 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route}": {
|
||||||
|
"get": {
|
||||||
|
"description": "Proxies all calls to the actual data source.",
|
||||||
|
"tags": ["datasources"],
|
||||||
|
"summary": "Data source proxy GET calls.",
|
||||||
|
"operationId": "datasourceProxyGETByUIDcalls",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceUID",
|
||||||
|
"name": "datasource_uid",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceProxyRoute",
|
||||||
|
"name": "datasource_proxy_route",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/responses/badRequestError"
|
||||||
|
},
|
||||||
|
"401": {
|
||||||
|
"$ref": "#/responses/unauthorisedError"
|
||||||
|
},
|
||||||
|
"403": {
|
||||||
|
"$ref": "#/responses/forbiddenError"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"$ref": "#/responses/notFoundError"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/responses/internalServerError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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",
|
||||||
|
"tags": ["datasources"],
|
||||||
|
"summary": "Data source proxy POST calls.",
|
||||||
|
"operationId": "datasourceProxyPOSTByUIDcalls",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceUID",
|
||||||
|
"name": "datasource_uid",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceProxyRoute",
|
||||||
|
"name": "datasource_proxy_route",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"201": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"202": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/responses/badRequestError"
|
||||||
|
},
|
||||||
|
"401": {
|
||||||
|
"$ref": "#/responses/unauthorisedError"
|
||||||
|
},
|
||||||
|
"403": {
|
||||||
|
"$ref": "#/responses/forbiddenError"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"$ref": "#/responses/notFoundError"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/responses/internalServerError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"delete": {
|
||||||
|
"description": "Proxies all calls to the actual data source.",
|
||||||
|
"tags": ["datasources"],
|
||||||
|
"summary": "Data source proxy DELETE calls.",
|
||||||
|
"operationId": "datasourceProxyDELETEByUIDcalls",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceUID",
|
||||||
|
"name": "datasource_uid",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceProxyRoute",
|
||||||
|
"name": "datasource_proxy_route",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"202": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/responses/badRequestError"
|
||||||
|
},
|
||||||
|
"401": {
|
||||||
|
"$ref": "#/responses/unauthorisedError"
|
||||||
|
},
|
||||||
|
"403": {
|
||||||
|
"$ref": "#/responses/forbiddenError"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"$ref": "#/responses/notFoundError"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/responses/internalServerError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/datasources/proxy/{datasource_id}/{datasource_proxy_route}": {
|
"/datasources/proxy/{datasource_id}/{datasource_proxy_route}": {
|
||||||
"get": {
|
"get": {
|
||||||
"description": "Proxies all calls to the actual data source.",
|
"description": "Proxies all calls to the actual data source.",
|
||||||
@ -4273,7 +4404,7 @@
|
|||||||
},
|
},
|
||||||
"/datasources/{datasource_id}": {
|
"/datasources/{datasource_id}": {
|
||||||
"get": {
|
"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).",
|
"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"],
|
"tags": ["datasources"],
|
||||||
"summary": "Get a single data source by Id.",
|
"summary": "Get a single data source by Id.",
|
||||||
"operationId": "getDatasourceByID",
|
"operationId": "getDatasourceByID",
|
||||||
@ -4308,7 +4439,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"put": {
|
"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).",
|
"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:uid:*` and `datasources:uid:1` (single data source).",
|
||||||
"tags": ["datasources"],
|
"tags": ["datasources"],
|
||||||
"summary": "Update an existing data source.",
|
"summary": "Update an existing data source.",
|
||||||
"operationId": "updateDatasource",
|
"operationId": "updateDatasource",
|
||||||
@ -4345,7 +4476,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"delete": {
|
"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).",
|
"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"],
|
"tags": ["datasources"],
|
||||||
"summary": "Delete an existing data source by id.",
|
"summary": "Delete an existing data source by id.",
|
||||||
"operationId": "deleteDatasourceByID",
|
"operationId": "deleteDatasourceByID",
|
||||||
@ -4494,15 +4625,15 @@
|
|||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "PermissionID",
|
"x-go-name": "DatasourceID",
|
||||||
"name": "permissionId",
|
"name": "datasource_id",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"required": true
|
"required": true
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "DatasourceID",
|
"x-go-name": "PermissionID",
|
||||||
"name": "datasource_id",
|
"name": "permissionId",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"required": true
|
"required": true
|
||||||
}
|
}
|
||||||
@ -6469,6 +6600,145 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/provisioning/contact-points": {
|
||||||
|
"get": {
|
||||||
|
"tags": ["provisioning"],
|
||||||
|
"summary": "Get all the contact points.",
|
||||||
|
"operationId": "RouteGetContactpoints",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "Route",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/Route"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"description": "ValidationError",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/ValidationError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"put": {
|
||||||
|
"consumes": ["application/json"],
|
||||||
|
"tags": ["provisioning"],
|
||||||
|
"summary": "Update an existing contact point.",
|
||||||
|
"operationId": "RoutePutContactpoints",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "Body",
|
||||||
|
"in": "body",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/EmbeddedContactPoint"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"202": {
|
||||||
|
"$ref": "#/responses/Accepted"
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"description": "ValidationError",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/ValidationError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"post": {
|
||||||
|
"consumes": ["application/json"],
|
||||||
|
"tags": ["provisioning"],
|
||||||
|
"summary": "Create a contact point.",
|
||||||
|
"operationId": "RoutePostContactpoints",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "Body",
|
||||||
|
"in": "body",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/EmbeddedContactPoint"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"202": {
|
||||||
|
"$ref": "#/responses/Accepted"
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"description": "ValidationError",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/ValidationError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/provisioning/contact-points/{ID}": {
|
||||||
|
"delete": {
|
||||||
|
"consumes": ["application/json"],
|
||||||
|
"tags": ["provisioning"],
|
||||||
|
"summary": "Delete a contact point.",
|
||||||
|
"operationId": "RouteDeleteContactpoints",
|
||||||
|
"responses": {
|
||||||
|
"202": {
|
||||||
|
"$ref": "#/responses/Accepted"
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"description": "ValidationError",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/ValidationError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/provisioning/policies": {
|
||||||
|
"get": {
|
||||||
|
"tags": ["provisioning"],
|
||||||
|
"summary": "Get the notification policy tree.",
|
||||||
|
"operationId": "RouteGetPolicyTree",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "Route",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/Route"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"description": "ValidationError",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/ValidationError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"post": {
|
||||||
|
"consumes": ["application/json"],
|
||||||
|
"tags": ["provisioning"],
|
||||||
|
"summary": "Sets the notification policy tree.",
|
||||||
|
"operationId": "RoutePostPolicyTree",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "Body",
|
||||||
|
"in": "body",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/Route"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"202": {
|
||||||
|
"$ref": "#/responses/Accepted"
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"description": "ValidationError",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/ValidationError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/recording-rules": {
|
"/recording-rules": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": ["recording_rules", "enterprise"],
|
"tags": ["recording_rules", "enterprise"],
|
||||||
@ -10122,6 +10392,36 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
|
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
|
||||||
},
|
},
|
||||||
|
"AnnotationActions": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"canAdd": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "CanAdd"
|
||||||
|
},
|
||||||
|
"canDelete": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "CanDelete"
|
||||||
|
},
|
||||||
|
"canEdit": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "CanEdit"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
|
},
|
||||||
|
"AnnotationPermission": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"dashboard": {
|
||||||
|
"$ref": "#/definitions/AnnotationActions"
|
||||||
|
},
|
||||||
|
"organization": {
|
||||||
|
"$ref": "#/definitions/AnnotationActions"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
|
},
|
||||||
"ApiKeyDTO": {
|
"ApiKeyDTO": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -10240,7 +10540,7 @@
|
|||||||
"x-go-name": "ReportLogo"
|
"x-go-name": "ReportLogo"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"CalculateDiffTarget": {
|
"CalculateDiffTarget": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -10390,7 +10690,7 @@
|
|||||||
"x-go-name": "UserID"
|
"x-go-name": "UserID"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"CreateAlertNotificationCommand": {
|
"CreateAlertNotificationCommand": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -10576,7 +10876,7 @@
|
|||||||
"x-go-name": "TemplateVars"
|
"x-go-name": "TemplateVars"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"CreateOrgCommand": {
|
"CreateOrgCommand": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -10836,6 +11136,9 @@
|
|||||||
"DashboardMeta": {
|
"DashboardMeta": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
"annotationsPermissions": {
|
||||||
|
"$ref": "#/definitions/AnnotationPermission"
|
||||||
|
},
|
||||||
"canAdmin": {
|
"canAdmin": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"x-go-name": "CanAdmin"
|
"x-go-name": "CanAdmin"
|
||||||
@ -11499,32 +11802,6 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/prometheus/alertmanager/timeinterval"
|
"x-go-package": "github.com/prometheus/alertmanager/timeinterval"
|
||||||
},
|
},
|
||||||
"DeleteAnnotationsCmd": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"alertId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "AlertId"
|
|
||||||
},
|
|
||||||
"annotationId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "AnnotationId"
|
|
||||||
},
|
|
||||||
"dashboardId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "DashboardId"
|
|
||||||
},
|
|
||||||
"panelId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "PanelId"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
|
||||||
},
|
|
||||||
"DeleteTokenCommand": {
|
"DeleteTokenCommand": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -11631,6 +11908,36 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/prometheus/alertmanager/config"
|
"x-go-package": "github.com/prometheus/alertmanager/config"
|
||||||
},
|
},
|
||||||
|
"EmbeddedContactPoint": {
|
||||||
|
"description": "EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"disableResolveMessage": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "DisableResolveMessage"
|
||||||
|
},
|
||||||
|
"name": {
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "Name"
|
||||||
|
},
|
||||||
|
"provanance": {
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "Provenance"
|
||||||
|
},
|
||||||
|
"settings": {
|
||||||
|
"$ref": "#/definitions/Json"
|
||||||
|
},
|
||||||
|
"type": {
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "Type"
|
||||||
|
},
|
||||||
|
"uid": {
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "UID"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
|
||||||
|
},
|
||||||
"ErrorResponseBody": {
|
"ErrorResponseBody": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": ["message"],
|
"required": ["message"],
|
||||||
@ -12479,18 +12786,18 @@
|
|||||||
"x-go-name": "URL"
|
"x-go-name": "URL"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/search"
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
},
|
},
|
||||||
"HitList": {
|
"HitList": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/Hit"
|
"$ref": "#/definitions/Hit"
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/search"
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
},
|
},
|
||||||
"HitType": {
|
"HitType": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/search"
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
},
|
},
|
||||||
"HostPort": {
|
"HostPort": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -13033,6 +13340,27 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/libraryelements"
|
"x-go-package": "github.com/grafana/grafana/pkg/services/libraryelements"
|
||||||
},
|
},
|
||||||
|
"MassDeleteAnnotationsCmd": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"annotationId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "AnnotationId"
|
||||||
|
},
|
||||||
|
"dashboardId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "DashboardId"
|
||||||
|
},
|
||||||
|
"panelId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "PanelId"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
|
},
|
||||||
"MatchRegexps": {
|
"MatchRegexps": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"title": "MatchRegexps represents a map of Regexp.",
|
"title": "MatchRegexps represents a map of Regexp.",
|
||||||
@ -13691,6 +14019,9 @@
|
|||||||
"navbar": {
|
"navbar": {
|
||||||
"$ref": "#/definitions/NavbarPreference"
|
"$ref": "#/definitions/NavbarPreference"
|
||||||
},
|
},
|
||||||
|
"queryHistory": {
|
||||||
|
"$ref": "#/definitions/QueryHistoryPreference"
|
||||||
|
},
|
||||||
"theme": {
|
"theme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["light", "dark"],
|
"enum": ["light", "dark"],
|
||||||
@ -14153,6 +14484,9 @@
|
|||||||
"navbar": {
|
"navbar": {
|
||||||
"$ref": "#/definitions/NavbarPreference"
|
"$ref": "#/definitions/NavbarPreference"
|
||||||
},
|
},
|
||||||
|
"queryHistory": {
|
||||||
|
"$ref": "#/definitions/QueryHistoryPreference"
|
||||||
|
},
|
||||||
"theme": {
|
"theme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "Theme"
|
"x-go-name": "Theme"
|
||||||
@ -14250,6 +14584,16 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/backend"
|
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/backend"
|
||||||
},
|
},
|
||||||
|
"QueryHistoryPreference": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"homeTab": {
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "HomeTab"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
|
},
|
||||||
"Receiver": {
|
"Receiver": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"title": "Receiver configuration provides configuration on how to contact a receiver.",
|
"title": "Receiver configuration provides configuration on how to contact a receiver.",
|
||||||
@ -14427,7 +14771,7 @@
|
|||||||
"x-go-name": "UseEmailsFromReport"
|
"x-go-name": "UseEmailsFromReport"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"ReportOptionsDTO": {
|
"ReportOptionsDTO": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -14444,7 +14788,7 @@
|
|||||||
"$ref": "#/definitions/TimeRangeDTO"
|
"$ref": "#/definitions/TimeRangeDTO"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"ResponseDetails": {
|
"ResponseDetails": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -14900,7 +15244,7 @@
|
|||||||
"x-go-name": "WorkdaysOnly"
|
"x-go-name": "WorkdaysOnly"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"SearchTeamQueryResult": {
|
"SearchTeamQueryResult": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -15020,7 +15364,7 @@
|
|||||||
"x-go-name": "UserID"
|
"x-go-name": "UserID"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"SigV4Config": {
|
"SigV4Config": {
|
||||||
"description": "SigV4Config is the configuration for signing remote write requests with\nAWS's SigV4 verification process. Empty values will be retrieved using the\nAWS default credentials chain.",
|
"description": "SigV4Config is the configuration for signing remote write requests with\nAWS's SigV4 verification process. Empty values will be retrieved using the\nAWS default credentials chain.",
|
||||||
@ -15713,7 +16057,7 @@
|
|||||||
"x-go-name": "To"
|
"x-go-name": "To"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"Token": {
|
"Token": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -15814,6 +16158,15 @@
|
|||||||
"format": "int64",
|
"format": "int64",
|
||||||
"x-go-name": "TokenExpiresWarnDays"
|
"x-go-name": "TokenExpiresWarnDays"
|
||||||
},
|
},
|
||||||
|
"trial": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "Trial"
|
||||||
|
},
|
||||||
|
"trial_exp": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "TrialExpires"
|
||||||
|
},
|
||||||
"update_days": {
|
"update_days": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int64",
|
"format": "int64",
|
||||||
@ -15856,9 +16209,8 @@
|
|||||||
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
},
|
},
|
||||||
"URL": {
|
"URL": {
|
||||||
"description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use RawPath, an optional field which only gets\nset if the default encoding is different from Path.\n\nURL's String method uses the EscapedPath method to obtain the path. See the\nEscapedPath method for more details.",
|
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"title": "A URL represents a parsed URL (technically, a URI reference).",
|
"title": "URL is a custom URL type that allows validation at configuration load time.",
|
||||||
"properties": {
|
"properties": {
|
||||||
"ForceQuery": {
|
"ForceQuery": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
@ -15891,7 +16243,7 @@
|
|||||||
"$ref": "#/definitions/Userinfo"
|
"$ref": "#/definitions/Userinfo"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "net/url"
|
"x-go-package": "github.com/prometheus/common/config"
|
||||||
},
|
},
|
||||||
"UpdateAlertNotificationCommand": {
|
"UpdateAlertNotificationCommand": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -16204,6 +16556,9 @@
|
|||||||
"navbar": {
|
"navbar": {
|
||||||
"$ref": "#/definitions/NavbarPreference"
|
"$ref": "#/definitions/NavbarPreference"
|
||||||
},
|
},
|
||||||
|
"queryHistory": {
|
||||||
|
"$ref": "#/definitions/QueryHistoryPreference"
|
||||||
|
},
|
||||||
"theme": {
|
"theme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["light", "dark"],
|
"enum": ["light", "dark"],
|
||||||
@ -16792,12 +17147,11 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"alertGroups": {
|
"alertGroups": {
|
||||||
|
"description": "AlertGroups alert groups",
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/alertGroup"
|
"$ref": "#/definitions/alertGroup"
|
||||||
},
|
}
|
||||||
"x-go-name": "AlertGroups",
|
|
||||||
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
|
|
||||||
},
|
},
|
||||||
"alertStatus": {
|
"alertStatus": {
|
||||||
"description": "AlertStatus alert status",
|
"description": "AlertStatus alert status",
|
||||||
@ -16900,7 +17254,6 @@
|
|||||||
"$ref": "#/definitions/Duration"
|
"$ref": "#/definitions/Duration"
|
||||||
},
|
},
|
||||||
"gettableAlert": {
|
"gettableAlert": {
|
||||||
"description": "GettableAlert gettable alert",
|
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": ["labels", "annotations", "endsAt", "fingerprint", "receivers", "startsAt", "status", "updatedAt"],
|
"required": ["labels", "annotations", "endsAt", "fingerprint", "receivers", "startsAt", "status", "updatedAt"],
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -16950,7 +17303,9 @@
|
|||||||
"format": "date-time",
|
"format": "date-time",
|
||||||
"x-go-name": "UpdatedAt"
|
"x-go-name": "UpdatedAt"
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
|
"x-go-name": "GettableAlert",
|
||||||
|
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
|
||||||
},
|
},
|
||||||
"gettableAlerts": {
|
"gettableAlerts": {
|
||||||
"description": "GettableAlerts gettable alerts",
|
"description": "GettableAlerts gettable alerts",
|
||||||
@ -17006,12 +17361,11 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"gettableSilences": {
|
"gettableSilences": {
|
||||||
|
"description": "GettableSilences gettable silences",
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/gettableSilence"
|
"$ref": "#/definitions/gettableSilence"
|
||||||
},
|
}
|
||||||
"x-go-name": "GettableSilences",
|
|
||||||
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
|
|
||||||
},
|
},
|
||||||
"labelSet": {
|
"labelSet": {
|
||||||
"description": "LabelSet label set",
|
"description": "LabelSet label set",
|
||||||
|
@ -506,6 +506,14 @@
|
|||||||
"summary": "Add a user role assignment.",
|
"summary": "Add a user role assignment.",
|
||||||
"operationId": "addUserRole",
|
"operationId": "addUserRole",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "UserID",
|
||||||
|
"name": "user_id",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"x-go-name": "Body",
|
"x-go-name": "Body",
|
||||||
"name": "body",
|
"name": "body",
|
||||||
@ -514,14 +522,6 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "#/definitions/AddUserRoleCommand"
|
"$ref": "#/definitions/AddUserRoleCommand"
|
||||||
}
|
}
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "UserID",
|
|
||||||
"name": "user_id",
|
|
||||||
"in": "path",
|
|
||||||
"required": true
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
@ -547,6 +547,14 @@
|
|||||||
"summary": "Remove a user role assignment.",
|
"summary": "Remove a user role assignment.",
|
||||||
"operationId": "removeUserRole",
|
"operationId": "removeUserRole",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "UserID",
|
||||||
|
"name": "user_id",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "RoleUID",
|
"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.",
|
"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",
|
"name": "global",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "UserID",
|
|
||||||
"name": "user_id",
|
|
||||||
"in": "path",
|
|
||||||
"required": true
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
@ -1025,7 +1025,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Delete global User.",
|
"summary": "Delete global User.",
|
||||||
"operationId": "deleteUser",
|
"operationId": "deleteUser",
|
||||||
@ -1065,7 +1065,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Return a list of all auth tokens (devices) that the user currently have logged in from.",
|
"summary": "Return a list of all auth tokens (devices) that the user currently have logged in from.",
|
||||||
"operationId": "getAuthTokens",
|
"operationId": "getAuthTokens",
|
||||||
@ -1102,7 +1102,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Disable user.",
|
"summary": "Disable user.",
|
||||||
"operationId": "disableUser",
|
"operationId": "disableUser",
|
||||||
@ -1142,7 +1142,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Enable user.",
|
"summary": "Enable user.",
|
||||||
"operationId": "enableUser",
|
"operationId": "enableUser",
|
||||||
@ -1182,7 +1182,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in and will be required to authenticate again upon next activity.",
|
"summary": "Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in and will be required to authenticate again upon next activity.",
|
||||||
"operationId": "logoutUser",
|
"operationId": "logoutUser",
|
||||||
@ -1225,7 +1225,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global:users:*`.",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Set password for user.",
|
"summary": "Set password for user.",
|
||||||
"operationId": "setPassword",
|
"operationId": "setPassword",
|
||||||
@ -1269,7 +1269,7 @@
|
|||||||
},
|
},
|
||||||
"/admin/users/{user_id}/permissions": {
|
"/admin/users/{user_id}/permissions": {
|
||||||
"put": {
|
"put": {
|
||||||
"description": "Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global:users:*`.",
|
"description": "Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Set permissions for user.",
|
"summary": "Set permissions for user.",
|
||||||
"operationId": "setPermissions",
|
"operationId": "setPermissions",
|
||||||
@ -1318,7 +1318,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Fetch user quota.",
|
"summary": "Fetch user quota.",
|
||||||
"operationId": "getUserQuota",
|
"operationId": "getUserQuota",
|
||||||
@ -1358,7 +1358,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global:users:1` (userIDScope).",
|
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global.users:1` (userIDScope).",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Update user quota.",
|
"summary": "Update user quota.",
|
||||||
"operationId": "updateUserQuota",
|
"operationId": "updateUserQuota",
|
||||||
@ -1414,7 +1414,7 @@
|
|||||||
"basic": []
|
"basic": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global:users:*`.",
|
"description": "Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global.users:*`.",
|
||||||
"tags": ["admin_users"],
|
"tags": ["admin_users"],
|
||||||
"summary": "Revoke auth token for user.",
|
"summary": "Revoke auth token for user.",
|
||||||
"operationId": "revokeAuthToken",
|
"operationId": "revokeAuthToken",
|
||||||
@ -2200,7 +2200,7 @@
|
|||||||
"in": "body",
|
"in": "body",
|
||||||
"required": true,
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "#/definitions/DeleteAnnotationsCmd"
|
"$ref": "#/definitions/MassDeleteAnnotationsCmd"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@ -3113,6 +3113,137 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/datasources/proxy/uid/{datasource_uid}/{datasource_proxy_route}": {
|
||||||
|
"get": {
|
||||||
|
"description": "Proxies all calls to the actual data source.",
|
||||||
|
"tags": ["datasources"],
|
||||||
|
"summary": "Data source proxy GET calls.",
|
||||||
|
"operationId": "datasourceProxyGETByUIDcalls",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceUID",
|
||||||
|
"name": "datasource_uid",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceProxyRoute",
|
||||||
|
"name": "datasource_proxy_route",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/responses/badRequestError"
|
||||||
|
},
|
||||||
|
"401": {
|
||||||
|
"$ref": "#/responses/unauthorisedError"
|
||||||
|
},
|
||||||
|
"403": {
|
||||||
|
"$ref": "#/responses/forbiddenError"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"$ref": "#/responses/notFoundError"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/responses/internalServerError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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",
|
||||||
|
"tags": ["datasources"],
|
||||||
|
"summary": "Data source proxy POST calls.",
|
||||||
|
"operationId": "datasourceProxyPOSTByUIDcalls",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceUID",
|
||||||
|
"name": "datasource_uid",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceProxyRoute",
|
||||||
|
"name": "datasource_proxy_route",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"201": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"202": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/responses/badRequestError"
|
||||||
|
},
|
||||||
|
"401": {
|
||||||
|
"$ref": "#/responses/unauthorisedError"
|
||||||
|
},
|
||||||
|
"403": {
|
||||||
|
"$ref": "#/responses/forbiddenError"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"$ref": "#/responses/notFoundError"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/responses/internalServerError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"delete": {
|
||||||
|
"description": "Proxies all calls to the actual data source.",
|
||||||
|
"tags": ["datasources"],
|
||||||
|
"summary": "Data source proxy DELETE calls.",
|
||||||
|
"operationId": "datasourceProxyDELETEByUIDcalls",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceUID",
|
||||||
|
"name": "datasource_uid",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "DatasourceProxyRoute",
|
||||||
|
"name": "datasource_proxy_route",
|
||||||
|
"in": "path",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"202": {
|
||||||
|
"description": ""
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/responses/badRequestError"
|
||||||
|
},
|
||||||
|
"401": {
|
||||||
|
"$ref": "#/responses/unauthorisedError"
|
||||||
|
},
|
||||||
|
"403": {
|
||||||
|
"$ref": "#/responses/forbiddenError"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"$ref": "#/responses/notFoundError"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/responses/internalServerError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/datasources/proxy/{datasource_id}/{datasource_proxy_route}": {
|
"/datasources/proxy/{datasource_id}/{datasource_proxy_route}": {
|
||||||
"get": {
|
"get": {
|
||||||
"description": "Proxies all calls to the actual data source.",
|
"description": "Proxies all calls to the actual data source.",
|
||||||
@ -3323,7 +3454,7 @@
|
|||||||
},
|
},
|
||||||
"/datasources/{datasource_id}": {
|
"/datasources/{datasource_id}": {
|
||||||
"get": {
|
"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).",
|
"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"],
|
"tags": ["datasources"],
|
||||||
"summary": "Get a single data source by Id.",
|
"summary": "Get a single data source by Id.",
|
||||||
"operationId": "getDatasourceByID",
|
"operationId": "getDatasourceByID",
|
||||||
@ -3358,7 +3489,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"put": {
|
"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).",
|
"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:uid:*` and `datasources:uid:1` (single data source).",
|
||||||
"tags": ["datasources"],
|
"tags": ["datasources"],
|
||||||
"summary": "Update an existing data source.",
|
"summary": "Update an existing data source.",
|
||||||
"operationId": "updateDatasource",
|
"operationId": "updateDatasource",
|
||||||
@ -3395,7 +3526,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"delete": {
|
"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).",
|
"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"],
|
"tags": ["datasources"],
|
||||||
"summary": "Delete an existing data source by id.",
|
"summary": "Delete an existing data source by id.",
|
||||||
"operationId": "deleteDatasourceByID",
|
"operationId": "deleteDatasourceByID",
|
||||||
@ -3544,15 +3675,15 @@
|
|||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "PermissionID",
|
"x-go-name": "DatasourceID",
|
||||||
"name": "permissionId",
|
"name": "datasource_id",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"required": true
|
"required": true
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "DatasourceID",
|
"x-go-name": "PermissionID",
|
||||||
"name": "datasource_id",
|
"name": "permissionId",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"required": true
|
"required": true
|
||||||
}
|
}
|
||||||
@ -8374,6 +8505,36 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
},
|
},
|
||||||
|
"AnnotationActions": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"canAdd": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "CanAdd"
|
||||||
|
},
|
||||||
|
"canDelete": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "CanDelete"
|
||||||
|
},
|
||||||
|
"canEdit": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "CanEdit"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
|
},
|
||||||
|
"AnnotationPermission": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"dashboard": {
|
||||||
|
"$ref": "#/definitions/AnnotationActions"
|
||||||
|
},
|
||||||
|
"organization": {
|
||||||
|
"$ref": "#/definitions/AnnotationActions"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
|
},
|
||||||
"ApiKeyDTO": {
|
"ApiKeyDTO": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -8421,7 +8582,7 @@
|
|||||||
"x-go-name": "ReportLogo"
|
"x-go-name": "ReportLogo"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"CalculateDiffTarget": {
|
"CalculateDiffTarget": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -8537,7 +8698,7 @@
|
|||||||
"x-go-name": "UserID"
|
"x-go-name": "UserID"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"CreateAlertNotificationCommand": {
|
"CreateAlertNotificationCommand": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -8723,7 +8884,7 @@
|
|||||||
"x-go-name": "TemplateVars"
|
"x-go-name": "TemplateVars"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"CreateOrgCommand": {
|
"CreateOrgCommand": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -8983,6 +9144,9 @@
|
|||||||
"DashboardMeta": {
|
"DashboardMeta": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
"annotationsPermissions": {
|
||||||
|
"$ref": "#/definitions/AnnotationPermission"
|
||||||
|
},
|
||||||
"canAdmin": {
|
"canAdmin": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"x-go-name": "CanAdmin"
|
"x-go-name": "CanAdmin"
|
||||||
@ -9625,32 +9789,6 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
|
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
|
||||||
},
|
},
|
||||||
"DeleteAnnotationsCmd": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"alertId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "AlertId"
|
|
||||||
},
|
|
||||||
"annotationId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "AnnotationId"
|
|
||||||
},
|
|
||||||
"dashboardId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "DashboardId"
|
|
||||||
},
|
|
||||||
"panelId": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64",
|
|
||||||
"x-go-name": "PanelId"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
|
||||||
},
|
|
||||||
"DeleteTokenCommand": {
|
"DeleteTokenCommand": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -9952,18 +10090,18 @@
|
|||||||
"x-go-name": "URL"
|
"x-go-name": "URL"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/search"
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
},
|
},
|
||||||
"HitList": {
|
"HitList": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/Hit"
|
"$ref": "#/definitions/Hit"
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/search"
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
},
|
},
|
||||||
"HitType": {
|
"HitType": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/search"
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
},
|
},
|
||||||
"ImportDashboardInput": {
|
"ImportDashboardInput": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -10395,6 +10533,27 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/services/libraryelements"
|
"x-go-package": "github.com/grafana/grafana/pkg/services/libraryelements"
|
||||||
},
|
},
|
||||||
|
"MassDeleteAnnotationsCmd": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"annotationId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "AnnotationId"
|
||||||
|
},
|
||||||
|
"dashboardId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "DashboardId"
|
||||||
|
},
|
||||||
|
"panelId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "PanelId"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
|
||||||
|
},
|
||||||
"Metadata": {
|
"Metadata": {
|
||||||
"description": "Metadata contains user accesses for a given resource\nEx: map[string]bool{\"create\":true, \"delete\": true}",
|
"description": "Metadata contains user accesses for a given resource\nEx: map[string]bool{\"create\":true, \"delete\": true}",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -10711,6 +10870,9 @@
|
|||||||
"navbar": {
|
"navbar": {
|
||||||
"$ref": "#/definitions/NavbarPreference"
|
"$ref": "#/definitions/NavbarPreference"
|
||||||
},
|
},
|
||||||
|
"queryHistory": {
|
||||||
|
"$ref": "#/definitions/QueryHistoryPreference"
|
||||||
|
},
|
||||||
"theme": {
|
"theme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["light", "dark"],
|
"enum": ["light", "dark"],
|
||||||
@ -10857,6 +11019,9 @@
|
|||||||
"navbar": {
|
"navbar": {
|
||||||
"$ref": "#/definitions/NavbarPreference"
|
"$ref": "#/definitions/NavbarPreference"
|
||||||
},
|
},
|
||||||
|
"queryHistory": {
|
||||||
|
"$ref": "#/definitions/QueryHistoryPreference"
|
||||||
|
},
|
||||||
"theme": {
|
"theme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"x-go-name": "Theme"
|
"x-go-name": "Theme"
|
||||||
@ -10901,6 +11066,16 @@
|
|||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/backend"
|
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/backend"
|
||||||
},
|
},
|
||||||
|
"QueryHistoryPreference": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"homeTab": {
|
||||||
|
"type": "string",
|
||||||
|
"x-go-name": "HomeTab"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-go-package": "github.com/grafana/grafana/pkg/models"
|
||||||
|
},
|
||||||
"RecordingRuleJSON": {
|
"RecordingRuleJSON": {
|
||||||
"description": "RecordingRuleJSON is the external representation of a recording rule",
|
"description": "RecordingRuleJSON is the external representation of a recording rule",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -10984,7 +11159,7 @@
|
|||||||
"x-go-name": "UseEmailsFromReport"
|
"x-go-name": "UseEmailsFromReport"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"ReportOptionsDTO": {
|
"ReportOptionsDTO": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -11001,7 +11176,7 @@
|
|||||||
"$ref": "#/definitions/TimeRangeDTO"
|
"$ref": "#/definitions/TimeRangeDTO"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"Responses": {
|
"Responses": {
|
||||||
"description": "The QueryData method the QueryDataHandler method will set the RefId\nproperty on the DataRespones' frames based on these RefIDs.",
|
"description": "The QueryData method the QueryDataHandler method will set the RefId\nproperty on the DataRespones' frames based on these RefIDs.",
|
||||||
@ -11175,7 +11350,7 @@
|
|||||||
"x-go-name": "WorkdaysOnly"
|
"x-go-name": "WorkdaysOnly"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"SearchTeamQueryResult": {
|
"SearchTeamQueryResult": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -11286,7 +11461,7 @@
|
|||||||
"x-go-name": "UserID"
|
"x-go-name": "UserID"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"Status": {
|
"Status": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -11562,7 +11737,7 @@
|
|||||||
"x-go-name": "To"
|
"x-go-name": "To"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
|
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report/api"
|
||||||
},
|
},
|
||||||
"Token": {
|
"Token": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -11663,6 +11838,15 @@
|
|||||||
"format": "int64",
|
"format": "int64",
|
||||||
"x-go-name": "TokenExpiresWarnDays"
|
"x-go-name": "TokenExpiresWarnDays"
|
||||||
},
|
},
|
||||||
|
"trial": {
|
||||||
|
"type": "boolean",
|
||||||
|
"x-go-name": "Trial"
|
||||||
|
},
|
||||||
|
"trial_exp": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int64",
|
||||||
|
"x-go-name": "TrialExpires"
|
||||||
|
},
|
||||||
"update_days": {
|
"update_days": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int64",
|
"format": "int64",
|
||||||
@ -12015,6 +12199,9 @@
|
|||||||
"navbar": {
|
"navbar": {
|
||||||
"$ref": "#/definitions/NavbarPreference"
|
"$ref": "#/definitions/NavbarPreference"
|
||||||
},
|
},
|
||||||
|
"queryHistory": {
|
||||||
|
"$ref": "#/definitions/QueryHistoryPreference"
|
||||||
|
},
|
||||||
"theme": {
|
"theme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["light", "dark"],
|
"enum": ["light", "dark"],
|
||||||
|
Loading…
Reference in New Issue
Block a user