Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inclusion of rename organization api #33303

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

bsofiato
Copy link
Contributor

This adds an endpoint (/orgs/{org}/rename) to rename organizations.

I've modeled the endpoint using the rename user endpoint -- /admin/users/{username}/rename -- as base.

It is the 1st time I wrote a new API endpoint (I've tried to follow the rename users endpoint code while writing it). So feel free to ping me if there is something wrong or missing.

Resolves #32995

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jan 16, 2025
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 16, 2025
@github-actions github-actions bot added modifies/api This PR adds API routes or modifies them modifies/go Pull requests that update Go code labels Jan 16, 2025
@bsofiato bsofiato force-pushed the feature/rename-org-api branch from b14c5e7 to ff24828 Compare January 16, 2025 15:01
@yp05327
Copy link
Contributor

yp05327 commented Jan 17, 2025

You can reference the implementation here:

if ctx.ContextUser.IsOrganization() {
ctx.Error(http.StatusUnprocessableEntity, "", fmt.Errorf("%s is an organization not a user", ctx.ContextUser.Name))
return
}
oldName := ctx.ContextUser.Name
newName := web.GetForm(ctx).(*api.RenameUserOption).NewName
// Check if user name has been changed
if err := user_service.RenameUser(ctx, ctx.ContextUser, newName); err != nil {
switch {
case user_model.IsErrUserAlreadyExist(err):
ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("form.username_been_taken"))
case db.IsErrNameReserved(err):
ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("user.form.name_reserved", newName))
case db.IsErrNamePatternNotAllowed(err):
ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("user.form.name_pattern_not_allowed", newName))
case db.IsErrNameCharsNotAllowed(err):
ctx.Error(http.StatusUnprocessableEntity, "", ctx.Tr("user.form.name_chars_not_allowed", newName))
default:
ctx.ServerError("ChangeUserName", err)
}
return
}
log.Trace("User name changed: %s -> %s", oldName, newName)
ctx.Status(http.StatusNoContent)
}

@lunny
Copy link
Member

lunny commented Jan 17, 2025

It's better to have a test.

@bsofiato
Copy link
Contributor Author

It's better to have a test.

Hey @lunny, I've written a integration test to check for the new api :)

@bsofiato bsofiato requested a review from yp05327 January 29, 2025 13:43
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 30, 2025
@lunny lunny added the type/enhancement An improvement of existing functionality label Jan 30, 2025
@lunny lunny added this to the 1.24.0 milestone Jan 30, 2025
ctx.ServerError("RenameOrg", err)
}
} else {
log.Trace("Org name changed: %s -> %s", oldName, form.NewName)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that may as well be an Info, that is rather important

Suggested change
log.Trace("Org name changed: %s -> %s", oldName, form.NewName)
log.Info("Org name changed: %s -> %s", oldName, form.NewName)

@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/api This PR adds API routes or modifies them modifies/go Pull requests that update Go code size/L Denotes a PR that changes 100-499 lines, ignoring generated files. type/enhancement An improvement of existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add organization renaming API
5 participants