manifest.installer.1.1.0.json

{
  "$id": "https://aka.ms/winget-manifest.installer.1.1.0.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "A representation of a single-file manifest representing an app installers in the OWC. v1.1.0",
  "definitions": {
    "PackageIdentifier": {
      "type": "string",
      "pattern": "^[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}(\\.[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}){1,3}$",
      "maxLength": 128,
      "description": "The package unique identifier"
    },
    "PackageVersion": {
      "type": "string",
      "pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$",
      "maxLength": 128,
      "description": "The package version"
    },
    "Locale": {
      "type": [ "string", "null" ],
      "minLength": 1,
      "maxLength": 20,
      "description": "The package meta-data locale"
    },
    "Channel": {
      "type": [ "string", "null" ],
      "minLength": 1,
      "maxLength": 16,
      "description": "The distribution channel"
    },
    "Platform": {
      "type": [ "array", "null" ],
      "items": {
        "title": "Platform",
        "type": "string",
        "enum": [
          "Windows.Desktop",
          "Windows.Universal"
        ]
      },
      "maxItems": 2,
      "uniqueItems": true,
      "description": "The installer supported operating system"
    },
    "MinimumOSVersion": {
      "type": [ "string", "null" ],
      "pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){0,3}$",
      "description": "The installer minimum operating system version"
    },
    "InstallerType": {
      "type": [ "string", "null" ],
      "enum": [
        "msix",
        "msi",
        "appx",
        "exe",
        "zip",
        "inno",
        "nullsoft",
        "wix",
        "burn",
        "pwa"
      ],
      "description": "Enumeration of supported installer types. InstallerType is required in either root level or individual Installer level"
    },
    "Scope": {
      "type": [ "string", "null" ],
      "enum": [
        "user",
        "machine"
      ],
      "description": "Scope indicates if the installer is per user or per machine"
    },
    "InstallModes": {
      "type": [ "array", "null" ],
      "items": {
        "title": "InstallModes",
        "type": "string",
        "enum": [
          "interactive",
          "silent",
          "silentWithProgress"
        ]
      },
      "maxItems": 3,
      "uniqueItems": true,
      "description": "List of supported installer modes"
    },
    "InstallerSwitches": {
      "type": "object",
      "properties": {
        "Silent": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 512,
          "description": "Silent is the value that should be passed to the installer when user chooses a silent or quiet install"
        },
        "SilentWithProgress": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 512,
          "description": "SilentWithProgress is the value that should be passed to the installer when user chooses a non-interactive install"
        },
        "Interactive": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 512,
          "description": "Interactive is the value that should be passed to the installer when user chooses an interactive install"
        },
        "InstallLocation": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 512,
          "description": "InstallLocation is the value passed to the installer for custom install location. <INSTALLPATH> token can be included in the switch value so that winget will replace the token with user provided path"
        },
        "Log": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 512,
          "description": "Log is the value passed to the installer for custom log file path. <LOGPATH> token can be included in the switch value so that winget will replace the token with user provided path"
        },
        "Upgrade": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 512,
          "description": "Upgrade is the value that should be passed to the installer when user chooses an upgrade"
        },
        "Custom": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 2048,
          "description": "Custom switches will be passed directly to the installer by winget"
        }
      }
    },
    "InstallerReturnCode": {
      "type": "integer",
      "format": "long",
      "not": {
        "enum": [ 0 ]
      },
      "minimum": -2147483648,
      "maximum": 4294967295,
      "description": "An exit code that can be returned by the installer after execution"
    },
    "InstallerSuccessCodes": {
      "type": [ "array", "null" ],
      "items": {
        "$ref": "#/definitions/InstallerReturnCode"
      },
      "maxItems": 16,
      "uniqueItems": true,
      "description": "List of additional non-zero installer success exit codes other than known default values by winget"
    },
    "ExpectedReturnCodes": {
      "type": [ "array", "null" ],
      "items": {
        "type": "object",
        "properties": {
          "InstallerReturnCode": {
            "$ref": "#/definitions/InstallerReturnCode"
          },
          "ReturnResponse": {
            "type": "string",
            "enum": [
              "packageInUse",
              "installInProgress",
              "fileInUse",
              "missingDependency",
              "diskFull",
              "insufficientMemory",
              "noNetwork",
              "contactSupport",
              "rebootRequiredToFinish",
              "rebootRequiredForInstall",
              "rebootInitiated",
              "cancelledByUser",
              "alreadyInstalled",
              "downgrade",
              "blockedByPolicy"
            ]
          }
        }
      },
      "maxItems": 128,
      "description": "Installer exit codes for common errors"
    },
    "UpgradeBehavior": {
      "type": [ "string", "null" ],
      "enum": [
        "install",
        "uninstallPrevious"
      ],
      "description": "The upgrade method"
    },
    "Commands": {
      "type": [ "array", "null" ],
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      },
      "maxItems": 16,
      "uniqueItems": true,
      "description": "List of commands or aliases to run the package"
    },
    "Protocols": {
      "type": [ "array", "null" ],
      "items": {
        "type": "string",
        "pattern": "^[a-z][-a-z0-9\\.\\+]*$",
        "maxLength": 2048
      },
      "maxItems": 16,
      "uniqueItems": true,
      "description": "List of protocols the package provides a handler for"
    },
    "FileExtensions": {
      "type": [ "array", "null" ],
      "items": {
        "type": "string",
        "pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$",
        "maxLength": 64
      },
      "maxItems": 256,
      "uniqueItems": true,
      "description": "List of file extensions the package could support"
    },
    "Dependencies": {
      "type": [ "object", "null" ],
      "properties": {
        "WindowsFeatures": {
          "type": [ "array", "null" ],
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "maxItems": 16,
          "uniqueItems": true,
          "description": "List of Windows feature dependencies"
        },
        "WindowsLibraries": {
          "type": [ "array", "null" ],
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "maxItems": 16,
          "uniqueItems": true,
          "description": "List of Windows library dependencies"
        },
        "PackageDependencies": {
          "type": [ "array", "null" ],
          "items": {
            "type": "object",
            "properties": {
              "PackageIdentifier": {
                "$ref": "#/definitions/PackageIdentifier"
              },
              "MinimumVersion": {
                "$ref": "#/definitions/PackageVersion"
              }
            },
            "required": [ "PackageIdentifier" ]
          },
          "maxItems": 16,
          "uniqueItems": true,
          "description": "List of package dependencies from current source"
        },
        "ExternalDependencies": {
          "type": [ "array", "null" ],
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "maxItems": 16,
          "uniqueItems": true,
          "description": "List of external package dependencies"
        }
      }
    },
    "PackageFamilyName": {
      "type": [ "string", "null" ],
      "pattern": "^[A-Za-z0-9][-\\.A-Za-z0-9]+_[A-Za-z0-9]{13}$",
      "maxLength": 255,
      "description": "PackageFamilyName for appx or msix installer. Could be used for correlation of packages across sources"
    },
    "ProductCode": {
      "type": [ "string", "null" ],
      "minLength": 1,
      "maxLength": 255,
      "description": "ProductCode could be used for correlation of packages across sources"
    },
    "Capabilities": {
      "type": [ "array", "null" ],
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      },
      "maxItems": 1000,
      "uniqueItems": true,
      "description": "List of appx or msix installer capabilities"
    },
    "RestrictedCapabilities": {
      "type": [ "array", "null" ],
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      },
      "maxItems": 1000,
      "uniqueItems": true,
      "description": "List of appx or msix installer restricted capabilities"
    },
    "Market": {
      "type": "string",
      "pattern": "^[A-Z]{2}$",
      "description": "The installer target market"
    },
    "MarketArray": {
      "type": [ "array", "null" ],
      "uniqueItems": true,
      "maxItems": 256,
      "items": {
        "$ref": "#/definitions/Market"
      },
      "description": "Array of markets"
    },
    "Markets": {
      "description": "The installer markets",
      "type": [ "object", "null" ],
      "oneOf": [
        {
          "properties": {
            "AllowedMarkets": {
              "$ref": "#/definitions/MarketArray"
            }
          },
          "required": [ "AllowedMarkets" ]
        },
        {
          "properties": {
            "ExcludedMarkets": {
              "$ref": "#/definitions/MarketArray"
            }
          },
          "required": [ "ExcludedMarkets" ]
        }
      ]
    },
    "InstallerAbortsTerminal": {
      "type": [ "boolean", "null" ],
      "description": "Indicates whether the installer will abort terminal. Default is false"
    },
    "ReleaseDate": {
      "type": [ "string", "null" ],
      "format": "date",
      "description": "The installer release date"
    },
    "InstallLocationRequired": {
      "type": [ "boolean", "null" ],
      "description": "Indicates whether the installer requires an install location provided"
    },
    "RequireExplicitUpgrade": {
      "type": [ "boolean", "null" ],
      "description": "Indicates whether the installer should be pinned by default from upgrade"
    },
    "UnsupportedOSArchitectures": {
      "type": [ "array", "null" ],
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "x86",
          "x64",
          "arm",
          "arm64"
        ]
      },
      "description": "List of OS architectures the installer does not support"
    },
    "AppsAndFeaturesEntry": {
      "type": "object",
      "properties": {
        "DisplayName": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 256,
          "description": "The DisplayName registry value"
        },
        "Publisher": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 256,
          "description": "The Publisher registry value"
        },
        "DisplayVersion": {
          "type": [ "string", "null" ],
          "minLength": 1,
          "maxLength": 128,
          "description": "The DisplayVersion registry value"
        },
        "ProductCode": {
          "$ref": "#/definitions/ProductCode"
        },
        "UpgradeCode": {
          "$ref": "#/definitions/ProductCode"
        },
        "InstallerType": {
          "$ref": "#/definitions/InstallerType"
        }
      },
      "description": "Various key values under installer's ARP entry"
    },
    "AppsAndFeaturesEntries": {
      "type": [ "array", "null" ],
      "uniqueItems": true,
      "maxItems": 128,
      "items": {
        "$ref": "#/definitions/AppsAndFeaturesEntry"
      },
      "description": "List of ARP entries."
    },
    "ElevationRequirement": {
      "type": [ "string", "null" ],
      "enum": [
        "elevationRequired",
        "elevationProhibited",
        "elevatesSelf"
      ],
      "description": "The installer's elevation requirement"
    },
    "Installer": {
      "type": "object",
      "properties": {
        "InstallerLocale": {
          "$ref": "#/definitions/Locale"
        },
        "Platform": {
          "$ref": "#/definitions/Platform"
        },
        "MinimumOSVersion": {
          "$ref": "#/definitions/MinimumOSVersion"
        },
        "Architecture": {
          "type": "string",
          "enum": [
            "x86",
            "x64",
            "arm",
            "arm64",
            "neutral"
          ],
          "description": "The installer target architecture"
        },
        "InstallerType": {
          "$ref": "#/definitions/InstallerType"
        },
        "Scope": {
          "$ref": "#/definitions/Scope"
        },
        "InstallerUrl": {
          "type": "string",
          "pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
          "maxLength": 2048,
          "description": "The installer Url"
        },
        "InstallerSha256": {
          "type": "string",
          "pattern": "^[A-Fa-f0-9]{64}$",
          "description": "Sha256 is required. Sha256 of the installer"
        },
        "SignatureSha256": {
          "type": [ "string", "null" ],
          "pattern": "^[A-Fa-f0-9]{64}$",
          "description": "SignatureSha256 is recommended for appx or msix. It is the sha256 of signature file inside appx or msix. Could be used during streaming install if applicable"
        },
        "InstallModes": {
          "$ref": "#/definitions/InstallModes"
        },
        "InstallerSwitches": {
          "$ref": "#/definitions/InstallerSwitches"
        },
        "InstallerSuccessCodes": {
          "$ref": "#/definitions/InstallerSuccessCodes"
        },
        "ExpectedReturnCodes": {
          "$ref": "#/definitions/ExpectedReturnCodes"
        },
        "UpgradeBehavior": {
          "$ref": "#/definitions/UpgradeBehavior"
        },
        "Commands": {
          "$ref": "#/definitions/Commands"
        },
        "Protocols": {
          "$ref": "#/definitions/Protocols"
        },
        "FileExtensions": {
          "$ref": "#/definitions/FileExtensions"
        },
        "Dependencies": {
          "$ref": "#/definitions/Dependencies"
        },
        "PackageFamilyName": {
          "$ref": "#/definitions/PackageFamilyName"
        },
        "ProductCode": {
          "$ref": "#/definitions/ProductCode"
        },
        "Capabilities": {
          "$ref": "#/definitions/Capabilities"
        },
        "RestrictedCapabilities": {
          "$ref": "#/definitions/RestrictedCapabilities"
        },
        "Markets": {
          "$ref": "#/definitions/Markets"
        },
        "InstallerAbortsTerminal": {
          "$ref": "#/definitions/InstallerAbortsTerminal"
        },
        "ReleaseDate": {
          "$ref": "#/definitions/ReleaseDate"
        },
        "InstallLocationRequired": {
          "$ref": "#/definitions/InstallLocationRequired"
        },
        "RequireExplicitUpgrade": {
          "$ref": "#/definitions/RequireExplicitUpgrade"
        },
        "UnsupportedOSArchitectures": {
          "$ref": "#/definitions/UnsupportedOSArchitectures"
        },
        "AppsAndFeaturesEntries": {
          "$ref": "#/definitions/AppsAndFeaturesEntries"
        },
        "ElevationRequirement": {
          "$ref": "#/definitions/ElevationRequirement"
        }
      },
      "required": [
        "Architecture",
        "InstallerUrl",
        "InstallerSha256"
      ]
    }
  },
  "type": "object",
  "properties": {
    "PackageIdentifier": {
      "$ref": "#/definitions/PackageIdentifier"
    },
    "PackageVersion": {
      "$ref": "#/definitions/PackageVersion"
    },
    "Channel": {
      "$ref": "#/definitions/Channel"
    },
    "InstallerLocale": {
      "$ref": "#/definitions/Locale"
    },
    "Platform": {
      "$ref": "#/definitions/Platform"
    },
    "MinimumOSVersion": {
      "$ref": "#/definitions/MinimumOSVersion"
    },
    "InstallerType": {
      "$ref": "#/definitions/InstallerType"
    },
    "Scope": {
      "$ref": "#/definitions/Scope"
    },
    "InstallModes": {
      "$ref": "#/definitions/InstallModes"
    },
    "InstallerSwitches": {
      "$ref": "#/definitions/InstallerSwitches"
    },
    "InstallerSuccessCodes": {
      "$ref": "#/definitions/InstallerSuccessCodes"
    },
    "ExpectedReturnCodes": {
      "$ref": "#/definitions/ExpectedReturnCodes"
    },
    "UpgradeBehavior": {
      "$ref": "#/definitions/UpgradeBehavior"
    },
    "Commands": {
      "$ref": "#/definitions/Commands"
    },
    "Protocols": {
      "$ref": "#/definitions/Protocols"
    },
    "FileExtensions": {
      "$ref": "#/definitions/FileExtensions"
    },
    "Dependencies": {
      "$ref": "#/definitions/Dependencies"
    },
    "PackageFamilyName": {
      "$ref": "#/definitions/PackageFamilyName"
    },
    "ProductCode": {
      "$ref": "#/definitions/ProductCode"
    },
    "Capabilities": {
      "$ref": "#/definitions/Capabilities"
    },
    "RestrictedCapabilities": {
      "$ref": "#/definitions/RestrictedCapabilities"
    },
    "Markets": {
      "$ref": "#/definitions/Markets"
    },
    "InstallerAbortsTerminal": {
      "$ref": "#/definitions/InstallerAbortsTerminal"
    },
    "ReleaseDate": {
      "$ref": "#/definitions/ReleaseDate"
    },
    "InstallLocationRequired": {
      "$ref": "#/definitions/InstallLocationRequired"
    },
    "RequireExplicitUpgrade": {
      "$ref": "#/definitions/RequireExplicitUpgrade"
    },
    "UnsupportedOSArchitectures": {
      "$ref": "#/definitions/UnsupportedOSArchitectures"
    },
    "AppsAndFeaturesEntries": {
      "$ref": "#/definitions/AppsAndFeaturesEntries"
    },
    "ElevationRequirement": {
      "$ref": "#/definitions/ElevationRequirement"
    },
    "Installers": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/Installer"
      },
      "minItems": 1,
      "maxItems": 1024
    },
    "ManifestType": {
      "type": "string",
      "default": "installer",
      "const": "installer",
      "description": "The manifest type"
    },
    "ManifestVersion": {
      "type": "string",
      "default": "1.1.0",
      "pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
      "description": "The manifest syntax version"
    }
  },
  "required": [
    "PackageIdentifier",
    "PackageVersion",
    "Installers",
    "ManifestType",
    "ManifestVersion"
  ]
}