Mark a branch an experiment, or land it when ready

PUT

/api/orgs/{org}/projects/{project}/branches/state

curl --request PUT \
  --url https://api.wrktr.com/api/orgs/example/projects/example/branches/state \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "example", "experiment": true, "autoLand": true }'

Each field given is changed; the others are left as they are. autoLand lands the branch (as the caller) once checks, the review and threads allow it.

Authorizations

• bearer

Parameters

Path Parameters

org

required

string

project

required

string

Request Body^required

Media typeapplication/json

object

branch

required

string

experiment

Any of:

boolean

boolean

null

null

autoLand

Any of:

boolean

boolean

null

null

Example^generated

{
  "branch": "example",
  "experiment": true,
  "autoLand": true
}

Responses

200

BranchState

Media typeapplication/json

object

branch

required

string

experiment

required

boolean

autoLand

required

Any of:

object

object

by

required

string

since

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

waiting

required

Any of:

string

string

null

null

null

null

overlaps

required

Array<object>

object

branch

required

string

paths

required

Array<string>

landing

required

Any of:

object

object

sha

required

string

branch

required

Any of:

string

string

null

null

title

required

string

landedBy

required

string

landedAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

Example

{
  "autoLand": {
    "since": "Infinity"
  },
  "landing": {
    "landedAt": "Infinity"
  }
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

object

object

_tag

required

string

Allowed values: BranchNotFound

project

required

string

branch

required

string

Example

{
  "_tag": "ProjectNotFound"
}