mirror of
https://github.com/go-gitea/gitea.git
synced 2025-07-22 01:51:19 +02:00
Add a login
/login-name
/username
disambiguation to affected endpoint parameters and response/request models (#34901)
Issue: [link](https://github.com/go-gitea/gitea/issues/9637) Changes introduced: I have clarified the problematic terms (`login`, `login_name`, and `username`) in all affected endpoints. The changes were made to relevant: - HTTP endpoint parameters' descriptions - response/request models' fields
This commit is contained in:
@@ -29,7 +29,7 @@ func CreateOrg(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user that will own the created organization
|
||||
// description: username of the user who will own the created organization
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: organization
|
||||
|
@@ -22,7 +22,7 @@ func CreateRepo(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user. This user will own the created repository
|
||||
// description: username of the user who will own the created repository
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repository
|
||||
|
@@ -175,7 +175,7 @@ func EditUser(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user to edit
|
||||
// description: username of the user whose data is to be edited
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: body
|
||||
@@ -272,7 +272,7 @@ func DeleteUser(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user to delete
|
||||
// description: username of the user to delete
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: purge
|
||||
@@ -328,7 +328,7 @@ func CreatePublicKey(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user
|
||||
// description: username of the user who is to receive a public key
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: key
|
||||
@@ -358,7 +358,7 @@ func DeleteUserPublicKey(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose public key is to be deleted
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: id
|
||||
@@ -405,7 +405,7 @@ func SearchUsers(ctx *context.APIContext) {
|
||||
// format: int64
|
||||
// - name: login_name
|
||||
// in: query
|
||||
// description: user's login name to search for
|
||||
// description: identifier of the user, provided by the external authenticator
|
||||
// type: string
|
||||
// - name: page
|
||||
// in: query
|
||||
@@ -456,7 +456,7 @@ func RenameUser(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: existing username of user
|
||||
// description: current username of the user
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: body
|
||||
|
@@ -22,7 +22,7 @@ func ListUserBadges(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose badges are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -53,7 +53,7 @@ func AddUserBadges(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user to whom a badge is to be added
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: body
|
||||
@@ -87,7 +87,7 @@ func DeleteUserBadges(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose badge is to be deleted
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: body
|
||||
|
@@ -47,7 +47,7 @@ func CheckUserBlock(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: user to check
|
||||
// description: username of the user to check
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -71,7 +71,7 @@ func BlockUser(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: user to block
|
||||
// description: username of the user to block
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: note
|
||||
@@ -101,7 +101,7 @@ func UnblockUser(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: user to unblock
|
||||
// description: username of the user to unblock
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -133,7 +133,7 @@ func IsMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user
|
||||
// description: username of the user to check for an organization membership
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -186,7 +186,7 @@ func IsPublicMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user
|
||||
// description: username of the user to check for a public organization membership
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -240,7 +240,7 @@ func PublicizeMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user
|
||||
// description: username of the user whose membership is to be publicized
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -282,7 +282,7 @@ func ConcealMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user
|
||||
// description: username of the user whose membership is to be concealed
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -324,7 +324,7 @@ func DeleteMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user
|
||||
// description: username of the user to remove from the organization
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -82,7 +82,7 @@ func ListUserOrgs(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose organizations are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: page
|
||||
@@ -112,7 +112,7 @@ func GetUserOrgsPermissions(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose permissions are to be obtained
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: org
|
||||
|
@@ -426,7 +426,7 @@ func GetTeamMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the member to list
|
||||
// description: username of the user whose data is to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -467,7 +467,7 @@ func AddTeamMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user to add
|
||||
// description: username of the user to add to a team
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -509,7 +509,7 @@ func RemoveTeamMember(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of the user to remove
|
||||
// description: username of the user to remove from a team
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -93,7 +93,7 @@ func IsCollaborator(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: collaborator
|
||||
// in: path
|
||||
// description: username of the collaborator
|
||||
// description: username of the user to check for being a collaborator
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -145,7 +145,7 @@ func AddOrUpdateCollaborator(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: collaborator
|
||||
// in: path
|
||||
// description: username of the collaborator to add
|
||||
// description: username of the user to add or update as a collaborator
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: body
|
||||
@@ -264,7 +264,7 @@ func GetRepoPermissions(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: collaborator
|
||||
// in: path
|
||||
// description: username of the collaborator
|
||||
// description: username of the collaborator whose permissions are to be obtained
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -43,7 +43,7 @@ func AddIssueSubscription(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: user
|
||||
// in: path
|
||||
// description: user to subscribe
|
||||
// description: username of the user to subscribe the issue to
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -87,7 +87,7 @@ func DelIssueSubscription(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: user
|
||||
// in: path
|
||||
// description: user witch unsubscribe
|
||||
// description: username of the user to unsubscribe from an issue
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -405,7 +405,7 @@ func ListTrackedTimesByUser(ctx *context.APIContext) {
|
||||
// required: true
|
||||
// - name: user
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose tracked times are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -30,7 +30,7 @@ func ListAccessTokens(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of to user whose access tokens are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: page
|
||||
@@ -83,7 +83,7 @@ func CreateAccessToken(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose token is to be created
|
||||
// required: true
|
||||
// type: string
|
||||
// - name: body
|
||||
@@ -149,7 +149,7 @@ func DeleteAccessToken(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose token is to be deleted
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: token
|
||||
|
@@ -37,7 +37,7 @@ func CheckUserBlock(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: user to check
|
||||
// description: username of the user to check
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -56,7 +56,7 @@ func BlockUser(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: user to block
|
||||
// description: username of the user to block
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: note
|
||||
@@ -81,7 +81,7 @@ func UnblockUser(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: user to unblock
|
||||
// description: username of the user to unblock
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -67,7 +67,7 @@ func ListFollowers(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose followers are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: page
|
||||
@@ -131,7 +131,7 @@ func ListFollowing(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose followed users are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: page
|
||||
@@ -167,7 +167,7 @@ func CheckMyFollowing(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of followed user
|
||||
// description: username of the user to check for authenticated followers
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -187,12 +187,12 @@ func CheckFollowing(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of following user
|
||||
// description: username of the following user
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: target
|
||||
// in: path
|
||||
// description: username of followed user
|
||||
// description: username of the followed user
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -216,7 +216,7 @@ func Follow(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user to follow
|
||||
// description: username of the user to follow
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -246,7 +246,7 @@ func Unfollow(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user to unfollow
|
||||
// description: username of the user to unfollow
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
|
@@ -53,7 +53,7 @@ func ListGPGKeys(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose GPG key list is to be obtained
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: page
|
||||
|
@@ -136,7 +136,7 @@ func ListPublicKeys(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose public keys are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: fingerprint
|
||||
|
@@ -62,7 +62,7 @@ func ListUserRepos(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose owned repos are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: page
|
||||
|
@@ -50,7 +50,7 @@ func GetStarredRepos(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose starred repos are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: page
|
||||
|
@@ -110,7 +110,7 @@ func GetInfo(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user to get
|
||||
// description: username of the user whose data is to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -151,7 +151,7 @@ func GetUserHeatmapData(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user to get
|
||||
// description: username of the user whose heatmap is to be obtained
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
@@ -177,7 +177,7 @@ func ListUserActivityFeeds(ctx *context.APIContext) {
|
||||
// parameters:
|
||||
// - name: username
|
||||
// in: path
|
||||
// description: username of user
|
||||
// description: username of the user whose activity feeds are to be listed
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: only-performed-by
|
||||
|
@@ -49,7 +49,7 @@ func GetWatchedRepos(ctx *context.APIContext) {
|
||||
// - name: username
|
||||
// type: string
|
||||
// in: path
|
||||
// description: username of the user
|
||||
// description: username of the user whose watched repos are to be listed
|
||||
// required: true
|
||||
// - name: page
|
||||
// in: query
|
||||
|
Reference in New Issue
Block a user