File tree Expand file tree Collapse file tree 27 files changed +131
-112
lines changed Expand file tree Collapse file tree 27 files changed +131
-112
lines changed Original file line number Diff line number Diff line change @@ -8,8 +8,11 @@ import "time"
8
8
9
9
// CreateUserOption create user options
10
10
type CreateUserOption struct {
11
- SourceID int64 `json:"source_id"`
11
+ SourceID int64 `json:"source_id"`
12
+ // identifier of the user, provided by the external authenticator (if configured)
13
+ // default: empty
12
14
LoginName string `json:"login_name"`
15
+ // username of the user
13
16
// required: true
14
17
Username string `json:"username" binding:"Required;Username;MaxSize(40)"`
15
18
FullName string `json:"full_name" binding:"MaxSize(100)"`
@@ -32,6 +35,8 @@ type CreateUserOption struct {
32
35
type EditUserOption struct {
33
36
// required: true
34
37
SourceID int64 `json:"source_id"`
38
+ // identifier of the user, provided by the external authenticator (if configured)
39
+ // default: empty
35
40
// required: true
36
41
LoginName string `json:"login_name" binding:"Required"`
37
42
// swagger:strfmt email
Original file line number Diff line number Diff line change @@ -71,7 +71,8 @@ type PayloadUser struct {
71
71
// Full name of the commit author
72
72
Name string `json:"name"`
73
73
// swagger:strfmt email
74
- Email string `json:"email"`
74
+ Email string `json:"email"`
75
+ // username of the user
75
76
UserName string `json:"username"`
76
77
}
77
78
Original file line number Diff line number Diff line change @@ -14,7 +14,7 @@ type AddTimeOption struct {
14
14
Time int64 `json:"time" binding:"Required"`
15
15
// swagger:strfmt date-time
16
16
Created time.Time `json:"created"`
17
- // User who spent the time (optional)
17
+ // username of the user who spent the time working on the issue (optional)
18
18
User string `json:"user_name"`
19
19
}
20
20
@@ -26,7 +26,8 @@ type TrackedTime struct {
26
26
// Time in seconds
27
27
Time int64 `json:"time"`
28
28
// deprecated (only for backwards compatibility)
29
- UserID int64 `json:"user_id"`
29
+ UserID int64 `json:"user_id"`
30
+ // username of the user
30
31
UserName string `json:"user_name"`
31
32
// deprecated (only for backwards compatibility)
32
33
IssueID int64 `json:"issue_id"`
Original file line number Diff line number Diff line change @@ -15,6 +15,7 @@ type Organization struct {
15
15
Location string `json:"location"`
16
16
Visibility string `json:"visibility"`
17
17
RepoAdminChangeTeamAccess bool `json:"repo_admin_change_team_access"`
18
+ // username of the organization
18
19
// deprecated
19
20
UserName string `json:"username"`
20
21
}
@@ -30,6 +31,7 @@ type OrganizationPermissions struct {
30
31
31
32
// CreateOrgOption options for creating an organization
32
33
type CreateOrgOption struct {
34
+ // username of the organization
33
35
// required: true
34
36
UserName string `json:"username" binding:"Required;Username;MaxSize(40)"`
35
37
FullName string `json:"full_name" binding:"MaxSize(100)"`
Original file line number Diff line number Diff line change @@ -15,9 +15,9 @@ import (
15
15
type User struct {
16
16
// the user's id
17
17
ID int64 `json:"id"`
18
- // the user's username
18
+ // login of the user, same as ` username`
19
19
UserName string `json:"login"`
20
- // the user's authentication sign-in name.
20
+ // identifier of the user, provided by the external authenticator (if configured)
21
21
// default: empty
22
22
LoginName string `json:"login_name"`
23
23
// The ID of the user's Authentication Source
Original file line number Diff line number Diff line change @@ -11,6 +11,7 @@ type Email struct {
11
11
Verified bool `json:"verified"`
12
12
Primary bool `json:"primary"`
13
13
UserID int64 `json:"user_id"`
14
+ // username of the user
14
15
UserName string `json:"username"`
15
16
}
16
17
Original file line number Diff line number Diff line change @@ -29,7 +29,7 @@ func CreateOrg(ctx *context.APIContext) {
29
29
// parameters:
30
30
// - name: username
31
31
// in: path
32
- // description: username of the user that will own the created organization
32
+ // description: username of the user who will own the created organization
33
33
// type: string
34
34
// required: true
35
35
// - name: organization
Original file line number Diff line number Diff line change @@ -22,7 +22,7 @@ func CreateRepo(ctx *context.APIContext) {
22
22
// parameters:
23
23
// - name: username
24
24
// in: path
25
- // description: username of the user. This user will own the created repository
25
+ // description: username of the user who will own the created repository
26
26
// type: string
27
27
// required: true
28
28
// - name: repository
Original file line number Diff line number Diff line change @@ -175,7 +175,7 @@ func EditUser(ctx *context.APIContext) {
175
175
// parameters:
176
176
// - name: username
177
177
// in: path
178
- // description: username of user to edit
178
+ // description: username of the user whose data is to be edited
179
179
// type: string
180
180
// required: true
181
181
// - name: body
@@ -272,7 +272,7 @@ func DeleteUser(ctx *context.APIContext) {
272
272
// parameters:
273
273
// - name: username
274
274
// in: path
275
- // description: username of user to delete
275
+ // description: username of the user to delete
276
276
// type: string
277
277
// required: true
278
278
// - name: purge
@@ -328,7 +328,7 @@ func CreatePublicKey(ctx *context.APIContext) {
328
328
// parameters:
329
329
// - name: username
330
330
// in: path
331
- // description: username of the user
331
+ // description: username of the user who is to receive a public key
332
332
// type: string
333
333
// required: true
334
334
// - name: key
@@ -358,7 +358,7 @@ func DeleteUserPublicKey(ctx *context.APIContext) {
358
358
// parameters:
359
359
// - name: username
360
360
// in: path
361
- // description: username of user
361
+ // description: username of the user whose public key is to be deleted
362
362
// type: string
363
363
// required: true
364
364
// - name: id
@@ -405,7 +405,7 @@ func SearchUsers(ctx *context.APIContext) {
405
405
// format: int64
406
406
// - name: login_name
407
407
// in: query
408
- // description: user's login name to search for
408
+ // description: identifier of the user, provided by the external authenticator
409
409
// type: string
410
410
// - name: page
411
411
// in: query
@@ -456,7 +456,7 @@ func RenameUser(ctx *context.APIContext) {
456
456
// parameters:
457
457
// - name: username
458
458
// in: path
459
- // description: existing username of user
459
+ // description: current username of the user
460
460
// type: string
461
461
// required: true
462
462
// - name: body
Original file line number Diff line number Diff line change @@ -22,7 +22,7 @@ func ListUserBadges(ctx *context.APIContext) {
22
22
// parameters:
23
23
// - name: username
24
24
// in: path
25
- // description: username of user
25
+ // description: username of the user whose badges are to be listed
26
26
// type: string
27
27
// required: true
28
28
// responses:
@@ -53,7 +53,7 @@ func AddUserBadges(ctx *context.APIContext) {
53
53
// parameters:
54
54
// - name: username
55
55
// in: path
56
- // description: username of user
56
+ // description: username of the user to whom a badge is to be added
57
57
// type: string
58
58
// required: true
59
59
// - name: body
@@ -87,7 +87,7 @@ func DeleteUserBadges(ctx *context.APIContext) {
87
87
// parameters:
88
88
// - name: username
89
89
// in: path
90
- // description: username of user
90
+ // description: username of the user whose badge is to be deleted
91
91
// type: string
92
92
// required: true
93
93
// - name: body
You can’t perform that action at this time.
0 commit comments