gitpublish module route (requires gitpublish:pull_request:write)

POST

/v1/m/gitpublish/targets/{id}/pull-requests

curl --request POST \
  --url https://example.com/v1/m/gitpublish/targets/example/pull-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "acknowledge_intent": "example", "base": "example", "body": "example", "commit": "example", "draft": true, "head_ref": "example", "operation_id": "example", "title": "example" }'

• this engine

Opens a pull request from a branch under the target’s push prefix into an allowed merge base, or adopts the matching open one, and returns the publication intent with its receipt.

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

base

required

An allowed merge base.

string

/^[A-Za-z0-9._/-]+$/

body

string

<= 65536 characters

commit

required

The requested head commit, recorded beside the observed one.

string

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

draft

boolean

head_ref

required

Source branch under push_prefix; the host binds branches, not SHAs.

string

/^[A-Za-z0-9._/-]+$/

operation_id

required

Client idempotency key.

string

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

title

required

string

<= 256 characters

Example ^generated

{
  "acknowledge_intent": "example",
  "base": "example",
  "body": "example",
  "commit": "example",
  "draft": true,
  "head_ref": "example",
  "operation_id": "example",
  "title": "example"
}

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

{}