Branches

Merge branch

Merges a branch into main, or creates a change request if approval is required.

post/api/projects/{projectId}/branches/{branchId}/merge

Request

The document declares no server URL.
Auth
- HTTP bearer
- or HTTP internal
TypeScript
https://skmtc.dev/gorules/apis/gorules-agent-api/docs/api/projects/:projectId/branches/:branchId/merge/post.ts
A function with typed inputs. Its response is checked against the schema.

projectIdstring uuid required

Project ID

string uuid required

'main' required

Branch ID or "main" for the default branch

messagestring required

Merge commit message

Merge result

successboolean required

Whether the operation was successful

requiresApprovalboolean required

Whether approval is required for the merge

changeRequestIdstring uuid

ID of created change request

mergeCommitIdstring uuid

ID of the merge commit

messagestring required

Human-readable result message

No recorded changes to this operation across all 1 revision of this API.