Skip to content

Commit

Permalink
[API] User expose counters (#16167)
Browse files Browse the repository at this point in the history
  • Loading branch information
6543 authored Jun 17, 2021
1 parent 9469e14 commit c9d053f
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
4 changes: 4 additions & 0 deletions modules/convert/user.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ func toUser(user *models.User, signed, authed bool) *api.User {
Location: user.Location,
Website: user.Website,
Description: user.Description,
// counter's
Followers: user.NumFollowers,
Following: user.NumFollowing,
StarredRepos: user.NumStars,
}
// hide primary email if API caller is anonymous or user keep email private
if signed && (!user.KeepEmailPrivate || authed) {
Expand Down
5 changes: 5 additions & 0 deletions modules/structs/user.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ type User struct {
Website string `json:"website"`
// the user's description
Description string `json:"description"`

// 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
Expand Down
16 changes: 16 additions & 0 deletions templates/swagger/v1_json.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -16345,6 +16345,17 @@
"format": "email",
"x-go-name": "Email"
},
"followers_count": {
"description": "user counts",
"type": "integer",
"format": "int64",
"x-go-name": "Followers"
},
"following_count": {
"type": "integer",
"format": "int64",
"x-go-name": "Following"
},
"full_name": {
"description": "the user's full name",
"type": "string",
Expand Down Expand Up @@ -16391,6 +16402,11 @@
"type": "boolean",
"x-go-name": "Restricted"
},
"starred_repos_count": {
"type": "integer",
"format": "int64",
"x-go-name": "StarredRepos"
},
"website": {
"description": "the user's website",
"type": "string",
Expand Down

0 comments on commit c9d053f

Please sign in to comment.