diff options
author | Ethan Koenig <ethantkoenig@gmail.com> | 2017-11-12 23:02:25 -0800 |
---|---|---|
committer | Lauris BH <lauris@nix.lv> | 2017-11-13 09:02:25 +0200 |
commit | f26f4a7e01f9c380c261fa5bc21bd7e48f2f2f9f (patch) | |
tree | 39c2fc0abc5a10f80f8fa31b3bd57ec3604bf7fd /vendor/code.gitea.io/sdk/gitea/user.go | |
parent | 4287d100b39ff89e297ba8945e54fb5911226974 (diff) | |
download | gitea-f26f4a7e01f9c380c261fa5bc21bd7e48f2f2f9f.tar.gz gitea-f26f4a7e01f9c380c261fa5bc21bd7e48f2f2f9f.zip |
Update swagger documentation (#2899)
* Update swagger documentation
Add docs for missing endpoints
Add documentation for request parameters
Make parameter naming consistent
Fix response documentation
* Restore delete comments
Diffstat (limited to 'vendor/code.gitea.io/sdk/gitea/user.go')
-rw-r--r-- | vendor/code.gitea.io/sdk/gitea/user.go | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/vendor/code.gitea.io/sdk/gitea/user.go b/vendor/code.gitea.io/sdk/gitea/user.go index 9fe2edcbf2..d104cc9933 100644 --- a/vendor/code.gitea.io/sdk/gitea/user.go +++ b/vendor/code.gitea.io/sdk/gitea/user.go @@ -9,20 +9,21 @@ import ( "fmt" ) -// User represents a API user. -// swagger:response User +// 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 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"` } -// UserList represents a list of API user. -// swagger:response UserList -type UserList []*User - // 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 |