mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-10-02 08:22:01 +00: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>
192 lines
6.1 KiB
Go
192 lines
6.1 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/woodpecker-ci/woodpecker/server"
|
|
"github.com/woodpecker-ci/woodpecker/server/model"
|
|
"github.com/woodpecker-ci/woodpecker/server/router/middleware/session"
|
|
)
|
|
|
|
// GetRegistry
|
|
//
|
|
// @Summary Get a named registry
|
|
// @Router /repos/{owner}/{name}/registry/{registry} [get]
|
|
// @Produce json
|
|
// @Success 200 {object} Registry
|
|
// @Tags Repository registries
|
|
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
|
|
// @Param owner path string true "the repository owner's name"
|
|
// @Param name path string true "the repository name"
|
|
// @Param registry path string true "the registry name"
|
|
func GetRegistry(c *gin.Context) {
|
|
var (
|
|
repo = session.Repo(c)
|
|
name = c.Param("registry")
|
|
)
|
|
registry, err := server.Config.Services.Registries.RegistryFind(repo, name)
|
|
if err != nil {
|
|
handleDbGetError(c, err)
|
|
return
|
|
}
|
|
c.JSON(200, registry.Copy())
|
|
}
|
|
|
|
// PostRegistry
|
|
//
|
|
// @Summary Persist/create a registry
|
|
// @Router /repos/{owner}/{name}/registry [post]
|
|
// @Produce json
|
|
// @Success 200 {object} Registry
|
|
// @Tags Repository registries
|
|
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
|
|
// @Param owner path string true "the repository owner's name"
|
|
// @Param name path string true "the repository name"
|
|
// @Param registry body Registry true "the new registry data"
|
|
func PostRegistry(c *gin.Context) {
|
|
repo := session.Repo(c)
|
|
|
|
in := new(model.Registry)
|
|
if err := c.Bind(in); err != nil {
|
|
c.String(http.StatusBadRequest, "Error parsing request. %s", err)
|
|
return
|
|
}
|
|
registry := &model.Registry{
|
|
RepoID: repo.ID,
|
|
Address: in.Address,
|
|
Username: in.Username,
|
|
Password: in.Password,
|
|
Token: in.Token,
|
|
Email: in.Email,
|
|
}
|
|
if err := registry.Validate(); err != nil {
|
|
c.String(http.StatusBadRequest, "Error inserting registry. %s", err)
|
|
return
|
|
}
|
|
if err := server.Config.Services.Registries.RegistryCreate(repo, registry); err != nil {
|
|
c.String(http.StatusInternalServerError, "Error inserting registry %q. %s", in.Address, err)
|
|
return
|
|
}
|
|
c.JSON(http.StatusOK, in.Copy())
|
|
}
|
|
|
|
// PatchRegistry
|
|
//
|
|
// @Summary Update a named registry
|
|
// @Router /repos/{owner}/{name}/registry/{registry} [patch]
|
|
// @Produce json
|
|
// @Success 200 {object} Registry
|
|
// @Tags Repository registries
|
|
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
|
|
// @Param owner path string true "the repository owner's name"
|
|
// @Param name path string true "the repository name"
|
|
// @Param registry path string true "the registry name"
|
|
// @Param registryData body Registry true "the attributes for the registry"
|
|
func PatchRegistry(c *gin.Context) {
|
|
var (
|
|
repo = session.Repo(c)
|
|
name = c.Param("registry")
|
|
)
|
|
|
|
in := new(model.Registry)
|
|
err := c.Bind(in)
|
|
if err != nil {
|
|
c.String(http.StatusBadRequest, "Error parsing request. %s", err)
|
|
return
|
|
}
|
|
|
|
registry, err := server.Config.Services.Registries.RegistryFind(repo, name)
|
|
if err != nil {
|
|
handleDbGetError(c, err)
|
|
return
|
|
}
|
|
if in.Username != "" {
|
|
registry.Username = in.Username
|
|
}
|
|
if in.Password != "" {
|
|
registry.Password = in.Password
|
|
}
|
|
if in.Token != "" {
|
|
registry.Token = in.Token
|
|
}
|
|
if in.Email != "" {
|
|
registry.Email = in.Email
|
|
}
|
|
|
|
if err := registry.Validate(); err != nil {
|
|
c.String(http.StatusUnprocessableEntity, "Error updating registry. %s", err)
|
|
return
|
|
}
|
|
if err := server.Config.Services.Registries.RegistryUpdate(repo, registry); err != nil {
|
|
c.String(http.StatusInternalServerError, "Error updating registry %q. %s", in.Address, err)
|
|
return
|
|
}
|
|
c.JSON(http.StatusOK, in.Copy())
|
|
}
|
|
|
|
// GetRegistryList
|
|
//
|
|
// @Summary Get the registry list
|
|
// @Router /repos/{owner}/{name}/registry [get]
|
|
// @Produce json
|
|
// @Success 200 {array} Registry
|
|
// @Tags Repository registries
|
|
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
|
|
// @Param owner path string true "the repository owner's name"
|
|
// @Param name path string true "the repository name"
|
|
// @Param page query int false "for response pagination, page offset number" default(1)
|
|
// @Param perPage query int false "for response pagination, max items per page" default(50)
|
|
func GetRegistryList(c *gin.Context) {
|
|
repo := session.Repo(c)
|
|
list, err := server.Config.Services.Registries.RegistryList(repo, session.Pagination(c))
|
|
if err != nil {
|
|
c.String(http.StatusInternalServerError, "Error getting registry list. %s", err)
|
|
return
|
|
}
|
|
// copy the registry detail to remove the sensitive
|
|
// password and token fields.
|
|
for i, registry := range list {
|
|
list[i] = registry.Copy()
|
|
}
|
|
c.JSON(http.StatusOK, list)
|
|
}
|
|
|
|
// DeleteRegistry
|
|
//
|
|
// @Summary Delete a named registry
|
|
// @Router /repos/{owner}/{name}/registry/{registry} [delete]
|
|
// @Produce plain
|
|
// @Success 200
|
|
// @Tags Repository registries
|
|
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
|
|
// @Param owner path string true "the repository owner's name"
|
|
// @Param name path string true "the repository name"
|
|
// @Param registry path string true "the registry name"
|
|
func DeleteRegistry(c *gin.Context) {
|
|
var (
|
|
repo = session.Repo(c)
|
|
name = c.Param("registry")
|
|
)
|
|
err := server.Config.Services.Registries.RegistryDelete(repo, name)
|
|
if err != nil {
|
|
handleDbGetError(c, err)
|
|
return
|
|
}
|
|
c.String(http.StatusNoContent, "")
|
|
}
|