gitpublish module route (requires gitpublish:merge:admin)

POST

/v1/m/gitpublish/targets/{id}/merges

curl --request POST \
  --url https://example.com/v1/m/gitpublish/targets/example/merges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "acknowledge_intent": "example", "expected_base": "example", "expected_head": "example", "expected_result_tree": "example", "method": "merge", "number": 1, "operation_id": "example" }'

• this engine

Merges one pull request only while its head is still the reviewed expected_head, and returns the publication intent with the merge commit and tree it recorded.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

id

required

string

Path parameter id.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

The handler decodes one strict JSON document, bounded at 1 MiB; an unknown field is field_not_accepted.

Media type application/json

object

acknowledge_intent

string

expected_base

Unsupported: refused with unsupported_requirement.

string

expected_head

required

The reviewed source head; the host refuses the merge if the head differs.

string

/^[0-9a-f]{40}([0-9a-f]{24})?$/

expected_result_tree

Unsupported: refused with unsupported_requirement.

string

method

required

Rebase is refused as unsupported_requirement on a GitLab target.

string

Allowed values: merge squash rebase

number

required

integer

>= 1

operation_id

required

Client idempotency key.

string

/^[A-Za-z0-9._:-]{1,128}$/

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}