Create A Merge Proposal

Record a request to merge a source branch into a target branch. Anyone with edit access can open one; merging it later is gated on write access to the target branch, so this is how a change reaches a protected branch the author cannot merge into themselves.

パスパラメータ

agent_idstring必須
The id of an agent. This is returned on agent creation.

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
source_branch_idstring必須
Branch whose changes should be merged.
target_branch_idstring必須
Branch that should receive the changes.
titlestring必須1-140 characters

Short title for the merge_proposal.

descriptionstringオプション<=4096 charactersデフォルト値
Optional longer description for reviewers.
requested_reviewer_user_idslist of stringsオプション
User IDs to request a review from.
triage_ticket_idstringオプション

Triage ticket of this agent that the merge_proposal resolves. Merging it resolves the ticket if still open.

レスポンス

Successful Response
created_merge_proposal_idstring

ID of the created merge_proposal

エラー

422
Merge Proposals Create Request Unprocessable Entity Error