mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-02 09:52:21 +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>
87 lines
2.4 KiB
Go
87 lines
2.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
|
|
|
|
import (
|
|
"errors"
|
|
"regexp"
|
|
)
|
|
|
|
// validate a username (e.g. from github)
|
|
var reUsername = regexp.MustCompile("^[a-zA-Z0-9-_.]+$")
|
|
|
|
var errUserLoginInvalid = errors.New("Invalid User Login")
|
|
|
|
// User represents a registered user.
|
|
type User struct {
|
|
// the id for this user.
|
|
//
|
|
// required: true
|
|
ID int64 `json:"id" xorm:"pk autoincr 'user_id'"`
|
|
|
|
ForgeRemoteID ForgeRemoteID `json:"-" xorm:"forge_remote_id"`
|
|
|
|
// Login is the username for this user.
|
|
//
|
|
// required: true
|
|
Login string `json:"login" xorm:"UNIQUE 'user_login'"`
|
|
|
|
// Token is the oauth2 token.
|
|
Token string `json:"-" xorm:"TEXT 'user_token'"`
|
|
|
|
// Secret is the oauth2 token secret.
|
|
Secret string `json:"-" xorm:"TEXT 'user_secret'"`
|
|
|
|
// Expiry is the token and secret expiration timestamp.
|
|
Expiry int64 `json:"-" xorm:"user_expiry"`
|
|
|
|
// Email is the email address for this user.
|
|
//
|
|
// required: true
|
|
Email string `json:"email" xorm:" varchar(500) 'user_email'"`
|
|
|
|
// the avatar url for this user.
|
|
Avatar string `json:"avatar_url" xorm:" varchar(500) 'user_avatar'"`
|
|
|
|
// Admin indicates the user is a system administrator.
|
|
//
|
|
// NOTE: If the username is part of the WOODPECKER_ADMIN
|
|
// environment variable this value will be set to true on login.
|
|
Admin bool `json:"admin,omitempty" xorm:"user_admin"`
|
|
|
|
// Hash is a unique token used to sign tokens.
|
|
Hash string `json:"-" xorm:"UNIQUE varchar(500) 'user_hash'"`
|
|
} // @name User
|
|
|
|
// TableName return database table name for xorm
|
|
func (User) TableName() string {
|
|
return "users"
|
|
}
|
|
|
|
// Validate validates the required fields and formats.
|
|
func (u *User) Validate() error {
|
|
switch {
|
|
case len(u.Login) == 0:
|
|
return errUserLoginInvalid
|
|
case len(u.Login) > 250:
|
|
return errUserLoginInvalid
|
|
case !reUsername.MatchString(u.Login):
|
|
return errUserLoginInvalid
|
|
default:
|
|
return nil
|
|
}
|
|
}
|