mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-01 14:21:07 +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>
68 lines
4.4 KiB
Go
68 lines
4.4 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
|
|
|
|
type Pipeline struct {
|
|
ID int64 `json:"id" xorm:"pk autoincr 'pipeline_id'"`
|
|
RepoID int64 `json:"-" xorm:"UNIQUE(s) INDEX 'pipeline_repo_id'"`
|
|
Number int64 `json:"number" xorm:"UNIQUE(s) 'pipeline_number'"`
|
|
Author string `json:"author" xorm:"INDEX 'pipeline_author'"`
|
|
ConfigID int64 `json:"-" xorm:"pipeline_config_id"`
|
|
Parent int64 `json:"parent" xorm:"pipeline_parent"`
|
|
Event WebhookEvent `json:"event" xorm:"pipeline_event"`
|
|
Status StatusValue `json:"status" xorm:"INDEX 'pipeline_status'"`
|
|
Error string `json:"error" xorm:"pipeline_error"`
|
|
Enqueued int64 `json:"enqueued_at" xorm:"pipeline_enqueued"`
|
|
Created int64 `json:"created_at" xorm:"pipeline_created"`
|
|
Updated int64 `json:"updated_at" xorm:"updated NOT NULL DEFAULT 0 'updated'"`
|
|
Started int64 `json:"started_at" xorm:"pipeline_started"`
|
|
Finished int64 `json:"finished_at" xorm:"pipeline_finished"`
|
|
Deploy string `json:"deploy_to" xorm:"pipeline_deploy"`
|
|
Commit string `json:"commit" xorm:"pipeline_commit"`
|
|
Branch string `json:"branch" xorm:"pipeline_branch"`
|
|
Ref string `json:"ref" xorm:"pipeline_ref"`
|
|
Refspec string `json:"refspec" xorm:"pipeline_refspec"`
|
|
CloneURL string `json:"clone_url" xorm:"pipeline_clone_url"`
|
|
Title string `json:"title" xorm:"pipeline_title"`
|
|
Message string `json:"message" xorm:"TEXT 'pipeline_message'"`
|
|
Timestamp int64 `json:"timestamp" xorm:"pipeline_timestamp"`
|
|
Sender string `json:"sender" xorm:"pipeline_sender"` // uses reported user for webhooks and name of cron for cron pipelines
|
|
Avatar string `json:"author_avatar" xorm:"pipeline_avatar"`
|
|
Email string `json:"author_email" xorm:"pipeline_email"`
|
|
Link string `json:"link_url" xorm:"pipeline_link"`
|
|
Signed bool `json:"signed" xorm:"pipeline_signed"` // deprecate
|
|
Verified bool `json:"verified" xorm:"pipeline_verified"` // deprecate
|
|
Reviewer string `json:"reviewed_by" xorm:"pipeline_reviewer"`
|
|
Reviewed int64 `json:"reviewed_at" xorm:"pipeline_reviewed"`
|
|
Steps []*Step `json:"steps,omitempty" xorm:"-"`
|
|
ChangedFiles []string `json:"changed_files,omitempty" xorm:"json 'changed_files'"`
|
|
AdditionalVariables map[string]string `json:"variables,omitempty" xorm:"json 'additional_variables'"`
|
|
PullRequestLabels []string `json:"pr_labels,omitempty" xorm:"json 'pr_labels'"`
|
|
} // @name Pipeline
|
|
|
|
// TableName return database table name for xorm
|
|
func (Pipeline) TableName() string {
|
|
return "pipelines"
|
|
}
|
|
|
|
type UpdatePipelineStore interface {
|
|
UpdatePipeline(*Pipeline) error
|
|
}
|
|
|
|
type PipelineOptions struct {
|
|
Branch string `json:"branch"`
|
|
Variables map[string]string `json:"variables"`
|
|
} // @name PipelineOptions
|