mirror of https://github.com/grafana/grafana.git
75 lines
2.4 KiB
Go
75 lines
2.4 KiB
Go
package datasource
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"k8s.io/kube-openapi/pkg/spec3"
|
|
"k8s.io/kube-openapi/pkg/validation/spec"
|
|
|
|
"github.com/grafana/grafana/pkg/registry/apis/query/queryschema"
|
|
)
|
|
|
|
func (b *DataSourceAPIBuilder) PostProcessOpenAPI(oas *spec3.OpenAPI) (*spec3.OpenAPI, error) {
|
|
// The plugin description
|
|
oas.Info.Description = b.pluginJSON.Info.Description
|
|
|
|
// The root api URL
|
|
root := "/apis/" + b.datasourceResourceInfo.GroupVersion().String() + "/"
|
|
|
|
// Add queries to the request properties
|
|
if err := queryschema.AddQueriesToOpenAPI(queryschema.OASQueryOptions{
|
|
Swagger: oas,
|
|
PluginJSON: &b.pluginJSON,
|
|
QueryTypes: b.queryTypes,
|
|
Root: root,
|
|
QueryPath: "namespaces/{namespace}/datasources/{name}/query",
|
|
QueryDescription: fmt.Sprintf("Query the %s datasources", b.pluginJSON.Name),
|
|
}); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Hide the resource routes -- explicit ones will be added if defined below
|
|
prefix := root + "namespaces/{namespace}/datasources/{name}/resource"
|
|
r := oas.Paths.Paths[prefix]
|
|
if r != nil && r.Get != nil {
|
|
r.Get.Description = "Get resources in the datasource plugin. NOTE, additional routes may exist, but are not exposed via OpenAPI"
|
|
r.Delete = nil
|
|
r.Head = nil
|
|
r.Patch = nil
|
|
r.Post = nil
|
|
r.Put = nil
|
|
r.Options = nil
|
|
}
|
|
delete(oas.Paths.Paths, prefix+"/{path}")
|
|
|
|
// Set explicit apiVersion and kind on the datasource
|
|
ds, ok := oas.Components.Schemas["com.github.grafana.grafana.pkg.apis.datasource.v0alpha1.DataSource"]
|
|
if !ok {
|
|
return nil, fmt.Errorf("missing DS type")
|
|
}
|
|
ds.Properties["apiVersion"] = *spec.StringProperty().WithEnum(b.GetGroupVersion().String())
|
|
ds.Properties["kind"] = *spec.StringProperty().WithEnum("DataSource")
|
|
|
|
// Mark connections as deprecated
|
|
delete(oas.Paths.Paths, root+"namespaces/{namespace}/connections/{name}")
|
|
query := oas.Paths.Paths[root+"namespaces/{namespace}/connections/{name}/query"]
|
|
for query == nil || query.Post == nil {
|
|
return nil, fmt.Errorf("missing temporary connection path")
|
|
}
|
|
query.Post.Tags = []string{"Connections (deprecated)"}
|
|
query.Post.Deprecated = true
|
|
query.Post.RequestBody = &spec3.RequestBody{
|
|
RequestBodyProps: spec3.RequestBodyProps{
|
|
Content: map[string]*spec3.MediaType{
|
|
"application/json": {
|
|
MediaTypeProps: spec3.MediaTypeProps{
|
|
Schema: spec.MapProperty(nil),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
return oas, nil
|
|
}
|