Publish a release: upload to live in one flow

curl --request POST \
  --url https://patch.gg/api/v1/projects/{owner}/{slug}/releases/{version}/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "test_again": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({test_again: true})
};

fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/releases/{version}/publish', 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}/releases/{version}/publish"

payload = { "test_again": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "project": "<string>",
  "version": "<string>",
  "stage": "uploading",
  "line": "Testing on your PC",
  "next": "<string>",
  "code": "<string>",
  "status": "draft",
  "needs_person": {
    "code": "open_patch_desktop",
    "why": "<string>",
    "ask": "<string>",
    "link": "<string>"
  },
  "test_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "footage": [
    {
      "run": 123,
      "index": 123,
      "kind": "frames",
      "from": "<string>",
      "to": "<string>",
      "frames": [
        "<string>"
      ],
      "sha256": "<string>",
      "url": "<string>",
      "expires_at": "<string>"
    }
  ],
  "findings": [
    {
      "rule_id": "PA-130",
      "severity": "blocking",
      "path": "<string>",
      "message": "<string>",
      "suggestion": "<string>",
      "url": "<string>"
    }
  ],
  "urls": {
    "page": "<string>",
    "play": "<string>",
    "game": "<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>"
  }
}

Review

Publish a release: upload to live in one flow

Takes a release from its upload to live, one step a call. It checks the files and starts the test on the person’s PC, holds while Patch Desktop plays it (wait, up to 50 seconds), and once it’s recorded answers your_review with the footage: send review to this route and, if it passes, it’s submitted at once and followed through Patch’s review. Call it again until stage is live, or it stops and says why. Calling it is the person’s yes: call it when they want it out. In a Patch Desktop chat a game or mod stops at ready: the person’s press on the chat’s publish button sends it.

POST

projects

{owner}

{slug}

releases

{version}

publish

Publish a release: upload to live in one flow

curl --request POST \
  --url https://patch.gg/api/v1/projects/{owner}/{slug}/releases/{version}/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "test_again": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({test_again: true})
};

fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/releases/{version}/publish', 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}/releases/{version}/publish"

payload = { "test_again": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "project": "<string>",
  "version": "<string>",
  "stage": "uploading",
  "line": "Testing on your PC",
  "next": "<string>",
  "code": "<string>",
  "status": "draft",
  "needs_person": {
    "code": "open_patch_desktop",
    "why": "<string>",
    "ask": "<string>",
    "link": "<string>"
  },
  "test_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "footage": [
    {
      "run": 123,
      "index": 123,
      "kind": "frames",
      "from": "<string>",
      "to": "<string>",
      "frames": [
        "<string>"
      ],
      "sha256": "<string>",
      "url": "<string>",
      "expires_at": "<string>"
    }
  ],
  "findings": [
    {
      "rule_id": "PA-130",
      "severity": "blocking",
      "path": "<string>",
      "message": "<string>",
      "suggestion": "<string>",
      "url": "<string>"
    }
  ],
  "urls": {
    "page": "<string>",
    "play": "<string>",
    "game": "<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>"
  }
}

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"

version

string

required

Example:

"0.1.0"

Query Parameters

wait

integer | null

Seconds (up to 50) to wait for this to change while Patch is working on it. Answers at once when it's your turn or the person's.

Required range: 0 <= x <= 50

Body

application/json

review

object

Your review of the recorded test's footage, at your_review

Show child attributes

test_again

boolean

Start another test after one that couldn't run

Response

Where it is now

project

string

required

version

string

required

stage

enum<string>

required

uploading: files are missing. testing: Patch Desktop on the person's PC tests it. your_review: the test is recorded and footage has its sheets: look at every one and send review. in_review: Patch reviews it. ready: in a Patch Desktop chat, it passed and the person's press on the chat's publish button sends it. live. stopped: code and next say why and what to do

Available options:

uploading,

testing,

your_review,

in_review,

ready,

live,

stopped

line

string

required

One line to show the person: Uploading, Testing on your PC, In review or Live

Example:

"Testing on your PC"

string

required

What to do now, for the agent

code

string | null

required

Why it stopped: files_failed, test_failed, couldnt_run, rejected, repo_private or overtaken

status

enum<string>

required

draft, then checking (file checks). A browser game is testing until a test on its creator's PC passes, then cloud_review, then published. A mod goes to cloud_review, then in_review (a staff member), then published. Any step can end in rejected.

Available options:

draft,

checking,

testing,

cloud_review,

in_review,

published,

rejected,

yanked,

quarantined

needs_person

object | null

required

Something only the person can do. Ask them, then wait for their answer rather than asking Patch again.

Show child attributes

test_id

string<uuid> | null

required

footage

object[] | null

required

At your_review: every contact sheet of the test, in order

Show child attributes

findings

object[]

required

When stopped: what to fix

Show child attributes

urls

object

required

Where it is on Patch. On single-project responses, not in lists.

Show child attributes

Overview

Endpoints

Publish a release: upload to live in one flow

Authorizations

Path Parameters

Query Parameters

Body

Response