mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-02 12:02:03 +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>
56 lines
1.6 KiB
Go
56 lines
1.6 KiB
Go
// Copyright 2022 Woodpecker Authors
|
|
//
|
|
// 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 (
|
|
"fmt"
|
|
|
|
"github.com/robfig/cron"
|
|
)
|
|
|
|
type Cron struct {
|
|
ID int64 `json:"id" xorm:"pk autoincr"`
|
|
Name string `json:"name" xorm:"UNIQUE(s) INDEX"`
|
|
RepoID int64 `json:"repo_id" xorm:"repo_id UNIQUE(s) INDEX"`
|
|
CreatorID int64 `json:"creator_id" xorm:"creator_id INDEX"`
|
|
NextExec int64 `json:"next_exec"`
|
|
Schedule string `json:"schedule" xorm:"NOT NULL"` // @weekly, 3min, ...
|
|
Created int64 `json:"created_at" xorm:"created NOT NULL DEFAULT 0"`
|
|
Branch string `json:"branch"`
|
|
} // @name Cron
|
|
|
|
// TableName returns the database table name for xorm
|
|
func (Cron) TableName() string {
|
|
return "crons"
|
|
}
|
|
|
|
// Validate a cron
|
|
func (c *Cron) Validate() error {
|
|
if c.Name == "" {
|
|
return fmt.Errorf("name is required")
|
|
}
|
|
|
|
if c.Schedule == "" {
|
|
return fmt.Errorf("schedule is required")
|
|
}
|
|
|
|
_, err := cron.Parse(c.Schedule)
|
|
if err != nil {
|
|
return fmt.Errorf("can't parse schedule: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|