Pierwsze krokiAgentsMerge 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.

Parametry ścieżki

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

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects an object.
source_branch_idstringWymagany
Branch whose changes should be merged.
target_branch_idstringWymagany
Branch that should receive the changes.
titlestringWymagany1-140 characters

Short title for the merge_proposal.

descriptionstringOpcjonalny<=4096 charactersDomyślnie
Optional longer description for reviewers.
requested_reviewer_user_idslist of stringsOpcjonalny
User IDs to request a review from.
triage_ticket_idstringOpcjonalny

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

Odpowiedź

Successful Response
created_merge_proposal_idstring

ID of the created merge_proposal

Błędy

422
Merge Proposals Create Request Unprocessable Entity Error