Merge a pull request

POST

/repos/{owner}/{repo}/pulls/{index}/merge

const url = 'https://gitea.com/api/v1/repos/example/example/pulls/1/merge';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"delete_branch_after_merge":true,"do":"merge","force_merge":true,"head_commit_id":"example","merge_commit_id":"example","merge_message_field":"example","merge_title_field":"example","merge_when_checks_succeed":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://gitea.com/api/v1/repos/example/example/pulls/1/merge \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "delete_branch_after_merge": true, "do": "merge", "force_merge": true, "head_commit_id": "example", "merge_commit_id": "example", "merge_message_field": "example", "merge_title_field": "example", "merge_when_checks_succeed": true }'

Authorizations

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

index

required

integer format: int64

Index of the pull request to merge

Request Body

application/json

MergePullRequestForm form for merging Pull Request

object

delete_branch_after_merge

boolean

required

string

Allowed values: merge rebase rebase-merge squash fast-forward-only manually-merged

force_merge

boolean

head_commit_id

string

merge_commit_id

string

merge_message_field

string

merge_title_field

string

merge_when_checks_succeed

boolean

Responses

200

APIEmpty is an empty response

application/json

403

APIForbiddenError is a forbidden error response

application/json

Headers

message

string

url

string

404

APINotFound is a not found empty response

application/json

405

APIEmpty is an empty response

application/json

409

APIError is error format response

application/json

Headers

message

string

url

string

423

APIRepoArchivedError is an error that is raised when an archived repo should be modified

application/json

Headers

message

string

url

string