schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
hws-config.json
timeout
Sets how long until the WMI request times out (Default: 120s).
{"default": "120s"}
hws-config.json
username
Sets the username used to establish the connection with the host through the WMI protocol.
{"type": "string"}
hws-config.json
jobPoolSize
Sets the number of jobs that Hardware Sentry can run simultaneously (Default: 20).
{"type": "integer", "default": "20"}
hws-config.json
loggerLevel
Enables the debug mode of the core engine (Default: off).
{}
hws-config.json
otelCollector
Customizes the OpenTelemetry Collector sub-process.
{"type": "object", "properties": {"commandLine": {"type": "array", "items": {"type": "string"}}, "environment": {}, "output": {"type": "string", "enum": ["log", "console", "silent"], "default": "log"}, "workingDir": {"type": "string"}, "disabled": {"type": "boolean", "default": false}}}
hws-config.json
commandLine
Overrides the OpenTelemetry Collector command line.
{"type": "array", "items": {"type": "string"}}
hws-config.json
environment
Configures the OpenTelemetry Collector environment variables.
{}
hws-config.json
output
Configures where to print the OpenTelemetry Collector's output (Default: log).
{"type": "string", "enum": ["log", "console", "silent"], "default": "log"}
hws-config.json
workingDir
Configures the working directory of the OpenTelemetry Collector.
{"type": "string"}
hws-config.json
disabled
Disables the OpenTelemetry Collector (Default: false).
{"type": "boolean", "default": false}
hws-config.json
outputDirectory
Sets the debug output directory for all the monitored hosts. By default, the debug output files are saved in the `logs` directory under the Hardware Sentry's home directory.
{}
hws-config.json
resolveHostnameToFqdn
Displays the configured hostname in the Host Resource `host.name` attribute instead of the resolved FQDN (Default: false).
{"type": "boolean", "default": false}
hws-config.json
sequential
Forces all the network calls to be executed in sequential order for all the monitored hosts - NOT RECOMMENDED (Default: false).
{}
event-horizons.json
The event horizons configuration
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "definitions": {"eventHorizonConfiguration": {"type": "object", "properties": {"application": {"type": "string"}, "boundedContext": {"type": "string"}, "url": {"type": "string", "format": "uri-reference"}, "events": {"type": "array", "items": {}}}, "required": ["application", "boundedContext", "url", "events"]}, "artifact": {"properties": {"id": {"type": "string"}, "generation": {"type": "number"}}, "required": ["id", "generation"]}}}
event-horizons.json
eventHorizonConfiguration
The configuration of an event horizon
{"type": "object", "properties": {"application": {"type": "string"}, "boundedContext": {"type": "string"}, "url": {"type": "string", "format": "uri-reference"}, "events": {"type": "array", "items": {}}}, "required": ["application", "boundedContext", "url", "events"]}
event-horizons.json
application
The application id of the application which the bounded context you want to communicate belongs to
{"type": "string"}
event-horizons.json
boundedContext
The bounded context id you wish to penetrate to
{"type": "string"}
event-horizons.json
url
The url where the other bounded context's event horizon lives
{"type": "string", "format": "uri-reference"}
event-horizons.json
events
An array of event artifacts that this bounded context is interested in
{"type": "array", "items": {}}
event-horizons.json
artifact
The configuration of an artifact
{"properties": {"id": {"type": "string"}, "generation": {"type": "number"}}, "required": ["id", "generation"]}
event-horizons.json
id
The artifact id
{"type": "string"}
event-horizons.json
generation
The artifact generation
{"type": "number"}
vsls.json
excludeFiles
An array of globs which indicate the files that should be completely unavailable to guests when you share (e.g. secrets).
{"type": "array", "items": {"type": "string"}}
vsls.json
gitignore
Indicates how .gitignore files should be treated with respects to excluding/hiding files from guests.
{"type": "string", "default": "hide", "enum": ["none", "hide", "exclude"]}
vsls.json
hideFiles
An array of globs which indicate the files that should be hidden from guest's file trees, but still accessible (e.g. when following the host).
{"type": "array", "items": {"type": "string"}}
codeclimate.json
Configuration file as an alternative for configuring your repository in the settings page.
{"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"enabled": {"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}}}, "config": {"type": "object"}, "threshold": {"type": ["integer", "null"]}}, "id": "https://json.schemastore.org/codeclimate.json", "properties": {"version": {"type": "string", "default": "2"}, "prepare": {"type": "array", "items": {"type": "object", "properties": {"url": {"type": "string", "format": "uri"}, "path": {"type": "string"}}}}, "checks": {"type": "object", "properties": {"argument-count": {"properties": {"config": {"properties": {"threshold": {"default": 4}}}}}, "complex-logic": {"properties": {"config": {"properties": {"threshold": {"default": 4}}}}}, "file-lines": {"properties": {"config": {"properties": {"threshold": {"default": 250}}}}}, "method-complexity": {"properties": {"config": {"properties": {"threshold": {"default": 5}}}}}, "method-count": {"properties": {"config": {"properties": {"threshold": {"default": 20}}}}}, "method-lines": {"properties": {"config": {"properties": {"threshold": {"default": 25}}}}}, "nested-control-flow": {"properties": {"config": {"properties": {"threshold": {"default": 4}}}}}, "return-statements": {"properties": {"config": {"properties": {"threshold": {"default": 4}}}}}, "similar-code": {"properties": {"config": {"properties": {"threshold": {}}}}}, "identical-code": {"properties": {"config": {"properties": {"threshold": {}}}}}}}, "plugins": {"type": "object", "additionalProperties": {}}, "exclude_patterns": {"type": "array", "items": {"type": "string"}}}, "type": "object"}
codeclimate.json
version
Required to adjust maintainability checks.
{"type": "string", "default": "2"}
codeclimate.json
plugins
To add a plugin to your analysis. You can find the complete list of available plugins here: https://docs.codeclimate.com/docs/list-of-engines
{"type": "object", "additionalProperties": {}}
project-1.0.0-beta5.json
script
A command line script or scripts. Available variables: %project:Directory% - The project directory %project:Name% - The project name %project:Version% - The project version
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-beta5.json
bundleExclude
List of files to exclude from publish output (kpm bundle).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta5.json
code
Glob pattern to specify all the code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "Folder1\*.cs", "Folder2\*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": "**\\*.cs"}
project-1.0.0-beta5.json
configurations
Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.
{"type": "object", "additionalProperties": {"type": "object", "properties": {"compilationOptions": {}}}}
project-1.0.0-beta5.json
copyright
Copyright details for the package
{"type": "string"}
project-1.0.0-beta5.json
iconUrl
A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.
{"type": "string"}
project-1.0.0-beta5.json
licenseUrl
A link to the license that the package is under
{"type": "string"}
project-1.0.0-beta5.json
requireLicenseAcceptance
A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.
{"type": "boolean", "default": false}
project-1.0.0-beta5.json
projectUrl
A URL for the home page of the package
{"type": "string"}
project-1.0.0-beta5.json
summary
A short description of the package
{"type": "string"}
project-1.0.0-beta5.json
title
The human-friendly title of the package
{"type": "string"}
project-1.0.0-beta5.json
releaseNotes
A description of the changes made in each release of the package.
{"type": "string"}
project-1.0.0-beta5.json
language
The locale ID for the package, such as en-us.
{"type": "string"}
project-1.0.0-beta5.json
description
The description of the application
{"type": "string"}
project-1.0.0-beta5.json
exclude
Glob pattern to indicate all the code files to be excluded from compilation. (data type: string or array with glob pattern(s)).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ["bin/**/*.*", "obj/**/*.*"]}
project-1.0.0-beta5.json
namedResource
Overrides the generated resource names with custom ones.
{"type": "object", "additionalProperties": {"type": "string"}}
project-1.0.0-beta5.json
preprocess
Glob pattern to indicate all the code files to be preprocessed. (data type: string with glob pattern).
{"type": "string", "default": "Compiler\\Preprocess\\**\\*.cs"}
project-1.0.0-beta5.json
resources
Glob pattern to indicate all the files that need to be compiled as resources.
{"type": ["string", "array"], "items": {"type": "string"}, "default": "Compiler\\Resources\\**\\*.cs"}
project-1.0.0-beta5.json
scripts
Scripts to execute during the various stages.
{"type": "object", "properties": {"prepack": {}, "postpack": {}, "prebundle": {}, "postbundle": {}, "prerestore": {}, "postrestore": {}, "prepare": {}}}
project-1.0.0-beta5.json
shared
Glob pattern to specify the code files to share with dependent projects. Example: [ "Folder1\*.cs", "Folder2\*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": "Compiler\\Shared\\**\\*.cs"}
project-1.0.0-beta5.json
version
The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*
{"type": "string"}
project-1.0.0-beta5.json
webroot
Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.
{"type": "string"}
package.manifest.json
editor
This describes details about the editor.
{"type": "object", "additionalProperties": false, "properties": {"view": {"type": "string"}, "hideLabel": {"type": "boolean"}, "valueType": {"type": "string", "enum": ["STRING", "JSON", "DATETIME", "TEXT", "INT"]}, "validation": {"type": "object"}, "isReadOnly": {"type": "boolean", "default": false}, "supportsReadOnly": {"type": "boolean", "default": false}}}
package.manifest.json
view
This is the full path to the HTML view for your property editor.
{"type": "string"}
package.manifest.json
hideLabel
If set to true, this hides the label for the property editor when used on a document type.
{"type": "boolean"}
package.manifest.json
valueType
This is the type of data you want your property editor to save to the database.
{"type": "string", "enum": ["STRING", "JSON", "DATETIME", "TEXT", "INT"]}
package.manifest.json
validation
Object describing required validators on the editor.
{"type": "object"}
package.manifest.json
isReadOnly
If set to true, this makes the property editor read-only.
{"type": "boolean", "default": false}
package.manifest.json
supportsReadOnly
If set to true, this will disable the default read-only overlay and requires the editor to implement support for this instead.
{"type": "boolean", "default": false}
package.manifest.json
alias
This must be a unique alias to your property editor.
{"type": "string"}
package.manifest.json
defaultConfig
Provides a collection of default configuration values, in cases the property editor is not configured or is used a parameter editor, which doesn't allow configuration. The object is a key/value collection and must match the prevalue fields keys.
{"type": "object", "minProperties": 1}
package.manifest.json
isParameterEditor
Enables the property editor as a macro parameter editor.
{"type": "boolean", "default": false}
package.manifest.json
name
The friendly name of the property editor, shown in the backoffice.
{"type": "string"}
package.manifest.json
icon
A CSS class for the icon to be used in the 'Select Editor' dialog, e.g. `icon-autofill`.
{"type": "string"}
package.manifest.json
group
The group to place this editor in within the 'Select Editor' dialog. Use a new group name or alternatively use an existing one such as `Pickers`.
{"type": "string"}
package.manifest.json
name
The friendly name of the grid editor, shown in the backoffice.
{"type": "string"}
package.manifest.json
alias
This must be a unique alias to your grid editor.
{"type": "string"}
package.manifest.json
icon
A CSS class for the icon to be used in the 'Select Editor' dialog, e.g. `icon-autofill`.
{"type": "string"}
package.manifest.json
view
This is backoffice HTML view for your grid editor. Either refers to one of the built-in view (textstring, rte, embed, macro, media) or the full path to a custom view, e.g. `~/App_Plugins/FolderName/editor.html`.
{"type": "string"}
package.manifest.json
render
This is front end Razor view for your grid editor. Accepts full path to a custom view, e.g. `~/App_Plugins/FolderName/editor.cshtml`.
{"type": "string"}
package.manifest.json
config
Configuration for the grid editor. Can be used with textstring and media views or for custom configuration properties.
{"type": "object", "minProperties": 1, "properties": {"style": {"type": "string"}, "markup": {"type": "string"}, "size": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"type": "integer"}}}}}
package.manifest.json
style
If used with the textstring view, this accepts inline CSS to style the textstring box, e.g. `font-size: 30px; line-height: 40px; font-weight: bold;`.
{"type": "string"}
package.manifest.json
markup
If used with the textstring view, this allows wrapping the value in custom markup, e.g. `<h2>#value#</h2>`.
{"type": "string"}
package.manifest.json
size
If used with the media view, this accepts hight and width key/value pairs for cropping.
{"type": "object", "properties": {"height": {"type": "integer"}, "width": {"type": "integer"}}}
package.manifest.json
height
Height of image in pixels.
{"type": "integer"}
package.manifest.json
width
Width of image in pixels.
{"type": "integer"}
package.manifest.json
prevalues
This is an object that stores an array of prevalue fields or options to configure your property editor.
{"type": "object", "properties": {"fields": {}}}
package.manifest.json
fields
This is the collection of prevalue fields.
{"type": "array", "minItems": 1, "items": {"type": "object", "minProperties": 1, "properties": {"key": {"type": "string", "minLength": 1}, "label": {"type": "string"}, "view": {"type": "string"}, "validation": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string"}}}}}}}
package.manifest.json
key
A unique key for the prevalue field.
{"type": "string", "minLength": 1}
package.manifest.json
label
The user friendly label for the prevalue.
{"type": "string"}
package.manifest.json
description
A more detailed description for the user.
{"type": "string"}
package.manifest.json
view
The type of editor to use for this prevalue field.
{"type": "string"}
package.manifest.json
dashboard
A dashboard to display contextual information when in a section/application.
{"type": "object", "additionalProperties": false, "required": ["alias", "view", "sections"], "properties": {"alias": {"type": "string", "minLength": 1}, "view": {"type": "string", "minLength": 1}, "sections": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"type": "string", "minLength": 1}}, "weight": {"type": "integer"}, "access": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"deny": {"type": "string"}, "grant": {"type": "string"}}, "oneOf": [{"required": ["deny"]}, {"required": ["grant"]}]}}}}
package.manifest.json
alias
The alias of the dashboard which can be queried via the Dashboard Service API.
{"type": "string", "minLength": 1}
package.manifest.json
view
This is the full path to the HTML view for your dashboard.
{"type": "string", "minLength": 1}
package.manifest.json
sections
A list of section/application aliases that the dashboard should be visible in.
{"type": "array", "uniqueItems": true, "minItems": 1, "items": {"type": "string", "minLength": 1}}
package.manifest.json
weight
The weight (sort order) of the dashboard. Defaults to 100 if not specified.
{"type": "integer"}
package.manifest.json
access
A list of what user groups aliases are granted or denied permission to see the dashboard. All users will have access if not specified.
{"type": "array", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"deny": {"type": "string"}, "grant": {"type": "string"}}, "oneOf": [{"required": ["deny"]}, {"required": ["grant"]}]}}
package.manifest.json
deny
A user group alias who is denied access.
{"type": "string"}
package.manifest.json
grant
A user group alias who is granted access.
{"type": "string"}
package.manifest.json
section
A section/application to extend the backoffice.
{"type": "object", "additionalProperties": false, "required": ["name", "alias"], "properties": {"name": {"type": "string", "minLength": 1}, "alias": {"type": "string", "minLength": 1}}}
package.manifest.json
name
The friendly name of the section/application, shown in the backoffice.
{"type": "string", "minLength": 1}
package.manifest.json
alias
The alias of the section/application which can be queried via the Section Service API.
{"type": "string", "minLength": 1}
package.manifest.json
contentApp
A section/application to extend the backoffice.
{"type": "object", "additionalProperties": false, "required": ["name", "alias", "icon", "view"], "properties": {"name": {"type": "string", "minLength": 1}, "alias": {"type": "string", "minLength": 1}, "icon": {"type": "string"}, "view": {"type": "string"}, "weight": {"type": "integer"}, "show": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}}
package.manifest.json
name
The friendly name of the content app that appears under the icon.
{"type": "string", "minLength": 1}
package.manifest.json
alias
A unique alias of the content app.
{"type": "string", "minLength": 1}
package.manifest.json
icon
A CSS class for the icon to be used for the content app, e.g. `icon-calculator`.
{"type": "string"}
package.manifest.json
view
This is the full path to the HTML view for your content app.
{"type": "string"}
package.manifest.json
weight
The weight (sort order) of the content app. Default is 0, use values between -99 and +99 to appear between the existing Content (-100) and Info (100) apps.
{"type": "integer"}
package.manifest.json
show
A list of rules to show or hide the content app based on content, media and member types.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
package.manifest.json
items
See documentation for examples of rules: https://our.umbraco.com/Documentation/Extending/Content-Apps/#limiting-according-to-type.
{"type": "string"}
package.manifest.json
id
The (NuGet) package ID, shown in the backoffice and included in package telemetry as unique identifier (supported in v12+). Also used to retrieve the assembly informational version if no explicit `version` and `versionAssemlbyName` is set.
{"type": "string"}