curl --request POST \
--url https://patch.gg/api/v1/projects/{owner}/{slug}/fork \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": "<string>",
"slug": "<string>",
"name": "<string>",
"private": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({owner: '<string>', slug: '<string>', name: '<string>', private: true})
};
fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/fork', 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}/fork"
payload = {
"owner": "<string>",
"slug": "<string>",
"name": "<string>",
"private": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"name": "<string>",
"summary": "<string>",
"code_license": "MIT",
"art_license": "MIT",
"clone_url": "https://git.patch.gg/patch/demo-mod.git",
"visibility": "open",
"opening": {
"status": "scanning",
"says": "<string>",
"found": [
{
"kind": "an AWS access key",
"path": "<string>",
"line": 2,
"commit": "<string>"
}
],
"was_open": true
},
"can_read_source": true,
"default_branch": "main",
"created_at": "2023-11-07T05:31:56Z",
"head_commit": "<string>",
"pushed_at": "2023-11-07T05:31:56Z",
"forked_from": "patch/demo-mod",
"fork_count": 123,
"clone_count": 123,
"training_opt_out": true,
"change_requests": true,
"open_change_requests": 123,
"last_commit": {
"id": "<string>",
"subject": "<string>",
"author": "<string>",
"committed_at": "2023-11-07T05:31:56Z"
},
"readme": {
"path": "README.md",
"text": "<string>"
},
"readme_pictures": [
{
"url": "<string>",
"levels": [
{
"width": 123,
"url": "<string>"
}
],
"fit": "cover"
}
],
"visibility_chosen_at": "<string>",
"home": "patch",
"github": {
"full_name": "sam/sky-mod",
"html_url": "https://github.com/sam/sky-mod",
"private": true,
"default_branch": "main",
"head_commit": "<string>",
"pushed_at": "2023-11-07T05:31:56Z",
"state": "connected"
}
}{
"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>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}Fork a project's repo into a new project
Copies the repo’s default branch into a new project of owner’s (an org you’re in), which records this one as its parent, starts at its head with its README, and holds the big files its history names. It brings only what that commit reaches, so no other branch, no tag and no commit the repo has dropped, and it answers once it’s all there, a few seconds at most. A repo with more than 100 MB of packed git history, or that takes more than the 4.5 minutes a fork has, answers 422 too_big, with nothing made: clone it and pch push it to a new repo instead. Big files in Git LFS don’t count towards that. A client can give up on a long fork, which goes on without it: asking again answers that fork once it’s there, and 503 fork_in_progress until then. The slug and name default to this project’s. A fork starts no more open than the repo it copies, and only its own org can fork a closed source or private repo (403 source_closed for someone else, and 404 for a private one). An org at the most repos it can have gets 403 repo_limit_reached, and a repo staff took down is 403 for its own org too. Needs the publish scope. A repo whose home is GitHub is copied from GitHub when it’s forked, with its history, and only while it’s open (409 fork_on_github), public on GitHub (422 needs_public) and with a licence GitHub can find in it (422 needs_license). GitHub is asked as it’s forked, so one that went private there, or lost its licence, stops being open, and the fork takes the licence GitHub reads then for its code and its art. When Patch reads the repo again meanwhile, GitHub is asked once more, and a second time answers 409 github_changed. One too big for Patch (422 too_big), or with big files in Git LFS on GitHub (422 big_files_on_github), can’t be forked here: fork it on GitHub.
curl --request POST \
--url https://patch.gg/api/v1/projects/{owner}/{slug}/fork \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": "<string>",
"slug": "<string>",
"name": "<string>",
"private": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({owner: '<string>', slug: '<string>', name: '<string>', private: true})
};
fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/fork', 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}/fork"
payload = {
"owner": "<string>",
"slug": "<string>",
"name": "<string>",
"private": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"name": "<string>",
"summary": "<string>",
"code_license": "MIT",
"art_license": "MIT",
"clone_url": "https://git.patch.gg/patch/demo-mod.git",
"visibility": "open",
"opening": {
"status": "scanning",
"says": "<string>",
"found": [
{
"kind": "an AWS access key",
"path": "<string>",
"line": 2,
"commit": "<string>"
}
],
"was_open": true
},
"can_read_source": true,
"default_branch": "main",
"created_at": "2023-11-07T05:31:56Z",
"head_commit": "<string>",
"pushed_at": "2023-11-07T05:31:56Z",
"forked_from": "patch/demo-mod",
"fork_count": 123,
"clone_count": 123,
"training_opt_out": true,
"change_requests": true,
"open_change_requests": 123,
"last_commit": {
"id": "<string>",
"subject": "<string>",
"author": "<string>",
"committed_at": "2023-11-07T05:31:56Z"
},
"readme": {
"path": "README.md",
"text": "<string>"
},
"readme_pictures": [
{
"url": "<string>",
"levels": [
{
"width": 123,
"url": "<string>"
}
],
"fit": "cover"
}
],
"visibility_chosen_at": "<string>",
"home": "patch",
"github": {
"full_name": "sam/sky-mod",
"html_url": "https://github.com/sam/sky-mod",
"private": true,
"default_branch": "main",
"head_commit": "<string>",
"pushed_at": "2023-11-07T05:31:56Z",
"state": "connected"
}
}{
"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>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}Authorizations
An API key (pch_...) or the token from pch login.
Body
The org the fork goes to
1 - 1001 - 641 - 100Starts it private, so it's never open. Without it, a fork is as open as the repo it copies, unless it's made from a Patch Desktop chat, which starts it private
Response
The fork's repo
License of the code
64^[A-Za-z0-9][A-Za-z0-9.+-]*$"MIT"
License of original art and other assets
64^[A-Za-z0-9][A-Za-z0-9.+-]*$"MIT"
"https://git.patch.gg/patch/demo-mod.git"
Who can reach the project's repo. open: anyone can find it, read it and fork it. closed_source: anyone can find and play what it releases; only its org reads the source. private: only its org can find it, and anyone else gets a 404. It isn't locked: the game host serves a published browser game to anyone who has its address.
open, closed_source, private For the repo's org. A repo that was open when its first push landed stays closed source until a scan of its history is clean, and then opens by itself, and so does an open repo that a later push closed by bringing a secret, or something Patch couldn't read. This says where that's got to. Null for anyone else, and for a repo that isn't waiting.
Show child attributes
Show child attributes
Whether you can read its source. When false, as for someone outside a closed source repo's org, head_commit, last_commit and readme are null, and its file, tree and commit reads answer 403 source_closed.
"main"
When the repo was made; null until its first push.
The default branch's latest commit, as of the last push.
The repo it was forked from, as owner/slug.
"patch/demo-mod"
Its forks anyone can see: open ones with a repo, each once it has a public release. Until then a fork is quiet, and nothing counts it.
Fresh clones by people outside its org, each cloner counted once a day, as the git host saw them.
When true, Patch doesn't train its own models on this project.
The owner's switch for change requests. Only open repos take them, so it does nothing while the repo isn't open.
How many change requests are open, for whoever can read its source: 0 for anyone else.
The default branch's latest commit, as read after the push that moved it.
Show child attributes
Show child attributes
The README at the top of the default branch, its first 128 KB; null when there's none.
Show child attributes
Show child attributes
The pictures in a library repo's README, which Patch holds copies of, so a page can show them at their levels. Empty for any other repo, and for anyone who can't read its source.
Show child attributes
Show child attributes
When someone last set visibility on purpose, for its org: what to send back with a change that depends on nobody having done that since
Where its repo lives, where connecting GitHub is on (and only there): patch, or github once a GitHub repo is connected to it, whose files and commits stay on GitHub. clone_url is the same either way.
patch, github The GitHub repo that's its home, with home. Null on Patch, and for someone outside the project's org when the repo is private on GitHub.
Show child attributes
Show child attributes