Erste SchritteAgentsMerge proposals

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.

Pfadparameter

agent_idstringErforderlich
The id of an agent. This is returned on agent creation.

Header

xi-api-keystringOptional

Anfrage

This endpoint expects an object.
source_branch_idstringErforderlich
Branch whose changes should be merged.
target_branch_idstringErforderlich
Branch that should receive the changes.
titlestringErforderlich1-140 characters

Short title for the merge_proposal.

descriptionstringOptional<=4096 charactersStandardwert ist
Optional longer description for reviewers.
requested_reviewer_user_idslist of stringsOptional
User IDs to request a review from.
triage_ticket_idstringOptional

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

Antwort

Successful Response
created_merge_proposal_idstring

ID of the created merge_proposal

Fehler

422
Merge Proposals Create Request Unprocessable Entity Error