mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-02 11:02:02 +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>
42 lines
2.2 KiB
Go
42 lines
2.2 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
|
|
|
|
// Feed represents an item in the user's feed or timeline.
|
|
type Feed struct {
|
|
Owner string `json:"owner" xorm:"feed_repo_owner"`
|
|
Name string `json:"name" xorm:"feed_repo_name"`
|
|
FullName string `json:"full_name" xorm:"feed_repo_full_name"`
|
|
|
|
ID int64 `json:"id,omitempty" xorm:"feed_pipeline_id"`
|
|
Number int64 `json:"number,omitempty" xorm:"feed_pipeline_number"`
|
|
Event string `json:"event,omitempty" xorm:"feed_pipeline_event"`
|
|
Status string `json:"status,omitempty" xorm:"feed_pipeline_status"`
|
|
Created int64 `json:"created_at,omitempty" xorm:"feed_pipeline_created"`
|
|
Started int64 `json:"started_at,omitempty" xorm:"feed_pipeline_started"`
|
|
Finished int64 `json:"finished_at,omitempty" xorm:"feed_pipeline_finished"`
|
|
Commit string `json:"commit,omitempty" xorm:"feed_pipeline_commit"`
|
|
Branch string `json:"branch,omitempty" xorm:"feed_pipeline_branch"`
|
|
Ref string `json:"ref,omitempty" xorm:"feed_pipeline_ref"`
|
|
Refspec string `json:"refspec,omitempty" xorm:"feed_pipeline_refspec"`
|
|
Remote string `json:"remote,omitempty" xorm:"feed_pipeline_clone_url"`
|
|
Title string `json:"title,omitempty" xorm:"feed_pipeline_title"`
|
|
Message string `json:"message,omitempty" xorm:"feed_pipeline_message"`
|
|
Author string `json:"author,omitempty" xorm:"feed_pipeline_author"`
|
|
Avatar string `json:"author_avatar,omitempty" xorm:"feed_pipeline_avatar"`
|
|
Email string `json:"author_email,omitempty" xorm:"feed_pipeline_email"`
|
|
} // @name Feed
|