schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
mtad.json
properties
A collection of key-value pairs that will be inherited by all resources of this type.
{"type": "object"}
mtad.json
properties-metadata
Additional information about the resource type's properties.
{}
mtad.json
parameters
Configuration parameters that will be inherited in all resources of this type.
{"type": "object"}
mtad.json
parameters-metadata
Additional information about the resource's parameters.
{}
uplugin.json
Descriptor for plugins. Contains all the information contained within a `.uplugin` file.
{"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {"BuildConfiguration": {"type": "string", "enum": ["Unknown", "Debug", "DebugGame", "Development", "Shipping", "Test"]}, "BuildTargetType": {"type": "string", "enum": ["Unknown", "Game", "Server", "Client", "Editor", "Program"]}, "ModuleDescriptor": {"type": "object", "properties": {"AdditionalDependencies": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "LoadingPhase": {"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "Type": {"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}}}, "PluginReferenceDescriptor": {"type": "object", "properties": {"Enabled": {"type": "boolean", "default": true}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "Optional": {"type": "boolean", "default": false}, "MarketplaceURL": {"type": "string"}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}}, "required": ["Enabled", "Name"]}}, "id": "https://json.schemastore.org/uplugin.json", "properties": {"CanContainContent": {"type": "boolean", "default": false}, "CanContainVerse": {"type": "boolean", "default": false}, "ExplicitlyLoaded": {"type": "boolean", "default": false}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "Installed": {"type": "boolean", "default": false}, "IsBetaVersion": {"type": "boolean", "default": false}, "IsExperimentalVersion": {"type": "boolean", "default": false}, "IsHidden": {"type": "boolean", "default": false}, "IsPluginExtension": {"type": "boolean", "default": false}, "RequiresBuildPlatform": {"type": "boolean", "default": false}, "Category": {"type": "string", "default": "Other"}, "CreatedBy": {"type": "string"}, "CreatedByURL": {"type": "string"}, "DocsURL": {"type": "string"}, "EditorCustomVirtualPath": {"type": "string"}, "EnabledByDefault": {"type": "string", "enum": ["Unspecified", "Enabled", "Disabled"]}, "EngineVersion": {"type": "string"}, "FileVersion": {"type": "number", "default": 3}, "FriendlyName": {"type": "string"}, "LocalizationTargets": {"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["LoadingPolicy", "Name"], "properties": {"LoadingPolicy": {"type": "string", "enum": ["Never", "Always", "Editor", "Game", "PropertyNames", "ToolTips", "Max"]}, "Name": {"type": "string"}}}}, "MarketplaceURL": {"type": "string"}, "Modules": {"type": "array", "uniqueItems": true, "items": {}}, "ParentPluginName": {"type": "string"}, "Plugins": {"type": "array", "uniqueItems": true, "items": {}}, "PostBuildSteps": {"type": "object"}, "PreBuildSteps": {"type": "object"}, "SupportedPrograms": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "SupportedTargetPlatforms": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "SupportURL": {"type": "string"}, "Version": {"type": "number", "default": 1}, "VersionName": {"type": "string", "default": "1.0"}}, "required": ["FileVersion"], "type": "object"}
uplugin.json
BuildConfiguration
Available build configurations. Mirorred from `UnrealTargetConfiguration`.
{"type": "string", "enum": ["Unknown", "Debug", "DebugGame", "Development", "Shipping", "Test"]}
uplugin.json
BuildTargetType
Enumerates build target types.
{"type": "string", "enum": ["Unknown", "Game", "Server", "Client", "Editor", "Program"]}
uplugin.json
ModuleDescriptor
Description of a loadable module.
{"type": "object", "properties": {"AdditionalDependencies": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "LoadingPhase": {"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "ProgramDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "Type": {"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}}}
uplugin.json
AdditionalDependencies
List of additional dependencies for building this module.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
HasExplicitPlatforms
When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions
{"type": "boolean", "default": false}
uplugin.json
LoadingPhase
When should the module be loaded during the startup sequence? This is sort of an advanced setting.
{"type": "string", "enum": ["EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max"]}
uplugin.json
Name
Name of this module
{"type": "string"}
uplugin.json
PlatformAllowList
List of allowed platforms
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
PlatformDenyList
List of disallowed platforms
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
ProgramAllowList
List of allowed programs
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
ProgramDenyList
List of disallowed programs
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
TargetAllowList
List of allowed targets
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
TargetConfigurationAllowList
List of allowed target configurations
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
TargetConfigurationDenyList
List of disallowed target configurations
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
TargetDenyList
List of disallowed targets
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
Type
Usage type of module
{"type": "string", "enum": ["Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max"]}
uplugin.json
PluginReferenceDescriptor
Descriptor for a plugin reference.
{"type": "object", "properties": {"Enabled": {"type": "boolean", "default": true}, "HasExplicitPlatforms": {"type": "boolean", "default": false}, "Optional": {"type": "boolean", "default": false}, "MarketplaceURL": {"type": "string"}, "Name": {"type": "string"}, "PlatformAllowList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "PlatformDenyList": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "TargetAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationAllowList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetConfigurationDenyList": {"type": "array", "uniqueItems": true, "items": {}}, "TargetDenyList": {"type": "array", "uniqueItems": true, "items": {}}}, "required": ["Enabled", "Name"]}
uplugin.json
Enabled
Whether it should be enabled by default
{"type": "boolean", "default": true}
uplugin.json
HasExplicitPlatforms
When true, empty `SupportedTargetPlatforms` and `PlatformAllowList` are interpreted as *no platforms* with the expectation that explicit platforms will be added in plugin platform extensions
{"type": "boolean", "default": false}
uplugin.json
Optional
Whether this plugin is optional, and the game should silently ignore it not being present
{"type": "boolean", "default": false}
uplugin.json
Description
Description of the plugin for users that do not have it installed.
{"type": "string"}
uplugin.json
MarketplaceURL
URL for this plugin on the marketplace, if the user doesn't have it installed.
{"type": "string"}
uplugin.json
Name
Name of the plugin
{"type": "string"}
uplugin.json
PlatformAllowList
List of allowed platforms
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
PlatformDenyList
List of disallowed platforms
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
TargetAllowList
List of allowed targets
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
TargetConfigurationAllowList
List of allowed target configurations
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
TargetConfigurationDenyList
List of disallowed target configurations
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
TargetDenyList
List of disallowed targets
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
CanContainContent
Can this plugin contain content?
{"type": "boolean", "default": false}
uplugin.json
CanContainVerse
Can this plugin contain Verse code?
{"type": "boolean", "default": false}
uplugin.json
ExplicitlyLoaded
When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically.
{"type": "boolean", "default": false}
uplugin.json
HasExplicitPlatforms
When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions
{"type": "boolean", "default": false}
uplugin.json
Installed
Signifies that the plugin was installed on top of the engine
{"type": "boolean", "default": false}
uplugin.json
IsBetaVersion
Marks the plugin as beta in the UI
{"type": "boolean", "default": false}
uplugin.json
IsExperimentalVersion
Marks the plugin as experimental in the UI
{"type": "boolean", "default": false}
uplugin.json
IsHidden
For auto-generated plugins that should not be listed in the plugin browser for users to disable freely.
{"type": "boolean", "default": false}
uplugin.json
IsPluginExtension
If true, this plugin from a platform extension extending another plugin
{"type": "boolean", "default": false}
uplugin.json
RequiresBuildPlatform
For plugins that are under a platform folder (eg. /PS4/), determines whether compiling the plugin requires the build platform and/or SDK to be available
{"type": "boolean", "default": false}
uplugin.json
Category
The name of the category this plugin
{"type": "string", "default": "Other"}
uplugin.json
CreatedBy
The company or individual who created this plugin.
{"type": "string"}
uplugin.json
CreatedByURL
Hyperlink URL string for the company or individual who created this plugin. This is optional.
{"type": "string"}
uplugin.json
Description
Description of the plugin
{"type": "string"}
uplugin.json
DocsURL
Documentation URL string.
{"type": "string"}
uplugin.json
EditorCustomVirtualPath
Optional custom virtual path to display in editor to better organize.
{"type": "string"}
uplugin.json
EnabledByDefault
Whether this plugin should be enabled by default for all projects
{"type": "string", "enum": ["Unspecified", "Enabled", "Disabled"]}
uplugin.json
EngineVersion
Version of the engine that this plugin is compatible with
{"type": "string"}
uplugin.json
FileVersion
Descriptor version number.
{"type": "number", "default": 3}
uplugin.json
FriendlyName
Friendly name of the plugin
{"type": "string"}
uplugin.json
LocalizationTargets
List of all localization targets associated with this plugin
{"type": "array", "uniqueItems": true, "items": {"type": "object", "required": ["LoadingPolicy", "Name"], "properties": {"LoadingPolicy": {"type": "string", "enum": ["Never", "Always", "Editor", "Game", "PropertyNames", "ToolTips", "Max"]}, "Name": {"type": "string"}}}}
uplugin.json
LoadingPolicy
When should the localization data associated with a target should be loaded?
{"type": "string", "enum": ["Never", "Always", "Editor", "Game", "PropertyNames", "ToolTips", "Max"]}
uplugin.json
Name
Name of this target
{"type": "string"}
uplugin.json
MarketplaceURL
Marketplace URL for this plugin.
{"type": "string"}
uplugin.json
Modules
List of all modules associated with this plugin
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
ParentPluginName
If specified, this is the real plugin that this one is just extending
{"type": "string"}
uplugin.json
Plugins
Plugins used by this plugin
{"type": "array", "uniqueItems": true, "items": {}}
uplugin.json
PostBuildSteps
Post-build steps for each host platform
{"type": "object"}
uplugin.json
PreBuildSteps
Pre-build steps for each host platform
{"type": "object"}
uplugin.json
SupportedPrograms
List of programs that are supported by this plugin.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
SupportedTargetPlatforms
Controls a subset of platforms that can use this plugin, and which ones will stage the `.uplugin` file and content files.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
uplugin.json
SupportURL
Support URL/email for this plugin.
{"type": "string"}
uplugin.json
Version
Version number for the plugin.
{"type": "number", "default": 1}
uplugin.json
VersionName
Name of the version for this plugin.
{"type": "string", "default": "1.0"}
creatomic.json
tslint.enable
Control whether tslint is enabled for TypeScript files or not.
{"type": "boolean", "default": true}
creatomic.json
tslint.jsEnable
Control whether tslint is enabled for JavaScript files or not.
{"type": "boolean", "default": false, "scope": "resource"}
creatomic.json
tslint.rulesDirectory
An additional rules directory
{"type": ["string", "array"], "items": {"type": "string"}, "default": "", "scope": "resource"}
creatomic.json
tslint.validateWithDefaultConfig
Validate a file when there is only a default tslint configuration is found
{"type": "boolean", "default": false, "scope": "resource"}
creatomic.json
tslint.configFile
The path to the rules configuration file
{"type": "string", "default": "", "scope": "resource"}
creatomic.json
tslint.ignoreDefinitionFiles
Control if TypeScript definition files should be ignored
{"type": "boolean", "default": true, "scope": "resource"}
creatomic.json
tslint.exclude
Configure glob patterns of file paths to exclude from linting
{"type": ["string", "array"], "items": {"type": "string"}, "scope": "resource"}
creatomic.json
tslint.run
Run the linter on save (onSave) or on type (onType)
{"type": "string", "enum": ["onSave", "onType"], "default": "onType", "scope": "window"}
creatomic.json
tslint.nodePath
A path added to NODE_PATH when resolving the tslint module.
{"type": "string", "default": "", "scope": "resource"}
creatomic.json
tslint.autoFixOnSave
Turns auto fix on save on or off, or defines which rules (e.g. `no-var-keyword`) to auto fix on save.
{"type": ["boolean", "array"], "items": {"type": "string"}, "default": false, "scope": "resource"}
creatomic.json
tslint.alwaysShowRuleFailuresAsWarnings
Always show rule failures as warnings, independent of the tslint configuration.
{"type": "boolean", "default": false, "scope": "resource"}
artifacthub-repo.json
repositoryID
An identifier of the Artifact Hub repository where the packages will be published to
{"type": "string", "format": "uuid"}
artifacthub-repo.json
owners
Repository owners
{"type": "array", "uniqueItems": true, "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "email": {"type": "string", "format": "email"}}}}
artifacthub-repo.json
items
A repository owner
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "email": {"type": "string", "format": "email"}}}
artifacthub-repo.json
name
A repository owner name
{"type": "string"}
artifacthub-repo.json
email
A repository owner email
{"type": "string", "format": "email"}
artifacthub-repo.json
ignore
Packages that should not be indexed by Artifact Hub
{"type": "array", "uniqueItems": true, "items": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "version": {"type": "string"}}}}
artifacthub-repo.json
items
A package
{"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "version": {"type": "string"}}}
artifacthub-repo.json
name
A package name
{"type": "string"}
artifacthub-repo.json
version
Regular expression
{"type": "string"}
fossa-deps.schema.json
fossa-deps for dependency specification for FOSSA CLI
{"$schema": "http://json-schema.org/draft-07/schema#", "$defs": {"os": {"enum": ["alpine", "centos", "debian", "redhat", "ubuntu", "oraclelinux", "busybox", "sles", "fedora"]}, "referenced-app-dependency": {"properties": {"name": {"type": "string", "minLength": 1}, "type": {"enum": ["bower", "cargo", "carthage", "composer", "cpan", "renv", "gem", "git", "go", "hackage", "hex", "maven", "npm", "nuget", "paket", "pub", "pypi", "cocoapods", "swift", "url"]}, "version": {"type": "string"}}, "required": ["name", "type"], "additionalProperties": false}, "referenced-apk-deb-dependency": {"properties": {"name": {"type": "string", "minLength": 1}, "type": {"enum": ["apk", "deb"]}, "version": {"type": "string"}, "arch": {"type": "string", "minLength": 1}, "os": {}, "osVersion": {"type": "string", "minLength": 1}}, "required": ["name", "type", "arch", "os", "osVersion"], "additionalProperties": false}, "referenced-rpm-dependency": {"properties": {"name": {"type": "string", "minLength": 1}, "type": {"enum": ["rpm-generic"]}, "version": {"type": "string"}, "arch": {"type": "string", "minLength": 1}, "epoch": {"type": "string", "minLength": 1}, "os": {}, "osVersion": {"type": "string", "minLength": 1}}, "required": ["name", "type", "arch", "os", "osVersion"], "additionalProperties": false}, "referenced-dependency": {"oneOf": [{}, {}, {}]}, "custom-dependency": {"properties": {"name": {"type": "string", "minLength": 1}, "version": {"type": "string", "minLength": 1}, "license": {"type": "string", "minLength": 1}, "metadata": {"type": "object", "properties": {"homepage": {"type": "string"}}}}, "required": ["name", "version", "license"], "additionalProperties": false}, "vendored-dependency": {"properties": {"name": {"type": "string", "minLength": 1}, "path": {"type": "string", "minLength": 1}, "version": {"type": "string"}}, "required": ["name", "path"], "additionalProperties": false}, "remote-dependency": {"properties": {"name": {"type": "string", "minLength": 1}, "url": {"type": "string", "minLength": 1}, "version": {"type": "string"}, "metadata": {"type": "object", "properties": {"homepage": {"type": "string"}}}}, "required": ["name", "url", "version"], "additionalProperties": false}}, "type": "object", "properties": {"version": {"type": "integer"}, "referenced-dependencies": {"type": "array", "items": {}}, "custom-dependencies": {"type": "array", "items": {}}, "vendored-dependencies": {"type": "array", "items": {}}, "remote-dependencies": {"type": "array", "items": {}}}, "required": []}
fossa-deps.schema.json
os
Name of the distribution OS.
{"enum": ["alpine", "centos", "debian", "redhat", "ubuntu", "oraclelinux", "busybox", "sles", "fedora"]}
fossa-deps.schema.json
name
Name of the dependency. This name will be used to search for dependency in relevant registries.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
type
Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution.
{"enum": ["bower", "cargo", "carthage", "composer", "cpan", "renv", "gem", "git", "go", "hackage", "hex", "maven", "npm", "nuget", "paket", "pub", "pypi", "cocoapods", "swift", "url"]}
fossa-deps.schema.json
version
Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used.
{"type": "string"}
fossa-deps.schema.json
name
Name of the dependency. This name will be used to search for dependency in relevant registries.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
type
Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution.
{"enum": ["apk", "deb"]}
fossa-deps.schema.json
version
Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used.
{"type": "string"}
fossa-deps.schema.json
arch
Architecture associated with this package
{"type": "string", "minLength": 1}
fossa-deps.schema.json
osVersion
Version of the distribution OS.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
name
Name of the dependency. This name will be used to search for dependency in relevant registries.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
type
Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution.
{"enum": ["rpm-generic"]}