repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
CSWU-Challenge/CSWU-Challenge.github.io | 52dee025ef8333c3ea2ba08afa3178c6303fce7f | 2022-03-12T08:56:24 | docs/schema/extra.json | 14 | 2024-05-27T05:55:58.859188Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"analytics": {
"property": "${2:UA-XXXXXXXX-X}",
"provider": "${1:google}"
}
},
"label": "analytics"
}
],
"definitions": {
"icon": {
"oneOf": [
{
"$ref": "assets/icons.json"
},
{
"title": "Unknown icon",
"type": "string"
}
]
}
},
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/",
"properties": {
"alternate": {
"items": {
"additionalProperties": false,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector",
"properties": {
"lang": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-lang",
"title": "Alternate language code (ISO 639-1)",
"type": "string"
},
"link": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-link",
"title": "Alternate language link",
"type": "string"
},
"name": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-name",
"title": "Alternate language name",
"type": "string"
}
},
"required": [
"name",
"link",
"lang"
],
"title": "Alternate language",
"type": "object"
},
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector",
"title": "Site language selector",
"type": "array"
},
"analytics": {
"additionalProperties": false,
"defaultSnippets": [
{
"body": {
"feedback": {
"ratings": [
{
"data": 1,
"icon": "${2:material/emoticon-happy-outline}",
"name": "${3:This page was helpful}",
"note": "${4:Thanks for your feedback!}"
},
{
"data": 0,
"icon": "${5:material/emoticon-sad-outline}",
"name": "${6:This page could be improved}",
"note": "${7:Thanks for your feedback!}"
}
],
"title": "${1:Was this page helpful}"
}
},
"label": "feedback"
}
],
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"properties": {
"feedback": {
"additionalProperties": false,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
"properties": {
"ratings": {
"items": {
"additionalProperties": false,
"properties": {
"data": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-data",
"title": "Feedback rating data",
"type": "number"
},
"icon": {
"$ref": "#/definitions/icon"
},
"name": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-name",
"title": "Feedback rating name",
"type": "string"
},
"note": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-note",
"title": "Feedback rating data",
"type": "string"
}
},
"required": [
"icon",
"name",
"data",
"note"
],
"title": "Feedback rating",
"type": "object"
},
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
"title": "Feedback ratings",
"type": "array"
},
"title": {
"default": "Was this page helpful?",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
"title": "Feedback widget title",
"type": "string"
}
},
"required": [
"title"
],
"title": "Was this page helpful?",
"type": "object"
},
"property": {
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"pattern": "^G-\\w{10}$",
"title": "Google Analytics 4"
},
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"pattern": "^UA-\\w{9}-\\w$",
"title": "Universal Analytics"
},
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"title": "Unknown property",
"type": "string"
}
]
},
"provider": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"oneOf": [
{
"enum": [
"google"
]
},
{
"type": "string"
}
],
"title": "Analytics provider"
}
},
"required": [
"provider",
"property"
],
"title": "Analytics provider",
"type": "object"
},
"consent": {
"additionalProperties": false,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
"properties": {
"cookies": {
"additionalProperties": false,
"defaultSnippets": [
{
"body": {
"analytics": {
"checked": true,
"name": "Google Analytics"
}
},
"label": "analytics"
}
],
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
"properties": {
"analytics": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"checked": {
"default": true,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
"title": "Initial state",
"type": "boolean"
},
"name": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
"title": "Cookie name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
{
"type": "string"
}
],
"title": "Cookie"
}
},
"title": "Cookies",
"type": "object"
},
"description": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
"title": "Cookie consent description",
"type": "string"
},
"title": {
"default": "Cookie consent",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#cookie-consent",
"title": "Cookie consent title",
"type": "string"
}
},
"required": [
"title",
"description"
],
"title": "Cookie consent",
"type": "object"
},
"generator": {
"default": true,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice",
"title": "Generator notice",
"type": "boolean"
},
"homepage": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo",
"title": "Homepage link (when clicking on logo)",
"type": "string"
},
"social": {
"items": {
"additionalProperties": false,
"properties": {
"icon": {
"$ref": "#/definitions/icon"
},
"link": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-link",
"title": "Social link",
"type": "string"
},
"name": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-name",
"title": "Social link name",
"type": "string"
}
},
"required": [
"icon",
"link"
],
"title": "Social link",
"type": "object"
},
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links",
"title": "Social links",
"type": "array"
},
"version": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning",
"properties": {
"default": {
"default": "stable",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#version-warning",
"title": "Default version"
},
"provider": {
"enum": [
"mike"
],
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning",
"title": "Versioning provider"
}
},
"title": "Versioning",
"type": "object"
}
},
"title": "Extra configuration",
"type": "object"
} | MIT | en |
CSWU-Challenge/CSWU-Challenge.github.io | 52dee025ef8333c3ea2ba08afa3178c6303fce7f | 2022-03-12T08:56:24 | docs/schema/nav.json | 14 | 2024-05-27T05:55:58.859188Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalItems": false,
"items": {
"oneOf": [
{
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"pattern": "\\.md$",
"title": "Navigation item"
},
{
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"patternProperties": {
".*": {
"oneOf": [
{
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"pattern": "\\.md$",
"title": "Navigation item"
},
{
"$ref": "#"
}
]
}
},
"type": "object"
}
]
},
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"title": "Navigation tree",
"type": "array"
} | MIT | en |
CSWU-Challenge/CSWU-Challenge.github.io | 52dee025ef8333c3ea2ba08afa3178c6303fce7f | 2022-03-12T08:56:24 | docs/schema/plugins/offline.json | 14 | 2024-05-27T05:55:58.859188Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"offline"
],
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/"
},
{
"additionalProperties": false,
"properties": {
"offline": {
"additionalProperties": false,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/",
"properties": {
"enabled": {
"default": true,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#enabled",
"title": "Enable plugin",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Built-in offline plugin"
} | MIT | en |
CSWU-Challenge/CSWU-Challenge.github.io | 52dee025ef8333c3ea2ba08afa3178c6303fce7f | 2022-03-12T08:56:24 | docs/schema/plugins/privacy.json | 14 | 2024-05-27T05:55:58.859188Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"privacy"
],
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/"
},
{
"additionalProperties": false,
"properties": {
"privacy": {
"additionalProperties": false,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/",
"properties": {
"enabled": {
"default": true,
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#enabled",
"title": "Enable plugin",
"type": "boolean"
},
"externals": {
"default": "bundle",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals",
"oneOf": [
{
"enum": [
"bundle"
],
"title": "Bundle external assets"
},
{
"enum": [
"report"
],
"title": "Report external assets as warnings"
}
],
"title": "External assets"
},
"externals_directory": {
"default": "assets/externals",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-directory",
"title": "External assets download directory",
"type": "string"
},
"externals_exclude": {
"items": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-exclude",
"pattern": ".*",
"title": "External assets matching this pattern will not be bundled"
},
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-exclude",
"minItems": 1,
"title": "External assets to be excluded",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Built-in privacy plugin"
} | MIT | en |
nuvolaris/nuvolaris-controller | 88a536286b373e97e2e5f97403891c38a6777e25 | 2023-12-22T17:14:51 | demos/demo-apisix/helm/apisix-helm-chart/charts/apisix/values.schema.json | 7 | 2024-05-27T09:07:42.066044Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"customPlugins": {
"description": "customPlugins allows you to mount your own HTTP plugins",
"properties": {
"enabled": {
"type": "boolean"
},
"luaPath": {
"type": "string"
},
"plugins": {
"items": {
"properties": {
"attrs": {
"type": "object"
},
"configMap": {
"properties": {
"mounts": {
"items": {
"properties": {
"key": {
"minLength": 1,
"type": "string"
},
"path": {
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"mounts"
],
"type": "object"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"configMap"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled",
"luaPath",
"plugins"
],
"type": "object"
},
"plugins": {
"description": "APISIX plugins to be enabled",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"stream_plugins": {
"description": "APISIX stream_plugins to be enabled",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
}
}
} | Apache-2.0 | en |
ui-schema/ui-schema | 2cb344d1054508339b18dba3a4c8cf989420153e | 2020-03-15T08:46:49 | schema/2019-09/schema.json | 282 | 2024-05-28T04:15:06.645469Z | {
"$id": "https://ui-schema.bemit.codes/schema/2019-09/schema",
"$recursiveAnchor": true,
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$vocabulary": {
"https://json-schema.org/draft/2019-09/vocab/applicator": true,
"https://json-schema.org/draft/2019-09/vocab/content": true,
"https://json-schema.org/draft/2019-09/vocab/core": true,
"https://json-schema.org/draft/2019-09/vocab/format": false,
"https://json-schema.org/draft/2019-09/vocab/hyper-schema": true,
"https://json-schema.org/draft/2019-09/vocab/meta-data": true,
"https://json-schema.org/draft/2019-09/vocab/validation": true,
"https://ui-schema.bemit.codes/schema/2019-09/vocab/translation": true,
"https://ui-schema.bemit.codes/schema/2019-09/vocab/view": true,
"https://ui-schema.bemit.codes/schema/2019-09/vocab/widget": true
},
"allOf": [
{
"$ref": "https://json-schema.org/draft/2019-09/schema"
},
{
"$ref": "https://json-schema.org/draft/2019-09/hyper-schema"
}
],
"links": [
{
"href": "{+%24id}",
"rel": "self"
}
],
"title": "JSON UI-Schema"
} | MIT | en |
ui-schema/ui-schema | fbd9620bb9924ab7b83d48ce8e945a439b4f8963 | 2020-03-15T15:11:54 | schema/2019-09/meta/translation.json | 282 | 2024-05-28T04:15:06.645469Z | {
"$id": "https://ui-schema.bemit.codes/schema/2019-09/meta/translation",
"$recursiveAnchor": true,
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$vocabulary": {
"https://ui-schema.bemit.codes/schema/2019-09/vocab/translation": true
},
"properties": {
"t": {
"$comment": "enables in-schema translation",
"type": "object"
},
"tt": {
"$comment": "Text-transformation for the `title` keyword or it's translated equivalent",
"enum": [
true,
false,
"ol",
"upper",
"lower",
"upper-beauty",
"lower-beauty"
],
"type": [
"boolean",
"string"
]
}
},
"title": "Translation and text-transform vocabulary",
"type": [
"object",
"boolean"
]
} | MIT | en |
ui-schema/ui-schema | fbd9620bb9924ab7b83d48ce8e945a439b4f8963 | 2020-03-15T15:11:54 | schema/2019-09/meta/widget.json | 282 | 2024-05-28T04:15:06.645469Z | {
"$id": "https://ui-schema.bemit.codes/schema/2019-09/meta/widget",
"$recursiveAnchor": true,
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$vocabulary": {
"https://ui-schema.bemit.codes/schema/2019-09/vocab/widget": true
},
"properties": {
"widget": {
"type": "string"
}
},
"title": "Widget vocabulary",
"type": [
"object",
"boolean"
]
} | MIT | en |
ui-schema/ui-schema | fbd9620bb9924ab7b83d48ce8e945a439b4f8963 | 2020-03-15T15:11:54 | schema/2019-09/meta/view.json | 282 | 2024-05-28T04:15:06.645469Z | {
"$id": "https://ui-schema.bemit.codes/schema/2019-09/meta/view",
"$recursiveAnchor": true,
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$vocabulary": {
"https://ui-schema.bemit.codes/schema/2019-09/vocab/view": true
},
"properties": {
"view": {
"$comment": "enables in-schema translation",
"properties": {
"sizeLg": {
"type": "number"
},
"sizeMd": {
"type": "number"
},
"sizeSm": {
"type": "number"
},
"sizeXl": {
"type": "number"
},
"sizeXs": {
"type": "number"
}
},
"type": "object"
}
},
"title": "View / Grid vocabulary",
"type": [
"object",
"boolean"
]
} | MIT | en |
beatcracker/toptout | 51a4b3f1da711dbf710b76c95d35057166ebd5c6 | 2021-11-08T16:29:51 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Dasel": {
"description": "Standard selector syntax no matter the data format: https://github.com/TomWright/dasel",
"title": "Dasel",
"type": "string"
},
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"INIFile": {
"additionalProperties": false,
"description": "\"INI file\". Modify INI file: https://en.wikipedia.org/wiki/INI_file",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "INIFile",
"type": "object"
},
"INIFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/INIFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "INIFileProperties",
"type": "object"
},
"INIFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application INI configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "INIFileSelector",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file: https://www.json.org/",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/JSONFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"JSONFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application JSON configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"json_pointer": {
"$ref": "#/definitions/JSONPointer"
}
},
"required": [
"dasel",
"json_pointer"
],
"title": "JSONFileSelector",
"type": "object"
},
"JSONPointer": {
"description": "JSON Pointer: https://datatracker.ietf.org/doc/html/rfc6901",
"title": "JSONPointer",
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/PlainFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"PlainFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application plaintext configuration file.",
"properties": {
"regex": {
"$ref": "#/definitions/Regex"
}
},
"required": [
"regex"
],
"title": "PlainFileSelector",
"type": "object"
},
"Regex": {
"description": "Regular expression. RE2 flavor: https://github.com/google/re2/wiki/Syntax",
"title": "Regex",
"type": "string"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: number/boolean)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/exec/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"TOMLFile": {
"additionalProperties": false,
"description": "\"TOML file\". Modify TOML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "TOMLFile",
"type": "object"
},
"TOMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/TOMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "TOMLFileProperties",
"type": "object"
},
"TOMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application TOML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "TOMLFileSelector",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"noop"
]
},
{
"required": [
"env"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"ini_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"toml_file"
]
},
{
"required": [
"xml_file"
]
},
{
"required": [
"yaml_file"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"ini_file": {
"$ref": "#/definitions/INIFile"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
},
"toml_file": {
"$ref": "#/definitions/TOMLFile"
},
"xml_file": {
"$ref": "#/definitions/XMLFile"
},
"yaml_file": {
"$ref": "#/definitions/YAMLFile"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"description": "Toptout data file schema. Describes application telemetry channels.",
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
},
"XMLFile": {
"additionalProperties": false,
"description": "\"XML file\". Modify XML file: https://developer.mozilla.org/docs/Web/XML/XML_introduction",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "XMLFile",
"type": "object"
},
"XMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/XMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "XMLFileProperties",
"type": "object"
},
"XMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application XML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"xpath": {
"$ref": "#/definitions/XPath"
}
},
"required": [
"dasel",
"xpath"
],
"title": "XMLFileSelector",
"type": "object"
},
"XPath": {
"description": "XML Path Language: https://developer.mozilla.org/docs/Web/XPath",
"title": "XPath",
"type": "string"
},
"YAMLFile": {
"additionalProperties": false,
"description": "\"YAML file\". Modify YAML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "YAMLFile",
"type": "object"
},
"YAMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/YAMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "YAMLFileProperties",
"type": "object"
},
"YAMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application YAML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "YAMLFileSelector",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 47a3a2d4f88cfa6616d13d6af028fabd815c81d5 | 2021-07-24T17:21:41 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: number/boolean)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/exec/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 4200dd3c302e8760d96c982f20fcbb38a84e43b5 | 2021-11-20T22:36:32 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Dasel": {
"description": "Standard selector syntax no matter the data format: https://github.com/TomWright/dasel",
"title": "Dasel",
"type": "string"
},
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringArrayValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"INIFile": {
"additionalProperties": false,
"description": "\"INI file\". Modify INI file: https://en.wikipedia.org/wiki/INI_file",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "INIFile",
"type": "object"
},
"INIFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/INIFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "INIFileProperties",
"type": "object"
},
"INIFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application INI configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "INIFileSelector",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file: https://www.json.org/",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/JSONFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"JSONFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application JSON configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"json_pointer": {
"$ref": "#/definitions/JSONPointer"
}
},
"required": [
"dasel",
"json_pointer"
],
"title": "JSONFileSelector",
"type": "object"
},
"JSONPointer": {
"description": "JSON Pointer: https://datatracker.ietf.org/doc/html/rfc6901",
"title": "JSONPointer",
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^https?:\\/\\/\\S+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/PlainFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"PlainFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application plaintext configuration file.",
"properties": {
"regex": {
"$ref": "#/definitions/Regex"
}
},
"required": [
"regex"
],
"title": "PlainFileSelector",
"type": "object"
},
"Regex": {
"description": "Regular expression. RE2 flavor: https://github.com/google/re2/wiki/Syntax",
"title": "Regex",
"type": "string"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: object/number/boolean/null)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": [
"number",
"string",
"boolean",
"null"
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"type": [
"number",
"string",
"boolean",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringArrayValue": {
"additionalProperties": false,
"description": "Opt-in/out values (commandline arguments) for exec target.",
"properties": {
"opt_in": {
"description": "These arguments will opt-IN of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-in is not applicable.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"opt_out": {
"description": "These arguments will opt-OUT of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-out is not applicable.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringArrayValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": [
"string",
"null"
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"type": [
"string",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"TOMLFile": {
"additionalProperties": false,
"description": "\"TOML file\". Modify TOML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "TOMLFile",
"type": "object"
},
"TOMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/TOMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "TOMLFileProperties",
"type": "object"
},
"TOMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application TOML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "TOMLFileSelector",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"noop"
]
},
{
"required": [
"env"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"ini_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"toml_file"
]
},
{
"required": [
"xml_file"
]
},
{
"required": [
"yaml_file"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"ini_file": {
"$ref": "#/definitions/INIFile"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
},
"toml_file": {
"$ref": "#/definitions/TOMLFile"
},
"xml_file": {
"$ref": "#/definitions/XMLFile"
},
"yaml_file": {
"$ref": "#/definitions/YAMLFile"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"description": "Toptout data file schema. Describes application telemetry channels.",
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
},
"XMLFile": {
"additionalProperties": false,
"description": "\"XML file\". Modify XML file: https://developer.mozilla.org/docs/Web/XML/XML_introduction",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "XMLFile",
"type": "object"
},
"XMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/XMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "XMLFileProperties",
"type": "object"
},
"XMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application XML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"xpath": {
"$ref": "#/definitions/XPath"
}
},
"required": [
"dasel",
"xpath"
],
"title": "XMLFileSelector",
"type": "object"
},
"XPath": {
"description": "XML Path Language: https://developer.mozilla.org/docs/Web/XPath",
"title": "XPath",
"type": "string"
},
"YAMLFile": {
"additionalProperties": false,
"description": "\"YAML file\". Modify YAML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "YAMLFile",
"type": "object"
},
"YAMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/YAMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "YAMLFileProperties",
"type": "object"
},
"YAMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application YAML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "YAMLFileSelector",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | a40f8e98ba4210a7490894f5655b18ff849540f6 | 2021-04-25T19:18:34 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows regustry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name if presence of this product can be detected by PATH environment variable lookup.",
"type": "string"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. Example: Foo Bar.",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"description": "Opt-in/out values",
"properties": {
"opt_in": {
"oneOf": [
{
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": "string"
},
{
"description": "This value will opt--IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection.",
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 2c4580cd59d667ba91861204dcf06164fc9c6025 | 2020-02-19T23:01:35 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "Env",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "Env",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFile",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFile",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"json_file"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
}
},
"required": [],
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"ToptoutLinks": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "ToptoutLinks",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | f95019f31ba662033f7bdead1ae3299fe950df3e | 2019-11-23T16:34:30 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "Env",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "Env",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFile",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFile",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"json_file"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
}
},
"required": [],
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"ToptoutLinks": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "ToptoutLinks",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | b4737bc75d218537d28ade57b865aeb7fce9ebf2 | 2020-06-17T23:05:08 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"json_file"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"registry"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"required": [],
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"ToptoutLinks": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "ToptoutLinks",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 4964d705c200a8c6d38bac88459c407536ff3515 | 2021-11-05T22:15:57 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: number/boolean)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/exec/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"description": "Toptout data file schema. Describes application telemetry channels.",
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | f351edf79103a42db8d17866e4d35f5aa467d420 | 2021-11-17T00:38:12 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Dasel": {
"description": "Standard selector syntax no matter the data format: https://github.com/TomWright/dasel",
"title": "Dasel",
"type": "string"
},
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringArrayValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"INIFile": {
"additionalProperties": false,
"description": "\"INI file\". Modify INI file: https://en.wikipedia.org/wiki/INI_file",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "INIFile",
"type": "object"
},
"INIFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/INIFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "INIFileProperties",
"type": "object"
},
"INIFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application INI configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "INIFileSelector",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file: https://www.json.org/",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/JSONFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"JSONFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application JSON configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"json_pointer": {
"$ref": "#/definitions/JSONPointer"
}
},
"required": [
"dasel",
"json_pointer"
],
"title": "JSONFileSelector",
"type": "object"
},
"JSONPointer": {
"description": "JSON Pointer: https://datatracker.ietf.org/doc/html/rfc6901",
"title": "JSONPointer",
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/PlainFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"PlainFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application plaintext configuration file.",
"properties": {
"regex": {
"$ref": "#/definitions/Regex"
}
},
"required": [
"regex"
],
"title": "PlainFileSelector",
"type": "object"
},
"Regex": {
"description": "Regular expression. RE2 flavor: https://github.com/google/re2/wiki/Syntax",
"title": "Regex",
"type": "string"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: object/number/boolean/null)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": [
"number",
"string",
"boolean",
"null"
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"type": [
"number",
"string",
"boolean",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringArrayValue": {
"additionalProperties": false,
"description": "Opt-in/out values (commandline arguments) for exec target.",
"properties": {
"opt_in": {
"description": "These arguments will opt-IN of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-in is not applicable.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"opt_out": {
"description": "These arguments will opt-OUT of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-out is not applicable.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringArrayValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": [
"string",
"null"
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"type": [
"string",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"TOMLFile": {
"additionalProperties": false,
"description": "\"TOML file\". Modify TOML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "TOMLFile",
"type": "object"
},
"TOMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/TOMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "TOMLFileProperties",
"type": "object"
},
"TOMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application TOML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "TOMLFileSelector",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"noop"
]
},
{
"required": [
"env"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"ini_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"toml_file"
]
},
{
"required": [
"xml_file"
]
},
{
"required": [
"yaml_file"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"ini_file": {
"$ref": "#/definitions/INIFile"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
},
"toml_file": {
"$ref": "#/definitions/TOMLFile"
},
"xml_file": {
"$ref": "#/definitions/XMLFile"
},
"yaml_file": {
"$ref": "#/definitions/YAMLFile"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"description": "Toptout data file schema. Describes application telemetry channels.",
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
},
"XMLFile": {
"additionalProperties": false,
"description": "\"XML file\". Modify XML file: https://developer.mozilla.org/docs/Web/XML/XML_introduction",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "XMLFile",
"type": "object"
},
"XMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/XMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "XMLFileProperties",
"type": "object"
},
"XMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application XML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"xpath": {
"$ref": "#/definitions/XPath"
}
},
"required": [
"dasel",
"xpath"
],
"title": "XMLFileSelector",
"type": "object"
},
"XPath": {
"description": "XML Path Language: https://developer.mozilla.org/docs/Web/XPath",
"title": "XPath",
"type": "string"
},
"YAMLFile": {
"additionalProperties": false,
"description": "\"YAML file\". Modify YAML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "YAMLFile",
"type": "object"
},
"YAMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/YAMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "YAMLFileProperties",
"type": "object"
},
"YAMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application YAML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "YAMLFileSelector",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | b2ae5c215443ad1b1a7beb36339dc4cfa09adecc | 2021-02-26T10:26:30 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"link": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 6da1ee1230094c0604e2bcb9e15727706298bf88 | 2021-02-26T11:11:07 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"link": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 6ad145bf3175d03b8cdf29a85c9af4a57184aca1 | 2021-06-20T22:46:09 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: number/boolean)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/exec/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 7557cb01f18afb774e4598cc24ddc6a64ab7c9bf | 2021-11-13T19:53:14 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Dasel": {
"description": "Standard selector syntax no matter the data format: https://github.com/TomWright/dasel",
"title": "Dasel",
"type": "string"
},
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringArrayValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"INIFile": {
"additionalProperties": false,
"description": "\"INI file\". Modify INI file: https://en.wikipedia.org/wiki/INI_file",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "INIFile",
"type": "object"
},
"INIFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/INIFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "INIFileProperties",
"type": "object"
},
"INIFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application INI configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "INIFileSelector",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file: https://www.json.org/",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/JSONFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"JSONFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application JSON configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"json_pointer": {
"$ref": "#/definitions/JSONPointer"
}
},
"required": [
"dasel",
"json_pointer"
],
"title": "JSONFileSelector",
"type": "object"
},
"JSONPointer": {
"description": "JSON Pointer: https://datatracker.ietf.org/doc/html/rfc6901",
"title": "JSONPointer",
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/PlainFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"PlainFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application plaintext configuration file.",
"properties": {
"regex": {
"$ref": "#/definitions/Regex"
}
},
"required": [
"regex"
],
"title": "PlainFileSelector",
"type": "object"
},
"Regex": {
"description": "Regular expression. RE2 flavor: https://github.com/google/re2/wiki/Syntax",
"title": "Regex",
"type": "string"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: object/number/boolean/null)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringArrayValue": {
"additionalProperties": false,
"description": "Opt-in/out values (commandline arguments) for exec target.",
"properties": {
"opt_in": {
"description": "These arguments will opt-IN of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-in is not applicable.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "null"
},
"type": "null"
}
]
},
"opt_out": {
"description": "These arguments will opt-OUT of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-out is not applicable.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "null"
},
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringArrayValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"TOMLFile": {
"additionalProperties": false,
"description": "\"TOML file\". Modify TOML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "TOMLFile",
"type": "object"
},
"TOMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/TOMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "TOMLFileProperties",
"type": "object"
},
"TOMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application TOML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "TOMLFileSelector",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"noop"
]
},
{
"required": [
"env"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"ini_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"toml_file"
]
},
{
"required": [
"xml_file"
]
},
{
"required": [
"yaml_file"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"ini_file": {
"$ref": "#/definitions/INIFile"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
},
"toml_file": {
"$ref": "#/definitions/TOMLFile"
},
"xml_file": {
"$ref": "#/definitions/XMLFile"
},
"yaml_file": {
"$ref": "#/definitions/YAMLFile"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"description": "Toptout data file schema. Describes application telemetry channels.",
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
},
"XMLFile": {
"additionalProperties": false,
"description": "\"XML file\". Modify XML file: https://developer.mozilla.org/docs/Web/XML/XML_introduction",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "XMLFile",
"type": "object"
},
"XMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/XMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "XMLFileProperties",
"type": "object"
},
"XMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application XML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"xpath": {
"$ref": "#/definitions/XPath"
}
},
"required": [
"dasel",
"xpath"
],
"title": "XMLFileSelector",
"type": "object"
},
"XPath": {
"description": "XML Path Language: https://developer.mozilla.org/docs/Web/XPath",
"title": "XPath",
"type": "string"
},
"YAMLFile": {
"additionalProperties": false,
"description": "\"YAML file\". Modify YAML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "YAMLFile",
"type": "object"
},
"YAMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/YAMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "YAMLFileProperties",
"type": "object"
},
"YAMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application YAML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "YAMLFileSelector",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 6ed89c5fd0657a6d70eb17dbabdc734530dff9d4 | 2021-05-09T20:32:24 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"items": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"description": "Opt-in/out values",
"properties": {
"opt_in": {
"oneOf": [
{
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": "string"
},
{
"description": "This value will opt--IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection.",
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | f1b3e628b1c6f5cb7c243e2725868b66b44f0471 | 2021-10-21T23:29:03 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: number/boolean)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/exec/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 4c5b9b479a1fd3df738763de2cb46baede145cc7 | 2021-02-27T12:59:11 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"link": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | fd978de06db7cf6a0b3473a02a5fc7224e644efe | 2021-06-20T22:49:43 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: number/boolean)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/exec/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | d938eb39feaa7e66a8dc0a76e584b4c781618912 | 2020-08-01T23:51:21 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"link": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"json_file"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"ToptoutLinks": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "ToptoutLinks",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 2631610fd3d4f14b9bbfd4c9da8056d760548a68 | 2021-05-04T21:56:51 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows regustry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name if presence of this product can be detected by PATH environment variable lookup.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"description": "Opt-in/out values",
"properties": {
"opt_in": {
"oneOf": [
{
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": "string"
},
{
"description": "This value will opt--IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection.",
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 9f6e71e15bac76bb9e9b017faa6d77858351213c | 2021-05-05T19:53:52 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows regustry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"items": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"description": "Opt-in/out values",
"properties": {
"opt_in": {
"oneOf": [
{
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": "string"
},
{
"description": "This value will opt--IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection.",
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 39c9c7bd9356638e69830ed981592075ff974c1c | 2020-06-17T22:54:08 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"required": [],
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"json_file"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"registry"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"required": [],
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"ToptoutLinks": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "ToptoutLinks",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | e281837927cdc40ca004dcdddecbedaaacc3a12a | 2021-05-09T22:27:35 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"description": "Opt-in/out values",
"properties": {
"opt_in": {
"oneOf": [
{
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": "string"
},
{
"description": "This value will opt--IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection.",
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 2baa9ed92ca38ab693a50a29610254003bc4247b | 2021-04-24T14:09:07 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"properties": {
"description": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | e24ffddf6a1c7227110e5deae2192a76bd8ed341 | 2021-10-16T00:28:16 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: number/boolean)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/exec/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 1ff0d574b26ca7ea10fdddf831384a7de2faf2c4 | 2021-05-11T21:50:15 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"description": "Specify, if this channel oficially supports opt-in/opt-out.",
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally desription and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"description": "Opt-in/out values",
"properties": {
"opt_in": {
"oneOf": [
{
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": "string"
},
{
"description": "This value will opt--IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection.",
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 81cc4996fa2b488de9f2c59bb312627264bcf31c | 2021-12-10T01:08:08 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Dasel": {
"description": "Standard selector syntax no matter the data format: https://github.com/TomWright/dasel",
"title": "Dasel",
"type": "string"
},
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringArrayValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"INIFile": {
"additionalProperties": false,
"description": "\"INI file\". Modify INI file: https://en.wikipedia.org/wiki/INI_file",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "INIFile",
"type": "object"
},
"INIFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/INIFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "INIFileProperties",
"type": "object"
},
"INIFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application INI configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "INIFileSelector",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file: https://www.json.org/",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/JSONFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"JSONFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application JSON configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"json_pointer": {
"$ref": "#/definitions/JSONPointer"
}
},
"required": [
"dasel",
"json_pointer"
],
"title": "JSONFileSelector",
"type": "object"
},
"JSONPointer": {
"description": "JSON Pointer: https://datatracker.ietf.org/doc/html/rfc6901",
"title": "JSONPointer",
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^https?:\\/\\/\\S+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/PlainFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"PlainFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application plaintext configuration file.",
"properties": {
"regex": {
"$ref": "#/definitions/Regex"
}
},
"required": [
"regex"
],
"title": "PlainFileSelector",
"type": "object"
},
"Regex": {
"description": "Regular expression. RE2 flavor: https://github.com/google/re2/wiki/Syntax",
"title": "Regex",
"type": "string"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: object/number/boolean/null)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"type": [
"number",
"string",
"boolean",
"null"
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"type": [
"number",
"string",
"boolean",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringArrayValue": {
"additionalProperties": false,
"description": "Opt-in/out values (commandline arguments) for exec target.",
"properties": {
"opt_in": {
"description": "These arguments will opt-IN of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-in is not applicable.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"opt_out": {
"description": "These arguments will opt-OUT of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-out is not applicable.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringArrayValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"type": [
"string",
"null"
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"type": [
"string",
"null"
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"TOMLFile": {
"additionalProperties": false,
"description": "\"TOML file\". Modify TOML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "TOMLFile",
"type": "object"
},
"TOMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/TOMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "TOMLFileProperties",
"type": "object"
},
"TOMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application TOML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "TOMLFileSelector",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"noop"
]
},
{
"required": [
"env"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"ini_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"toml_file"
]
},
{
"required": [
"xml_file"
]
},
{
"required": [
"yaml_file"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"ini_file": {
"$ref": "#/definitions/INIFile"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
},
"toml_file": {
"$ref": "#/definitions/TOMLFile"
},
"xml_file": {
"$ref": "#/definitions/XMLFile"
},
"yaml_file": {
"$ref": "#/definitions/YAMLFile"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"description": "Toptout data file schema. Describes application telemetry channels.",
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^\\S+(\\s+\\S+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
},
"XMLFile": {
"additionalProperties": false,
"description": "\"XML file\". Modify XML file: https://developer.mozilla.org/docs/Web/XML/XML_introduction",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "XMLFile",
"type": "object"
},
"XMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/XMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "XMLFileProperties",
"type": "object"
},
"XMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application XML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"xpath": {
"$ref": "#/definitions/XPath"
}
},
"required": [
"dasel",
"xpath"
],
"title": "XMLFileSelector",
"type": "object"
},
"XPath": {
"description": "XML Path Language: https://developer.mozilla.org/docs/Web/XPath",
"title": "XPath",
"type": "string"
},
"YAMLFile": {
"additionalProperties": false,
"description": "\"YAML file\". Modify YAML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"user"
]
},
{
"required": [
"process"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "YAMLFile",
"type": "object"
},
"YAMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/YAMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "YAMLFileProperties",
"type": "object"
},
"YAMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application YAML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "YAMLFileSelector",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 021cb039894a9631cfa6dfd5986192a4d1e7414b | 2020-06-17T23:11:59 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"json_file"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"registry"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"ToptoutLinks": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"http",
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "ToptoutLinks",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 68510a864c5cb0faa8e39dc3b2ef4b1cce837a84 | 2020-02-19T21:03:32 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "Env",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "Env",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFile",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFile",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"json_file"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
}
},
"required": [],
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/ToptoutLinks"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"ToptoutLinks": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
},
"privacy": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
},
"telemetry": {
"format": "uri",
"qt-uri-protocols": [
"https"
],
"type": "string"
}
},
"required": [
"main"
],
"title": "ToptoutLinks",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"type": [
"string",
"null"
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | 2e9227a64978eacf85917ac5c5cd2f53521a4b1e | 2021-11-13T18:33:15 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Dasel": {
"description": "Standard selector syntax no matter the data format: https://github.com/TomWright/dasel",
"title": "Dasel",
"type": "string"
},
"Env": {
"additionalProperties": false,
"description": "\"Environment variable\" target. Set or remove environment variable. Environment variables are by design configured in process scope. There are mechanisms to configure them for every new process, but it's up to OS/shell.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/EnvProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"description": "Describe variable name and applicable values",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"description": "\"Execute command\". Run command with arguments.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/ExecProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"description": "Describes command name and arguments.",
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/StringArrayValue"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"INIFile": {
"additionalProperties": false,
"description": "\"INI file\". Modify INI file: https://en.wikipedia.org/wiki/INI_file",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/INIFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "INIFile",
"type": "object"
},
"INIFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/INIFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "INIFileProperties",
"type": "object"
},
"INIFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application INI configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "INIFileSelector",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"description": "\"JSON file\". Modify JSON file: https://www.json.org/",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/JSONFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/JSONFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"JSONFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application JSON configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"json_pointer": {
"$ref": "#/definitions/JSONPointer"
}
},
"required": [
"dasel",
"json_pointer"
],
"title": "JSONFileSelector",
"type": "object"
},
"JSONPointer": {
"description": "JSON Pointer: https://datatracker.ietf.org/doc/html/rfc6901",
"title": "JSONPointer",
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "Contains links to the main product page, telemetry and privacy policy.",
"properties": {
"main": {
"description": "Link to the product's website. Mandatory.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"description": "Link to the product's privacy policy. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"description": "Link to the product's general telemetry description. Optional.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"description": "\"No operation\". Use this for links to third-party telemetry configuration tools, that are not supported by this schema.",
"properties": {
"description": {
"description": "Friendly description. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"link": {
"description": "Link to website. Example: https://example.com.",
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"description": "Friendly name. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"description": "Item path. For environment variables this would be name, for files - full path.",
"properties": {
"default": {
"description": "if no OS-specific path is specified, this one should be used.",
"type": "string"
},
"linux": {
"description": "This path should be used on Linux.",
"type": "string"
},
"macos": {
"description": "This path should be used on macOS.",
"type": "string"
},
"windows": {
"description": "This path should be used on Windows.",
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"description": "\"Plaintext file\". Modify plaintext file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/PlainFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/PlainFileSelector"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"PlainFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application plaintext configuration file.",
"properties": {
"regex": {
"$ref": "#/definitions/Regex"
}
},
"required": [
"regex"
],
"title": "PlainFileSelector",
"type": "object"
},
"Regex": {
"description": "Regular expression. RE2 flavor: https://github.com/google/re2/wiki/Syntax",
"title": "Regex",
"type": "string"
},
"Registry": {
"additionalProperties": false,
"description": "\"Windows registry\". Modify keys/values in Windows registry.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/RegistryProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"description": "Describes registry path and keys/values.",
"properties": {
"key": {
"description": "Registry key name.",
"type": "string"
},
"path": {
"description": "Registry key path.",
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"description": "Registry hive name: https://docs.microsoft.com/en-us/windows/win32/sysinfo/predefined-keys",
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"description": "Registry key type.",
"enum": [
"REG_SZ",
"REG_EXPAND_SZ",
"REG_MULTI_SZ",
"REG_DWORD_BIG_ENDIAN",
"REG_DWORD",
"REG_QWORD",
"REG_BINARY"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/StringValue"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"RichValue": {
"additionalProperties": false,
"description": "Opt-in/out values for JSON and other targets that can use non-string values (e.g.: object/number/boolean/null)",
"properties": {
"opt_in": {
"description": "This value will opt-IN to the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "object"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that the entire key holding this value should be removed.",
"oneOf": [
{
"type": "object"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "RichValue",
"type": "object"
},
"StringArrayValue": {
"additionalProperties": false,
"description": "Opt-in/out values (commandline arguments) for exec target.",
"properties": {
"opt_in": {
"description": "These arguments will opt-IN of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-in is not applicable.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "null"
},
"type": "null"
}
]
},
"opt_out": {
"description": "These arguments will opt-OUT of the telemetry collection. Use empty array to indicate that no arguments to command are needed. Use null to indicate that opt-out is not applicable.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "null"
},
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringArrayValue",
"type": "object"
},
"StringValue": {
"additionalProperties": false,
"description": "Opt-in/out values for env/plain_file/registry targets",
"properties": {
"opt_in": {
"description": "This value will opt-IN of the telemetry collection. Use null to indicate that value should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"description": "This value will opt-OUT of the telemetry collection. Use null to indicate that entry should be removed.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "StringValue",
"type": "object"
},
"TOMLFile": {
"additionalProperties": false,
"description": "\"TOML file\". Modify TOML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/TOMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "TOMLFile",
"type": "object"
},
"TOMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/TOMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "TOMLFileProperties",
"type": "object"
},
"TOMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application TOML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "TOMLFileSelector",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"noop"
]
},
{
"required": [
"env"
]
},
{
"required": [
"exec"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"ini_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"toml_file"
]
},
{
"required": [
"xml_file"
]
},
{
"required": [
"yaml_file"
]
}
],
"description": "Describes telemetry channel configuration options. Optional, since you may wish to describe telemetry channels that don't provide a ways to control them.",
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"ini_file": {
"$ref": "#/definitions/INIFile"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
},
"toml_file": {
"$ref": "#/definitions/TOMLFile"
},
"xml_file": {
"$ref": "#/definitions/XMLFile"
},
"yaml_file": {
"$ref": "#/definitions/YAMLFile"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Describes single telemetry channel (version check, analytics, etc..).",
"properties": {
"description": {
"description": "Optional description. Example: Disable usage data reporting.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"id": {
"description": "Telemetry channel unique ID. Use [a-z0-9-] character set. Must be unique in this array. Example: usage-data.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the channel. No leading/trailing whitespace allowed. Example: Usage data.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
},
"traits": {
"$ref": "#/definitions/Traits"
}
},
"required": [
"id",
"name",
"traits"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"description": "Toptout data file schema. Describes application telemetry channels.",
"properties": {
"category_id": {
"description": "Unique category id. Use [a-z0-9-] character set. The API generator uses it to group products. Example: development.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"description": "Friendly category name. The README generator uses it to group products. No leading/trailing whitespace allowed. Example: Development.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"description": {
"description": "Short description of the collected telemetry. Usually copied from the product's documentation. No leading/trailing whitespace allowed.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"executable_name": {
"description": "Optional. Provide executable name(s) if presence of this product can be detected by PATH environment variable lookup. No leading/trailing whitespace allowed.",
"items": {
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Product unique ID. Use [a-z0-9-] character set. Must be unique across all files. Example: foo-bar.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"description": "Friendly name of the product. No leading/trailing whitespace allowed. Example: Foo Bar.",
"pattern": "^[\\S]+(\\s+[\\S]+)*$",
"type": "string"
},
"telemetry": {
"description": "Telemetry channels list. Contains name and optionally description and opt-in/out methods. Optional, since you may wish to add a product that contains telemetry but doesn't provide a way to control it.",
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Traits": {
"additionalProperties": false,
"description": "Describes telemetry channel traits",
"properties": {
"error_report": {
"description": "Telemetry channel provides error reports.",
"type": "boolean"
},
"official": {
"description": "Telemetry channel officially supports opt-in/opt-out.",
"type": "boolean"
},
"update_check": {
"description": "Telemetry channel provides update checks.",
"type": "boolean"
},
"usage_data": {
"description": "Telemetry channel provides usage data.",
"type": "boolean"
}
},
"required": [
"official",
"usage_data",
"update_check",
"error_report"
],
"title": "Traits",
"type": "object"
},
"XMLFile": {
"additionalProperties": false,
"description": "\"XML file\". Modify XML file: https://developer.mozilla.org/docs/Web/XML/XML_introduction",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/XMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "XMLFile",
"type": "object"
},
"XMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/XMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "XMLFileProperties",
"type": "object"
},
"XMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application XML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
},
"xpath": {
"$ref": "#/definitions/XPath"
}
},
"required": [
"dasel",
"xpath"
],
"title": "XMLFileSelector",
"type": "object"
},
"XPath": {
"description": "XML Path Language: https://developer.mozilla.org/docs/Web/XPath",
"title": "XPath",
"type": "string"
},
"YAMLFile": {
"additionalProperties": false,
"description": "\"YAML file\". Modify YAML file.",
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"description": "Target scope. You can use multiple scopes: machine (applies to all users of the computer), user (applies to current user of the computer), process (applies to current process only).",
"properties": {
"machine": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for all users of the computer."
},
"process": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for process only."
},
"user": {
"$ref": "#/definitions/YAMLFileProperties",
"description": "Configures telemetry channel for current user of the computer."
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "YAMLFile",
"type": "object"
},
"YAMLFileProperties": {
"additionalProperties": false,
"description": "Describes file path, selector for target property and values.",
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"$ref": "#/definitions/YAMLFileSelector"
},
"value": {
"$ref": "#/definitions/RichValue"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "YAMLFileProperties",
"type": "object"
},
"YAMLFileSelector": {
"additionalProperties": false,
"description": "Describes selector used to configure telemetry channel in application YAML configuration file.",
"properties": {
"dasel": {
"$ref": "#/definitions/Dasel"
}
},
"required": [
"dasel"
],
"title": "YAMLFileSelector",
"type": "object"
}
}
} | MIT | en |
beatcracker/toptout | e1ce9fe04ba4ebc3e1c4e64103448fb64a1179cd | 2021-02-28T20:46:30 | schema/toptout.schema.json | 131 | 2024-05-29T17:59:50.000969Z | {
"$ref": "#/definitions/Toptout",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Env": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/EnvProperties"
},
"process": {
"$ref": "#/definitions/EnvProperties"
},
"user": {
"$ref": "#/definitions/EnvProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Env",
"type": "object"
},
"EnvProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "EnvProperties",
"type": "object"
},
"Exec": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/ExecProperties"
},
"process": {
"$ref": "#/definitions/ExecProperties"
},
"user": {
"$ref": "#/definitions/ExecProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Exec",
"type": "object"
},
"ExecProperties": {
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/definitions/Path"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"path",
"value"
],
"title": "ExecProperties",
"type": "object"
},
"JSONFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/JSONFileProperties"
},
"process": {
"$ref": "#/definitions/JSONFileProperties"
},
"user": {
"$ref": "#/definitions/JSONFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "JSONFile",
"type": "object"
},
"JSONFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "JSONFileProperties",
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"main": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"privacy": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"telemetry": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
}
},
"required": [
"main"
],
"title": "Links",
"type": "object"
},
"Noop": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"link": {
"format": "uri",
"pattern": "^http[s]?:\\/\\/.+$",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"description",
"link",
"name"
],
"title": "Noop",
"type": "object"
},
"Path": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"default"
]
},
{
"required": [
"linux"
]
},
{
"required": [
"macos"
]
},
{
"required": [
"windows"
]
}
],
"properties": {
"default": {
"type": "string"
},
"linux": {
"type": "string"
},
"macos": {
"type": "string"
},
"windows": {
"type": "string"
}
},
"title": "Path",
"type": "object"
},
"PlainFile": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/PlainFileProperties"
},
"process": {
"$ref": "#/definitions/PlainFileProperties"
},
"user": {
"$ref": "#/definitions/PlainFileProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "PlainFile",
"type": "object"
},
"PlainFileProperties": {
"additionalProperties": false,
"properties": {
"display_value": {
"type": "string"
},
"path": {
"$ref": "#/definitions/Path"
},
"selector": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"display_value",
"path",
"selector",
"value"
],
"title": "PlainFileProperties",
"type": "object"
},
"Registry": {
"additionalProperties": false,
"properties": {
"scope": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"machine"
]
},
{
"required": [
"process"
]
},
{
"required": [
"user"
]
}
],
"properties": {
"machine": {
"$ref": "#/definitions/RegistryProperties"
},
"process": {
"$ref": "#/definitions/RegistryProperties"
},
"user": {
"$ref": "#/definitions/RegistryProperties"
}
},
"type": "object"
}
},
"required": [
"scope"
],
"title": "Registry",
"type": "object"
},
"RegistryProperties": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"path": {
"pattern": "^(?!\\\\).+?(?<!\\\\)$",
"type": "string"
},
"root": {
"enum": [
"HKEY_CLASSES_ROOT",
"HKEY_CURRENT_CONFIG",
"HKEY_CURRENT_USER",
"HKEY_CURRENT_USER_LOCAL_SETTINGS",
"HKEY_LOCAL_MACHINE",
"HKEY_PERFORMANCE_DATA",
"HKEY_PERFORMANCE_NLSTEXT",
"HKEY_PERFORMANCE_TEXT",
"HKEY_USERS"
],
"type": "string"
},
"type": {
"enum": [
"REG_BINARY",
"REG_DWORD",
"REG_DWORD_LITTLE_ENDIAN",
"REG_DWORD_BIG_ENDIAN",
"REG_EXPAND_SZ",
"REG_LINK",
"REG_MULTI_SZ",
"REG_NONE",
"REG_QWORD",
"REG_QWORD_LITTLE_ENDIAN",
"REG_SZ"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
}
},
"required": [
"root",
"path",
"key",
"type",
"value"
],
"title": "RegistryProperties",
"type": "object"
},
"Target": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"exec"
]
},
{
"required": [
"env"
]
},
{
"required": [
"plain_file"
]
},
{
"required": [
"json_file"
]
},
{
"required": [
"registry"
]
},
{
"required": [
"noop"
]
}
],
"properties": {
"env": {
"$ref": "#/definitions/Env"
},
"exec": {
"$ref": "#/definitions/Exec"
},
"json_file": {
"$ref": "#/definitions/JSONFile"
},
"noop": {
"items": {
"$ref": "#/definitions/Noop"
},
"type": "array"
},
"plain_file": {
"$ref": "#/definitions/PlainFile"
},
"registry": {
"$ref": "#/definitions/Registry"
}
},
"title": "Target",
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"is_official": {
"type": "boolean"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"target": {
"$ref": "#/definitions/Target"
}
},
"required": [
"id",
"name",
"is_official"
],
"title": "Telemetry",
"type": "object"
},
"Toptout": {
"additionalProperties": false,
"properties": {
"category_id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"category_name": {
"type": "string"
},
"description": {
"type": "string"
},
"executable_name": {
"type": "string"
},
"id": {
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"name": {
"type": "string"
},
"telemetry": {
"items": {
"$ref": "#/definitions/Telemetry"
},
"type": "array"
}
},
"required": [
"description",
"category_id",
"category_name",
"id",
"links",
"name"
],
"title": "Toptout",
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"opt_in": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"opt_out": {
"type": "string"
}
},
"required": [
"opt_in",
"opt_out"
],
"title": "Value",
"type": "object"
}
}
} | MIT | en |
glasskube/glasskube | de5f04047231e623b1b413d40fc1ae894c6add4f | 2024-04-03T14:52:31 | website/static/schemas/v1/package-manifest.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"Dependency": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmManifest": {
"additionalProperties": false,
"properties": {
"chartName": {
"type": "string"
},
"chartVersion": {
"type": "string"
},
"repositoryUrl": {
"type": "string"
},
"values": {
"$ref": "#/$defs/JSON"
}
},
"required": [
"repositoryUrl",
"chartName",
"chartVersion"
],
"type": "object"
},
"JSON": {
"additionalProperties": true,
"type": "object"
},
"KustomizeManifest": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"PackageEntrypoint": {
"additionalProperties": false,
"properties": {
"localPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"scheme": {
"type": "string"
},
"serviceName": {
"type": "string"
}
},
"required": [
"serviceName",
"port"
],
"type": "object"
},
"PackageReference": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"label",
"url"
],
"type": "object"
},
"PartialJsonPatch": {
"additionalProperties": false,
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"op",
"path"
],
"type": "object"
},
"PlainManifest": {
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"TypedObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"ValueDefinition": {
"additionalProperties": false,
"properties": {
"constraints": {
"$ref": "#/$defs/ValueDefinitionConstraints"
},
"defaultValue": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ValueDefinitionMetadata"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"targets": {
"items": {
"$ref": "#/$defs/ValueDefinitionTarget"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/ValueType"
}
},
"required": [
"type",
"targets"
],
"type": "object"
},
"ValueDefinitionConstraints": {
"additionalProperties": false,
"properties": {
"max": {
"type": "integer"
},
"maxLength": {
"type": "integer"
},
"min": {
"type": "integer"
},
"minLength": {
"type": "integer"
},
"pattern": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"type": "object"
},
"ValueDefinitionMetadata": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"hints": {
"items": {
"type": "string"
},
"type": "array"
},
"label": {
"type": "string"
}
},
"type": "object"
},
"ValueDefinitionTarget": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"resource"
],
"title": "WithResource"
},
{
"required": [
"chartName"
],
"title": "WithChartName"
}
],
"properties": {
"chartName": {
"type": "string"
},
"patch": {
"$ref": "#/$defs/PartialJsonPatch"
},
"resource": {
"$ref": "#/$defs/TypedObjectReference"
},
"valueTemplate": {
"type": "string"
}
},
"required": [
"patch"
],
"type": "object"
},
"ValueType": {
"enum": [
"boolean",
"text",
"number",
"options"
],
"type": "string"
}
},
"$id": "https://glasskube.dev/schemas/v1/package-manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/$defs/Dependency"
},
"type": "array"
},
"entrypoints": {
"items": {
"$ref": "#/$defs/PackageEntrypoint"
},
"type": "array"
},
"helm": {
"$ref": "#/$defs/HelmManifest"
},
"iconUrl": {
"format": "uri",
"type": "string"
},
"kustomize": {
"$ref": "#/$defs/KustomizeManifest"
},
"longDescription": {
"type": "string"
},
"manifests": {
"items": {
"$ref": "#/$defs/PlainManifest"
},
"type": "array"
},
"name": {
"type": "string"
},
"references": {
"items": {
"$ref": "#/$defs/PackageReference"
},
"type": "array"
},
"shortDescription": {
"type": "string"
},
"valueDefinitions": {
"additionalProperties": {
"$ref": "#/$defs/ValueDefinition"
},
"type": "object"
}
},
"required": [
"name",
"defaultNamespace"
],
"type": "object"
} | Apache-2.0 | en |
glasskube/glasskube | c05e5ced509d6332434170f615c16fc417fa12e5 | 2024-02-19T15:54:54 | website/static/schemas/v1/index.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"PackageRepoIndexItem": {
"additionalProperties": false,
"properties": {
"iconUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"shortDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"$id": "https://glasskube.dev/schemas/v1/index.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"packages": {
"items": {
"$ref": "#/$defs/PackageRepoIndexItem"
},
"type": "array"
}
},
"required": [
"packages"
],
"type": "object"
} | Apache-2.0 | en |
glasskube/glasskube | fe856bc30aaaee861dba7b78e5cac6647de1db08 | 2024-02-20T15:46:36 | website/static/schemas/v1/index.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"PackageRepoIndexItem": {
"additionalProperties": false,
"properties": {
"iconUrl": {
"type": "string"
},
"latestVersion": {
"type": "string"
},
"name": {
"type": "string"
},
"shortDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"$id": "https://glasskube.dev/schemas/v1/index.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"packages": {
"items": {
"$ref": "#/$defs/PackageRepoIndexItem"
},
"type": "array"
}
},
"required": [
"packages"
],
"type": "object"
} | Apache-2.0 | en |
glasskube/glasskube | 8e1c66365ac894e3de7c406d698021b33fcb632b | 2024-04-03T08:34:23 | website/static/schemas/v1/package-manifest.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"Dependency": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmManifest": {
"additionalProperties": false,
"properties": {
"chartName": {
"type": "string"
},
"chartVersion": {
"type": "string"
},
"repositoryUrl": {
"type": "string"
},
"values": {
"$ref": "#/$defs/JSON"
}
},
"required": [
"repositoryUrl",
"chartName",
"chartVersion"
],
"type": "object"
},
"JSON": {
"additionalProperties": true,
"type": "object"
},
"KustomizeManifest": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"PackageEntrypoint": {
"additionalProperties": false,
"properties": {
"localPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"scheme": {
"type": "string"
},
"serviceName": {
"type": "string"
}
},
"required": [
"serviceName",
"port"
],
"type": "object"
},
"PackageReference": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"label",
"url"
],
"type": "object"
},
"PartialJsonPatch": {
"additionalProperties": false,
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"op",
"path"
],
"type": "object"
},
"PlainManifest": {
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"TypedObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"ValueDefinition": {
"additionalProperties": false,
"properties": {
"constraints": {
"$ref": "#/$defs/ValueDefinitionConstraints"
},
"defaultValue": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ValueDefinitionMetadata"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"targets": {
"items": {
"$ref": "#/$defs/ValueDefinitionTarget"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/ValueType"
}
},
"required": [
"type",
"targets"
],
"type": "object"
},
"ValueDefinitionConstraints": {
"additionalProperties": false,
"properties": {
"max": {
"type": "integer"
},
"maxLength": {
"type": "integer"
},
"min": {
"type": "integer"
},
"minLength": {
"type": "integer"
},
"required": {
"type": "boolean"
}
},
"type": "object"
},
"ValueDefinitionMetadata": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"hints": {
"items": {
"type": "string"
},
"type": "array"
},
"label": {
"type": "string"
}
},
"type": "object"
},
"ValueDefinitionTarget": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"resource"
],
"title": "WithResource"
},
{
"required": [
"chartName"
],
"title": "WithChartName"
}
],
"properties": {
"chartName": {
"type": "string"
},
"patch": {
"$ref": "#/$defs/PartialJsonPatch"
},
"resource": {
"$ref": "#/$defs/TypedObjectReference"
},
"valueTemplate": {
"type": "string"
}
},
"required": [
"patch"
],
"type": "object"
},
"ValueType": {
"enum": [
"boolean",
"text",
"number",
"options"
],
"type": "string"
}
},
"$id": "https://glasskube.dev/schemas/v1/package-manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/$defs/Dependency"
},
"type": "array"
},
"entrypoints": {
"items": {
"$ref": "#/$defs/PackageEntrypoint"
},
"type": "array"
},
"helm": {
"$ref": "#/$defs/HelmManifest"
},
"iconUrl": {
"format": "uri",
"type": "string"
},
"kustomize": {
"$ref": "#/$defs/KustomizeManifest"
},
"longDescription": {
"type": "string"
},
"manifests": {
"items": {
"$ref": "#/$defs/PlainManifest"
},
"type": "array"
},
"name": {
"type": "string"
},
"references": {
"items": {
"$ref": "#/$defs/PackageReference"
},
"type": "array"
},
"shortDescription": {
"type": "string"
},
"valueDefinitions": {
"additionalProperties": {
"$ref": "#/$defs/ValueDefinition"
},
"type": "object"
}
},
"required": [
"name",
"defaultNamespace"
],
"type": "object"
} | Apache-2.0 | en |
glasskube/glasskube | 3c83668ea65d240b678864e522d98a72f87d4cee | 2024-03-01T09:51:54 | website/static/schemas/v1/package-manifest.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"Dependency": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmManifest": {
"additionalProperties": false,
"properties": {
"chartName": {
"type": "string"
},
"chartVersion": {
"type": "string"
},
"repositoryUrl": {
"type": "string"
},
"values": {
"$ref": "#/$defs/JSON"
}
},
"required": [
"repositoryUrl",
"chartName",
"chartVersion"
],
"type": "object"
},
"JSON": {
"additionalProperties": true,
"type": "object"
},
"KustomizeManifest": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"PackageEntrypoint": {
"additionalProperties": false,
"properties": {
"localPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"scheme": {
"type": "string"
},
"serviceName": {
"type": "string"
}
},
"required": [
"serviceName",
"port"
],
"type": "object"
},
"PackageReference": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"label",
"url"
],
"type": "object"
},
"PlainManifest": {
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
},
"$id": "https://glasskube.dev/schemas/v1/package-manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/$defs/Dependency"
},
"type": "array"
},
"entrypoints": {
"items": {
"$ref": "#/$defs/PackageEntrypoint"
},
"type": "array"
},
"helm": {
"$ref": "#/$defs/HelmManifest"
},
"iconUrl": {
"format": "uri",
"type": "string"
},
"kustomize": {
"$ref": "#/$defs/KustomizeManifest"
},
"longDescription": {
"type": "string"
},
"manifests": {
"items": {
"$ref": "#/$defs/PlainManifest"
},
"type": "array"
},
"name": {
"type": "string"
},
"references": {
"items": {
"$ref": "#/$defs/PackageReference"
},
"type": "array"
},
"shortDescription": {
"type": "string"
}
},
"required": [
"name",
"defaultNamespace"
],
"type": "object"
} | Apache-2.0 | en |
glasskube/glasskube | d42fcb11c51631a558f32dfd58d251f7b5dcb2ee | 2024-02-16T11:57:18 | website/static/schemas/v1/package-manifest.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"HelmManifest": {
"additionalProperties": false,
"properties": {
"chartName": {
"type": "string"
},
"chartVersion": {
"type": "string"
},
"repositoryUrl": {
"type": "string"
},
"values": {
"$ref": "#/$defs/JSON"
}
},
"required": [
"repositoryUrl",
"chartName",
"chartVersion"
],
"type": "object"
},
"JSON": {
"additionalProperties": true,
"type": "object"
},
"KustomizeManifest": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"PackageEntrypoint": {
"additionalProperties": false,
"properties": {
"localPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"scheme": {
"type": "string"
},
"serviceName": {
"type": "string"
}
},
"required": [
"serviceName",
"port"
],
"type": "object"
},
"PackageReference": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"label",
"url"
],
"type": "object"
},
"PlainManifest": {
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
},
"$id": "https://glasskube.dev/schemas/v1/package-manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"entrypoints": {
"items": {
"$ref": "#/$defs/PackageEntrypoint"
},
"type": "array"
},
"helm": {
"$ref": "#/$defs/HelmManifest"
},
"iconUrl": {
"format": "uri",
"type": "string"
},
"kustomize": {
"$ref": "#/$defs/KustomizeManifest"
},
"longDescription": {
"type": "string"
},
"manifests": {
"items": {
"$ref": "#/$defs/PlainManifest"
},
"type": "array"
},
"name": {
"type": "string"
},
"references": {
"items": {
"$ref": "#/$defs/PackageReference"
},
"type": "array"
},
"shortDescription": {
"type": "string"
}
},
"required": [
"name",
"defaultNamespace"
],
"type": "object"
} | Apache-2.0 | en |
glasskube/glasskube | 97e17a5ff8bbb57f73fbcd9d39d1700797b0be6d | 2024-03-07T15:33:56 | website/static/schemas/v1/package-manifest.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"Dependency": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmManifest": {
"additionalProperties": false,
"properties": {
"chartName": {
"type": "string"
},
"chartVersion": {
"type": "string"
},
"repositoryUrl": {
"type": "string"
},
"values": {
"$ref": "#/$defs/JSON"
}
},
"required": [
"repositoryUrl",
"chartName",
"chartVersion"
],
"type": "object"
},
"JSON": {
"additionalProperties": true,
"type": "object"
},
"KustomizeManifest": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"PackageEntrypoint": {
"additionalProperties": false,
"properties": {
"localPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"scheme": {
"type": "string"
},
"serviceName": {
"type": "string"
}
},
"required": [
"serviceName",
"port"
],
"type": "object"
},
"PackageReference": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"label",
"url"
],
"type": "object"
},
"PlainManifest": {
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
},
"$id": "https://glasskube.dev/schemas/v1/package-manifest.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"defaultNamespace": {
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/$defs/Dependency"
},
"type": "array"
},
"entrypoints": {
"items": {
"$ref": "#/$defs/PackageEntrypoint"
},
"type": "array"
},
"helm": {
"$ref": "#/$defs/HelmManifest"
},
"iconUrl": {
"format": "uri",
"type": "string"
},
"kustomize": {
"$ref": "#/$defs/KustomizeManifest"
},
"longDescription": {
"type": "string"
},
"manifests": {
"items": {
"$ref": "#/$defs/PlainManifest"
},
"type": "array"
},
"name": {
"type": "string"
},
"references": {
"items": {
"$ref": "#/$defs/PackageReference"
},
"type": "array"
},
"shortDescription": {
"type": "string"
}
},
"required": [
"name",
"defaultNamespace"
],
"type": "object"
} | Apache-2.0 | en |
glasskube/glasskube | c05e5ced509d6332434170f615c16fc417fa12e5 | 2024-02-19T15:54:54 | website/static/schemas/v1/versions.json | 1,009 | 2024-05-27T04:41:49.164846Z | {
"$defs": {
"PackageIndexItem": {
"additionalProperties": false,
"properties": {
"version": {
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
}
},
"$id": "https://glasskube.dev/schemas/v1/versions.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"latestVersion": {
"type": "string"
},
"versions": {
"items": {
"$ref": "#/$defs/PackageIndexItem"
},
"type": "array"
}
},
"required": [
"versions",
"latestVersion"
],
"type": "object"
} | Apache-2.0 | en |
vmssoftware/vms-ide | 7e85aa2faa2aaaac84455539d540d95a82554c53 | 2021-11-09T09:43:59 | resources/synch_schema.json | 12 | 2024-05-28T05:44:51.301567Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"builds": {
"description": "Build settings",
"properties": {
"configurations": {
"default": [
{
"command": "",
"description": "debug",
"label": "DEBUG",
"parameter": "DEBUG"
},
{
"command": "",
"description": "release",
"label": "RELEASE",
"parameter": "RELEASE"
}
],
"description": "Build configurations",
"items": {
"properties": {
"command": {
"description": "Command to invoke the build",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"label": {
"description": "Configuration name",
"type": "string"
},
"parameter": {
"description": "Parameter to pass to the build command",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"project": {
"description": "Project settings",
"properties": {
"addCompDef": {
"default": "",
"description": "Additional compiler definitions",
"type": "string"
},
"addCompQual": {
"default": "",
"description": "Additional compiler qualifiers",
"type": "string"
},
"addIncludes": {
"default": "",
"description": "Additional include folders for the compiler",
"type": "string"
},
"addLibraries": {
"default": "",
"description": "Additional linker libraries",
"type": "string"
},
"break": {
"default": "C",
"description": "Debugger break key",
"type": "string"
},
"builders": {
"default": "*.{mms,com,opt}",
"description": "Builders",
"type": "string"
},
"exclude": {
"default": "**/{.vscode,out}",
"description": "Exclude pattern",
"type": "string"
},
"headers": {
"default": "*.{h,hpp}",
"description": "Headers pattern",
"type": "string"
},
"listing": {
"default": "*.{lis,map}",
"description": "Listing pattern",
"type": "string"
},
"outdir": {
"default": "out",
"description": "Output directory",
"type": "string"
},
"projectName": {
"default": "project",
"description": "Name of target",
"type": "string"
},
"projectType": {
"default": "executable",
"description": "Type of target",
"enum": [
"executable",
"library",
"shareable",
"java",
"kotlin",
"scala"
],
"enumDescriptions": [
"Produces executable image",
"Creates static library",
"Produces shareable image",
"Java project",
"Kotlin project",
"Scala project"
],
"type": "string"
},
"resource": {
"default": "**/resource/**/*.*",
"description": "Resource pattern",
"type": "string"
},
"root": {
"default": "project",
"description": "VMS root",
"type": "string"
},
"source": {
"default": "*.{c,cpp}",
"description": "Source pattern",
"type": "string"
}
},
"required": [
"root",
"projectName",
"projectType"
],
"type": "object"
},
"synchronize": {
"description": "Synchronization settings",
"properties": {
"downloadNewFiles": {
"default": "edit",
"description": "Download strategy",
"enum": [
"overwrite",
"skip",
"edit"
],
"enumDescriptions": [
"Overwrite older files on PC",
"Skip files with newer version from OpenVMS",
"Download and edit"
],
"type": "string"
},
"forceLocalTime": {
"default": true,
"description": "Force local time for ZIPped files",
"type": "boolean"
},
"keepAlive": {
"default": false,
"description": "Do not close connection",
"type": "boolean"
},
"preferZip": {
"default": false,
"description": "Use ZIP to upload files",
"type": "boolean"
},
"purge": {
"default": false,
"description": "Execute PURGE command after uploading",
"type": "boolean"
},
"setTimeAttempts": {
"default": 3,
"description": "Amount of tries to set file time",
"type": "number"
}
},
"type": "object"
}
},
"required": [
"project",
"synchronize",
"builds"
],
"type": "object"
} | MIT | en |
vmssoftware/vms-ide | 7e85aa2faa2aaaac84455539d540d95a82554c53 | 2021-11-09T09:43:59 | resources/ssh_schema.json | 12 | 2024-05-28T05:44:51.301567Z | {
"$defs": {
"host_props": {
"description": "Connection settings",
"properties": {
"algorithms": {
"default": {},
"description": "Additional algorithms passed to SSH connection",
"properties": {
"cipher": {
"description": "Algorithms for performing encryption",
"items": {
"description": "An algorithm for performing encryption",
"type": "string"
},
"type": "array"
},
"compress": {
"description": "SSH compression",
"items": {
"description": "SSH compression",
"type": "string"
},
"type": "array"
},
"hmac": {
"description": "Hash-based message authentication codes",
"items": {
"description": "Hash-based message authentication code",
"type": "string"
},
"type": "array"
},
"kex": {
"description": "Key exchange methods",
"items": {
"description": "Key exchange method",
"type": "string"
},
"type": "array"
},
"serverHostKey": {
"description": "Configures SSH to use a set of host key algorithms in the specified priority order.",
"items": {
"description": "Host key algorithm",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"host": {
"default": "<hostname>",
"description": "Host",
"type": "string"
},
"keyFile": {
"default": "",
"description": "SSH key file. Leave empty to use password authentication.",
"type": "string"
},
"password": {
"default": "",
"description": "Password, may be omitted",
"type": "string"
},
"port": {
"default": 22,
"description": "Port",
"type": "number"
},
"skipSignatureVerification": {
"default": false,
"description": "Skip signature verification",
"type": "boolean"
},
"supportSetFileTime": {
"default": true,
"description": "Server supports setting file time. Shell will be used as a fallback.",
"type": "boolean"
},
"unzipCmd": {
"default": "",
"description": "Command to unzip archive on VMS side",
"type": "string"
},
"username": {
"default": "",
"description": "Username",
"type": "string"
},
"zipCmd": {
"default": "",
"description": "Command to zip archive on VMS side",
"scope": "resource",
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"connection": {
"$ref": "#/$defs/host_props"
},
"host-collection": {
"description": "Predefined hosts collection",
"properties": {
"hosts": {
"description": "Predefined hosts",
"items": {
"allOf": [
{
"$ref": "#/$defs/host_props"
},
{
"properties": {
"label": {
"description": "Connection name",
"type": "string"
}
}
}
],
"required": [
"label"
]
},
"type": "array"
}
},
"required": [
"hosts"
],
"type": "object"
},
"terminal": {
"description": "Terminal settings",
"properties": {
"command": {
"description": "Command to invoke SSH client",
"type": "string"
}
},
"type": "object"
},
"timeouts": {
"description": "Timeouts",
"properties": {
"cmdTimeout": {
"default": 0,
"description": "Timeout for command response",
"type": "number"
},
"feedbackTimeout": {
"default": 0,
"description": "Feedback timeout",
"type": "number"
},
"welcomeTimeout": {
"default": 0,
"description": "Timeout for welcome parser",
"type": "number"
}
},
"type": "object"
}
},
"required": [
"connection"
],
"type": "object"
} | MIT | en |
vmssoftware/vms-ide | 50cbb8208645f21cc48ea604229a90ad81f63225 | 2021-11-23T09:18:16 | resources/ssh_schema.json | 12 | 2024-05-28T05:44:51.301567Z | {
"$defs": {
"host_props": {
"description": "Connection settings",
"properties": {
"algorithms": {
"default": {},
"description": "Additional algorithms passed to SSH connection",
"properties": {
"cipher": {
"description": "Algorithms for performing encryption",
"items": {
"description": "An algorithm for performing encryption",
"type": "string"
},
"type": "array"
},
"compress": {
"description": "SSH compression",
"items": {
"description": "SSH compression",
"type": "string"
},
"type": "array"
},
"hmac": {
"description": "Hash-based message authentication codes",
"items": {
"description": "Hash-based message authentication code",
"type": "string"
},
"type": "array"
},
"kex": {
"description": "Key exchange methods",
"items": {
"description": "Key exchange method",
"type": "string"
},
"type": "array"
},
"serverHostKey": {
"description": "Configures SSH to use a set of host key algorithms in the specified priority order.",
"items": {
"description": "Host key algorithm",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"debug": {
"default": false,
"description": "debug ssh protocol",
"type": "boolean"
},
"host": {
"default": "<hostname>",
"description": "Host",
"type": "string"
},
"keyFile": {
"default": "",
"description": "SSH key file. Leave empty to use password authentication.",
"type": "string"
},
"password": {
"default": "",
"description": "Password, may be omitted",
"type": "string"
},
"port": {
"default": 22,
"description": "Port",
"type": "number"
},
"supportSetFileTime": {
"default": true,
"description": "Server supports setting file time. Shell will be used as a fallback.",
"type": "boolean"
},
"unzipCmd": {
"default": "",
"description": "Command to unzip archive on VMS side",
"type": "string"
},
"username": {
"default": "",
"description": "Username",
"type": "string"
},
"zipCmd": {
"default": "",
"description": "Command to zip archive on VMS side",
"scope": "resource",
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"connection": {
"$ref": "#/$defs/host_props"
},
"host-collection": {
"description": "Predefined hosts collection",
"properties": {
"hosts": {
"description": "Predefined hosts",
"items": {
"allOf": [
{
"$ref": "#/$defs/host_props"
},
{
"properties": {
"label": {
"description": "Connection name",
"type": "string"
}
}
}
],
"required": [
"label"
]
},
"type": "array"
}
},
"required": [
"hosts"
],
"type": "object"
},
"terminal": {
"description": "Terminal settings",
"properties": {
"command": {
"description": "Command to invoke SSH client",
"type": "string"
}
},
"type": "object"
},
"timeouts": {
"description": "Timeouts",
"properties": {
"cmdTimeout": {
"default": 0,
"description": "Timeout for command response",
"type": "number"
},
"feedbackTimeout": {
"default": 0,
"description": "Feedback timeout",
"type": "number"
},
"welcomeTimeout": {
"default": 0,
"description": "Timeout for welcome parser",
"type": "number"
}
},
"type": "object"
}
},
"required": [
"connection"
],
"type": "object"
} | MIT | en |
vmssoftware/vms-ide | 87b093b581f25842c24bf8f62fdd78b207eb8762 | 2022-12-14T14:17:33 | resources/ssh_schema.json | 12 | 2024-05-28T05:44:51.301567Z | {
"$defs": {
"host_props": {
"description": "Connection settings",
"properties": {
"addConnectConfig": {
"default": null,
"description": "Values of customizing ConnectConfig",
"properties": {
"readyTimeout": {
"default": 20000,
"description": "Timeout for handshake",
"type": "number"
}
},
"type": "object"
},
"algorithms": {
"default": {},
"description": "Additional algorithms passed to SSH connection",
"properties": {
"cipher": {
"description": "Algorithms for performing encryption",
"items": {
"description": "An algorithm for performing encryption",
"type": "string"
},
"type": "array"
},
"compress": {
"description": "SSH compression",
"items": {
"description": "SSH compression",
"type": "string"
},
"type": "array"
},
"hmac": {
"description": "Hash-based message authentication codes",
"items": {
"description": "Hash-based message authentication code",
"type": "string"
},
"type": "array"
},
"kex": {
"description": "Key exchange methods",
"items": {
"description": "Key exchange method",
"type": "string"
},
"type": "array"
},
"serverHostKey": {
"description": "Configures SSH to use a set of host key algorithms in the specified priority order.",
"items": {
"description": "Host key algorithm",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"debug": {
"default": false,
"description": "debug ssh protocol",
"type": "boolean"
},
"host": {
"default": "<hostname>",
"description": "Host",
"type": "string"
},
"keyFile": {
"default": "",
"description": "SSH key file. Leave empty to use password authentication.",
"type": "string"
},
"password": {
"default": "",
"description": "Password, may be omitted",
"type": "string"
},
"port": {
"default": 22,
"description": "Port",
"type": "number"
},
"skipSignatureVerification": {
"default": false,
"description": "Skip signature verification",
"type": "boolean"
},
"supportSetFileTime": {
"default": true,
"description": "Server supports setting file time. Shell will be used as a fallback.",
"type": "boolean"
},
"unzipCmd": {
"default": "",
"description": "Command to unzip archive on VMS side",
"type": "string"
},
"username": {
"default": "",
"description": "Username",
"type": "string"
},
"zipCmd": {
"default": "",
"description": "Command to zip archive on VMS side",
"scope": "resource",
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"connection": {
"$ref": "#/$defs/host_props"
},
"host-collection": {
"description": "Predefined hosts collection",
"properties": {
"hosts": {
"description": "Predefined hosts",
"items": {
"allOf": [
{
"$ref": "#/$defs/host_props"
},
{
"properties": {
"label": {
"description": "Connection name",
"type": "string"
}
}
}
],
"required": [
"label"
]
},
"type": "array"
}
},
"required": [
"hosts"
],
"type": "object"
},
"terminal": {
"description": "Terminal settings",
"properties": {
"command": {
"description": "Command to invoke SSH client",
"type": "string"
}
},
"type": "object"
},
"timeouts": {
"description": "Timeouts",
"properties": {
"cmdTimeout": {
"default": 0,
"description": "Timeout for command response",
"type": "number"
},
"feedbackTimeout": {
"default": 0,
"description": "Feedback timeout",
"type": "number"
},
"welcomeTimeout": {
"default": 0,
"description": "Timeout for welcome parser",
"type": "number"
}
},
"type": "object"
}
},
"required": [
"connection"
],
"type": "object"
} | MIT | en |
vmssoftware/vms-ide | 691cd3ad0330a855f2cc7ab940adafcef10a7833 | 2021-11-25T11:41:39 | resources/ssh_schema.json | 12 | 2024-05-28T05:44:51.301567Z | {
"$defs": {
"host_props": {
"description": "Connection settings",
"properties": {
"algorithms": {
"default": {},
"description": "Additional algorithms passed to SSH connection",
"properties": {
"cipher": {
"description": "Algorithms for performing encryption",
"items": {
"description": "An algorithm for performing encryption",
"type": "string"
},
"type": "array"
},
"compress": {
"description": "SSH compression",
"items": {
"description": "SSH compression",
"type": "string"
},
"type": "array"
},
"hmac": {
"description": "Hash-based message authentication codes",
"items": {
"description": "Hash-based message authentication code",
"type": "string"
},
"type": "array"
},
"kex": {
"description": "Key exchange methods",
"items": {
"description": "Key exchange method",
"type": "string"
},
"type": "array"
},
"serverHostKey": {
"description": "Configures SSH to use a set of host key algorithms in the specified priority order.",
"items": {
"description": "Host key algorithm",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"debug": {
"default": false,
"description": "debug ssh protocol",
"type": "boolean"
},
"host": {
"default": "<hostname>",
"description": "Host",
"type": "string"
},
"keyFile": {
"default": "",
"description": "SSH key file. Leave empty to use password authentication.",
"type": "string"
},
"password": {
"default": "",
"description": "Password, may be omitted",
"type": "string"
},
"port": {
"default": 22,
"description": "Port",
"type": "number"
},
"skipSignatureVerification": {
"default": false,
"description": "Skip signature verification",
"type": "boolean"
},
"supportSetFileTime": {
"default": true,
"description": "Server supports setting file time. Shell will be used as a fallback.",
"type": "boolean"
},
"unzipCmd": {
"default": "",
"description": "Command to unzip archive on VMS side",
"type": "string"
},
"username": {
"default": "",
"description": "Username",
"type": "string"
},
"zipCmd": {
"default": "",
"description": "Command to zip archive on VMS side",
"scope": "resource",
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"connection": {
"$ref": "#/$defs/host_props"
},
"host-collection": {
"description": "Predefined hosts collection",
"properties": {
"hosts": {
"description": "Predefined hosts",
"items": {
"allOf": [
{
"$ref": "#/$defs/host_props"
},
{
"properties": {
"label": {
"description": "Connection name",
"type": "string"
}
}
}
],
"required": [
"label"
]
},
"type": "array"
}
},
"required": [
"hosts"
],
"type": "object"
},
"terminal": {
"description": "Terminal settings",
"properties": {
"command": {
"description": "Command to invoke SSH client",
"type": "string"
}
},
"type": "object"
},
"timeouts": {
"description": "Timeouts",
"properties": {
"cmdTimeout": {
"default": 0,
"description": "Timeout for command response",
"type": "number"
},
"feedbackTimeout": {
"default": 0,
"description": "Feedback timeout",
"type": "number"
},
"welcomeTimeout": {
"default": 0,
"description": "Timeout for welcome parser",
"type": "number"
}
},
"type": "object"
}
},
"required": [
"connection"
],
"type": "object"
} | MIT | en |
mimuret/dtap | 5682fbea4889cef9eaf971c2e452f174da2174fa | 2022-09-18T14:20:37 | pkg/plugin/filter/matcher/config-schema.json | 18 | 2024-05-29T09:34:01.664434Z | {
"$defs": {
"ConfigSet": {
"properties": {
"Matchers": {
"items": {
"$ref": "#/$defs/MatcherConfig"
},
"type": "array"
},
"Op": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"SubConfigs": {
"items": {
"$ref": "#/$defs/ConfigSet"
},
"type": "array"
}
},
"required": [
"Op"
],
"title": "ConfigSet",
"type": "object"
},
"MatcherConfig": {
"properties": {
"Arg": {
"type": [
"integer",
"string"
]
},
"Name": {
"type": "string"
},
"Type": {
"enum": [
"DNS",
"DNSTAP"
],
"type": "string"
}
},
"required": [
"Type",
"Name",
"Arg"
],
"title": "MatcherConfig",
"type": "object"
}
},
"$id": "/pkg/plugin/filter/matcher/config-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "The `matcher` is the filter plugin that filters DNSTAP message using rules.",
"properties": {
"Name": {
"const": "matcher"
},
"Rule": {
"$ref": "#/$defs/ConfigSet",
"description": "The `Rule` is the rule set. see https://pkg.go.dev/github.com/mimuret/dnsutils/matcher#Config"
}
},
"required": [
"Name",
"Rule"
],
"title": "matcher filter plugin",
"type": "object"
} | Apache-2.0 | en |
mimuret/dtap | e849efe11448322b18f04b12076456dfff031f15 | 2023-08-10T08:19:33 | pkg/plugin/filter/matcher/config-schema.json | 18 | 2024-05-29T09:34:01.664434Z | {
"$defs": {
"ConfigSet": {
"properties": {
"Matchers": {
"items": {
"$ref": "#/$defs/MatcherConfig"
},
"type": "array"
},
"Op": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"SubConfigs": {
"items": {
"$ref": "#/$defs/ConfigSet"
},
"type": "array"
}
},
"required": [
"Op"
],
"title": "ConfigSet",
"type": "object"
},
"MatcherConfig": {
"properties": {
"Arg": {
"type": [
"integer",
"string"
]
},
"Name": {
"type": "string"
},
"Type": {
"enum": [
"DNS",
"DNSTAP"
],
"type": "string"
}
},
"required": [
"Type",
"Name",
"Arg"
],
"title": "MatcherConfig",
"type": "object"
}
},
"$id": "/pkg/plugin/filter/matcher/config-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "The `matcher` is the filter plugin that filters DNSTAP message using rules.",
"properties": {
"Name": {
"const": "matcher"
},
"Rule": {
"$ref": "#/$defs/ConfigSet",
"description": "The `Rule` is the rule set. see https://pkg.go.dev/github.com/mimuret/dnsutils/matcher#Config"
}
},
"required": [
"Name",
"Rule"
],
"title": "matcher filter plugin",
"type": "object"
} | Apache-2.0 | en |
mimuret/dtap | 5682fbea4889cef9eaf971c2e452f174da2174fa | 2022-09-18T14:20:37 | pkg/plugin/input/file/config-schema.json | 18 | 2024-05-29T09:34:01.664434Z | {
"$id": "/pkg/plugin/input/file/config-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "The `file` is the input plugin that input DNSTAP message from file.",
"properties": {
"Name": {
"const": "file"
},
"Path": {
"description": "The `Path` is the file path of DNSTAP message file.",
"type": "string"
}
},
"required": [
"Name",
"Path"
],
"title": "file input plugin",
"type": "object"
} | Apache-2.0 | en |
mimuret/dtap | d47c6bc934b175b82baab1394b3ce3f193232c81 | 2023-10-15T15:59:44 | pkg/plugin/input/file/config-schema.json | 18 | 2024-05-29T09:34:01.664434Z | {
"$id": "/pkg/plugin/input/file/config-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "The `file` is the input plugin that input DNSTAP message from file.",
"properties": {
"ID": {
"type": "string"
},
"Name": {
"const": "file"
},
"Path": {
"description": "The `Path` is the file path of DNSTAP message file.",
"type": "string"
}
},
"required": [
"Name",
"ID",
"Path"
],
"title": "file input plugin",
"type": "object"
} | Apache-2.0 | en |
mimuret/dtap | d47c6bc934b175b82baab1394b3ce3f193232c81 | 2023-10-15T15:59:44 | schemas/schema.json | 18 | 2024-05-29T09:34:01.664434Z | {
"$defs": {
"BufferConfig": {
"description": "Buffer config",
"properties": {
"Size": {
"default": 10000,
"description": "Buffer Size",
"minimum": 1,
"type": "integer"
}
},
"title": "BufferConfig",
"type": "object"
},
"Filters": {
"items": {
"$ref": "/schemas/filter_plugins.json"
},
"title": "FiltersPlugins",
"type": "array"
},
"InputFilterWorkerNum": {
"default": 1,
"description": "The number of input filter goroutine workers",
"minimum": 1,
"title": "InputFilterWorkerNum",
"type": "integer"
},
"Inputs": {
"items": {
"$ref": "/schemas/input_plugins.json"
},
"minItems": 1,
"title": "InputPlugins",
"type": "array"
},
"LogLevel": {
"default": "info",
"description": "Log level",
"enum": [
"debug",
"info",
"warn",
"error",
"dpanic",
"panic",
"fatal"
],
"title": "LogLevel",
"type": "string"
},
"ManageHTTPSServer": {
"default": ":9520",
"description": "Metrics listener address host:port format",
"title": "ManageHTTPSServer",
"type": "string"
},
"OutputGroup": {
"properties": {
"BufferConfig": {
"$ref": "#/$defs/BufferConfig"
},
"Filters": {
"$ref": "#/$defs/Filters"
},
"Name": {
"type": "string"
},
"Outputs": {
"items": {
"$ref": "/schemas/output_plugins.json"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"Outputs"
],
"title": "OutputGroup",
"type": "object"
},
"OutputGroups": {
"items": {
"$ref": "#/$defs/OutputGroup"
},
"minItems": 1,
"title": "OutputGroups",
"type": "array"
}
},
"$id": "/schemas/schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "The DTAP version 2 config schema",
"properties": {
"Filters": {
"$ref": "#/$defs/Filters"
},
"InputBufferConfig": {
"$ref": "#/$defs/BufferConfig"
},
"InputFilterWorkerNum": {
"$ref": "#/$defs/InputFilterWorkerNum"
},
"Inputs": {
"$ref": "#/$defs/Inputs"
},
"LogLevel": {
"$ref": "#/$defs/LogLevel"
},
"ManageHTTPSServer": {
"$ref": "#/$defs/ManageHTTPSServer"
},
"OutputGroups": {
"$ref": "#/$defs/OutputGroups"
}
},
"required": [
"Inputs",
"OutputGroups"
],
"title": "DTAP version 2 Config schema",
"type": "object"
} | Apache-2.0 | en |
mimuret/dtap | 5682fbea4889cef9eaf971c2e452f174da2174fa | 2022-09-18T14:20:37 | schemas/schema.json | 18 | 2024-05-29T09:34:01.664434Z | {
"$defs": {
"BufferConfig": {
"description": "Buffer config",
"properties": {
"Size": {
"default": 10000,
"description": "Buffer Size",
"minimum": 1,
"type": "integer"
}
},
"title": "BufferConfig",
"type": "object"
},
"Filters": {
"items": {
"$ref": "/schemas/filter_plugins.json"
},
"title": "FiltersPlugins",
"type": "array"
},
"InputFilterWorkerNum": {
"default": 1,
"description": "The number of input filter goroutine workers",
"minimum": 1,
"title": "InputFilterWorkerNum",
"type": "integer"
},
"Inputs": {
"items": {
"$ref": "/schemas/input_plugins.json"
},
"minItems": 1,
"title": "InputPlugins",
"type": "array"
},
"LogLevel": {
"default": "info",
"description": "Log level",
"enum": [
"debug",
"info",
"warn",
"error",
"dpanic",
"panic",
"fatal"
],
"title": "LogLevel",
"type": "string"
},
"MetricsListen": {
"default": ":9520",
"description": "Metrics listener address host:port format",
"title": "MetricsListen",
"type": "string"
},
"OutputGroup": {
"properties": {
"BufferConfig": {
"$ref": "#/$defs/BufferConfig"
},
"Filters": {
"$ref": "#/$defs/Filters"
},
"Name": {
"type": "string"
},
"Outputs": {
"items": {
"$ref": "/schemas/output_plugins.json"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"Outputs"
],
"title": "OutputGroup",
"type": "object"
},
"OutputGroups": {
"items": {
"$ref": "#/$defs/OutputGroup"
},
"minItems": 1,
"title": "OutputGroups",
"type": "array"
}
},
"$id": "/schemas/schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "The DTAP version 2 config schema",
"properties": {
"Filters": {
"$ref": "#/$defs/Filters"
},
"InputBufferConfig": {
"$ref": "#/$defs/BufferConfig"
},
"InputFilterWorkerNum": {
"$ref": "#/$defs/InputFilterWorkerNum"
},
"Inputs": {
"$ref": "#/$defs/Inputs"
},
"LogLevel": {
"$ref": "#/$defs/LogLevel"
},
"MetricsListen": {
"$ref": "#/$defs/MetricsListen"
},
"OutputGroups": {
"$ref": "#/$defs/OutputGroups"
}
},
"required": [
"Inputs",
"OutputGroups"
],
"title": "DTAP version 2 Config schema",
"type": "object"
} | Apache-2.0 | en |
mimuret/dtap | d47c6bc934b175b82baab1394b3ce3f193232c81 | 2023-10-15T15:59:44 | pkg/plugin/filter/matcher/config-schema.json | 18 | 2024-05-29T09:34:01.664434Z | {
"$defs": {
"ConfigSet": {
"properties": {
"Matchers": {
"items": {
"$ref": "#/$defs/MatcherConfig"
},
"type": "array"
},
"Op": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"SubConfigs": {
"items": {
"$ref": "#/$defs/ConfigSet"
},
"type": "array"
}
},
"required": [
"Op"
],
"title": "ConfigSet",
"type": "object"
},
"MatcherConfig": {
"properties": {
"Arg": {
"type": [
"integer",
"string"
]
},
"Name": {
"type": "string"
},
"Type": {
"enum": [
"DNS",
"DNSTAP"
],
"type": "string"
}
},
"required": [
"Type",
"Name",
"Arg"
],
"title": "MatcherConfig",
"type": "object"
}
},
"$id": "/pkg/plugin/filter/matcher/config-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "The `matcher` is the filter plugin that filters DNSTAP message using rules.",
"properties": {
"ID": {
"type": "string"
},
"Name": {
"const": "matcher"
},
"Rule": {
"$ref": "#/$defs/ConfigSet",
"description": "The `Rule` is the rule set. see https://pkg.go.dev/github.com/mimuret/dnsutils/matcher#Config"
}
},
"required": [
"Name",
"ID",
"Rule"
],
"title": "matcher filter plugin",
"type": "object"
} | Apache-2.0 | en |
apereo/cas | 9936e1681236be96db42725a847b114f03da69fa | 2023-09-21T11:16:44 | support/cas-server-support-palantir/src/test/resources/schema/SimpleContainer2.schema.json | 10,701 | 2024-05-29T15:22:03.493453Z | {
"$defs": {
"AttributeBasedRegisteredServiceAccessStrategyActivationCriteria": {
"properties": {
"@class": {
"const": "org.apereo.cas.services.AttributeBasedRegisteredServiceAccessStrategyActivationCriteria"
},
"allowIfInactive": {
"type": "boolean"
},
"operator": {
"$ref": "#/$defs/LogicalOperatorTypes"
},
"order": {
"type": "integer"
},
"requiredAttributes": {
"$ref": "#/$defs/Map(String,Object)"
}
},
"required": [
"@class"
],
"type": "object"
},
"ChainingRegisteredServiceAccessStrategyActivationCriteria": {
"properties": {
"@class": {
"const": "org.apereo.cas.services.ChainingRegisteredServiceAccessStrategyActivationCriteria"
},
"conditions": {
"items": {
"$ref": "#/$defs/RegisteredServiceAccessStrategyActivationCriteria"
},
"type": "array"
},
"operator": {
"$ref": "#/$defs/LogicalOperatorTypes"
}
},
"required": [
"@class"
],
"type": "object"
},
"GroovyRegisteredServiceAccessStrategyActivationCriteria": {
"properties": {
"@class": {
"const": "org.apereo.cas.services.GroovyRegisteredServiceAccessStrategyActivationCriteria"
},
"groovyScript": {
"type": "string"
},
"order": {
"type": "integer"
}
},
"required": [
"@class"
],
"type": "object"
},
"LogicalOperatorTypes": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"Map(String,Object)": {
"type": "object"
},
"RegisteredServiceAccessStrategyActivationCriteria": {
"anyOf": [
{
"$ref": "#/$defs/AttributeBasedRegisteredServiceAccessStrategyActivationCriteria"
},
{
"$ref": "#/$defs/ChainingRegisteredServiceAccessStrategyActivationCriteria"
},
{
"$ref": "#/$defs/GroovyRegisteredServiceAccessStrategyActivationCriteria"
}
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"criteria": {
"$ref": "#/$defs/RegisteredServiceAccessStrategyActivationCriteria"
}
},
"type": "object"
} | Apache-2.0 | en |
apereo/cas | dd00afbc7b999c7390582bee851f205c016b67f3 | 2023-09-20T12:00:50 | support/cas-server-support-palantir/src/test/resources/schema/SimpleContainer2.schema.json | 10,701 | 2024-05-29T15:22:03.493453Z | {
"$defs": {
"AttributeBasedRegisteredServiceAccessStrategyActivationCriteria": {
"properties": {
"@class": {
"const": "org.apereo.cas.services.AttributeBasedRegisteredServiceAccessStrategyActivationCriteria"
},
"allowIfInactive": {
"type": "boolean"
},
"operator": {
"$ref": "#/$defs/LogicalOperatorTypes"
},
"order": {
"type": "integer"
},
"requiredAttributes": {
"$ref": "#/$defs/Map(String,Object)"
}
},
"required": [
"@class"
],
"type": "object"
},
"ChainingRegisteredServiceAccessStrategyActivationCriteria": {
"properties": {
"@class": {
"const": "org.apereo.cas.services.ChainingRegisteredServiceAccessStrategyActivationCriteria"
},
"conditions": {
"items": {
"$ref": "#/$defs/RegisteredServiceAccessStrategyActivationCriteria"
},
"type": "array"
},
"operator": {
"$ref": "#/$defs/LogicalOperatorTypes"
}
},
"required": [
"@class"
],
"type": "object"
},
"GroovyRegisteredServiceAccessStrategyActivationCriteria": {
"properties": {
"@class": {
"const": "org.apereo.cas.services.GroovyRegisteredServiceAccessStrategyActivationCriteria"
},
"groovyScript": {
"type": "string"
},
"order": {
"type": "integer"
}
},
"required": [
"@class"
],
"type": "object"
},
"LogicalOperatorTypes": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"Map(String,Object)": {
"type": "object"
},
"RegisteredServiceAccessStrategyActivationCriteria": {
"anyOf": [
{
"$ref": "#/$defs/AttributeBasedRegisteredServiceAccessStrategyActivationCriteria"
},
{
"$ref": "#/$defs/ChainingRegisteredServiceAccessStrategyActivationCriteria"
},
{
"$ref": "#/$defs/GroovyRegisteredServiceAccessStrategyActivationCriteria"
}
],
"properties": {
"@class": {
"const": "org.apereo.cas.services.RegisteredServiceAccessStrategyActivationCriteria"
}
},
"required": [
"@class"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"criteria": {
"$ref": "#/$defs/RegisteredServiceAccessStrategyActivationCriteria"
}
},
"type": "object"
} | Apache-2.0 | en |
omissis/go-jsonschema | 7f75500c04a4597c5c4abdd7df7e385e723504df | 2024-04-25T20:11:53 | tests/data/schemaExtensions/nonNillable/nillability.json | 523 | 2024-05-29T18:15:48.573056Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"goJSONSchema": {
"nillable": false,
"type": "map[bool]string"
},
"type": "string"
}
},
"type": "object"
} | MIT | en |
omissis/go-jsonschema | 7f75500c04a4597c5c4abdd7df7e385e723504df | 2024-04-25T20:11:53 | tests/data/schemaExtensions/nillable/nillability.json | 523 | 2024-05-29T18:15:48.573056Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"goJSONSchema": {
"nillable": true,
"type": "map[bool]string"
},
"type": "string"
}
},
"type": "object"
} | MIT | en |
synadia-io/rethink_connectivity | 8103667af096e0aaff9d25b1ca18b58e560f50a9 | 2024-01-05T22:31:42 | 09-microservices/client/request.json | 41 | 2024-05-27T05:42:13.496023Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
} | Apache-2.0 | en |
synadia-io/rethink_connectivity | 8103667af096e0aaff9d25b1ca18b58e560f50a9 | 2024-01-05T22:31:42 | 09-microservices/client/response.json | 41 | 2024-05-27T05:42:13.496023Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"lang": {
"type": "string"
},
"score": {
"type": "integer"
},
"sentences": {
"items": {
"additionalProperties": false,
"properties": {
"score": {
"type": "integer"
},
"sentence": {
"type": "string"
}
},
"required": [
"sentence",
"score"
],
"type": "object"
},
"type": "array"
},
"words": {
"items": {
"additionalProperties": false,
"properties": {
"score": {
"type": "integer"
},
"word": {
"type": "string"
}
},
"required": [
"word",
"score"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"lang",
"words",
"score"
],
"type": "object"
} | Apache-2.0 | en |
timvink/mkdocs-git-revision-date-localized-plugin | 27765ad6860aed8dd421b8f0d1e909e2f1d4c6a7 | 2022-07-14T08:20:55 | docs/schema.json | 176 | 2024-05-28T03:06:21.190864Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"git-revision-date-localized"
],
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/"
},
{
"additionalProperties": false,
"properties": {
"git-revision-date-localized": {
"additionalProperties": false,
"defaultSnippets": [
{
"body": "type: date",
"label": "type"
}
],
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/",
"properties": {
"custom_format": {
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options#custom_format",
"title": "Custom format",
"type": "string"
},
"enable_creation_date": {
"default": false,
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enable_creation_date",
"title": "Enable support for creation date",
"type": "boolean"
},
"enabled": {
"default": true,
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enabled",
"title": "Enable plugin",
"type": "boolean"
},
"exclude": {
"items": {
"pattern": "(\\*|\\.md)$"
},
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#exclude",
"title": "List of Markdown file patterns",
"type": "array"
},
"fallback_to_build_date": {
"default": false,
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#fallback_to_build_date",
"title": "Use build date when git is not available",
"type": "boolean"
},
"locale": {
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#locale",
"title": "Date locale",
"type": "string"
},
"timezone": {
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#timezone",
"title": "Date timezone",
"type": "string"
},
"type": {
"default": "date",
"enum": [
"date",
"datetime",
"iso_date",
"iso_datetime",
"timeago",
"custom"
],
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#type",
"title": "Date display format",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Git revision date plugin with localization support"
} | MIT | en |
timvink/mkdocs-table-reader-plugin | 2c7dc62a020f7e2fee7e2ed63b18448bdd408b68 | 2024-03-08T15:29:00 | docs/schema.json | 104 | 2024-05-28T04:35:22.145478Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"table-reader"
],
"markdownDescription": "https://timvink.github.io/mkdocs-table-reader-plugin/"
},
{
"additionalProperties": false,
"properties": {
"table-reader": {
"additionalProperties": false,
"markdownDescription": "https://timvink.github.io/mkdocs-table-reader-plugin/options/",
"properties": {
"allow_missing_files": {
"default": false,
"markdownDescription": "https://timvink.github.io/mkdocs-table-reader-plugin/options/#allow_missing_files",
"title": "When enabled, if a filepath is not found, the plugin will raise a warning instead of an error.",
"type": "boolean"
},
"base_path": {
"default": "config_dir",
"enum": [
"config_dir",
"docs_dir"
],
"markdownDescription": "https://timvink.github.io/mkdocs-table-reader-plugin/options/#base_path",
"title": "The base path where mkdocs-table-reader-plugin will search for input files. The path to your table files should be relative to the base_path.",
"type": "string"
},
"data_path": {
"default": ".",
"markdownDescription": "https://timvink.github.io/mkdocs-table-reader-plugin/options/#data_path",
"title": "The path to your table files should be relative to the base_path. If you use a folder for all your table files you can shorten the path specification by setting the data_path.",
"type": "string"
},
"search_page_directory": {
"default": true,
"markdownDescription": "https://timvink.github.io/mkdocs-table-reader-plugin/options/#search_page_directory",
"title": "When enabled, if a filepath is not found, the plugin will also attempt to find the file relative to the current page's directory.",
"type": "boolean"
},
"select_readers": {
"default": [
"read_csv",
"read_fwf",
"read_yaml",
"read_table",
"read_json",
"read_feather",
"read_excel",
"read_raw"
],
"items": {
"anyOf": [
{
"const": "read_csv",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_csv",
"title": "{{ read_csv() }} passed to pandas.read_csv()"
},
{
"const": "read_fwf",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_fwf",
"title": "{{ read_fwf() }} passed to pandas.read_fwf()"
},
{
"const": "read_yaml",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_yaml",
"title": "{{ read_yaml() }} is parsed with yaml.safe_load() and passed to pandas.json_normalize()"
},
{
"const": "read_table",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_table",
"title": "{{ read_table() }} passed to pandas.read_table()"
},
{
"const": "read_json",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_json",
"title": "{{ read_json() }} passed to pandas.read_json()"
},
{
"const": "read_feather",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_feather",
"title": "{{ read_feather() }} passed to pandas.read_feather()"
},
{
"const": "read_excel",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_excel",
"title": "{{ read_excel() }} passed to pandas.read_excel()"
},
{
"const": "read_raw",
"description": "https://timvink.github.io/mkdocs-table-reader-plugin/readers/#read_raw",
"title": "{{ read_raw() }} inserts contents from a file directly. This is great if you have a file with a table already in markdown format. It could also replace a workflow where you use the snippets extension to embed external files."
}
]
},
"markdownDescription": "https://timvink.github.io/mkdocs-table-reader-plugin/options/#select_readers",
"title": "Specify a list of reader to improve documentation build times for large sites.",
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "MkDocs plugin that enables a markdown tag like {{ read_csv('table.csv') }} to directly insert various table formats into a page."
} | MIT | en |
datalad/datalad-catalog | d6078f72acb445b9acd43e7e0b4e09407ecac38a | 2023-02-05T13:46:47 | datalad_catalog/catalog/assets/jsonschema_metadata_sources.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.metadata_sources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of sources of metadata for a dataset or file in the catalog, including which sources have provided content for which fields",
"properties": {
"key_source_map": {
"description": "A mapping of sources to catalog fields",
"title": "Key-source map",
"type": "object"
},
"sources": {
"description": "A list of sources of metadata for a dataset or file in the catalog",
"items": {
"properties": {
"agent_email": {
"description": "git identity email of person/process that sourced the metadata",
"title": "Agent email",
"type": "string"
},
"agent_name": {
"description": "git identity name of person/process that sourced the metadata",
"title": "Agent name",
"type": "string"
},
"source_name": {
"description": "The source name",
"title": "Source name",
"type": "string"
},
"source_parameter": {
"description": "Parameters used together with the source",
"title": "Source parameter",
"type": "object"
},
"source_time": {
"description": "The time (since epoch) when this source was used to provide the applicable metadata",
"title": "Source time",
"type": "number"
},
"source_version": {
"description": "The source version",
"title": "Source version",
"type": "string"
}
},
"required": [
"source_name",
"source_version"
],
"type": "object"
},
"minItems": 1,
"title": "Sources",
"type": "array",
"uniqueItems": true
}
},
"required": [
"sources"
],
"title": "metadata_sources",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | c0a0fabaf47e885ae69d3c2d1f3d88a7e4124383 | 2023-03-12T18:55:51 | datalad_catalog/catalog/assets/jsonschema_file.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.file.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A file in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additional items to display on the file level",
"items": {
"properties": {
"content": {
"description": "The content that will appear when selecting the file, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"contentbytesize": {
"description": "The size of the file in bytes",
"title": "Content byte size",
"type": "number"
},
"dataset_id": {
"description": "The parent dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The parent dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"path": {
"description": "The path of the file relative to its parent dataset",
"title": "Path",
"type": "string"
},
"type": {
"description": "The type of item",
"pattern": "file",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the annexed file",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"path"
],
"title": "file",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 25b5dae338644a1a80eabfc177cecfa39eb8efc5 | 2022-11-11T14:52:40 | datalad_catalog/catalog/assets/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additonal items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"type": "string"
},
"extractors_used": {
"$ref": "https://datalad.org/catalog.extractors.schema.json"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "The long name of the dataset",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additonal items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"name"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 10667b733eae936d47c31be15134f62c79443b3d | 2022-11-23T21:30:10 | datalad_catalog/catalog/assets/jsonschema_file.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.file.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A file in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additonal items to display on the file level",
"items": {
"properties": {
"content": {
"description": "The content that will appear when selecting the file, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"contentbytesize": {
"description": "The size of the file in bytes",
"title": "Content byte size",
"type": "number"
},
"dataset_id": {
"description": "The parent dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The parent dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"extractors_used": {
"$ref": "https://datalad.org/catalog.extractors.schema.json"
},
"path": {
"description": "The path of the file relative to its parent dataset",
"title": "Path",
"type": "string"
},
"type": {
"description": "The type of item",
"pattern": "file",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the annexed file",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"path"
],
"title": "file",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 25b5dae338644a1a80eabfc177cecfa39eb8efc5 | 2022-11-11T14:52:40 | datalad_catalog/catalog/assets/jsonschema_catalog.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "dataset"
}
}
},
"then": {
"$ref": "https://datalad.org/catalog.dataset.schema.json"
}
},
{
"if": {
"properties": {
"type": {
"const": "file"
}
}
},
"then": {
"$ref": "https://datalad.org/catalog.file.schema.json"
}
}
],
"description": "The main catalog schema",
"title": "catalog",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | b8e38ad22e76c08729d3393f06655c1b65344c3f | 2023-10-04T20:49:20 | datalad_catalog/catalog/schema/jsonschema_file.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.file.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A file in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additional items to display on the file level",
"items": {
"properties": {
"content": {
"description": "The content that will appear when selecting the file, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"contentbytesize": {
"description": "The size of the file in bytes",
"title": "Content byte size",
"type": "number"
},
"dataset_id": {
"description": "The parent dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The parent dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"path": {
"description": "The path of the file relative to its parent dataset",
"title": "Path",
"type": "string"
},
"type": {
"description": "The type of item",
"pattern": "file",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the annexed file",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"path",
"metadata_sources"
],
"title": "file",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 67d7f30eba76042acb4c3cb6af688740757f90c6 | 2022-11-10T21:46:26 | datalad_catalog/catalog/assets/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additonal items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"type": "string"
},
"extractors_used": {
"$ref": "https://datalad.org/catalog.extractors.schema.json"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "The long name of the dataset",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additonal items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"name"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 4afa4dfc38f2ed3ebf9bc9a1a988d349a0b932fe | 2023-06-04T21:46:27 | datalad_catalog/catalog/schema/jsonschema_catalog.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "dataset"
}
}
},
"then": {
"$ref": "https://datalad.org/catalog.dataset.schema.json"
}
},
{
"if": {
"properties": {
"type": {
"const": "file"
}
}
},
"then": {
"$ref": "https://datalad.org/catalog.file.schema.json"
}
}
],
"description": "The main catalog schema",
"title": "catalog",
"type": "object",
"version": "1.0.0"
} | MIT | en |
datalad/datalad-catalog | 25b5dae338644a1a80eabfc177cecfa39eb8efc5 | 2022-11-11T14:52:40 | datalad_catalog/catalog/assets/jsonschema_authors.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.authors.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Authors, creators, or maintainers of the entity",
"items": {
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "authors",
"type": "array",
"uniqueItems": true
} | MIT | en |
datalad/datalad-catalog | 4afa4dfc38f2ed3ebf9bc9a1a988d349a0b932fe | 2023-06-04T21:46:27 | datalad_catalog/catalog/schema/jsonschema_file.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.file.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A file in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additional items to display on the file level",
"items": {
"properties": {
"content": {
"description": "The content that will appear when selecting the file, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"contentbytesize": {
"description": "The size of the file in bytes",
"title": "Content byte size",
"type": "number"
},
"dataset_id": {
"description": "The parent dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The parent dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"path": {
"description": "The path of the file relative to its parent dataset",
"title": "Path",
"type": "string"
},
"type": {
"description": "The type of item",
"pattern": "file",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the annexed file",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"path"
],
"title": "file",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | d6078f72acb445b9acd43e7e0b4e09407ecac38a | 2023-02-05T13:46:47 | datalad_catalog/catalog/assets/jsonschema_file.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.file.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A file in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additonal items to display on the file level",
"items": {
"properties": {
"content": {
"description": "The content that will appear when selecting the file, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"contentbytesize": {
"description": "The size of the file in bytes",
"title": "Content byte size",
"type": "number"
},
"dataset_id": {
"description": "The parent dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The parent dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"path": {
"description": "The path of the file relative to its parent dataset",
"title": "Path",
"type": "string"
},
"type": {
"description": "The type of item",
"pattern": "file",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the annexed file",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"path"
],
"title": "file",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | c0a0fabaf47e885ae69d3c2d1f3d88a7e4124383 | 2023-03-12T18:55:51 | datalad_catalog/catalog/assets/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"access_request_contact": {
"description": "The contact details of the person/office from which to request access to the dataset content",
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [
"givenName",
"familyName",
"email"
],
"title": "Access Request Contact",
"type": "object"
},
"access_request_url": {
"description": "The url of the online location from which to request access to the dataset content",
"format": "uri",
"title": "Access Request URL",
"type": "string"
},
"additional_display": {
"description": "Additional items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additional items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"name"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 4afa4dfc38f2ed3ebf9bc9a1a988d349a0b932fe | 2023-06-04T21:46:27 | datalad_catalog/catalog/schema/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"access_request_contact": {
"description": "The contact details of the person/office from which to request access to the dataset content",
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [
"givenName",
"familyName",
"email"
],
"title": "Access Request Contact",
"type": "object"
},
"access_request_url": {
"description": "The url of the online location from which to request access to the dataset content",
"format": "uri",
"title": "Access Request URL",
"type": "string"
},
"additional_display": {
"description": "Additional items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additional items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"name"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | edf33203cb3f844687d2c6301d28b44b88d68d8a | 2024-04-17T08:27:01 | datalad_catalog/catalog/schema/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"access_request_contact": {
"description": "The contact details of the person/office from which to request access to the dataset content",
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [
"givenName",
"familyName",
"email"
],
"title": "Access Request Contact",
"type": "object"
},
"access_request_url": {
"description": "The url of the online location from which to request access to the dataset content",
"format": "uri",
"title": "Access Request URL",
"type": "string"
},
"additional_display": {
"description": "Additional items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"alias": {
"description": "An alias of the dataset, used for shortened URL access within the catalog",
"title": "Alias",
"type": "string"
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"notebooks": {
"description": "Jupyter notebooks that will be linked to from the 'Explore with Binder' button and will typically be used to demonstrate the use of the dataset",
"items": {
"properties": {
"git_repo_url": {
"description": "The URL to a publicly accessible git repository containing the notebook",
"title": "Repo URL",
"type": "string"
},
"notebook_path": {
"description": "The path to the notebook, relative to the repository root, including the filename and extension",
"title": "Notebook path",
"type": "string"
}
},
"required": [
"git_repo_url",
"notebook_path"
],
"type": "object"
},
"title": "Jupyter notebooks",
"type": "array",
"uniqueItems": true
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additional items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"metadata_sources"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 10667b733eae936d47c31be15134f62c79443b3d | 2022-11-23T21:30:10 | datalad_catalog/catalog/assets/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additonal items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"extractors_used": {
"$ref": "https://datalad.org/catalog.extractors.schema.json"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additonal items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"name"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | f4a484f4a05f169e1105493835c23dbc0df30075 | 2024-03-04T12:43:40 | datalad_catalog/catalog/schema/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"access_request_contact": {
"description": "The contact details of the person/office from which to request access to the dataset content",
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [
"givenName",
"familyName",
"email"
],
"title": "Access Request Contact",
"type": "object"
},
"access_request_url": {
"description": "The url of the online location from which to request access to the dataset content",
"format": "uri",
"title": "Access Request URL",
"type": "string"
},
"additional_display": {
"description": "Additional items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"alias": {
"description": "An alias of the dataset, used for shortened URL access within the catalog",
"title": "Alias",
"type": "string"
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additional items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"metadata_sources"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 5ac68d7cb54f4b66bf30b035855f59108f1690d4 | 2024-04-16T21:45:35 | datalad_catalog/catalog/schema/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"access_request_contact": {
"description": "The contact details of the person/office from which to request access to the dataset content",
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [
"givenName",
"familyName",
"email"
],
"title": "Access Request Contact",
"type": "object"
},
"access_request_url": {
"description": "The url of the online location from which to request access to the dataset content",
"format": "uri",
"title": "Access Request URL",
"type": "string"
},
"additional_display": {
"description": "Additional items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"notebooks": {
"description": "Jupyter notebooks that will be linked to from the 'Explore with Binder' button and will typically be used to demonstrate the use of the dataset",
"items": {
"properties": {
"git_repo_url": {
"description": "The URL to a publicly accessible git repository containing the notebook",
"title": "Repo URL",
"type": "string"
},
"notebook_path": {
"description": "The path to the notebook, relative to the repository root, including the filename and extension",
"title": "Notebook path",
"type": "string"
}
},
"required": [
"git_repo_url",
"notebook_path"
],
"type": "object"
},
"title": "Jupyter notebooks",
"type": "array",
"uniqueItems": true
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additional items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"metadata_sources"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | d6078f72acb445b9acd43e7e0b4e09407ecac38a | 2023-02-05T13:46:47 | datalad_catalog/catalog/assets/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"access_request_contact": {
"description": "The contact details of the person/office from which to request access to the dataset content",
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [
"givenName",
"familyName",
"email"
],
"title": "Access Request Contact",
"type": "object"
},
"access_request_url": {
"description": "The url of the online location from which to request access to the dataset content",
"format": "uri",
"title": "Access Request URL",
"type": "string"
},
"additional_display": {
"description": "Additonal items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additonal items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"name"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 4afa4dfc38f2ed3ebf9bc9a1a988d349a0b932fe | 2023-06-04T21:46:27 | datalad_catalog/catalog/schema/jsonschema_authors.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.authors.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Authors, creators, or maintainers of the entity",
"items": {
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "authors",
"type": "array",
"uniqueItems": true
} | MIT | en |
datalad/datalad-catalog | 10667b733eae936d47c31be15134f62c79443b3d | 2022-11-23T21:30:10 | datalad_catalog/catalog/assets/jsonschema_authors.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.authors.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Authors, creators, or maintainers of the entity",
"items": {
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "authors",
"type": "array",
"uniqueItems": true
} | MIT | en |
datalad/datalad-catalog | 4afa4dfc38f2ed3ebf9bc9a1a988d349a0b932fe | 2023-06-04T21:46:27 | datalad_catalog/catalog/schema/jsonschema_metadata_sources.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.metadata_sources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of sources of metadata for a dataset or file in the catalog, including which sources have provided content for which fields",
"properties": {
"key_source_map": {
"description": "A mapping of sources to catalog fields",
"title": "Key-source map",
"type": "object"
},
"sources": {
"description": "A list of sources of metadata for a dataset or file in the catalog",
"items": {
"properties": {
"agent_email": {
"description": "git identity email of person/process that sourced the metadata",
"title": "Agent email",
"type": "string"
},
"agent_name": {
"description": "git identity name of person/process that sourced the metadata",
"title": "Agent name",
"type": "string"
},
"source_name": {
"description": "The source name",
"title": "Source name",
"type": "string"
},
"source_parameter": {
"description": "Parameters used together with the source",
"title": "Source parameter",
"type": "object"
},
"source_time": {
"description": "The time (since epoch) when this source was used to provide the applicable metadata",
"title": "Source time",
"type": "number"
},
"source_version": {
"description": "The source version",
"title": "Source version",
"type": "string"
}
},
"required": [
"source_name",
"source_version"
],
"type": "object"
},
"minItems": 1,
"title": "Sources",
"type": "array",
"uniqueItems": true
}
},
"required": [
"sources"
],
"title": "metadata_sources",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | d6078f72acb445b9acd43e7e0b4e09407ecac38a | 2023-02-05T13:46:47 | datalad_catalog/catalog/assets/jsonschema_catalog.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "dataset"
}
}
},
"then": {
"$ref": "https://datalad.org/catalog.dataset.schema.json"
}
},
{
"if": {
"properties": {
"type": {
"const": "file"
}
}
},
"then": {
"$ref": "https://datalad.org/catalog.file.schema.json"
}
}
],
"description": "The main catalog schema",
"title": "catalog",
"type": "object",
"version": "1.0.0"
} | MIT | en |
datalad/datalad-catalog | b8e38ad22e76c08729d3393f06655c1b65344c3f | 2023-10-04T20:49:20 | datalad_catalog/catalog/schema/jsonschema_dataset.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.dataset.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A dataset in a DataLad Catalog",
"properties": {
"access_request_contact": {
"description": "The contact details of the person/office from which to request access to the dataset content",
"properties": {
"email": {
"description": "Email address of the author, such as [email protected]",
"format": "email",
"title": "Email",
"type": "string"
},
"familyName": {
"description": "The author's last/family name, such as 'Doe'",
"title": "Family name",
"type": "string"
},
"givenName": {
"description": "The author's given name, such as 'John'",
"title": "Given name",
"type": "string"
},
"honorificSuffix": {
"description": "Title of the author, such as 'Dr.'",
"title": "Honorific suffix",
"type": "string"
},
"identifiers": {
"description": "Identifiers for the person",
"items": {
"properties": {
"identifier": {
"description": "The actual identifier, such as the ORCID ID '0000-1212-5566'",
"title": "Identifier",
"type": "string"
},
"type": {
"description": "Type of identifier, such as 'ORCID'",
"title": "Type",
"type": "string"
}
},
"type": "object"
},
"title": "Identifiers",
"type": "array"
},
"name": {
"description": "A concatenation of the honorificSuffix, givenName and familyName properties, such as 'Dr. John Doe'",
"title": "Name",
"type": "string"
}
},
"required": [
"givenName",
"familyName",
"email"
],
"title": "Access Request Contact",
"type": "object"
},
"access_request_url": {
"description": "The url of the online location from which to request access to the dataset content",
"format": "uri",
"title": "Access Request URL",
"type": "string"
},
"additional_display": {
"description": "Additional items to display in tabs on dataset page",
"items": {
"properties": {
"content": {
"description": "The content that will appear in the tab when opened, specified as key-value pairs",
"title": "Content",
"type": "object"
},
"icon": {
"description": "An icon from the Font Awesome Free collection (v6.1.1), e.g. 'fas fa-database', that will be displayed in the tab heading",
"title": "icon",
"type": "string"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"title": "Additional display",
"type": "array",
"uniqueItems": true
},
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"dataset_id": {
"description": "The dataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The dataset VERSION",
"title": "Dataset version",
"type": "string"
},
"description": {
"description": "A 1-2 paragraph description of the dataset",
"title": "Description",
"type": [
"array",
"string"
]
},
"doi": {
"description": "The dataset's digital object identifier",
"title": "DOI",
"type": "string"
},
"funding": {
"description": "Sources of funding for the dataset",
"items": {
"properties": {
"description": {
"description": "Free form description of grant or funding",
"title": "Description",
"type": "string"
},
"identifier": {
"description": "Identifier of the fund, such as a grant number",
"title": "Identifier",
"type": "string"
},
"name": {
"description": "Name of the funding source, such as a funder or grant scheme",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
},
"title": "Funding",
"type": "array",
"uniqueItems": true
},
"keywords": {
"description": "Tags or keywords describing the dataset",
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array",
"uniqueItems": true
},
"license": {
"additionalProperties": false,
"dependentSchemas": {
"name": {
"required": [
"name"
]
},
"url": {
"required": [
"name"
]
}
},
"description": "The license under which the dataset is made available",
"properties": {
"name": {
"description": "The license name",
"title": "Name",
"type": "string"
},
"url": {
"description": "A URL where a description of the license can be viewed",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"metadata_sources": {
"$ref": "https://datalad.org/catalog.metadata_sources.schema.json"
},
"name": {
"description": "The long name of the dataset",
"title": "Name",
"type": "string"
},
"publications": {
"description": "Publications related to the dataset",
"items": {
"properties": {
"authors": {
"$ref": "https://datalad.org/catalog.authors.schema.json"
},
"datePublished": {
"description": "The publication date year",
"title": "Date published",
"type": [
"number",
"string"
]
},
"doi": {
"description": "The publication's digital object identifier",
"title": "DOI",
"type": "string"
},
"publicationOutlet": {
"description": "The publication outlet / venue, such as the journal, publisher name, or news outlet",
"title": "Publication outlet",
"type": "string"
},
"title": {
"description": "Title of the publication",
"title": "Title",
"type": "string"
},
"type": {
"description": "Type of publication, such as a scholarly article, book, blog post",
"title": "Type",
"type": "string"
}
},
"required": [
"title",
"doi",
"authors"
],
"type": "object"
},
"title": "Publications",
"type": "array",
"uniqueItems": true
},
"short_name": {
"description": "The short name of the dataset",
"title": "Short name",
"type": "string"
},
"subdatasets": {
"description": "Subdatasets of the current dataset",
"items": {
"properties": {
"dataset_id": {
"description": "The subdataset ID",
"title": "Dataset ID",
"type": "string"
},
"dataset_path": {
"description": "The subdataset PATH relative to its parent",
"title": "Dataset path",
"type": "string"
},
"dataset_version": {
"description": "The subdataset VERSION",
"title": "Dataset version",
"type": "string"
}
},
"required": [
"dataset_id",
"dataset_version",
"dataset_path"
],
"type": "object"
},
"title": "Subdatasets",
"type": "array",
"uniqueItems": true
},
"top_display": {
"description": "Additional items to display at the top of the dataset page (along with keywords, description, etc)",
"items": {
"properties": {
"name": {
"description": "Name of the item that will appear as part of the top display",
"title": "Name",
"type": "string"
},
"value": {
"description": "Value of the item that will appear as part of the top display",
"title": "Value",
"type": [
"number",
"string"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 5,
"title": "Top display",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of node",
"pattern": "dataset",
"title": "Type",
"type": "string"
},
"url": {
"description": "The location of the datalad dataset's annex",
"items": {
"type": "string"
},
"title": "URL",
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"metadata_sources"
],
"title": "dataset",
"type": "object"
} | MIT | en |
datalad/datalad-catalog | 25b5dae338644a1a80eabfc177cecfa39eb8efc5 | 2022-11-11T14:52:40 | datalad_catalog/catalog/assets/jsonschema_file.json | 13 | 2024-05-28T09:33:55.772881Z | {
"$id": "https://datalad.org/catalog.file.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A file in a DataLad Catalog",
"properties": {
"additional_display": {
"description": "Additonal items to display on the file level",
"items": {
"properties": {
"content": {
"description": "The content that will appear when selecting the file, specified as key-value pairs",
"type": "object"
},
"name": {
"description": "Name of the section that will appear as the tab name",
"type": "string"
}
},
"required": [
"name",
"content"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"contentbytesize": {
"description": "The size of the file in bytes",
"type": "number"
},
"dataset_id": {
"description": "The parent dataset ID",
"type": "string"
},
"dataset_version": {
"description": "The parent dataset VERSION",
"type": "string"
},
"extractors_used": {
"$ref": "https://datalad.org/catalog.extractors.schema.json"
},
"path": {
"description": "The path of the file relative to its parent dataset",
"type": "string"
},
"type": {
"description": "The type of item",
"pattern": "file",
"type": "string"
},
"url": {
"description": "The location of the annexed file",
"items": {
"type": "string"
},
"type": [
"array",
"string"
]
}
},
"required": [
"type",
"dataset_id",
"dataset_version",
"path"
],
"title": "file",
"type": "object"
} | MIT | en |
euroargodev/VirtualFleet | 41ea189b385b57e359648a3a7bc9f7aa80c9fc1b | 2024-03-25T14:48:21 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"parameter": {
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed",
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin",
"reco_free_surface_drift"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
},
"parameter_metadata": {
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "Set of meta-data documenting one parameter for a virtual Argo Float configuration",
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file with the 'FloatConfiguration' class.",
"type": "string"
},
"parameters": {
"allOf": [
{
"items": {
"$ref": "#/$defs/parameter"
}
}
],
"description": "List of virtual Argo floats configuration parameters",
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object",
"version": 2
} | Apache-2.0 | en |
euroargodev/VirtualFleet | 51577f63b478b1165bcaef755f4806b545981862 | 2024-03-07T10:17:44 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"optional_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration optional parameter",
"type": "object"
},
"parameter_metadata": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "Set of meta-data documenting one parameter for a virtual Argo Float configuration",
"type": "object"
},
"required_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file with the 'FloatConfiguration' class.",
"type": "string"
},
"parameters": {
"description": "List of virtual Argo floats configuration parameters",
"oneOf": [
{
"items": {
"$ref": "#/$defs/required_parameter"
}
},
{
"items": {
"$ref": "#/$defs/optional_parameter"
}
}
],
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object"
} | Apache-2.0 | en |
euroargodev/VirtualFleet | 72b5415ccd33f31f503e77c743b2af3ed3e612c5 | 2024-03-08T11:40:24 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"parameter": {
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed",
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
},
"parameter_metadata": {
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "Set of meta-data documenting one parameter for a virtual Argo Float configuration",
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file with the 'FloatConfiguration' class.",
"type": "string"
},
"parameters": {
"allOf": [
{
"items": {
"$ref": "#/$defs/parameter"
}
}
],
"description": "List of virtual Argo floats configuration parameters",
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object",
"version": 2
} | Apache-2.0 | en |
euroargodev/VirtualFleet | 4c56c8dfa22f3ecd6f57b98431c43afc79baf109 | 2024-03-25T14:23:28 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"parameter": {
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed",
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin",
"reco_free_surface_drift"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
},
"parameter_metadata": {
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "Set of meta-data documenting one parameter for a virtual Argo Float configuration",
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file with the 'FloatConfiguration' class.",
"type": "string"
},
"parameters": {
"allOf": [
{
"items": {
"$ref": "#/$defs/parameter"
}
}
],
"description": "List of virtual Argo floats configuration parameters",
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object",
"version": 2
} | Apache-2.0 | en |
euroargodev/VirtualFleet | 45c0f6365c5572449d3ed3b6b4c47ce5957a230e | 2024-03-05T09:21:47 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A set of meta-data documenting virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "0.1"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"data": {
"description": "List of configuration parameters",
"items": {
"$ref": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ConfigParam.json"
},
"minItems": 5,
"type": "array",
"uniqueItems": true
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file",
"type": "string"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object"
} | Apache-2.0 | en |
euroargodev/VirtualFleet | 33a0a910cd5d4237262a8848d5c58b593a64e5a0 | 2024-03-07T08:43:08 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"optional_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration optional parameter",
"type": "object"
},
"parameter_metadata": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "VirtualFleet Argo Float configuration parameter meta-data",
"type": "object"
},
"required_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file",
"type": "string"
},
"parameters": {
"description": "List of configuration parameters",
"oneOf": [
{
"items": {
"$ref": "#/$defs/required_parameter"
}
},
{
"items": {
"$ref": "#/$defs/optional_parameter"
}
}
],
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object"
} | Apache-2.0 | en |
euroargodev/VirtualFleet | f2067d5c3e98cec35bd71664c03c031f8cde82eb | 2024-03-05T09:52:46 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A set of meta-data documenting virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "0.1"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"data": {
"additionalItems": {
"anyOf": [
{
"properties": {
"area_cycle_duration": {
"properties": {
"meta": {
"properties": {
"description": {
"type": "string"
},
"dtype": {
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
{}
]
},
"allOf": [
{
"contains": {
"properties": {
"cycle_duration": {
"properties": {
"meta": {
"properties": {
"description": {
"type": "string"
},
"dtype": {
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
},
{
"contains": {
"properties": {
"life_expectancy": {
"properties": {
"meta": {
"properties": {
"description": {
"type": "string"
},
"dtype": {
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
],
"description": "List of configuration parameters",
"type": "array"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file",
"type": "string"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object"
} | Apache-2.0 | en |
euroargodev/VirtualFleet | 202547522b3d944062edaacb7d2f47c9f4fceb06 | 2024-03-07T10:16:13 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"optional_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration optional parameter",
"type": "object"
},
"parameter_metadata": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "VirtualFleet Argo Float configuration parameter meta-data",
"type": "object"
},
"required_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file with the 'FloatConfiguration' class.",
"type": "string"
},
"parameters": {
"description": "List of virtual Argo floats configuration parameters",
"oneOf": [
{
"items": {
"$ref": "#/$defs/required_parameter"
}
},
{
"items": {
"$ref": "#/$defs/optional_parameter"
}
}
],
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object"
} | Apache-2.0 | en |
euroargodev/VirtualFleet | 398d0beb80df3473a3710158fb80803ff3df83bf | 2024-03-06T15:51:01 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"optional_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration optional parameter",
"type": "object"
},
"parameter_metadata": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "VirtualFleet Argo Float configuration parameter meta-data",
"type": "object"
},
"required_parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file",
"type": "string"
},
"parameters": {
"description": "List of configuration parameters",
"oneOf": [
{
"items": {
"$ref": "#/$defs/required_parameter"
}
},
{
"items": {
"$ref": "#/$defs/optional_parameter"
}
}
],
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits