mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-24 08:57:03 -05:00
03591f0f95
this is a simple endpoint that adds the ability to rename users to the
admin API.
Note: this is not in a mergeable state. It would be better if this was
handled by a PATCH/POST to the /api/v1/admin/users/{username} endpoint
and the username is modified.
---------
Co-authored-by: Jason Song <i@wolfogre.com>
104 lines
3.1 KiB
Go
104 lines
3.1 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package structs
|
|
|
|
import (
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/modules/json"
|
|
)
|
|
|
|
// User represents a user
|
|
// swagger:model
|
|
type User struct {
|
|
// the user's id
|
|
ID int64 `json:"id"`
|
|
// the user's username
|
|
UserName string `json:"login"`
|
|
// the user's authentication sign-in name.
|
|
// default: empty
|
|
LoginName string `json:"login_name"`
|
|
// the user's full name
|
|
FullName string `json:"full_name"`
|
|
// swagger:strfmt email
|
|
Email string `json:"email"`
|
|
// URL to the user's avatar
|
|
AvatarURL string `json:"avatar_url"`
|
|
// User locale
|
|
Language string `json:"language"`
|
|
// Is the user an administrator
|
|
IsAdmin bool `json:"is_admin"`
|
|
// swagger:strfmt date-time
|
|
LastLogin time.Time `json:"last_login,omitempty"`
|
|
// swagger:strfmt date-time
|
|
Created time.Time `json:"created,omitempty"`
|
|
// Is user restricted
|
|
Restricted bool `json:"restricted"`
|
|
// Is user active
|
|
IsActive bool `json:"active"`
|
|
// Is user login prohibited
|
|
ProhibitLogin bool `json:"prohibit_login"`
|
|
// the user's location
|
|
Location string `json:"location"`
|
|
// the user's website
|
|
Website string `json:"website"`
|
|
// the user's description
|
|
Description string `json:"description"`
|
|
// User visibility level option: public, limited, private
|
|
Visibility string `json:"visibility"`
|
|
|
|
// user counts
|
|
Followers int `json:"followers_count"`
|
|
Following int `json:"following_count"`
|
|
StarredRepos int `json:"starred_repos_count"`
|
|
}
|
|
|
|
// MarshalJSON implements the json.Marshaler interface for User, adding field(s) for backward compatibility
|
|
func (u User) MarshalJSON() ([]byte, error) {
|
|
// Re-declaring User to avoid recursion
|
|
type shadow User
|
|
return json.Marshal(struct {
|
|
shadow
|
|
CompatUserName string `json:"username"`
|
|
}{shadow(u), u.UserName})
|
|
}
|
|
|
|
// UserSettings represents user settings
|
|
// swagger:model
|
|
type UserSettings struct {
|
|
FullName string `json:"full_name"`
|
|
Website string `json:"website"`
|
|
Description string `json:"description"`
|
|
Location string `json:"location"`
|
|
Language string `json:"language"`
|
|
Theme string `json:"theme"`
|
|
DiffViewStyle string `json:"diff_view_style"`
|
|
// Privacy
|
|
HideEmail bool `json:"hide_email"`
|
|
HideActivity bool `json:"hide_activity"`
|
|
}
|
|
|
|
// UserSettingsOptions represents options to change user settings
|
|
// swagger:model
|
|
type UserSettingsOptions struct {
|
|
FullName *string `json:"full_name" binding:"MaxSize(100)"`
|
|
Website *string `json:"website" binding:"OmitEmpty;ValidUrl;MaxSize(255)"`
|
|
Description *string `json:"description" binding:"MaxSize(255)"`
|
|
Location *string `json:"location" binding:"MaxSize(50)"`
|
|
Language *string `json:"language"`
|
|
Theme *string `json:"theme"`
|
|
DiffViewStyle *string `json:"diff_view_style"`
|
|
// Privacy
|
|
HideEmail *bool `json:"hide_email"`
|
|
HideActivity *bool `json:"hide_activity"`
|
|
}
|
|
|
|
// RenameUserOption options when renaming a user
|
|
type RenameUserOption struct {
|
|
// New username for this user. This name cannot be in use yet by any other user.
|
|
//
|
|
// required: true
|
|
// unique: true
|
|
NewName string `json:"new_username" binding:"Required"`
|
|
}
|