Skip to content

Commit

Permalink
- name: new parameter in CreateForkOption to give the forked repository
Browse files Browse the repository at this point in the history
  a custom name, intended to be used when there's a name conflict
- When a fork request results in a name conflict, HTTP 409: Conflict is
  returned instead of 500
- API documentation for the above mentioned changes

Signed-off-by: realaravinth <realaravinth@batsense.net>
  • Loading branch information
realaravinth committed Dec 22, 2021
1 parent 7821370 commit df520a9
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
2 changes: 2 additions & 0 deletions modules/structs/fork.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ package structs
type CreateForkOption struct {
// organization name, if forking into an organization
Organization *string `json:"organization"`
// name of the forked repository
Name *string `json:"name"`
}
17 changes: 15 additions & 2 deletions routers/api/v1/repo/fork.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ func CreateFork(ctx *context.APIContext) {
// "$ref": "#/responses/Repository"
// "403":
// "$ref": "#/responses/forbidden"
// "409":
// description: The repository with the same name already exists.
// "422":
// "$ref": "#/responses/validationError"

Expand Down Expand Up @@ -126,13 +128,24 @@ func CreateFork(ctx *context.APIContext) {
forker = org.AsUser()
}

var name string
if form.Name == nil {
name = repo.Name
} else {
name = *form.Name
}

fork, err := repo_service.ForkRepository(ctx.User, forker, repo_service.ForkRepoOptions{
BaseRepo: repo,
Name: repo.Name,
Name: name,
Description: repo.Description,
})
if err != nil {
ctx.Error(http.StatusInternalServerError, "ForkRepository", err)
if repo_model.IsErrRepoAlreadyExist(err) {
ctx.Error(http.StatusConflict, "ForkRepository", err)
} else {
ctx.Error(http.StatusInternalServerError, "ForkRepository", err)
}
return
}

Expand Down
8 changes: 8 additions & 0 deletions templates/swagger/v1_json.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -3503,6 +3503,9 @@
"403": {
"$ref": "#/responses/forbidden"
},
"409": {
"description": "The repository with the same name already exists."
},
"422": {
"$ref": "#/responses/validationError"
}
Expand Down Expand Up @@ -13292,6 +13295,11 @@
"description": "CreateForkOption options for creating a fork",
"type": "object",
"properties": {
"name": {
"description": "name of the forked repository",
"type": "string",
"x-go-name": "Name"
},
"organization": {
"description": "organization name, if forking into an organization",
"type": "string",
Expand Down

0 comments on commit df520a9

Please sign in to comment.