Branches

Get merge preview

Previews the result of merging a branch into main, including any conflicts.

get/api/projects/{projectId}/branches/{branchId}/merge-preview

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-preview/get.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

Merge preview result

canMergeboolean required

Whether the branch can be merged without conflicts

isUpToDateboolean required

Whether the branch is up to date with main

needsRebaseboolean required

Whether the branch needs to be rebased

messagestring required

Human-readable merge status message

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