mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 08:42:19 +08:00
API: Extract OpenAPI specification from source code using go-swagger (#40528)
* API: Using go-swagger for extracting OpenAPI specification from source code * Merge Grafana Alerting spec * Include enterprise endpoints (if enabled) * Serve SwaggerUI under feature flag * Fix building dev docker images * Configure swaggerUI * Add missing json tags Co-authored-by: Ying WANG <ying.wang@grafana.com> Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
This commit is contained in:
Sofia Papagiannaki
committed by
GitHub
GitHub
parent
9c2363ef08
commit
35fe58de37
350
pkg/api/docs/definitions/datasources.go
Normal file
350
pkg/api/docs/definitions/datasources.go
Normal file
@ -0,0 +1,350 @@
|
||||
package definitions
|
||||
|
||||
import (
|
||||
"github.com/grafana/grafana/pkg/api/dtos"
|
||||
"github.com/grafana/grafana/pkg/models"
|
||||
"github.com/grafana/grafana/pkg/tsdb/legacydata"
|
||||
)
|
||||
|
||||
// swagger:route GET /datasources datasources getDatasources
|
||||
//
|
||||
// Get all data sources.
|
||||
//
|
||||
// If you are running Grafana Enterprise and have Fine-grained access control enabled
|
||||
// you need to have a permission with action: `datasources:read` and scope: `datasources:*`.
|
||||
//
|
||||
// Responses:
|
||||
// 200: getDatasourcesResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route POST /datasources datasources addDatasource
|
||||
//
|
||||
// Create a data source.
|
||||
//
|
||||
// By defining `password` and `basicAuthPassword` under secureJsonData property
|
||||
// Grafana encrypts them securely as an encrypted blob in the database.
|
||||
// The response then lists the encrypted fields under secureJsonFields.
|
||||
//
|
||||
// If you are running Grafana Enterprise and have Fine-grained access control enabled
|
||||
// you need to have a permission with action: `datasources:create`
|
||||
//
|
||||
// Responses:
|
||||
// 200: createOrUpdateDatasourceResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 409: conflictError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route PUT /datasources/{datasource_id} datasources updateDatasource
|
||||
//
|
||||
// Update an existing data source.
|
||||
//
|
||||
// Similar to creating a data source, `password` and `basicAuthPassword` should be defined under
|
||||
// secureJsonData in order to be stored securely as an encrypted blob in the database. Then, the
|
||||
// encrypted fields are listed under secureJsonFields section in the response.
|
||||
//
|
||||
// If you are running Grafana Enterprise and have Fine-grained access control enabled
|
||||
// you need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: createOrUpdateDatasourceResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route DELETE /datasources/{datasource_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:id:*` and `datasources:id:1` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: okResponse
|
||||
// 401: unauthorisedError
|
||||
// 404: notFoundError
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route DELETE /datasources/uid/{datasource_uid} datasources deleteDatasourceByUID
|
||||
//
|
||||
// Delete an existing data source by UID.
|
||||
//
|
||||
// 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:kLtEtcRGk` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: okResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 404: notFoundError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route DELETE /datasources/name/{datasource_name} datasources deleteDatasourceByName
|
||||
//
|
||||
// Delete an existing data source by name.
|
||||
//
|
||||
// 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:name:*` and `datasources:name:test_datasource` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: deleteDatasourceByNameResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 404: notFoundError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route GET /datasources/{datasource_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:id:*` and `datasources:id:1` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: getDatasourceResponse
|
||||
// 400: badRequestError
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 404: notFoundError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route GET /datasources/uid/{datasource_uid} datasources getDatasourceByUID
|
||||
//
|
||||
// Get a single data source by UID.
|
||||
//
|
||||
// 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:kLtEtcRGk` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: getDatasourceResponse
|
||||
// 400: badRequestError
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 404: notFoundError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route GET /datasources/name/{datasource_name} datasources getDatasourceByName
|
||||
//
|
||||
// Get a single data source by Name.
|
||||
//
|
||||
// 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:name:*` and `datasources:name:test_datasource` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: getDatasourceResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route GET /datasources/id/{datasource_name} datasources getDatasourceIdByName
|
||||
//
|
||||
// Get data source Id by Name.
|
||||
//
|
||||
// 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:name:*` and `datasources:name:test_datasource` (single data source).
|
||||
//
|
||||
// Responses:
|
||||
// 200: getDatasourceIDresponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 404: notFoundError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route GET /datasources/proxy/{datasource_id}/{datasource_proxy_route} datasources datasourceProxyGETcalls
|
||||
//
|
||||
// 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
|
||||
//
|
||||
// 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
|
||||
//
|
||||
// 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
|
||||
//
|
||||
// Query metrics.
|
||||
//
|
||||
// Queries a data source having backend implementation.
|
||||
//
|
||||
// Most of Grafana’s builtin data sources have backend implementation.
|
||||
//
|
||||
// If you are running Grafana Enterprise and have Fine-grained access control enabled
|
||||
// you need to have a permission with action: `datasources:query`.
|
||||
//
|
||||
// Responses:
|
||||
// 200: queryDatasourceResponse
|
||||
// 401: unauthorisedError
|
||||
// 400: badRequestError
|
||||
// 403: forbiddenError
|
||||
// 404: notFoundError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:parameters updateDatasource deleteDatasourceByID getDatasourceByID datasourceProxyGETcalls datasourceProxyPOSTcalls datasourceProxyDELETEcalls
|
||||
// swagger:parameters enablePermissions disablePermissions getPermissions deletePermissions
|
||||
type DatasourceID struct {
|
||||
// in:path
|
||||
// required:true
|
||||
DatasourceID string `json:"datasource_id"`
|
||||
}
|
||||
|
||||
// swagger:parameters deleteDatasourceByUID getDatasourceByUID
|
||||
type DatasourceUID struct {
|
||||
// in:path
|
||||
// required:true
|
||||
DatasourceUID string `json:"datasource_uid"`
|
||||
}
|
||||
|
||||
// swagger:parameters getDatasourceByName deleteDatasourceByName getDatasourceIdByName
|
||||
type DatasourceName struct {
|
||||
// in:path
|
||||
// required:true
|
||||
DatasourceName string `json:"datasource_name"`
|
||||
}
|
||||
|
||||
// swagger:parameters datasourceProxyGETcalls datasourceProxyPOSTcalls datasourceProxyDELETEcalls
|
||||
type DatasourceProxyRouteParam struct {
|
||||
// in:path
|
||||
// required:true
|
||||
DatasourceProxyRoute string `json:"datasource_proxy_route"`
|
||||
}
|
||||
|
||||
// swagger:parameters datasourceProxyPOSTcalls
|
||||
type DatasourceProxyParam struct {
|
||||
// in:body
|
||||
// required:true
|
||||
DatasourceProxyParam interface{}
|
||||
}
|
||||
|
||||
// swagger:parameters addDatasource
|
||||
type AddDatasourceParam struct {
|
||||
// in:body
|
||||
// required:true
|
||||
Body models.AddDataSourceCommand
|
||||
}
|
||||
|
||||
// swagger:parameters updateDatasource
|
||||
type UpdateDatasource struct {
|
||||
// in:body
|
||||
// required:true
|
||||
Body models.UpdateDataSourceCommand
|
||||
}
|
||||
|
||||
// swagger:parameters queryDatasource
|
||||
type QueryDatasource struct {
|
||||
// in:body
|
||||
// required:true
|
||||
Body dtos.MetricRequest
|
||||
}
|
||||
|
||||
// swagger:response getDatasourcesResponse
|
||||
type GetDatasourcesResponse struct {
|
||||
// The response message
|
||||
// in: body
|
||||
Body dtos.DataSourceList `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:response getDatasourceResponse
|
||||
type GetDatasourceResponse struct {
|
||||
// The response message
|
||||
// in: body
|
||||
Body dtos.DataSource `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:response createOrUpdateDatasourceResponse
|
||||
type CreateOrUpdateDatasourceResponse struct {
|
||||
// The response message
|
||||
// in: body
|
||||
Body struct {
|
||||
// ID Identifier of the new data source.
|
||||
// required: true
|
||||
// example: 65
|
||||
ID int64 `json:"id"`
|
||||
|
||||
// Name of the new data source.
|
||||
// required: true
|
||||
// example: My Data source
|
||||
Name string `json:"name"`
|
||||
|
||||
// Message Message of the deleted dashboard.
|
||||
// required: true
|
||||
// example: Data source added
|
||||
Message string `json:"message"`
|
||||
|
||||
// Datasource properties
|
||||
// required: true
|
||||
Datasource dtos.DataSource `json:"datasource"`
|
||||
} `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:response getDatasourceIDresponse
|
||||
type GetDatasourceIDresponse struct {
|
||||
// The response message
|
||||
// in: body
|
||||
Body struct {
|
||||
// ID Identifier of the data source.
|
||||
// required: true
|
||||
// example: 65
|
||||
ID int64 `json:"id"`
|
||||
} `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:response deleteDatasourceByNameResponse
|
||||
type DeleteDatasourceByNameResponse struct {
|
||||
// The response message
|
||||
// in: body
|
||||
Body struct {
|
||||
// ID Identifier of the deleted data source.
|
||||
// required: true
|
||||
// example: 65
|
||||
ID int64 `json:"id"`
|
||||
|
||||
// Message Message of the deleted dashboard.
|
||||
// required: true
|
||||
// example: Dashboard My Dashboard deleted
|
||||
Message string `json:"message"`
|
||||
} `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:response queryDatasourceResponse
|
||||
type QueryDatasourceResponse struct {
|
||||
// The response message
|
||||
// in: body
|
||||
//nolint: staticcheck // plugins.DataResponse deprecated
|
||||
Body legacydata.DataResponse `json:"body"`
|
||||
}
|
||||
Reference in New Issue
Block a user