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

Alerting: Cleanup and move legacy to a legacy file (#32803)

Browse Source 
* Alerting: Cleanup and move legacy to a legacy file

A quick cleanup of the ngalert/api directory, optimising for an easy
removal of what is will be considered legacy at some point. A quick
summary of what's done is:

- Add a prefix `generated` prefix to files that are auto-generated by
  our swagger definitions.
- Create a legacy file to place all the legacy API routes implementation
  and helpers. Deleting files that where no longer needed after this
move.
- Rename the `lotex` file to `lotex_ruler`
- Adding a couple of comments here and there.

With this, I hope to organise our code in this directory a bit better
given there's a lot going on.
This commit is contained in:
gotjosh
2021-04-09 05:55:41 -04:00
committed by GitHub
parent 51e4106d1d
commit c9e5088e8b
20 changed files with 377 additions and 610 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/ngalert/api/swagger-codegen/templates/controller-api.mustache
+2 -15
View File
@@ -3,13 +3,11 @@ package {{packageName}}
{{#operations}}
import (
"net/http"
"github.com/go-macaron/binding"
"github.com/grafana/grafana/pkg/api/routing"
"github.com/grafana/grafana/pkg/api/response"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/infra/log"
apimodels "github.com/grafana/alerting-api/pkg/api"
"github.com/grafana/grafana/pkg/middleware"
)
@@ -18,22 +16,11 @@ type {{classname}}Service interface { {{#operation}}
{{nickname}}(*models.ReqContext{{#bodyParams}}, apimodels.{{dataType}}{{/bodyParams}}) response.Response{{/operation}}
}
type {{classname}}Base struct {
log log.Logger
}
func (api *API) Register{{classname}}Endpoints(srv {{classname}}Service) {
api.RouteRegister.Group("", func(group routing.RouteRegister){ {{#operations}}{{#operation}}
group.{{httpMethod}}(toMacaronPath("{{{path}}}"){{#bodyParams}}, binding.Bind(apimodels.{{dataType}}{}){{/bodyParams}}, routing.Wrap(srv.{{nickname}})){{/operation}}{{/operations}}
}, middleware.ReqSignedIn)
}{{#operation}}
func (base {{classname}}Base) {{nickname}}(c *models.ReqContext{{#bodyParams}}, {{paramName}} apimodels.{{dataType}}{{/bodyParams}}) response.Response { {{#pathParams}}
{{paramName}} := c.Params(":{{baseName}}")
base.log.Info("{{nickname}}: ", "{{baseName}}", {{paramName}}){{/pathParams}}{{#bodyParams}}
base.log.Info("{{nickname}}: ", "{{baseName}}", {{paramName}}){{/bodyParams}}
return response.Error(http.StatusNotImplemented, "", nil)
}{{/operation}}{{/operations}}
{{/operation}}{{/operations}}