mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-07-04 13:06:09 +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>
84 lines
2.4 KiB
Go
84 lines
2.4 KiB
Go
// Copyright 2022 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"
|
|
"fmt"
|
|
)
|
|
|
|
type WebhookEvent string // @name WebhookEvent
|
|
|
|
const (
|
|
EventPush WebhookEvent = "push"
|
|
EventPull WebhookEvent = "pull_request"
|
|
EventTag WebhookEvent = "tag"
|
|
EventDeploy WebhookEvent = "deployment"
|
|
EventCron WebhookEvent = "cron"
|
|
EventManual WebhookEvent = "manual"
|
|
)
|
|
|
|
type WebhookEventList []WebhookEvent
|
|
|
|
func (wel WebhookEventList) Len() int { return len(wel) }
|
|
func (wel WebhookEventList) Swap(i, j int) { wel[i], wel[j] = wel[j], wel[i] }
|
|
func (wel WebhookEventList) Less(i, j int) bool { return wel[i] < wel[j] }
|
|
|
|
var ErrInvalidWebhookEvent = errors.New("invalid webhook event")
|
|
|
|
func ValidateWebhookEvent(s WebhookEvent) error {
|
|
switch s {
|
|
case EventPush, EventPull, EventTag, EventDeploy, EventCron, EventManual:
|
|
return nil
|
|
default:
|
|
return fmt.Errorf("%w: %s", ErrInvalidWebhookEvent, s)
|
|
}
|
|
}
|
|
|
|
// StatusValue represent pipeline states woodpecker know
|
|
type StatusValue string // @name StatusValue
|
|
|
|
const (
|
|
StatusSkipped StatusValue = "skipped"
|
|
StatusPending StatusValue = "pending"
|
|
StatusRunning StatusValue = "running"
|
|
StatusSuccess StatusValue = "success"
|
|
StatusFailure StatusValue = "failure"
|
|
StatusKilled StatusValue = "killed"
|
|
StatusError StatusValue = "error"
|
|
StatusBlocked StatusValue = "blocked"
|
|
StatusDeclined StatusValue = "declined"
|
|
)
|
|
|
|
// SCMKind represent different version control systems
|
|
type SCMKind string // @name SCMKind
|
|
|
|
const (
|
|
RepoGit SCMKind = "git"
|
|
RepoHg SCMKind = "hg"
|
|
RepoFossil SCMKind = "fossil"
|
|
RepoPerforce SCMKind = "perforce"
|
|
)
|
|
|
|
// RepoVisibility represent to wat state a repo in woodpecker is visible to others
|
|
type RepoVisibility string // @name RepoVisibility
|
|
|
|
const (
|
|
VisibilityPublic RepoVisibility = "public"
|
|
VisibilityPrivate RepoVisibility = "private"
|
|
VisibilityInternal RepoVisibility = "internal"
|
|
)
|