Offer a branch to this repo

curl --request POST \
  --url https://patch.gg/api/v1/projects/{owner}/{slug}/change-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "port-26.5",
  "title": "<string>",
  "from": "kai/sky-mod",
  "into": "main",
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    branch: 'port-26.5',
    title: '<string>',
    from: 'kai/sky-mod',
    into: 'main',
    description: '<string>'
  })
};

fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/change-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://patch.gg/api/v1/projects/{owner}/{slug}/change-requests"

payload = {
    "branch": "port-26.5",
    "title": "<string>",
    "from": "kai/sky-mod",
    "into": "main",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "number": 12,
  "title": "Port to 26.5",
  "description": "<string>",
  "state": "open",
  "from": "kai/sky-mod",
  "branch": "port-26.5",
  "into": "26.5",
  "head_commit": "<string>",
  "problems": [
    "<string>"
  ],
  "author": "kai",
  "talk_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "closed_by": "<string>",
  "merge_commit": "<string>"
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Change requests

Offer a branch to this repo

Opens a change request from branch of from into into, this repo’s default branch unless you say. from is a fork of this repo, or a fork of one of its forks, and you’re in its org. The branch’s commits are first copied into this repo, on a hidden branch a clone doesn’t see, and read as they’re copied. git fetch <clone_url> <head_commit> gets them while it’s open. Only open repos take change requests from forks, unless their owner turned them off. The fork has to be open too, since its commits become readable here.

The repo’s own org can offer one of its branches into another, so a change is looked at before it lands: leave from out, or name this repo. That works whatever the repo’s visibility, and whether or not it takes change requests from forks, since its commits are already in it. The branch has to be there and not be into (422 same_branch). Anyone in the org can merge it, whoever opened it withdraws it, and the rest of the org declines it.

A repo whose home is GitHub takes none: its changes are pull requests on GitHub (403 change_requests_off, with that page in details.pull_requests). Needs the publish scope.

POST

projects

{owner}

{slug}

change-requests

Offer a branch to this repo

curl --request POST \
  --url https://patch.gg/api/v1/projects/{owner}/{slug}/change-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "port-26.5",
  "title": "<string>",
  "from": "kai/sky-mod",
  "into": "main",
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    branch: 'port-26.5',
    title: '<string>',
    from: 'kai/sky-mod',
    into: 'main',
    description: '<string>'
  })
};

fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/change-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://patch.gg/api/v1/projects/{owner}/{slug}/change-requests"

payload = {
    "branch": "port-26.5",
    "title": "<string>",
    "from": "kai/sky-mod",
    "into": "main",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "number": 12,
  "title": "Port to 26.5",
  "description": "<string>",
  "state": "open",
  "from": "kai/sky-mod",
  "branch": "port-26.5",
  "into": "26.5",
  "head_commit": "<string>",
  "problems": [
    "<string>"
  ],
  "author": "kai",
  "talk_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "closed_by": "<string>",
  "merge_commit": "<string>"
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "version_exists",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

An API key (pch_...) or the token from pch login.

Path Parameters

owner

string

required

Example:

"patch"

slug

string

required

Example:

"demo-mod"

Body

application/json

branch

string

required

The branch it offers, in from

Pattern: ^(?![-/])(?!.*\.\.)[\w.\-/]{1,200}$

Example:

"port-26.5"

title

string

required

Required string length: 1 - 200

from

string

The fork, as owner/slug. Leave it out, or name this repo, to offer one of this repo's own branches, as its org.

Pattern: ^[^/\s]+\/[^/\s]+$

Example:

"kai/sky-mod"

into

string

The branch it would change here; the default branch unless you say

Pattern: ^(?![-/])(?!.*\.\.)[\w.\-/]{1,200}$

Example:

"main"

description

string

Maximum string length: 20000

Response

Opened

number

integer

required

Example:

12

title

string

required

Example:

"Port to 26.5"

description

string

required

state

enum<string>

required

open: waiting on the repo's owner. merged: its commits are in the branch it was for. declined: the owner turned it down. withdrawn: its author took it back.

Available options:

open,

merged,

declined,

withdrawn

from

string | null

required

The repo its branch is in, as owner/slug: the fork it comes from, or this repo itself for one of its own branches. Null if you can't reach the fork.

Example:

"kai/sky-mod"

branch

string

required

The branch it offers, in from

Example:

"port-26.5"

into

string

required

The branch it would change in this repo

Example:

"26.5"

head_commit

string

required

Its latest commit, as copied into this repo, where a clone doesn't see it: git fetch <clone_url> <head_commit> gets its commits while it's open.

problems

string[]

required

What stopped the latest push to its branch being copied, which stays out of the request until it's fixed: a refusal, a fork that isn't open, which copies when it opens, or a copy that failed, which a new push tries again. Empty says nothing has stopped one, and a copy may still be on its way.

author

string | null

required

Who opened it: their username

Example:

"kai"

talk_count

integer

required

Posts in its talk

created_at

string<date-time>

required

updated_at

string<date-time>

required

closed_at

string<date-time> | null

required

closed_by

string | null

required

Who merged, declined or withdrew it: their username

merge_commit

string | null

required

The commit its branch was at after the merge.

Overview

Endpoints

Offer a branch to this repo

Authorizations

Path Parameters

Body

Response