Branch

merge branches

Changed on

Used to merge a branch into another

post/branch/{workspace_id}/merge

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/branch/{workspace_id}/merge
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

workspace_idstring required

The ID of the workspace the branch is in

Query parameters

fromstring

The name of the branch to merge from

tostring

The name of the branch to merge to. Defaults to master

Request body

diff_matchstring

A hash of the sorted list of [<target_branch_entity_id>, <source_branch_entity_id>] pairs for the entities being merged (all branched entities, or just entity_ids when that is set). This is sorted in ascending order by the second entity ID in the pair.

tostring

The name of the branch to merge into. Defaults to master.

fromstring

The name of the branch to merge from

entity_idsstring[]

Optional. Invariant IDs of specific branched entities to merge. When present and non-empty, only these entities are merged into the target branch and removed from the source branch, which stays open. When absent or empty, the entire branch is merged and the source branch is marked merged (the default behavior).

fast_forward_onlyboolean

When true, an entity whose version on the target branch advanced past the branch point aborts the merge with a 409 rather than superseding that newer version. Defaults to false, which promotes the branch version as a new head on the target.

Response

The merged branch

idstring

Unique ID for this branch

branch_type'feature' | 'snapshot'

The type of branch

namestring

The name of the branch. Must be unique within workspace.

status'merged' | 'open' | 'snapshot'

The current status of the branch

application_idstring

The ID of the application associated with this branch

environment_idstring

Optional id of environment this branch is associated with, if any

branched_fromstring

The branch this branch was created from

workspace_idstring

Workspace this branch exists in

created_timeinteger

Time at which the deployment was created

created_by_idstring

The ID of the user who created this deployment

Changes