mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-12 08:23:48 +02:00
14177635b6
# Summary This PR drops the outdated former swagger.yaml/json and introduced automatic API document generation from Go code. The generated code is also used to generate documentation/markdown for the community page, as well as enable the Woodpecker server to serve a Swagger Web UI for manual tinkering. I did opt-in for gin-swagger, a middleware for the Gin framework, to ease implementation and have a sophisticated output. This middleware only produces Swagger v2 specs. AFAIK the newer OpenApi 3x tooling is not yet that mature, so I guess that's fine for now. ## Implemenation notes - former swagger.json files removed - former // swagger godocs removed - introduced new dependency gin-swagger, which uses godoc annotations on top of Gin Handler functions. - reworked Makefile to automatically generate Go code for the server - introduce new dependency go-swagger, to generate Markdown for documentation purposes - add a Swagger Web UI, incl. capabilities for manual API exploration - consider relative root paths in the implementation - write documentation for all exposed API endpoints - incl. API docs in the community website (auto-generated) - provide developer documentation, for the Woodpecker authors - no other existing logic/code was intentionally changed --------- close #292 --------- Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> Co-authored-by: 6543 <6543@obermui.de>
103 lines
2.9 KiB
Go
103 lines
2.9 KiB
Go
// Copyright 2018 Drone.IO Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package api
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/rs/zerolog"
|
|
"github.com/rs/zerolog/log"
|
|
|
|
"github.com/woodpecker-ci/woodpecker/server/store"
|
|
"github.com/woodpecker-ci/woodpecker/version"
|
|
)
|
|
|
|
// Health
|
|
//
|
|
// @Summary Health information
|
|
// @Description If everything is fine, just a 200 will be returned, a 500 signals server state is unhealthy.
|
|
// @Router /healthz [get]
|
|
// @Produce plain
|
|
// @Success 200
|
|
// @Failure 500
|
|
// @Tags System
|
|
func Health(c *gin.Context) {
|
|
if err := store.FromContext(c).Ping(); err != nil {
|
|
c.String(http.StatusInternalServerError, err.Error())
|
|
return
|
|
}
|
|
c.String(http.StatusOK, "")
|
|
}
|
|
|
|
// Version
|
|
//
|
|
// @Summary Get version
|
|
// @Description Endpoint returns the server version and build information.
|
|
// @Router /version [get]
|
|
// @Produce json
|
|
// @Success 200 {object} string{source=string,version=string}
|
|
// @Tags System
|
|
func Version(c *gin.Context) {
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"source": "https://github.com/woodpecker-ci/woodpecker",
|
|
"version": version.String(),
|
|
})
|
|
}
|
|
|
|
// LogLevel
|
|
//
|
|
// @Summary Current log level
|
|
// @Description Endpoint returns the current logging level. Requires admin rights.
|
|
// @Router /log-level [get]
|
|
// @Produce json
|
|
// @Success 200 {object} string{log-level=string}
|
|
// @Tags System
|
|
func LogLevel(c *gin.Context) {
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"log-level": zerolog.GlobalLevel().String(),
|
|
})
|
|
}
|
|
|
|
// SetLogLevel
|
|
//
|
|
// @Summary Set log level
|
|
// @Description Endpoint sets the current logging level. Requires admin rights.
|
|
// @Router /log-level [post]
|
|
// @Produce json
|
|
// @Success 200 {object} string{log-level=string}
|
|
// @Tags System
|
|
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
|
|
// @Param log-level body string{log-level=string} true "the new log level, one of <debug,trace,info,warn,error,fatal,panic,disabled>"
|
|
func SetLogLevel(c *gin.Context) {
|
|
logLevel := struct {
|
|
LogLevel string `json:"log-level"`
|
|
}{}
|
|
if err := c.Bind(&logLevel); err != nil {
|
|
_ = c.AbortWithError(http.StatusBadRequest, err)
|
|
return
|
|
}
|
|
|
|
lvl, err := zerolog.ParseLevel(logLevel.LogLevel)
|
|
if err != nil {
|
|
_ = c.AbortWithError(http.StatusBadRequest, err)
|
|
return
|
|
}
|
|
|
|
log.Log().Msgf("log level set to %s", lvl.String())
|
|
zerolog.SetGlobalLevel(lvl)
|
|
c.JSON(http.StatusOK, logLevel)
|
|
}
|