Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
ntangle.json
JoinMapping
The 'JoinMapping' object defines one or more related table identifier mappings.
{"type": "object", "properties": {"name": {"type": "string"}, "schema": {"type": "string"}, "table": {"type": "string"}}, "required": ["name", "table"]}
ntangle.json
schema
Defaults to the owning (parent) table schema.
{"type": "string"}
ntangle.json
Where
This should only be used where the column value is largely immutable; otherwise, unintended side-effects may occur. _NTangle_ uses the condition explictily and does not attempt to handle value change to infer creation or deletion of data as a result of the underlying change; as such, this should be used cautiously. Note that the 'where' is applied when querying the 'cdc.fn_cdc_get_all_changes_...' function, not the underlying table itself.
{"type": "object", "properties": {"name": {"type": "string"}, "nullable": {"type": "string", "enum": ["ISNULL", "ISNOTNULL"]}, "operator": {"type": "string", "enum": ["EQ", "NE", "LT", "LE", "GT", "GE", "LIKE"]}, "value": {"type": "string"}}, "required": ["name"]}
ntangle.json
name
The column name.
{"type": "string"}
ntangle.json
nullable
This enables statements such as 'WHERE (COL IS NULL)' or 'WHERE (COL IS NULL OR COL = VALUE)' (where .
{"type": "string", "enum": ["ISNULL", "ISNOTNULL"]}
ntangle.json
operator
Defaults to 'EQ' where 'Value' is specified.
{"type": "string", "enum": ["EQ", "NE", "LT", "LE", "GT", "GE", "LIKE"]}
ntangle.json
value
This must be valid formatted/escaped SQL.
{"type": "string"}
ntangle.json
TableMapping
The 'TableMapping' object defines one or more related table identifier mappings.
{"type": "object", "properties": {"name": {"type": "string"}, "schema": {"type": "string"}, "table": {"type": "string"}}, "required": ["name", "table"]}
ntangle.json
schema
Defaults to the owning (parent) table schema.
{"type": "string"}
mycode.json
Eval
Script that is executed by passing a string to the host-provided eval function.
{"default": "MyCode", "allOf": [{}]}
mycode.json
Function
Script that is executed by passing a string to the 'Function' constructor.
{"default": "LibraryCode", "allOf": [{}]}
mycode.json
ScriptBlock
Script that is executed by passing a string to the 'setTimeout', 'setImmediate', or 'setInterval' functions.
{"default": "UnrelatedCode", "allOf": [{}]}
mycode.json
MyCode
An array of urls or files that are classified as 'MyCode'.
{"allOf": [{}]}
mycode.json
Libraries
An array of urls or files that are classified as 'LibraryCode'.
{"allOf": [{}]}
mycode.json
Unrelated
An array of urls or files that are classified as 'UnrelatedCode'.
{"allOf": [{}]}
mimetypes.json
^\..+$
A file extension
{"pattern": "^[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_.]+$", "type": "string", "examples": ["application/json"]}
ort-configuration-schema.json
The main configuration file for the OSS-Review-Toolkit (ORT). A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/resources/reference.yml.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"ort": {"properties": {"licenseFilePatterns": {}, "severeIssueThreshold": {}, "severeRuleViolationThreshold": {}, "enableRepositoryPackageCurations": {"type": "boolean"}, "enableRepositoryPackageConfigurations": {"type": "boolean"}, "analyzer": {}, "advisor": {}, "downloader": {}, "scanner": {}, "reporter": {}, "notifier": {}}}}, "required": ["ort"], "definitions": {"Advisor": {"type": "object", "additionalProperties": false, "properties": {"nexusIq": {}, "ossIndex": {}, "vulnerableCode": {}, "gitHubDefects": {}, "osv": {}, "options": {}}}, "GitHubDefects": {"type": "object", "additionalProperties": false, "properties": {"token": {"type": "string"}, "labelFilter": {"type": "array", "items": {"type": "string"}}, "maxNumberOfIssuesPerRepository": {"type": "integer"}, "parallelRequests": {"type": "integer"}}, "required": ["labelFilter"]}, "NexusIq": {"type": "object", "additionalProperties": false, "properties": {"serverUrl": {"type": "string", "format": "uri"}, "browseUrl": {"type": "string", "format": "uri"}, "username": {"type": "string"}, "password": {"type": "string"}}, "required": ["serverUrl"]}, "OssIndex": {"type": "object", "additionalProperties": false, "properties": {"serverUrl": {"type": "string", "format": "uri"}, "username": {"type": "string"}, "password": {"type": "string"}}}, "AdvisorOptions": {"type": "object", "additionalProperties": {"type": "object"}}, "CustomAdvisor": {"type": "object", "additionalProperties": false, "properties": {"apiKey": {"type": "string"}}, "required": ["apiKey"]}, "Osv": {"type": "object", "additionalProperties": false, "properties": {"serverUrl": {"type": "string", "format": "uri"}}}, "VulnerableCode": {"type": "object", "additionalProperties": false, "properties": {"serverUrl": {"type": "string", "format": "uri"}, "apiKey": {"type": "string"}}, "required": ["serverUrl"]}, "Analyzer": {}, "Downloader": {"type": "object", "additionalProperties": false, "properties": {"allowMovingRevisions": {"type": "boolean"}, "includedLicenseCategories": {"type": "array", "items": {"type": "string"}}, "sourceCodeOrigins": {"type": "array", "items": {}}}}, "LicenseFilePatterns": {"type": "object", "additionalProperties": false, "properties": {"licenseFilenames": {"type": "array", "items": {"type": "string"}}, "patentFilenames": {"type": "array", "items": {"type": "string"}}, "rootLicenseFilenames": {"type": "array", "items": {"type": "string"}}}}, "Notifier": {"type": "object", "additionalProperties": false, "properties": {"mail": {}, "jira": {}}}, "Jira": {"type": "object", "additionalProperties": false, "properties": {"host": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}}}, "Mail": {"type": "object", "additionalProperties": false, "properties": {"hostName": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "port": {"type": "integer"}, "useSsl": {"type": "boolean"}, "fromAddress": {"type": "string"}}}, "Reporter": {"type": "object", "additionalProperties": false, "properties": {"options": {}}, "required": ["options"]}, "ReporterOptions": {"type": "object", "additionalProperties": {"type": "object"}}, "Scanner": {"type": "object", "additionalProperties": false, "properties": {"skipConcluded": {"type": "boolean"}, "archive": {}, "createMissingArchives": {"type": "boolean"}, "detectedLicenseMapping": {}, "fileListStorage": {}, "options": {}, "storages": {}, "storageReaders": {"type": "array", "items": {}}, "storageWriters": {"type": "array", "items": {}}, "ignorePatterns": {"type": "array", "items": {"type": "string"}}, "provenanceStorage": {}}}, "Archive": {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "fileStorage": {}, "postgresStorage": {}}}, "FileListStorage": {"type": "object", "additionalProperties": false, "properties": {"fileStorage": {}, "postgresStorage": {}}}, "FileStorage": {"type": "object", "additionalProperties": false, "properties": {"localFileStorage": {}, "httpFileStorage": {"\u00a7ref": "#/definitions/HttpFileStorage"}}, "required": ["localFileStorage"]}, "LocalFileStorage": {"type": "object", "additionalProperties": false, "properties": {"directory": {"type": "string"}, "compression": {"type": "boolean"}}, "required": ["directory"]}, "HttpFileStorage": {"type": "object", "additionalProperties": false, "properties": {"url": {"type": "string", "format": "uri"}, "query": {"type": "string"}, "headers": {}}, "required": ["url"]}, "PostgresConfig": {"type": "object", "additionalProperties": false, "properties": {"connection": {}}, "required": ["connection"]}, "Connection": {"type": "object", "additionalProperties": false, "properties": {"url": {"type": "string"}, "schema": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "sslmode": {"type": "string"}, "sslcert": {"type": "string"}, "sslkey": {"type": "string"}, "sslrootcert": {"type": "string"}, "parallelTransactions": {"type": "integer"}}, "required": ["url", "username"]}, "DetectedLicenseMapping": {"type": "object", "additionalProperties": {"type": "string"}}, "ScannerOptions": {"type": "object", "additionalProperties": {"type": "object"}}, "ProvenanceStorage": {"type": "object", "additionalProperties": false, "properties": {"fileStorage": {}, "postgresStorage": {}}}, "Storages": {"type": "object", "additionalProperties": {"type": "object"}}, "Severity": {"enum": ["HINT", "WARNING", "ERROR"]}, "SourceCodeOrigins": {"enum": ["ARTIFACT", "VCS"]}, "StorageTypes": {"enum": ["clearlyDefined", "http", "local", "postgres"]}, "Headers": {"type": "object", "additionalProperties": {"type": ["boolean", "number", "string"]}}}}
codeship-services.json
codeship-services.yml is where you configure each service you need to run your CI/CD builds with CodeShip.
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {}, "definitions": {"ExternalService": {"properties": {"add_docker": {"default": false, "type": "boolean"}, "build": {"oneOf": [{}, {"type": "string"}]}, "cached": {"default": false, "type": "boolean"}, "cap_add": {"items": {"type": "string"}, "type": "array"}, "cap_drop": {"items": {"type": "string"}, "type": "array"}, "command": {"type": "string"}, "cpuset": {"type": "string"}, "cpu_shares": {"type": "integer"}, "default_cache_branch": {"type": "string"}, "dns": {"items": {"type": "string"}, "type": "array"}, "dns_search": {"items": {"type": "string"}, "type": "array"}, "dockercfg_service": {"type": "string"}, "dockerfile": {"type": "string"}, "domainname": {"type": "string"}, "encrypted_dockercfg_path": {"type": "string"}, "encrypted_env_file": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "encrypted_environment": {"items": {"type": "string"}, "type": "array"}, "entrypoint": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "env_file": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "environment": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "object", "additionalProperties": true}]}, "expose": {"items": {"type": "string"}, "type": "array"}, "extra_hosts": {"items": {"type": "string"}, "type": "array"}, "hostname": {"type": "string"}, "image": {"type": "string"}, "links": {"items": {"type": "string"}, "type": "array"}, "depends_on": {"items": {"type": "string"}, "type": "array"}, "mem_limit": {"type": "string"}, "privileged": {"type": "boolean"}, "ports": {"items": {"type": "string"}, "type": "array"}, "read_only": {"type": "boolean"}, "restart": {"type": "string"}, "security_opt": {"items": {"type": "string"}, "type": "array"}, "user": {"type": "string"}, "volumes": {"items": {"type": "string"}, "type": "array"}, "volumes_from": {"items": {"type": "string"}, "type": "array"}, "working_dir": {"type": "string"}}, "additionalProperties": false, "type": "object", "oneOf": [{"required": ["build"]}, {"required": ["image"]}]}, "externalBuild": {"properties": {"path": {"type": "string"}, "dockerfile_path": {"type": "string"}, "image": {"type": "string"}, "context": {"type": "string"}, "dockerfile": {"type": "string"}, "configure": {}, "args": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "object", "additionalProperties": true}]}, "encrypted_args_file": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "encrypted_args": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}}, "additionalProperties": false, "type": "object"}, "externalBuildConfigure": {"properties": {"service": {"type": "string"}, "command": {"type": "string"}}, "additionalProperties": false, "type": "object"}}, "type": "object"}
codeship-services.json
ExternalService
The definition of a service in a CodeShip Pro build, which can have steps run on it or have other services depend on it
{"properties": {"add_docker": {"default": false, "type": "boolean"}, "build": {"oneOf": [{}, {"type": "string"}]}, "cached": {"default": false, "type": "boolean"}, "cap_add": {"items": {"type": "string"}, "type": "array"}, "cap_drop": {"items": {"type": "string"}, "type": "array"}, "command": {"type": "string"}, "cpuset": {"type": "string"}, "cpu_shares": {"type": "integer"}, "default_cache_branch": {"type": "string"}, "dns": {"items": {"type": "string"}, "type": "array"}, "dns_search": {"items": {"type": "string"}, "type": "array"}, "dockercfg_service": {"type": "string"}, "dockerfile": {"type": "string"}, "domainname": {"type": "string"}, "encrypted_dockercfg_path": {"type": "string"}, "encrypted_env_file": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "encrypted_environment": {"items": {"type": "string"}, "type": "array"}, "entrypoint": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "env_file": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "environment": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "object", "additionalProperties": true}]}, "expose": {"items": {"type": "string"}, "type": "array"}, "extra_hosts": {"items": {"type": "string"}, "type": "array"}, "hostname": {"type": "string"}, "image": {"type": "string"}, "links": {"items": {"type": "string"}, "type": "array"}, "depends_on": {"items": {"type": "string"}, "type": "array"}, "mem_limit": {"type": "string"}, "privileged": {"type": "boolean"}, "ports": {"items": {"type": "string"}, "type": "array"}, "read_only": {"type": "boolean"}, "restart": {"type": "string"}, "security_opt": {"items": {"type": "string"}, "type": "array"}, "user": {"type": "string"}, "volumes": {"items": {"type": "string"}, "type": "array"}, "volumes_from": {"items": {"type": "string"}, "type": "array"}, "working_dir": {"type": "string"}}, "additionalProperties": false, "type": "object", "oneOf": [{"required": ["build"]}, {"required": ["image"]}]}
codeship-services.json
add_docker
If true, the docker socket will be exposed in this service.
{"default": false, "type": "boolean"}
codeship-services.json
build
How to build the image for this service. Mutually exclusive with 'image'. Can either be just a path containing a Dockerfile, or a build definition.
{"oneOf": [{}, {"type": "string"}]}
codeship-services.json
cached
Whether the image for this service should be rebuilt from scratch for each run, or if the latest build of the service's image from the configured cache branch (defaulting to 'master') should be used.
{"default": false, "type": "boolean"}
codeship-services.json
command
The command to run when launching the service, overriding the 'CMD' in the image. Optional.
{"type": "string"}
codeship-services.json
default_cache_branch
The branch to use for caching. Defaults to 'master'
{"type": "string"}
codeship-services.json
dockercfg_service
The name of another defined service that provides the Docker configuration for building and running this service. Optional.
{"type": "string"}
codeship-services.json
dockerfile
A specific Dockerfile to use, rather than the one in the build context
{"type": "string"}
codeship-services.json
encrypted_dockercfg_path
The location of a Docker configuration file encrypted by Jet to be used with building and running this service. Optional.
{"type": "string"}
codeship-services.json
encrypted_env_file
The location of one or more files, encrypted with Jet, containing environment variables to be made available to this service and steps running on it. Optional.
{"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}
codeship-services.json
encrypted_environment
A list of encrypted key/value pairs to be used in the environment for this service and steps running on it. Optional.
{"items": {"type": "string"}, "type": "array"}
codeship-services.json
env_file
The location of one or more files containing environment variables to be made available to this service and steps running on it. Optional.
{"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}
codeship-services.json
environment
Either a map of key/value pairs or a list of 'KEY=VALUE' pairs to be used in the environment for this service and steps running on it. Optional.
{"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "object", "additionalProperties": true}]}
codeship-services.json
image
A pre-existing image to use for this service. Mutually exclusive with 'build'
{"type": "string"}
codeship-services.json
depends_on
A list of other services that this service depends on. Use this instead of 'links'
{"items": {"type": "string"}, "type": "array"}
codeship-services.json
ports
A list of ports that should be exposed to other services. The ports should be defined like '9999', as strings
{"items": {"type": "string"}, "type": "array"}
codeship-services.json
volumes
A list of origin/destination pairs of directories or files relative to the build context and where they should be mounted in the service. Optional.
{"items": {"type": "string"}, "type": "array"}
codeship-services.json
volumes_from
A list of other services which should have their defined volumes mounted into this service as well. Optional.
{"items": {"type": "string"}, "type": "array"}
codeship-services.json
externalBuild
Configuration of how to build the image for this service
{"properties": {"path": {"type": "string"}, "dockerfile_path": {"type": "string"}, "image": {"type": "string"}, "context": {"type": "string"}, "dockerfile": {"type": "string"}, "configure": {}, "args": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "object", "additionalProperties": true}]}, "encrypted_args_file": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "encrypted_args": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}}, "additionalProperties": false, "type": "object"}
codeship-services.json
path
DEPRECATED: Use 'context' instead.
{"type": "string"}
codeship-services.json
dockerfile_path
DEPRECATED: Use 'dockerfile' instead
{"type": "string"}
codeship-services.json
image
The output image name for this image. Optional.
{"type": "string"}
codeship-services.json
context
The directory used as the Docker build context. Defaults to the same directory as the codeship-services.yml file
{"type": "string"}
codeship-services.json
dockerfile
A specific Dockerfile to use rather than the 'Dockerfile' present in the build context. Optional.
{"type": "string"}
codeship-services.json
args
Build args to pass to Docker. Optional.
{"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "object", "additionalProperties": true}]}
codeship-services.json
encrypted_args_file
One or more files, encrypted with Jet, to have their contents decrypted and passed to Docker as build args. Optional.
{"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}
codeship-services.json
encrypted_args
A list of encrypted key/value pairs to be used as build args to Docker. Optional.
{"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}
winget-pkgs-singleton-1.0.0.json
A representation of a single-file manifest representing an app in the OWC. v1.0.0
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"PackageIdentifier": {"type": "string", "pattern": "^[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}(\\.[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}){1,3}$", "maxLength": 128}, "PackageVersion": {"type": "string", "pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$", "maxLength": 128}, "Locale": {"type": ["string", "null"], "pattern": "^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$", "maxLength": 20}, "Url": {"type": ["string", "null"], "pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$", "maxLength": 2000}, "Tag": {"type": ["string", "null"], "minLength": 1, "maxLength": 40}, "Channel": {"type": ["string", "null"], "minLength": 1, "maxLength": 16}, "Platform": {"type": ["array", "null"], "items": {"type": "string", "enum": ["Windows.Desktop", "Windows.Universal"]}, "maxItems": 2, "uniqueItems": true}, "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}$"}, "InstallerType": {"type": ["string", "null"], "enum": ["msix", "msi", "appx", "exe", "zip", "inno", "nullsoft", "wix", "burn", "pwa"]}, "Scope": {"type": ["string", "null"], "enum": ["user", "machine"]}, "InstallModes": {"type": ["array", "null"], "items": {"type": "string", "enum": ["interactive", "silent", "silentWithProgress"]}, "maxItems": 3, "uniqueItems": true}, "InstallerSwitches": {"type": "object", "properties": {"Silent": {"type": ["string", "null"], "minLength": 1, "maxLength": 512}, "SilentWithProgress": {"type": ["string", "null"], "minLength": 1, "maxLength": 512}, "Interactive": {"type": ["string", "null"], "minLength": 1, "maxLength": 512}, "InstallLocation": {"type": ["string", "null"], "minLength": 1, "maxLength": 512}, "Log": {"type": ["string", "null"], "minLength": 1, "maxLength": 512}, "Upgrade": {"type": ["string", "null"], "minLength": 1, "maxLength": 512}, "Custom": {"type": ["string", "null"], "minLength": 1, "maxLength": 2048}}}, "InstallerSuccessCodes": {"type": ["array", "null"], "items": {"type": "integer", "not": {"enum": [0]}}, "maxItems": 16, "uniqueItems": true}, "UpgradeBehavior": {"type": ["string", "null"], "enum": ["install", "uninstallPrevious"]}, "Commands": {"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 40}, "maxItems": 16, "uniqueItems": true}, "Protocols": {"type": ["array", "null"], "items": {"type": "string", "pattern": "^[a-z][-a-z0-9\\.\\+]*$", "maxLength": 2048}, "maxItems": 16, "uniqueItems": true}, "FileExtensions": {"type": ["array", "null"], "items": {"type": "string", "pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$", "maxLength": 40}, "maxItems": 256, "uniqueItems": true}, "Dependencies": {"type": ["object", "null"], "properties": {"WindowsFeatures": {"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 128}, "maxItems": 16, "uniqueItems": true}, "WindowsLibraries": {"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 128}, "maxItems": 16, "uniqueItems": true}, "PackageDependencies": {"type": ["array", "null"], "items": {"type": "object", "properties": {"PackageIdentifier": {}, "MinimumVersion": {}}, "required": ["PackageIdentifier"]}, "maxItems": 16}, "ExternalDependencies": {"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 128}, "maxItems": 16, "uniqueItems": true}}}, "PackageFamilyName": {"type": ["string", "null"], "pattern": "^[A-Za-z0-9][-\\.A-Za-z0-9]+_[A-Za-z0-9]{13}$", "maxLength": 255}, "ProductCode": {"type": ["string", "null"], "minLength": 1, "maxLength": 255}, "Capabilities": {"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 40}, "maxItems": 1000, "uniqueItems": true}, "RestrictedCapabilities": {"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 40}, "maxItems": 1000, "uniqueItems": true}, "Installer": {"type": "object", "properties": {"InstallerLocale": {}, "Platform": {}, "MinimumOSVersion": {}, "Architecture": {"type": "string", "enum": ["x86", "x64", "arm", "arm64", "neutral"]}, "InstallerType": {}, "Scope": {}, "InstallerUrl": {"type": "string", "pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$"}, "InstallerSha256": {"type": "string", "pattern": "^[A-Fa-f0-9]{64}$"}, "SignatureSha256": {"type": ["string", "null"], "pattern": "^[A-Fa-f0-9]{64}$"}, "InstallModes": {}, "InstallerSwitches": {}, "InstallerSuccessCodes": {}, "UpgradeBehavior": {}, "Commands": {}, "Protocols": {}, "FileExtensions": {}, "Dependencies": {}, "PackageFamilyName": {}, "ProductCode": {}, "Capabilities": {}, "RestrictedCapabilities": {}}, "required": ["Architecture", "InstallerUrl", "InstallerSha256"]}}, "properties": {"PackageIdentifier": {}, "PackageVersion": {}, "PackageLocale": {"type": "string", "pattern": "^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$", "maxLength": 20}, "Publisher": {"type": "string", "minLength": 2, "maxLength": 256}, "PublisherUrl": {}, "PublisherSupportUrl": {}, "PrivacyUrl": {}, "Author": {"type": ["string", "null"], "minLength": 2, "maxLength": 256}, "PackageName": {"type": "string", "minLength": 2, "maxLength": 256}, "PackageUrl": {}, "License": {"type": "string", "minLength": 3, "maxLength": 512}, "LicenseUrl": {}, "Copyright": {"type": ["string", "null"], "minLength": 3, "maxLength": 512}, "CopyrightUrl": {}, "ShortDescription": {"type": "string", "minLength": 3, "maxLength": 256}, "Moniker": {}, "Tags": {"type": ["array", "null"], "items": {}, "maxItems": 16, "uniqueItems": true}, "Channel": {}, "InstallerLocale": {}, "Platform": {}, "MinimumOSVersion": {}, "InstallerType": {}, "Scope": {}, "InstallModes": {}, "InstallerSwitches": {}, "InstallerSuccessCodes": {}, "UpgradeBehavior": {}, "Commands": {}, "Protocols": {}, "FileExtensions": {}, "Dependencies": {}, "PackageFamilyName": {}, "ProductCode": {}, "Capabilities": {}, "RestrictedCapabilities": {}, "Installers": {"type": "array", "items": {}, "minItems": 1, "maxItems": 1}, "ManifestType": {"type": "string", "default": "singleton", "const": "singleton"}, "ManifestVersion": {"type": "string", "default": "1.0.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}$"}}, "required": ["PackageIdentifier", "PackageVersion", "PackageLocale", "Publisher", "PackageName", "License", "ShortDescription", "Installers", "ManifestType", "ManifestVersion"], "type": "object"}
winget-pkgs-singleton-1.0.0.json
PackageIdentifier
The package unique identifier
{"type": "string", "pattern": "^[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}(\\.[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}){1,3}$", "maxLength": 128}
winget-pkgs-singleton-1.0.0.json
PackageVersion
The package version
{"type": "string", "pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$", "maxLength": 128}
winget-pkgs-singleton-1.0.0.json
Locale
The package meta-data locale
{"type": ["string", "null"], "pattern": "^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$", "maxLength": 20}
winget-pkgs-singleton-1.0.0.json
Url
Optional Url type
{"type": ["string", "null"], "pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$", "maxLength": 2000}
winget-pkgs-singleton-1.0.0.json
Tag
Package moniker or tag
{"type": ["string", "null"], "minLength": 1, "maxLength": 40}
winget-pkgs-singleton-1.0.0.json
Channel
The distribution channel
{"type": ["string", "null"], "minLength": 1, "maxLength": 16}
winget-pkgs-singleton-1.0.0.json
Platform
The installer supported operating system
{"type": ["array", "null"], "items": {"type": "string", "enum": ["Windows.Desktop", "Windows.Universal"]}, "maxItems": 2, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
MinimumOSVersion
The installer minimum operating system version
{"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}$"}
winget-pkgs-singleton-1.0.0.json
InstallerType
Enumeration of supported installer types
{"type": ["string", "null"], "enum": ["msix", "msi", "appx", "exe", "zip", "inno", "nullsoft", "wix", "burn", "pwa"]}
winget-pkgs-singleton-1.0.0.json
Scope
Scope indicates if the installer is per user or per machine
{"type": ["string", "null"], "enum": ["user", "machine"]}
winget-pkgs-singleton-1.0.0.json
InstallModes
List of supported installer modes
{"type": ["array", "null"], "items": {"type": "string", "enum": ["interactive", "silent", "silentWithProgress"]}, "maxItems": 3, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
Silent
Silent is the value that should be passed to the installer when user chooses a silent or quiet install
{"type": ["string", "null"], "minLength": 1, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
SilentWithProgress
SilentWithProgress is the value that should be passed to the installer when user chooses a non-interactive install
{"type": ["string", "null"], "minLength": 1, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
Interactive
Interactive is the value that should be passed to the installer when user chooses an interactive install
{"type": ["string", "null"], "minLength": 1, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
InstallLocation
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
{"type": ["string", "null"], "minLength": 1, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
Log
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
{"type": ["string", "null"], "minLength": 1, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
Upgrade
Upgrade is the value that should be passed to the installer when user chooses an upgrade
{"type": ["string", "null"], "minLength": 1, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
Custom
Custom switches will be passed directly to the installer by winget
{"type": ["string", "null"], "minLength": 1, "maxLength": 2048}
winget-pkgs-singleton-1.0.0.json
InstallerSuccessCodes
List of additional non-zero installer success exit codes other than known default values by winget
{"type": ["array", "null"], "items": {"type": "integer", "not": {"enum": [0]}}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
UpgradeBehavior
The upgrade method
{"type": ["string", "null"], "enum": ["install", "uninstallPrevious"]}
winget-pkgs-singleton-1.0.0.json
Commands
List of commands or aliases to run the package
{"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 40}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
Protocols
List of protocols the package provides a handler for
{"type": ["array", "null"], "items": {"type": "string", "pattern": "^[a-z][-a-z0-9\\.\\+]*$", "maxLength": 2048}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
FileExtensions
List of file extensions the package could support
{"type": ["array", "null"], "items": {"type": "string", "pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$", "maxLength": 40}, "maxItems": 256, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
WindowsFeatures
List of Windows feature dependencies
{"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 128}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
WindowsLibraries
List of Windows library dependencies
{"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 128}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
PackageDependencies
List of package dependencies from current source
{"type": ["array", "null"], "items": {"type": "object", "properties": {"PackageIdentifier": {}, "MinimumVersion": {}}, "required": ["PackageIdentifier"]}, "maxItems": 16}
winget-pkgs-singleton-1.0.0.json
ExternalDependencies
List of external package dependencies
{"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 128}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
PackageFamilyName
PackageFamilyName for appx or msix installer. Could be used for correlation of packages across sources
{"type": ["string", "null"], "pattern": "^[A-Za-z0-9][-\\.A-Za-z0-9]+_[A-Za-z0-9]{13}$", "maxLength": 255}
winget-pkgs-singleton-1.0.0.json
ProductCode
ProductCode could be used for correlation of packages across sources
{"type": ["string", "null"], "minLength": 1, "maxLength": 255}
winget-pkgs-singleton-1.0.0.json
Capabilities
List of appx or msix installer capabilities
{"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 40}, "maxItems": 1000, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
RestrictedCapabilities
List of appx or msix installer restricted capabilities
{"type": ["array", "null"], "items": {"type": "string", "minLength": 1, "maxLength": 40}, "maxItems": 1000, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
Architecture
The installer target architecture
{"type": "string", "enum": ["x86", "x64", "arm", "arm64", "neutral"]}
winget-pkgs-singleton-1.0.0.json
InstallerUrl
The installer Url
{"type": "string", "pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$"}
winget-pkgs-singleton-1.0.0.json
InstallerSha256
Sha256 is required. Sha256 of the installer
{"type": "string", "pattern": "^[A-Fa-f0-9]{64}$"}
winget-pkgs-singleton-1.0.0.json
SignatureSha256
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
{"type": ["string", "null"], "pattern": "^[A-Fa-f0-9]{64}$"}
winget-pkgs-singleton-1.0.0.json
PackageLocale
The package meta-data locale
{"type": "string", "pattern": "^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$", "maxLength": 20}
winget-pkgs-singleton-1.0.0.json
Publisher
The publisher name
{"type": "string", "minLength": 2, "maxLength": 256}
winget-pkgs-singleton-1.0.0.json
PublisherUrl
The publisher home page
{}
winget-pkgs-singleton-1.0.0.json
PublisherSupportUrl
The publisher support page
{}
winget-pkgs-singleton-1.0.0.json
PrivacyUrl
The publisher privacy page or the package privacy page
{}
winget-pkgs-singleton-1.0.0.json
Author
The package author
{"type": ["string", "null"], "minLength": 2, "maxLength": 256}
winget-pkgs-singleton-1.0.0.json
PackageName
The package name
{"type": "string", "minLength": 2, "maxLength": 256}
winget-pkgs-singleton-1.0.0.json
PackageUrl
The package home page
{}
winget-pkgs-singleton-1.0.0.json
License
The package license
{"type": "string", "minLength": 3, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
LicenseUrl
The license page
{}
winget-pkgs-singleton-1.0.0.json
Copyright
The package copyright
{"type": ["string", "null"], "minLength": 3, "maxLength": 512}
winget-pkgs-singleton-1.0.0.json
CopyrightUrl
The package copyright page
{}
winget-pkgs-singleton-1.0.0.json
ShortDescription
The short package description
{"type": "string", "minLength": 3, "maxLength": 256}
winget-pkgs-singleton-1.0.0.json
Description
The full package description
{"type": ["string", "null"], "minLength": 3, "maxLength": 10000}
winget-pkgs-singleton-1.0.0.json
Moniker
The most common package term
{}
winget-pkgs-singleton-1.0.0.json
Tags
List of additional package search terms
{"type": ["array", "null"], "items": {}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-singleton-1.0.0.json
ManifestType
The manifest type
{"type": "string", "default": "singleton", "const": "singleton"}
winget-pkgs-singleton-1.0.0.json
ManifestVersion
The manifest syntax version
{"type": "string", "default": "1.0.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}$"}
schema-app.json
name
Name of the app. Defaults to directory name.
{"type": "string"}