gitHubUpdateCheckerRequest.schema.json

{
    "$id": "https://github.com/gusztavj/GitHub-Update-Checker/blob/main/gitHubUpdateCheckerRequest.schema.json",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "GitHub Update Checker Request Schema",
    "description": "This JSON schema describes how the JSON body of your POST requests submitted to the /getUpdateInfo shall look like.",
    "type": "object",
    
    "properties": {

      "appInfo": {

        "type": "object",
        "description": "Information of the application for which to check updates.",
        "required": ["properties", "currentVersion"],

        "properties": {

          "repoSlug": {

            "description": "The slug of the repository form pattern of https://github.com/<username>/<repoSlug>/. Only valid format accepted.",
            "type": "string",
            "pattern": "^/?[\\w\\d_][\\w\\d\\-_]*(/[\\w\\d\\-_]+)*/?$"
          },

          "currentVersion": {

            "description": "The current version of the application identified by repoSlug.",
            "type": "string",
            "pattern": "\\d+\\.\\d+\\.\\d+(\\-.*)?"
          }
        }        
      },      

      "forceUpdateCheck": {

        "description": "Force the update against GitHub or it is okay to be served from the cache. May be ignored by the server for security and performance considerations.",
        "type": "boolean"
      }
    }
  }