> ## Documentation Index
> Fetch the complete documentation index at: https://docs.patch.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Check now: pick up the repository's latest release if it's new



## OpenAPI

````yaml /api-reference/openapi.json post /projects/{owner}/{slug}/github/check
openapi: 3.1.0
info:
  title: Patch API
  version: 1.0.0
  description: >-
    The public API behind patch.gg, the desktop app and pch. Changes within v1
    are additive only. Errors are { error: { code, message, details } }; branch
    on code.
servers:
  - url: https://patch.gg/api/v1
security: []
paths:
  /projects/{owner}/{slug}/github/check:
    post:
      tags:
        - Releases
      summary: 'Check now: pick up the repository''s latest release if it''s new'
      parameters:
        - schema:
            type: string
            example: patch
          required: true
          name: owner
          in: path
        - schema:
            type: string
            example: demo-mod
          required: true
          name: slug
          in: path
      responses:
        '200':
          description: What the check found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubCheck'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Not signed in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    GithubCheck:
      type: object
      properties:
        status:
          type: string
          enum:
            - released
            - up_to_date
            - waiting
            - skipped
            - failed
          description: >-
            released: a new release went to review. up_to_date: nothing new.
            waiting: the repository has no release yet. failed: see note.
        note:
          type: string
        version:
          type: string
          description: The new release's version
        follow:
          $ref: '#/components/schemas/GithubFollow'
      required:
        - status
        - note
        - follow
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: version_exists
            message:
              type: string
            details: {}
          required:
            - code
            - message
      required:
        - error
    GithubFollow:
      type: object
      properties:
        repository:
          type: string
          example: https://github.com/mira/lantern-run
        files:
          type:
            - array
            - 'null'
          items:
            type: string
          description: >-
            The release files players get, by name with the version left out
            ("LanternRun_v*.zip"); null takes them all.
        unpack:
          type: boolean
          description: 'A browser game: its release''s zip is unpacked'
        released_tag:
          type:
            - string
            - 'null'
          description: >-
            The GitHub release the newest Patch release came from; null when it
            came from the default branch
        checked_at:
          type:
            - string
            - 'null'
        note:
          type:
            - string
            - 'null'
          description: What the last check found
      required:
        - repository
        - files
        - unpack
        - released_tag
        - checked_at
        - note
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key (pch_...) or the token from pch login.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.