Skip to content
localisyncDocs
Open panel

Apply a reviewed comparison

Owner/Admin; active target and parents required. Every conflict and integrity issue must be resolved. Snapshot freshness and permissions are rechecked under ordered locks. Content, history, graph edges, audit and success commit atomically. Retries never apply twice.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branch-comparisons/{id}/apply

Operation: mergeBranches · Download OpenAPI

This operation does not use the panel session as its authentication mechanism. Follow the operation-specific checks described above.

session

{
"type": "apiKey",
"in": "cookie",
"name": "__Host-localisync-session"
}
Name Location Required Description
workspaceId path Yes See constraints below.
projectId path Yes See constraints below.
id path Yes See constraints below.
Origin header Yes See constraints below.
X-CSRF-Token header Yes See constraints below.
Idempotency-Key header Yes See constraints below.
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uri"
}
{
"type": "string"
}
{
"type": "string",
"format": "uuid"
}

Required: Yes.

Schema reference: Version.

Field Type Required Constraints / description
version integer Yes minimum: 1; maximum: 2147483646
{
"$ref": "#/components/schemas/Version"
}

Operation queued; poll its state.

Response headers:

{
"Cache-Control": {
"schema": {
"type": "string",
"const": "no-store"
}
}
}

Content type: application/json Schema reference: BranchJob.

Field Type Required Constraints / description
id string Yes format: "uuid"
workspaceId string Yes format: "uuid"
projectId string Yes format: "uuid"
kind fork, compare, merge, delete Yes —
state queued, processing, ready, completed, failed, conflict, cancelled, expired Yes —
version integer Yes minimum: 1; maximum: 2147483646
summary object Yes —
resultBranchId See schema Yes —
appliedJobId See schema Yes —
errorCode See schema Yes —
createdAt string Yes format: "date-time"
expiresAt string Yes format: "date-time"
sourceBranchId See schema Yes —
targetBranchId See schema Yes —
actorId string Yes format: "uuid"
{
"$ref": "#/components/schemas/BranchJob"
}

Invalid request.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No —
{
"$ref": "#/components/schemas/Error"
}

Sign in required.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No —
{
"$ref": "#/components/schemas/Error"
}

Insufficient current workspace role.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No —
{
"$ref": "#/components/schemas/Error"
}

Resource unavailable in this scope.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No —
{
"$ref": "#/components/schemas/Error"
}

Version conflict, stale preview or content invariant.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No —
{
"$ref": "#/components/schemas/Error"
}

Request limit exceeded.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No —
{
"$ref": "#/components/schemas/Error"
}

Service unavailable; success is not implied.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No —
{
"$ref": "#/components/schemas/Error"
}

Request errors and safe retries · Troubleshooting

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.