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
expo-46.0.0.json
jsEngine
Sets the JS Engine that will interpret your code
{"type": "string", "enum": ["hermes", "jsc"]}
expo-46.0.0.json
_internal
Internal properties for developer tools
{"type": "object", "properties": {"pluginHistory": {"type": "object", "properties": {}, "additionalProperties": true}}, "additionalProperties": true}
expo-46.0.0.json
pluginHistory
List of plugins already run on the config
{"type": "object", "properties": {}, "additionalProperties": true}
replit.json
https://docs.replit.com/programming-ide/configuring-repl
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": {"run": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "language": {"type": "string", "enum": ["clojure", "haskell", "kotlin", "qbasic", "forth", "lolcode", "brainf***", "emoticon", "bloop", "react_native", "unlambda", "javascript", "babel", "coffeescript", "scheme", "apl", "lua", "python", "ruby", "roy", "php", "python3", "nodejs", "enzyme", "go", "java", "cpp", "cpp11", "c", "csharp", "fsharp", "web_project", "html", "rust", "swift", "python_turtle", "basic", "jest", "django", "express", "sinatra", "rails", "rlang", "nextjs", "gatsbyjs", "reactjs", "reactts", "reactre", "flow", "bash", "quil", "polygott", "crystal", "julia", "perl6", "elixir", "nim", "dart", "gatsbyjsv2", "reason_nodejs", "tcl", "erlang", "typescript", "ocaml", "pygame", "love2d", "reason", "Tkinter", "tkinter", "java_swing", "php_server", "nodejs_prybar", "elisp", "php7", "sqlite", "java10", "php_cli", "nodejs_beta", "pyxel", "static", "go_beta", "nodejs_static", "python3_beta", "raku", "testj", "wasm", "java10_beta", "python_beta", "html_beta", "testj_beta", "scala", "riddlejs", "java_maven"]}, "audio": {"type": "boolean"}, "packager": {"type": "object", "properties": {"afterInstall": {"type": "string"}, "ignoredPaths": {"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}, "ignoredPackages": {"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}, "language": {"type": "string", "enum": ["python-python3-poetry", "python-python2-poetry", "nodejs-npm", "nodejs-yarn", "ruby-bundler", "elisp-cask", "dart-pub", "java-maven", "rlang", "dotnet", "rust"]}, "features": {"type": "object", "properties": {"packageSearch": {"type": "boolean"}, "guessImports": {"type": "boolean"}}, "additionalProperties": false}}, "additionalProperties": false}, "languages": {"type": "object", "patternProperties": {".": {"type": "object", "properties": {"glob": {"type": "string", "minLength": 1}, "languageServer": {"type": "object", "properties": {"start": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": false}}, "type": "object", "x-taplo-info": {"authors": ["Emily Grace Seville (https://github.com/EmilySeville7cfg)"], "patterns": ["\\.replit(?:\\.toml)?$"]}}
replit.json
run
Command to run REPL
{"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
replit.json
language
Language name used in REPL
{"type": "string", "enum": ["clojure", "haskell", "kotlin", "qbasic", "forth", "lolcode", "brainf***", "emoticon", "bloop", "react_native", "unlambda", "javascript", "babel", "coffeescript", "scheme", "apl", "lua", "python", "ruby", "roy", "php", "python3", "nodejs", "enzyme", "go", "java", "cpp", "cpp11", "c", "csharp", "fsharp", "web_project", "html", "rust", "swift", "python_turtle", "basic", "jest", "django", "express", "sinatra", "rails", "rlang", "nextjs", "gatsbyjs", "reactjs", "reactts", "reactre", "flow", "bash", "quil", "polygott", "crystal", "julia", "perl6", "elixir", "nim", "dart", "gatsbyjsv2", "reason_nodejs", "tcl", "erlang", "typescript", "ocaml", "pygame", "love2d", "reason", "Tkinter", "tkinter", "java_swing", "php_server", "nodejs_prybar", "elisp", "php7", "sqlite", "java10", "php_cli", "nodejs_beta", "pyxel", "static", "go_beta", "nodejs_static", "python3_beta", "raku", "testj", "wasm", "java10_beta", "python_beta", "html_beta", "testj_beta", "scala", "riddlejs", "java_maven"]}
replit.json
audio
Enable/disable system-wide audio in REPL
{"type": "boolean"}
replit.json
packager
Universal Package Manager (UPM) configuration
{"type": "object", "properties": {"afterInstall": {"type": "string"}, "ignoredPaths": {"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}, "ignoredPackages": {"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}, "language": {"type": "string", "enum": ["python-python3-poetry", "python-python2-poetry", "nodejs-npm", "nodejs-yarn", "ruby-bundler", "elisp-cask", "dart-pub", "java-maven", "rlang", "dotnet", "rust"]}, "features": {"type": "object", "properties": {"packageSearch": {"type": "boolean"}, "guessImports": {"type": "boolean"}}, "additionalProperties": false}}, "additionalProperties": false}
replit.json
afterInstall
Command to run on new package install
{"type": "string"}
replit.json
ignoredPaths
List of ignored path
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}
replit.json
ignoredPackages
List of ignored packages
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}
replit.json
language
Language name
{"type": "string", "enum": ["python-python3-poetry", "python-python2-poetry", "nodejs-npm", "nodejs-yarn", "ruby-bundler", "elisp-cask", "dart-pub", "java-maven", "rlang", "dotnet", "rust"]}
replit.json
features
Universal Package Manager (UPM) features
{"type": "object", "properties": {"packageSearch": {"type": "boolean"}, "guessImports": {"type": "boolean"}}, "additionalProperties": false}
replit.json
packageSearch
Enable/disable package search panel
{"type": "boolean"}
replit.json
guessImports
Enable/disable guessing required packages
{"type": "boolean"}
replit.json
languages
Language configuration
{"type": "object", "patternProperties": {".": {"type": "object", "properties": {"glob": {"type": "string", "minLength": 1}, "languageServer": {"type": "object", "properties": {"start": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "additionalProperties": false}
replit.json
.
Language configuration
{"type": "object", "properties": {"glob": {"type": "string", "minLength": 1}, "languageServer": {"type": "object", "properties": {"start": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}
replit.json
glob
Glob for language files
{"type": "string", "minLength": 1}
replit.json
languageServer
Language Server Protocol (LSP) configuration
{"type": "object", "properties": {"start": {"type": "string"}}, "additionalProperties": false}
replit.json
start
Command to run server
{"type": "string"}
red_cog.schema.json
author
List of names of authors of the cog
{"type": "array", "items": {"type": "string"}}
red_cog.schema.json
description
A long description of the cog or repo. For cogs, this is displayed when a user executes [p]cog info.
{"type": "string"}
red_cog.schema.json
install_msg
The message that gets displayed when a cog is installed or a repo is added
{"type": "string"}
red_cog.schema.json
short
A short description of the cog or repo. For cogs, this info is displayed when a user executes [p]cog list
{"type": "string"}
red_cog.schema.json
end_user_data_statement
A statement explaining what end user data the cog is storing. This is displayed when a user executes [p]cog info. If the statement has changed since last update, user will be informed during the update.
{"type": "string"}
red_cog.schema.json
min_bot_version
Min version number of Red in the format MAJOR.MINOR.MICRO
{"type": "string", "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)((a|b|rc)(0|[1-9][0-9]*))?(\\.post(0|[1-9][0-9]*))?(\\.dev(0|[1-9][0-9]*))?$"}
red_cog.schema.json
max_bot_version
Max version number of Red in the format MAJOR.MINOR.MICRO, if min_bot_version is newer than max_bot_version, max_bot_version will be ignored
{"type": "string", "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)((a|b|rc)(0|[1-9][0-9]*))?(\\.post(0|[1-9][0-9]*))?(\\.dev(0|[1-9][0-9]*))?$"}
red_cog.schema.json
min_python_version
Min version number of Python in the format [MAJOR, MINOR, PATCH]
{"type": "array", "minItems": 3, "maxItems": 3, "items": {"type": "integer"}}
red_cog.schema.json
hidden
Determines if a cog is visible in the cog list for a repo.
{"type": "boolean"}
red_cog.schema.json
disabled
Determines if a cog is available for install.
{"type": "boolean"}
red_cog.schema.json
required_cogs
A dict of required cogs that this cog depends on in the format {cog_name : repo_url}. Downloader will not deal with this functionality but it may be useful for other cogs.
{"type": "object"}
red_cog.schema.json
requirements
List of required libraries that are passed to pip on cog install.
{"type": "array", "items": {"type": "string"}}
red_cog.schema.json
tags
A list of strings that are related to the functionality of the cog. Used to aid in searching.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
red_cog.schema.json
type
Optional, defaults to COG. Must be either COG or SHARED_LIBRARY. If SHARED_LIBRARY then hidden will be True.
{"type": "string", "enum": ["COG", "SHARED_LIBRARY"]}
solidaritySchema.json
A rule-set and config for the Solidarity JSON checker
{"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"cli": {"type": "object", "properties": {"rule": {"enum": ["cli"]}, "binary": {"type": "string"}, "semver": {"type": "string"}, "version": {"type": "string"}, "line": {"type": ["string", "integer"]}, "matchIndex": {"type": "integer"}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "binary"]}, "dir": {"type": "object", "properties": {"rule": {"enum": ["dir", "directory"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "location"]}, "file": {"type": "object", "properties": {"rule": {"enum": ["file"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "location"]}, "env": {"type": "object", "properties": {"rule": {"enum": ["env"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "variable"]}, "shell": {"type": "object", "properties": {"rule": {"enum": ["shell"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}, "match": {"type": "string"}}, "required": ["rule", "match"]}, "custom": {"type": "object", "additionalProperties": true, "properties": {"rule": {"enum": ["custom"]}, "plugin": {"type": "string"}, "name": {"type": "string"}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}, "match": {"type": "string"}}, "required": ["rule", "plugin", "name"]}}, "id": "https://json.schemastore.org/solidaritySchema.json", "properties": {"config": {"type": "object", "properties": {"output": {"type": "string", "enum": ["moderate", "verbose", "silent"]}}}, "requirements": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "object", "oneOf": [{}, {}, {}, {}, {}, {}]}, "minItems": 1, "uniqueItems": true}}}, "required": ["requirements"], "type": "object"}
solidaritySchema.json
cli
CLI Rule
{"type": "object", "properties": {"rule": {"enum": ["cli"]}, "binary": {"type": "string"}, "semver": {"type": "string"}, "version": {"type": "string"}, "line": {"type": ["string", "integer"]}, "matchIndex": {"type": "integer"}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "binary"]}
solidaritySchema.json
dir
Dir Rule
{"type": "object", "properties": {"rule": {"enum": ["dir", "directory"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "location"]}
solidaritySchema.json
file
File Rule
{"type": "object", "properties": {"rule": {"enum": ["file"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "location"]}
solidaritySchema.json
env
ENV Rule
{"type": "object", "properties": {"rule": {"enum": ["env"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}}, "required": ["rule", "variable"]}
solidaritySchema.json
shell
Shell Rule
{"type": "object", "properties": {"rule": {"enum": ["shell"]}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}, "match": {"type": "string"}}, "required": ["rule", "match"]}
solidaritySchema.json
match
A regexp to search the output.
{"type": "string"}
solidaritySchema.json
custom
Custom Rule
{"type": "object", "additionalProperties": true, "properties": {"rule": {"enum": ["custom"]}, "plugin": {"type": "string"}, "name": {"type": "string"}, "platform": {"enum": ["darwin", "macos", "freebsd", "linux", "sunos", "win32", "windows"]}, "error": {"type": "string"}, "ci": {"type": "boolean"}, "match": {"type": "string"}}, "required": ["rule", "plugin", "name"]}
solidaritySchema.json
match
A regexp to search the output.
{"type": "string"}
solidaritySchema.json
output
Identify what kind output should happen when a check is called
{"type": "string", "enum": ["moderate", "verbose", "silent"]}
solidaritySchema.json
requirements
List of requirement rules for your particular environment
{"type": "object", "additionalProperties": {"type": "array", "items": {"type": "object", "oneOf": [{}, {}, {}, {}, {}, {}]}, "minItems": 1, "uniqueItems": true}}
github-funding.json
You can add a sponsor button in your repository to increase the visibility of funding options for your open source project.
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"github_username": {"type": "string", "maxLength": 39, "pattern": "^[a-zA-Z0-9](-?[a-zA-Z0-9])*$", "examples": ["SampleUserName"]}, "nullable_string": {"type": ["string", "null"]}}, "properties": {"community_bridge": {"minLength": 1}, "github": {"oneOf": [{}, {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}]}, "issuehunt": {"minLength": 1}, "ko_fi": {"minLength": 1}, "liberapay": {"minLength": 1}, "open_collective": {"minLength": 1}, "otechie": {"minLength": 1}, "patreon": {"minLength": 1, "maxLength": 100}, "tidelift": {"pattern": "^(npm|pypi|rubygems|maven|packagist|nuget)/.+$"}, "custom": {"type": ["string", "array", "null"], "format": "uri-reference", "items": {"type": "string", "format": "uri-reference"}, "uniqueItems": true}}, "type": "object"}
github-funding.json
community_bridge
Project name on CommunityBridge.
{"minLength": 1}
github-funding.json
github
Username or usernames on GitHub.
{"oneOf": [{}, {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}]}
github-funding.json
issuehunt
Username on IssueHunt.
{"minLength": 1}
github-funding.json
ko_fi
Username on Ko-fi.
{"minLength": 1}
github-funding.json
liberapay
Username on Liberapay.
{"minLength": 1}
github-funding.json
open_collective
Username on Open Collective.
{"minLength": 1}
github-funding.json
otechie
Username on Otechie.
{"minLength": 1}
github-funding.json
patreon
Username on Pateron.
{"minLength": 1, "maxLength": 100}
github-funding.json
tidelift
Platform and package on Tidelift.
{"pattern": "^(npm|pypi|rubygems|maven|packagist|nuget)/.+$"}
github-funding.json
custom
Link or links where funding is accepted on external locations.
{"type": ["string", "array", "null"], "format": "uri-reference", "items": {"type": "string", "format": "uri-reference"}, "uniqueItems": true}
github-funding.json
items
Link to an external location.
{"type": "string", "format": "uri-reference"}
azure-deviceupdate-update-manifest-5.json
JSON schema of update manifest sent by Device Update for IoT Hub to device agent during deployment.
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"miniUpdateManifest": {"type": "object", "properties": {"detachedManifestFileId": {}, "files": {"type": "object", "additionalProperties": {}, "minProperties": 1, "maxProperties": 1}}, "required": ["detachedManifestFileId", "files"]}, "fullUpdateManifest": {"type": "object", "properties": {"compatibility": {}, "instructions": {"type": "object", "properties": {"steps": {"type": "array", "items": {"anyOf": [{}, {}]}, "minItems": 1, "maxItems": 10}}, "required": ["steps"]}, "files": {"type": "object", "additionalProperties": {}, "minProperties": 1, "maxProperties": 20}, "createdDateTime": {"type": "string", "examples": ["2020-10-02T22:18:04.9446744Z"]}}, "required": ["compatibility", "instructions", "files", "createdDateTime"]}, "fileId": {"type": "string", "minLength": 1}, "inlineStep": {"type": "object", "properties": {"type": {}, "handler": {}, "files": {"type": "array", "items": {}, "minItems": 1, "maxItems": 10}, "handlerProperties": {}}, "additionalProperties": false, "required": ["handler", "files"]}, "referenceStep": {"type": "object", "properties": {"type": {}, "detachedManifestFileId": {}}, "additionalProperties": false, "required": ["type", "detachedManifestFileId"]}}, "examples": [{"manifestVersion": "4", "updateId": {"provider": "Microsoft", "name": "Toaster", "version": "1.0"}, "compatibility": [{"deviceManufacturer": "Microsoft", "deviceModel": "Toaster"}], "instructions": {"steps": [{"handler": "microsoft/script:1", "handlerProperties": {"arguments": "--pre-install"}, "files": ["fileId0"]}, {"type": "reference", "detachedManifestFileId": "fileId1"}]}, "files": {"fileId0": {"filename": "configure.sh", "sizeInBytes": 718, "hashes": {"sha256": "mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="}, "relatedFiles": [{"filename": "in1_in2_deltaupdate.dat", "sizeInBytes": 102910752, "hashes": {"sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="}, "properties": {"microsoft.sourceFileHashAlgorithm": "sha256", "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="}}], "downloadHandler": {"id": "microsoft/delta:1"}}, "fileId1": {"filename": "microsoft.sensor.1.0.updatemanifest.json", "sizeInBytes": 2048, "hashes": {"sha256": "789s9PDfX4uA9wFUubyC30BWkLFbgmpkpmz1fEdqo2U="}}}, "createdDateTime": "2021-09-28T18:32:01.8404544Z"}], "oneOf": [{}, {}], "properties": {"$schema": {"type": "string"}, "updateId": {}, "manifestVersion": {"type": "string", "const": "4"}}, "required": ["updateId", "manifestVersion"], "type": "object"}
azure-deviceupdate-update-manifest-5.json
miniUpdateManifest
Manifest containing metadata of the detached, downloadable, complete update manifest.
{"type": "object", "properties": {"detachedManifestFileId": {}, "files": {"type": "object", "additionalProperties": {}, "minProperties": 1, "maxProperties": 1}}, "required": ["detachedManifestFileId", "files"]}
azure-deviceupdate-update-manifest-5.json
files
Map of '#/definitions/fileId' to file metadata.
{"type": "object", "additionalProperties": {}, "minProperties": 1, "maxProperties": 1}
azure-deviceupdate-update-manifest-5.json
fullUpdateManifest
Full update manifest containing metadata of the update being deployed.
{"type": "object", "properties": {"compatibility": {}, "instructions": {"type": "object", "properties": {"steps": {"type": "array", "items": {"anyOf": [{}, {}]}, "minItems": 1, "maxItems": 10}}, "required": ["steps"]}, "files": {"type": "object", "additionalProperties": {}, "minProperties": 1, "maxProperties": 20}, "createdDateTime": {"type": "string", "examples": ["2020-10-02T22:18:04.9446744Z"]}}, "required": ["compatibility", "instructions", "files", "createdDateTime"]}
azure-deviceupdate-update-manifest-5.json
files
Map of '#/definitions/fileId' to file metadata.
{"type": "object", "additionalProperties": {}, "minProperties": 1, "maxProperties": 20}
azure-deviceupdate-update-manifest-5.json
createdDateTime
Date & time update was created in ISO 8601 format.
{"type": "string", "examples": ["2020-10-02T22:18:04.9446744Z"]}
azure-deviceupdate-update-manifest-5.json
fileId
Server generated file identifier to be used for retrieving file metadata and download URL.
{"type": "string", "minLength": 1}
azure-deviceupdate-update-manifest-5.json
inlineStep
Installation instruction step that performs code execution.
{"type": "object", "properties": {"type": {}, "handler": {}, "files": {"type": "array", "items": {}, "minItems": 1, "maxItems": 10}, "handlerProperties": {}}, "additionalProperties": false, "required": ["handler", "files"]}
azure-deviceupdate-update-manifest-5.json
files
'fileId' of update files that agent will pass to handler.
{"type": "array", "items": {}, "minItems": 1, "maxItems": 10}
azure-deviceupdate-update-manifest-5.json
referenceStep
Installation instruction step that installs another update.
{"type": "object", "properties": {"type": {}, "detachedManifestFileId": {}}, "additionalProperties": false, "required": ["type", "detachedManifestFileId"]}
azure-deviceupdate-update-manifest-5.json
$schema
JSON schema reference
{"type": "string"}
winget-pkgs-locale-1.0.0.json
A representation of a multiple-file manifest representing app metadata in other locale in the OWC. v1.0.0
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"Url": {"type": ["string", "null"], "pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$", "maxLength": 2000}, "Tag": {"type": ["string", "null"], "minLength": 1, "maxLength": 40}}, "properties": {"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}, "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", "null"], "minLength": 2, "maxLength": 256}, "PublisherUrl": {}, "PublisherSupportUrl": {}, "PrivacyUrl": {}, "Author": {"type": ["string", "null"], "minLength": 2, "maxLength": 256}, "PackageName": {"type": ["string", "null"], "minLength": 2, "maxLength": 256}, "PackageUrl": {}, "License": {"type": ["string", "null"], "minLength": 3, "maxLength": 512}, "LicenseUrl": {}, "Copyright": {"type": ["string", "null"], "minLength": 3, "maxLength": 512}, "CopyrightUrl": {}, "ShortDescription": {"type": ["string", "null"], "minLength": 3, "maxLength": 256}, "Moniker": {}, "Tags": {"type": ["array", "null"], "items": {}, "maxItems": 16, "uniqueItems": true}, "ManifestType": {"type": "string", "default": "locale", "const": "locale"}, "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", "ManifestType", "ManifestVersion"], "type": "object"}
winget-pkgs-locale-1.0.0.json
Url
Optional Url type
{"type": ["string", "null"], "pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$", "maxLength": 2000}
winget-pkgs-locale-1.0.0.json
Tag
Package moniker or tag
{"type": ["string", "null"], "minLength": 1, "maxLength": 40}
winget-pkgs-locale-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-locale-1.0.0.json
PackageVersion
The package version
{"type": "string", "pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$", "maxLength": 128}
winget-pkgs-locale-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-locale-1.0.0.json
Publisher
The publisher name
{"type": ["string", "null"], "minLength": 2, "maxLength": 256}
winget-pkgs-locale-1.0.0.json
PublisherUrl
The publisher home page
{}
winget-pkgs-locale-1.0.0.json
PublisherSupportUrl
The publisher support page
{}
winget-pkgs-locale-1.0.0.json
PrivacyUrl
The publisher privacy page or the package privacy page
{}
winget-pkgs-locale-1.0.0.json
Author
The package author
{"type": ["string", "null"], "minLength": 2, "maxLength": 256}
winget-pkgs-locale-1.0.0.json
PackageName
The package name
{"type": ["string", "null"], "minLength": 2, "maxLength": 256}
winget-pkgs-locale-1.0.0.json
PackageUrl
The package home page
{}
winget-pkgs-locale-1.0.0.json
License
The package license
{"type": ["string", "null"], "minLength": 3, "maxLength": 512}
winget-pkgs-locale-1.0.0.json
LicenseUrl
The license page
{}
winget-pkgs-locale-1.0.0.json
Copyright
The package copyright
{"type": ["string", "null"], "minLength": 3, "maxLength": 512}
winget-pkgs-locale-1.0.0.json
CopyrightUrl
The package copyright page
{}
winget-pkgs-locale-1.0.0.json
ShortDescription
The short package description
{"type": ["string", "null"], "minLength": 3, "maxLength": 256}
winget-pkgs-locale-1.0.0.json
Description
The full package description
{"type": ["string", "null"], "minLength": 3, "maxLength": 10000}
winget-pkgs-locale-1.0.0.json
Moniker
The most common package term
{}
winget-pkgs-locale-1.0.0.json
Tags
List of additional package search terms
{"type": ["array", "null"], "items": {}, "maxItems": 16, "uniqueItems": true}
winget-pkgs-locale-1.0.0.json
ManifestType
The manifest type
{"type": "string", "default": "locale", "const": "locale"}
winget-pkgs-locale-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}$"}
azure-deviceupdate-import-manifest-5.0.json
Schema for import manifest used for importing an update to Device Update for IoT Hub.
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"instructions": {"type": "object", "properties": {"steps": {"type": "array", "items": {"anyOf": [{}, {}]}, "minItems": 1, "maxItems": 10}}, "additionalProperties": false, "required": ["steps"]}, "stepDescription": {"type": "string", "minLength": 1, "maxLength": 64}, "inlineStep": {"type": "object", "properties": {"type": {}, "handler": {}, "files": {"type": "array", "items": {}, "minItems": 1, "maxItems": 10}, "handlerProperties": {}}, "additionalProperties": false, "required": ["handler", "files"]}, "referenceStep": {"type": "object", "properties": {"type": {}, "updateId": {}}, "additionalProperties": false, "required": ["type", "updateId"]}}, "examples": [{"updateId": {"provider": "Microsoft", "name": "Toaster", "version": "1.0"}, "compatibility": [{"deviceManufacturer": "Microsoft", "deviceModel": "Toaster"}], "instructions": {"steps": [{"handler": "microsoft/script:1", "handlerProperties": {"arguments": "--pre-install"}, "files": ["configure.sh"]}, {"type": "reference", "updateId": {"provider": "Microsoft", "name": "Sensor", "version": "1.0"}}]}, "files": [{"filename": "configure.sh", "sizeInBytes": 718, "hashes": {"sha256": "mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="}, "relatedFiles": [{"filename": "in1_in2_deltaupdate.dat", "sizeInBytes": 102910752, "hashes": {"sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="}, "properties": {"microsoft.sourceFileHashAlgorithm": "sha256", "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="}}], "downloadHandler": {"id": "microsoft/delta:1"}}], "manifestVersion": "5.0", "createdDateTime": "2020-10-02T22:18:04.9446744Z"}], "properties": {"$schema": {"type": "string"}, "updateId": {}, "compatibility": {}, "instructions": {}, "files": {"type": "array", "items": {}, "minItems": 0, "maxItems": 10}, "manifestVersion": {"type": "string", "const": "5.0"}, "createdDateTime": {"type": "string", "examples": ["2020-10-02T22:18:04.9446744Z"]}}, "required": ["updateId", "compatibility", "instructions", "manifestVersion", "createdDateTime"], "type": "object"}
azure-deviceupdate-import-manifest-5.0.json
instructions
Update installation instructions.
{"type": "object", "properties": {"steps": {"type": "array", "items": {"anyOf": [{}, {}]}, "minItems": 1, "maxItems": 10}}, "additionalProperties": false, "required": ["steps"]}
azure-deviceupdate-import-manifest-5.0.json
stepDescription
Optional instruction step description.
{"type": "string", "minLength": 1, "maxLength": 64}
azure-deviceupdate-import-manifest-5.0.json
inlineStep
Installation instruction step that performs code execution.
{"type": "object", "properties": {"type": {}, "handler": {}, "files": {"type": "array", "items": {}, "minItems": 1, "maxItems": 10}, "handlerProperties": {}}, "additionalProperties": false, "required": ["handler", "files"]}
azure-deviceupdate-import-manifest-5.0.json
files
Names of update files that agent will pass to handler.
{"type": "array", "items": {}, "minItems": 1, "maxItems": 10}
azure-deviceupdate-import-manifest-5.0.json
referenceStep
Installation instruction step that installs another update.
{"type": "object", "properties": {"type": {}, "updateId": {}}, "additionalProperties": false, "required": ["type", "updateId"]}
azure-deviceupdate-import-manifest-5.0.json
examples
Example update
{"updateId": {"provider": "Microsoft", "name": "Toaster", "version": "1.0"}, "compatibility": [{"deviceManufacturer": "Microsoft", "deviceModel": "Toaster"}], "instructions": {"steps": [{"handler": "microsoft/script:1", "handlerProperties": {"arguments": "--pre-install"}, "files": ["configure.sh"]}, {"type": "reference", "updateId": {"provider": "Microsoft", "name": "Sensor", "version": "1.0"}}]}, "files": [{"filename": "configure.sh", "sizeInBytes": 718, "hashes": {"sha256": "mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="}, "relatedFiles": [{"filename": "in1_in2_deltaupdate.dat", "sizeInBytes": 102910752, "hashes": {"sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="}, "properties": {"microsoft.sourceFileHashAlgorithm": "sha256", "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="}}], "downloadHandler": {"id": "microsoft/delta:1"}}], "manifestVersion": "5.0", "createdDateTime": "2020-10-02T22:18:04.9446744Z"}
azure-deviceupdate-import-manifest-5.0.json
steps
pre-install script
{"handler": "microsoft/script:1", "handlerProperties": {"arguments": "--pre-install"}, "files": ["configure.sh"]}
azure-deviceupdate-import-manifest-5.0.json
$schema
JSON schema reference.
{"type": "string"}