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>
63 lines
1.6 KiB
Go
63 lines
1.6 KiB
Go
// Copyright 2021 Woodpecker Authors
|
|
// 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 model
|
|
|
|
import (
|
|
"errors"
|
|
)
|
|
|
|
var (
|
|
errEnvironNameInvalid = errors.New("Invalid Environment Variable Name")
|
|
errEnvironValueInvalid = errors.New("Invalid Environment Variable Value")
|
|
)
|
|
|
|
// EnvironService defines a service for managing environment variables.
|
|
type EnvironService interface {
|
|
EnvironList(*Repo) ([]*Environ, error)
|
|
}
|
|
|
|
// EnvironStore persists environment information to storage.
|
|
type EnvironStore interface {
|
|
EnvironList(*Repo) ([]*Environ, error)
|
|
}
|
|
|
|
// Environ represents an environment variable.
|
|
type Environ struct {
|
|
ID int64 `json:"id"`
|
|
Name string `json:"name"`
|
|
Value string `json:"value,omitempty"`
|
|
}
|
|
|
|
// Validate validates the required fields and formats.
|
|
func (e *Environ) Validate() error {
|
|
switch {
|
|
case len(e.Name) == 0:
|
|
return errEnvironNameInvalid
|
|
case len(e.Value) == 0:
|
|
return errEnvironValueInvalid
|
|
default:
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// Copy makes a copy of the environment variable without the value.
|
|
func (e *Environ) Copy() *Environ {
|
|
return &Environ{
|
|
ID: e.ID,
|
|
Name: e.Name,
|
|
}
|
|
}
|