Datasets:

dataunitylab

/

json-schema-store

like 1

Follow

Data Unity Lab 1

taurus.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "cli": { "type": "object", "properties": { "linter": { "type": "object", "properties": { "disable": { "type": "boolean" }, "ignored-warnings": { "type": "array", "items": { "type": "null" } }, "lint-and-exit": { "type": "boolean" }, "warn-on-unfamiliar-fields": { "type": "boolean" } } } } }, "cli-aliases": { "type": "object", "properties": { "cloud": { "type": "object", "properties": { "provisioning": { "type": "string" } } }, "detach": { "type": "object", "properties": { "modules": { "type": "object", "properties": { "cloud": { "type": "object", "properties": { "detach": { "type": "boolean" } } } } } } }, "func": { "type": "object", "properties": { "modules": { "type": "object", "properties": { "console": { "type": "object", "properties": { "disable": { "type": "boolean" } } } } }, "settings": { "type": "object", "properties": { "aggregator": { "type": "string" } } } } }, "gui": { "type": "object", "properties": { "modules": { "type": "object", "properties": { "jmeter": { "type": "object", "properties": { "gui": { "type": "boolean" } } } } } } }, "install-tools": { "type": "object", "properties": { "services": { "type": "array", "items": { "type": "string" } } } }, "lint": { "type": "object", "properties": { "cli": { "type": "object", "properties": { "linter": { "type": "object", "properties": { "lint-and-exit": { "type": "boolean" } } } } } } }, "local": { "type": "object", "properties": { "provisioning": { "type": "string" } } }, "locations": { "type": "object", "properties": { "modules": { "type": "object", "properties": { "cloud": { "type": "object", "properties": { "dump-locations": { "type": "boolean" } } } } }, "provisioning": { "type": "string" } } }, "nolint": { "type": "object", "properties": { "cli": { "type": "object", "properties": { "linter": { "type": "object", "properties": { "disable": { "type": "boolean" } } } } } } }, "public": { "type": "object", "properties": { "modules": { "type": "object", "properties": { "blazemeter": { "type": "object", "properties": { "public-report": { "type": "boolean" } } } } } } }, "report": { "type": "object", "properties": { "reporting": { "type": "array", "items": { "type": "string" } } } }, "sequential": { "type": "object", "properties": { "modules": { "type": "object", "properties": { "local": { "type": "object", "properties": { "sequential": { "type": "boolean" } } } } } } } } }, "execution": { "type": "array", "items": { "type": "object", "properties": { "concurrency": { "anyOf": [ { "type": "object", "properties": { "local": { "type": "integer" } } }, { "type": "integer" } ] }, "executor": { "type": "string" }, "hold-for": { "type": "string" }, "scenario": { "type": "string", "pattern": "[a-zA-Z0-9-_]" }, "throughput": { "type": "object", "properties": { "local": { "type": "integer" } } } } } }, "executor": { "type": "string", "enum": [ "ab", "apiritif", "gatling", "grinder", "jmeter", "junit", "locust", "mocha", "molotov", "newman", "nunit", "pbench", "pytest", "rspec", "selenium", "siege", "tsung", "wdio" ] }, "included-configs": { "type": "array", "items": { "type": "string" } }, "modules": { "type": "object", "properties": { "ab": { "type": "object", "properties": { "class": { "type": "string" } } }, "android-emulator": { "type": "object", "properties": { "class": { "type": "string" } } }, "apiritif": { "type": "object", "properties": { "class": { "type": "string" } } }, "appium": { "type": "object", "properties": { "class": { "type": "string" } } }, "blazemeter": { "type": "object", "properties": { "class": { "type": "string" } } }, "capturehar": { "type": "object", "properties": { "class": { "type": "string" } } }, "cloud": { "type": "object", "properties": { "class": { "type": "string" }, "default-location": { "type": "string" } } }, "console": { "type": "object", "properties": { "class": { "type": "string" }, "disable": { "type": "boolean" }, "screen": { "type": "string" } } }, "consolidator": { "type": "object", "properties": { "class": { "type": "string" }, "percentiles": { "type": "array", "items": { "type": "number" } } } }, "external-results-loader": { "type": "object", "properties": { "class": { "type": "string" } } }, "final-stats": { "type": "object", "properties": { "class": { "type": "string" } } }, "final_stats": { "type": "object", "properties": { "class": { "type": "string" } } }, "functional-consolidator": { "type": "object", "properties": { "class": { "type": "string" } } }, "gatling": { "type": "object", "properties": { "class": { "type": "string" }, "java-opts": { "type": "string" }, "version": { "type": "string" }, "properties": { "type": "object", "properties": { "gatling.data.file.bufferSize": { "type": "integer" } } } } }, "grinder": { "type": "object", "properties": { "class": { "type": "string" }, "properties": { "type": "object", "properties": { "grinder.useConsole": { "type": "boolean" } } } } }, "install-checker": { "type": "object", "properties": { "class": { "type": "string" } } }, "jmeter": { "type": "object", "properties": { "class": { "type": "string" }, "plugins": { "type": "array", "items": { "type": "string" } }, "properties": { "type": "object", "properties": { "jmeter.save.saveservice.autoflush": { "type": "string" }, "jmeter.save.saveservice.connect_time": { "type": "string" }, "jmeterengine.force.system.exit": { "type": "string" }, "summariser.name": { "type": "string" } } }, "protocol-handlers": { "type": "object", "properties": { "http": { "type": "string" } } } } }, "junit": { "type": "object", "properties": { "class": { "type": "string" } } }, "junit-xml": { "type": "object", "properties": { "class": { "type": "string" } } }, "local": { "type": "object", "properties": { "class": { "type": "string" } } }, "locust": { "type": "object", "properties": { "class": { "type": "string" } } }, "mocha": { "type": "object", "properties": { "class": { "type": "string" } } }, "molotov": { "type": "object", "properties": { "class": { "type": "string" } } }, "monitoring": { "type": "object", "properties": { "class": { "type": "string" } } }, "newman": { "type": "object", "properties": { "class": { "type": "string" } } }, "nunit": { "type": "object", "properties": { "class": { "type": "string" } } }, "passfail": { "type": "object", "properties": { "class": { "type": "string" } } }, "pbench": { "type": "object", "properties": { "class": { "type": "string" } } }, "proxy2jmx": { "type": "object", "properties": { "class": { "type": "string" } } }, "pytest": { "type": "object", "properties": { "class": { "type": "string" } } }, "robot": { "type": "object", "properties": { "class": { "type": "string" } } }, "rspec": { "type": "object", "properties": { "class": { "type": "string" } } }, "screenshoter": { "type": "object", "properties": { "class": { "type": "string" } } }, "selenium": { "type": "object", "properties": { "class": { "type": "string" } } }, "shellexec": { "type": "object", "properties": { "class": { "type": "string" } } }, "siege": { "type": "object", "properties": { "class": { "type": "string" } } }, "testng": { "type": "object", "properties": { "class": { "type": "string" } } }, "tsung": { "type": "object", "properties": { "class": { "type": "string" } } }, "unpacker": { "type": "object", "properties": { "class": { "type": "string" } } }, "virtual-display": { "type": "object", "properties": { "class": { "type": "string" } } }, "wdio": { "type": "object", "properties": { "class": { "type": "string" } } } } }, "provisioning": { "type": "string", "enum": ["local", "cloud"] }, "reporting": { "type": "array", "items": { "anyOf": [ { "items": { "type": "object", "properties": { "module": { "$ref": "#/definitions/reporting-modules" }, "criteria": { "type": "array", "items": { "type": "string" } } } } }, { "type": "array", "items": { "$ref": "#/definitions/reporting-modules" } } ] } }, "reporting-modules": { "type": "string", "enum": ["final-stats", "console", "blazemeter", "junit-xml"] }, "scenarios": { "type": "object", "patternProperties": { "[a-zA-Z0-9-_]": { "type": "object", "properties": { "default-address": { "type": "string" }, "headers": { "type": "object", "properties": { "Accept": { "type": "string" }, "Connection": { "type": "string" } } }, "requests": { "type": "array", "items": { "type": "object", "properties": { "assert": { "type": "array", "items": { "type": "object", "properties": { "contains": { "type": "array", "items": { "type": "string" } }, "not": { "type": "boolean" }, "regexp": { "type": "boolean" }, "subject": { "type": "string" } } } }, "follow-redirects": { "type": "boolean" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "url": { "type": "string" } } } }, "simulation": { "type": "string" } } } } }, "services": { "type": "array", "items": { "type": "object", "properties": { "local": { "type": "array", "items": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string" } } } } }, "module": { "type": "string" } } } }, "settings": { "type": "object", "properties": { "aggregator": { "type": "string", "enum": ["consolidator"] }, "artifacts-dir": { "type": "string" }, "check-updates": { "type": "boolean" }, "check-interval": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "default-executor": { "$ref": "#/definitions/executor" }, "env": { "type": "object" }, "proxy": { "type": "object", "properties": { "address": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "ssl-cert": { "type": "string" }, "ssl-client-cert": { "type": "string" } } }, "verbose": { "type": "boolean" } } }, "version": { "type": "string" } }, "id": "https://json.schemastore.org/taurus.json", "properties": { "execution": { "$ref": "#/definitions/execution" }, "reporting": { "$ref": "#/definitions/reporting" }, "services": { "$ref": "#/definitions/services" }, "modules": { "$ref": "#/definitions/modules" }, "settings": { "$ref": "#/definitions/settings" }, "included-configs": { "$ref": "#/definitions/included-configs" } }, "type": "object" }

project-1.0.0-rc2.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "compilationOptions": { "description": "[Deprecated] Options that are passed to the compiler. Use 'buildOptions' instead.", "type": "object", "properties": { "define": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "nowarn": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "warningsAsErrors": { "type": "boolean", "default": false }, "allowUnsafe": { "type": "boolean", "default": false }, "emitEntryPoint": { "type": "boolean", "default": false }, "optimize": { "type": "boolean", "default": false }, "platform": { "type": "string", "enum": [ "anycpu", "anycpu32bitpreferred", "ARM", "x86", "x64", "Itanium" ] }, "languageVersion": { "type": "string", "enum": [ "csharp1", "csharp2", "csharp3", "csharp4", "csharp5", "csharp6", "experimental" ] }, "keyFile": { "type": "string" }, "delaySign": { "type": "boolean", "default": false }, "publicSign": { "type": "boolean", "default": false }, "debugType": { "type": "string", "enum": ["portable", "full", "none"] }, "preserveCompilationContext": { "type": "boolean", "description": "Set this option to preserve reference assemblies and other context data to allow for runtime compilation" }, "outputName": { "type": "string" } } }, "buildOptions": { "description": "Options that are passed to the compiler.", "type": "object", "properties": { "define": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "nowarn": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "warningsAsErrors": { "type": "boolean", "default": false }, "allowUnsafe": { "type": "boolean", "default": false }, "emitEntryPoint": { "type": "boolean", "default": false }, "optimize": { "type": "boolean", "default": false }, "platform": { "type": "string", "enum": [ "anycpu", "anycpu32bitpreferred", "ARM", "x86", "x64", "Itanium" ] }, "languageVersion": { "type": "string", "enum": [ "csharp1", "csharp2", "csharp3", "csharp4", "csharp5", "csharp6", "experimental" ] }, "keyFile": { "type": "string" }, "delaySign": { "type": "boolean", "default": false }, "publicSign": { "type": "boolean", "default": false }, "debugType": { "type": "string", "enum": ["portable", "full", "none"] }, "preserveCompilationContext": { "type": "boolean", "description": "Set this option to preserve reference assemblies and other context data to allow for runtime compilation." }, "outputName": { "type": "string" }, "compilerName": { "type": "string", "default": "csc" }, "compile": { "description": "Defines glob patterns and file path to include for compilation.", "type": ["string", "array", "object"], "items": { "type": "string" }, "properties": { "include": { "type": ["string", "array"], "items": { "type": "string" }, "description": "List of file globbing patterns to be included." }, "exclude": { "type": ["string", "array"], "items": { "type": "string" }, "description": "List of file globbing patterns to be excluded." }, "includeFiles": { "type": ["string", "array"], "items": { "type": "string" }, "description": "List of file paths to be included." }, "excludeFiles": { "type": ["string", "array"], "items": { "type": "string" }, "description": "List of file paths to be excluded." }, "builtIns": { "type": ["string", "array", "object"], "items": { "type": "string" }, "properties": { "include": { "type": ["string", "array"], "items": { "type": "string" }, "description": "List of file globbing patterns to be included." }, "exclude": { "type": ["string", "array"], "items": { "type": "string" }, "description": "List of file globbing patterns to be included." } } }, "mappings": { "type": "object", "description": "Pairs of destination folders and glob patterns specifying additional files to include/exclude." } } }, "embed": { "allOf": [ { "$ref": "#/definitions/buildOptions/properties/compile" }, { "description": "Defines glob patterns and file paths of resource files to include for compilation." } ] }, "copyToOutput": { "allOf": [ { "$ref": "#/definitions/buildOptions/properties/compile" }, { "description": "Defines glob patterns and file paths to include for copying to build output." } ] }, "xmlDoc": { "type": "boolean" }, "additionalArguments": { "type": "array", "items": { "type": "string" } } } }, "runtimeOptions": { "type": "object", "properties": { "configProperties": { "type": "object", "properties": { "System.GC.Server": { "type": "boolean", "description": "Enables/disables server garbage collection.", "default": false }, "System.GC.Concurrent": { "type": "boolean", "description": "Enables/disables concurrent garbage collection.", "default": true }, "System.GC.HeapCount": { "type": "integer", "minimum": 0, "description": "Limits the number of heaps created by the garbage collector." }, "System.GC.HeapAffinitizeMask": { "type": "integer", "minimum": 0, "description": "Specifies the exact processors that garbage collector threads should use." }, "System.GC.GCHeapAffinitizeRanges": { "type": "string", "minLength": 1, "description": "Specifies the list of processors to use for garbage collector threads." }, "System.GC.NoAffinitize": { "type": "boolean", "description": "Specifies whether to affinitize garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU. A heap is created for each GC thread.", "default": false }, "System.GC.HeapHardLimit": { "type": "string", "description": "Specifies the maximum commit size, in bytes, for the GC heap and GC bookkeeping." }, "System.GC.HeapHardLimitPercent": { "type": "number", "description": "Specifies the GC heap usage as a percentage of the total memory." }, "System.GC.RetainVM": { "type": "boolean", "description": "Configures whether segments that should be deleted are put on a standby list for future use or are released back to the operating system (OS).", "default": false }, "System.GC.LOHThreshold": { "type": "integer", "description": "Specifies the threshold size, in bytes, that causes objects to go on the large object heap (LOH).", "default": 85000 }, "System.Threading.ThreadPool.MinThreads": { "type": "integer", "minimum": 1, "description": "Sets the minimum number of threads for the thread pool." }, "System.Threading.ThreadPool.MaxThreads": { "type": "integer", "minimum": 1, "description": "Sets the maximum number of threads for the thread pool." } } } } }, "packOptions": { "description": "Defines options pertaining to the packaging of the project output into a NuGet package.", "type": "object", "properties": { "summary": { "description": "A short description of the package.", "type": "string" }, "tags": { "description": "A space-delimited list of tags and keywords that describe the package.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "owners": { "description": "List of owners of the package.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "releaseNotes": { "description": "A description of the changes made in each release of the package.", "type": "string" }, "iconUrl": { "description": "A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.", "type": "string" }, "licenseUrl": { "description": "A link to the license for the package.", "type": "string" }, "requireLicenseAcceptance": { "description": "A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.", "type": "boolean", "default": false }, "repository": { "type": "object", "description": "Contains information about the repository where the project is stored.", "properties": { "type": { "type": "string", "enum": ["git"], "default": "git" }, "url": { "type": "string", "format": "uri" } }, "additionalProperties": { "type": "string" } }, "files": { "allOf": [ { "$ref": "#/definitions/buildOptions/properties/compile" }, { "description": "Defines glob patterns and file paths to include in the generated NuGet package." } ] } } }, "publishOptions": { "allOf": [ { "$ref": "#/definitions/buildOptions/properties/compile" }, { "description": "Defines glob patterns and file paths to include in publish output." } ] }, "configType": { "type": "object", "properties": { "dependencies": { "$ref": "#/definitions/dependencies" }, "compilationOptions": { "$ref": "#/definitions/compilationOptions" }, "buildOptions": { "$ref": "#/definitions/buildOptions" }, "frameworkAssemblies": { "$ref": "#/definitions/dependencies" }, "imports": { "type": ["string", "array"], "description": "Allow packages supporting these frameworks to be installed in this target, regardless of the compatibility rules.", "items": { "type": "string" } } } }, "libraryIncludeFlag": { "type": "string", "enum": [ "all", "runtime", "compile", "build", "contentFiles", "native", "analyzers", "none" ] }, "libraryIncludeFlags": { "oneOf": [ { "$ref": "#/definitions/libraryIncludeFlag" }, { "type": "array", "items": { "$ref": "#/definitions/libraryIncludeFlag" } } ] }, "dependencies": { "type": "object", "additionalProperties": { "type": ["string", "object"], "properties": { "version": { "type": "string" }, "type": { "type": "string", "default": "default", "enum": ["default", "build", "platform"] }, "target": { "type": "string", "description": "Restrict this dependency to matching only a Project or a Package.", "enum": ["project", "package"] }, "include": { "$ref": "#/definitions/libraryIncludeFlags" }, "exclude": { "$ref": "#/definitions/libraryIncludeFlags" }, "suppressParent": { "$ref": "#/definitions/libraryIncludeFlags" } } }, "description": "Each dependency is defined by a name and a version. Dependencies are resolved from NuGet feeds defined by your package sources and projects located in the directories specified by the 'global.json' file." }, "script": { "type": ["string", "array"], "items": { "type": "string" }, "description": "A command line script or scripts.\r\rAvailable variables:\r%project:Directory% - The project directory\r%project:Name% - The project name\r%project:Version% - The project version" } }, "id": "https://json.schemastore.org/project-1.0.0-rc2.json", "properties": { "authors": { "description": "The author of the application.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "packInclude": { "description": "[Deprecated] Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { \"tools/\": \"tools/**/*.*\" }. Use 'files' in 'packOptions' instead.", "type": "object" }, "publishExclude": { "description": "[Deprecated] Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'publishOptions' instead.", "type": ["string", "array"], "items": { "type": "string" }, "default": ["obj/**/*.*", "bin/**/*.*", "**/.*/**"] }, "compile": { "description": "[Deprecated] Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'compile' in 'buildOptions' instead.", "type": ["string", "array"], "items": { "type": "string" }, "default": "**/*.cs" }, "compileExclude": { "description": "[Deprecated] Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'compile' in 'buildOptions' instead.", "type": ["string", "array"], "items": { "type": "string" } }, "compileFiles": { "description": "[Deprecated] Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]. Use 'compile' in 'buildOptions' instead.", "type": ["string", "array"], "items": { "type": "string" } }, "content": { "description": "[Deprecated] Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.", "type": ["string", "array"], "items": { "type": "string" }, "default": "**/*" }, "contentExclude": { "description": "[Deprecated] Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.", "type": ["string", "array"], "items": { "type": "string" } }, "contentFiles": { "description": "[Deprecated] Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.", "type": ["string", "array"], "items": { "type": "string" } }, "preprocess": { "description": "Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "compiler/preprocess/**/*.cs" }, "preprocessExclude": { "description": "Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]", "type": ["string", "array"], "items": { "type": "string" } }, "preprocessFiles": { "description": "Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]", "type": ["string", "array"], "items": { "type": "string" } }, "resource": { "description": "[Deprecated] Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'embed' in 'buildOptions' instead.", "type": ["string", "array"], "items": { "type": "string" }, "default": ["compiler/resources/**/*", "**/*.resx"] }, "resourceExclude": { "description": "[Deprecated] Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'embed' in 'buildOptions' instead.", "type": ["string", "array"], "items": { "type": "string" } }, "resourceFiles": { "description": "[Deprecated] Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]. Use 'embed' in 'buildOptions' instead.", "type": ["string", "array"], "items": { "type": "string" } }, "shared": { "description": "Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "compiler/shared/**/*.cs" }, "sharedExclude": { "description": "Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]", "type": ["string", "array"], "items": { "type": "string" } }, "sharedFiles": { "description": "Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]", "type": ["string", "array"], "items": { "type": "string" } }, "exclude": { "description": "[Deprecated] Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'exclude' within 'compile' or 'embed' instead.", "type": ["string", "array"], "items": { "type": "string" } }, "excludeBuiltIn": { "description": "[Deprecated] Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'exclude' within 'compile' or 'embed' instead.", "type": ["string", "array"], "items": { "type": "string" }, "default": ["bin/**", "obj/**", "**/*.xproj"] }, "testRunner": { "description": "The name of the test runner to use with this project", "type": "string" }, "commands": { "type": "object", "additionalProperties": { "type": "string" } }, "compilationOptions": { "$ref": "#/definitions/compilationOptions" }, "buildOptions": { "$ref": "#/definitions/buildOptions" }, "packOptions": { "$ref": "#/definitions/packOptions" }, "runtimeOptions": { "$ref": "#/definitions/runtimeOptions" }, "publishOptions": { "$ref": "#/definitions/publishOptions" }, "configurations": { "type": "object", "description": "Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.", "additionalProperties": { "type": "object", "properties": { "compilationOptions": { "$ref": "#/definitions/compilationOptions" }, "buildOptions": { "$ref": "#/definitions/buildOptions" } } } }, "dependencies": { "$ref": "#/definitions/dependencies" }, "copyright": { "description": "Copyright details for the package.", "type": "string" }, "iconUrl": { "description": "[Deprecated] A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background. Use this in 'packOptions' instead.", "type": "string" }, "licenseUrl": { "description": "[Deprecated] A link to the license for the package. Use this in 'packOptions' instead.", "type": "string" }, "requireLicenseAcceptance": { "description": "[Deprecated] A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed. Use this in 'packOptions' instead.", "type": "boolean", "default": false }, "owners": { "description": "[Deprecated] List of owners of the package. Use this in 'packOptions' instead.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "projectUrl": { "description": "A URL for the home page of the package.", "type": "string" }, "summary": { "description": "[Deprecated] A short description of the package. Use this in 'packOptions' instead.", "type": "string" }, "tags": { "description": "[Deprecated] A space-delimited list of tags and keywords that describe the package. Use this in 'packOptions' instead.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "title": { "description": "The human-friendly title of the package", "type": "string" }, "releaseNotes": { "description": "[Deprecated] A description of the changes made in each release of the package. Use this in 'packOptions' instead.", "type": "string" }, "language": { "description": "The locale ID for the package, such as en-us.", "type": "string" }, "description": { "description": "The description of the project/package.", "type": "string" }, "frameworks": { "description": "Target frameworks that will be built, and dependencies that are specific to the build of this project for that framework.", "type": "object", "additionalProperties": { "$ref": "#/definitions/configType" } }, "namedResource": { "type": "object", "description": "Overrides the generated resource names with custom ones.", "additionalProperties": { "type": "string" } }, "repository": { "type": "object", "description": "[Deprecated] Contains information about the repository where the project is stored. Use this in 'packOptions' instead.", "properties": { "type": { "type": "string", "enum": ["git"], "default": "git" }, "url": { "type": "string", "format": "uri" } }, "additionalProperties": { "type": "string" } }, "scripts": { "type": "object", "description": "Scripts to execute during the various stages.", "properties": { "precompile": { "$ref": "#/definitions/script" }, "postcompile": { "$ref": "#/definitions/script" }, "prepack": { "$ref": "#/definitions/script" }, "postpack": { "$ref": "#/definitions/script" }, "prepublish": { "$ref": "#/definitions/script" }, "postpublish": { "$ref": "#/definitions/script" }, "prerestore": { "$ref": "#/definitions/script" }, "postrestore": { "$ref": "#/definitions/script" }, "prepare": { "$ref": "#/definitions/script" } } }, "version": { "description": "The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*", "type": "string" }, "tools": { "description": "Project-specific command line tools accessible when in the project.json directory.", "type": "object", "additionalProperties": { "type": ["string", "object"], "properties": { "version": { "type": "string" } } } }, "runtimes": { "description": "List of runtime identifiers supported by this project (used when building standalone applications).", "type": "object" } }, "title": "JSON schema for .NET Core project.json files", "type": "object" }

project-1.0.0-beta4.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "compilationOptions": { "type": "object", "properties": { "define": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "warningsAsErrors": { "type": "boolean", "default": false }, "allowUnsafe": { "type": "boolean", "default": false }, "optimize": { "type": "boolean", "default": false }, "languageVersion": { "type": "string", "enum": [ "csharp1", "csharp2", "csharp3", "csharp4", "csharp5", "csharp6", "experimental" ] } } }, "configType": { "type": "object", "properties": { "dependencies": { "$ref": "#/definitions/dependencies" }, "compilationOptions": { "$ref": "#/definitions/compilationOptions" }, "frameworkAssemblies": { "$ref": "#/definitions/dependencies" } } }, "dependencies": { "type": "object", "additionalProperties": { "type": ["string", "object"], "properties": { "version": { "type": "string" }, "type": { "type": "string", "default": "default", "enum": ["default", "build"] } } } }, "script": { "type": ["string", "array"], "items": { "type": "string" }, "description": "A command line script or scripts.\r\rAvailable variables:\r%project:Directory% - The project directory\r%project:Name% - The project name\r%project:Version% - The project version" } }, "id": "https://json.schemastore.org/project-1.0.0-beta4.json", "properties": { "authors": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "publishExclude": { "description": "List of files to exclude from publish output (dnu publish).", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "compile": { "description": "Glob pattern to specify additional code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ \"folder1/**/*.cs\", \"folder2/**/*.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "compileExclude": { "description": "Glob pattern to indicate code files that needs to be excluded from compilation. (data type: string or array with glob pattern(s)). Example: [ \"folder1/**/*.cs\", \"folder2/**/*.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "compileFiles": { "description": "Individual file paths relative to application root that needs to be included for compilation. (data type: string or array). Example: [ \"folder1/test1.cs\", \"folder2/test2.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "compileBuiltIn": { "description": "Glob pattern to indicate the default code files that are included for compilation. (data type: string or array with glob pattern(s)). Example: [ \"**/*.cs\", \"../folder2/**/*.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "**/*.cs" }, "exclude": { "description": "Glob pattern to indicate the default files to be excluded from processing. (data type: string or array with glob pattern(s)).", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "excludeBuiltIn": { "description": "Glob pattern to indicate all the additional files to be excluded from processing. (data type: string or array with glob pattern(s)).", "type": ["string", "array"], "items": { "type": "string" }, "default": ["bin/**/*.*", "obj/**/*.*", "**/*.xproj"] }, "preprocess": { "description": "Glob pattern to indicate all the code files to be pre-processed. (data type: string or array with glob pattern(s)).", "type": ["string", "array"], "items": { "type": "string" }, "default": ["compiler/preprocess/**/*.cs"] }, "preprocessExclude": { "description": "Glob pattern to indicate all the code files to be excluded from pre-processing. (data type: string or array with glob pattern(s)).", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "preprocessFiles": { "description": "Glob pattern to indicate specific code files to be included for pre-processing. (data type: string or array).", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "resource": { "description": "Glob pattern to indicate all the files that need to be compiled as resources. (data type: string or array with glob pattern(s))", "type": ["string", "array"], "items": { "type": "string" }, "default": ["compiler/resources/**/*", "**/*.resx"] }, "resourceExclude": { "description": "Glob pattern to indicate files that need to be excluded from being compiled as resources. (data type: string or array with glob pattern(s))", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "resourceFiles": { "description": "Glob pattern to indicate individual files that need to be compiled as resources. (data type: string or array).", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "shared": { "description": "Glob pattern to specify the code files to share with dependent projects. Example: [ \"folder1/*.cs\", \"folder2/*.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "compiler/shared/**/*.cs" }, "sharedExclude": { "description": "Glob pattern to specify the code files to be excluded from sharing with dependent projects. Example: [ \"folder1/*.cs\", \"folder2/*.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "sharedFiles": { "description": "Glob pattern to specify the individual code files to be shared with dependent projects. Example: [ \"folder1/shared1.cs\", \"folder2/shared2.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "content": { "description": "Glob pattern to specify the files to be considered as content on dnu publish. Example: [ \"folder1/**/*\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "**/*" }, "contentExclude": { "description": "Glob pattern to specify the files to be excluded from being content on dnu publish. Example: [ \"folder1/*.cs\", \"folder2/*.cs\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "contentFiles": { "description": "Glob pattern to specify the individual files to be content files on dnu publish. Example: [ \"folder1/content.cs\", \"folder2/content2.img\" ]", "type": ["string", "array"], "items": { "type": "string" }, "default": "" }, "commands": { "type": "object", "additionalProperties": { "type": "string" } }, "compilationOptions": { "$ref": "#/definitions/compilationOptions" }, "configurations": { "type": "object", "description": "Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.", "additionalProperties": { "type": "object", "properties": { "compilationOptions": { "$ref": "#/definitions/compilationOptions" } } } }, "copyright": { "description": "Copyright details for the package", "type": "string" }, "dependencies": { "$ref": "#/definitions/dependencies" }, "description": { "description": "The description of the application", "type": "string" }, "frameworks": { "type": "object", "additionalProperties": { "$ref": "#/definitions/configType" } }, "iconUrl": { "description": "A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.", "type": "string" }, "licenseUrl": { "description": "A link to the license that the package is under", "type": "string" }, "owners": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "projectUrl": { "description": "A URL for the home page of the package", "type": "string" }, "scripts": { "type": "object", "description": "Scripts to execute during the various stages.", "properties": { "prepack": { "$ref": "#/definitions/script" }, "postpack": { "$ref": "#/definitions/script" }, "prepublish": { "$ref": "#/definitions/script" }, "postpublish": { "$ref": "#/definitions/script" }, "prerestore": { "$ref": "#/definitions/script" }, "postrestore": { "$ref": "#/definitions/script" }, "prepare": { "$ref": "#/definitions/script" } } }, "summary": { "description": "A short description of the package", "type": "string" }, "tags": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "title": { "description": "The human-friendly title of the package", "type": "string" }, "version": { "description": "The version of the application. Example: 1.2.0.0", "type": "string" }, "webroot": { "description": "Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.", "type": "string" }, "userSecretsId": { "description": "Specify a unique id to manage the development time user secrets of the application", "type": "string" } }, "title": "JSON schema for ASP.NET project.json files", "type": "object" }

azure-iot-edgehub-deployment-1.2.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "policy": { "type": "array", "items": { "type": "object", "properties": { "operations": { "type": "array", "items": { "type": "string", "pattern": "^mqtt:connect$|^mqtt:subscribe$|^mqtt:publish$" } }, "resources": { "type": "array", "items": { "type": "string", "pattern": "^.+$", "examples": ["$iothub/clients/+/twin/res/#", "events/alerts"] } } }, "additionalProperties": false } } }, "id": "https://json.schemastore.org/azure-iot-edgehub-deployment-1.2.json", "properties": { "$edgeHub": { "type": "object", "title": "Configuration for the edgeHub module", "required": ["properties.desired"], "properties": { "properties.desired": { "type": "object", "required": ["schemaVersion", "routes"], "properties": { "schemaVersion": { "type": "string", "pattern": "1.2" }, "routes": { "type": "object", "patternProperties": { "^[^\\.\\$# ]+$": { "anyOf": [ { "type": "object", "required": ["route"], "properties": { "route": { "type": "string", "examples": ["FROM /* INTO $upstream"], "pattern": "^.+$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9 }, "timeToLiveSecs": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "additionalProperties": false }, { "type": "string", "examples": ["FROM /* INTO $upstream"], "pattern": "^.+$" } ] } }, "additionalProperties": false }, "storeAndForwardConfiguration": { "type": "object", "required": ["timeToLiveSecs"], "properties": { "timeToLiveSecs": { "type": "integer", "examples": [7200] } }, "additionalProperties": false }, "mqttBroker": { "type": "object", "properties": { "bridges": { "type": "array", "items": { "type": "object", "properties": { "endpoint": { "type": "string", "pattern": "\\$upstream" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "pattern": "^in$|^out$" }, "topic": { "type": "string", "pattern": "^.*$" }, "inPrefix": { "type": "string", "pattern": "^.*$" }, "outPrefix": { "type": "string", "pattern": "^.*$" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "authorizations": { "type": "array", "items": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "string", "pattern": "^.+$", "examples": [ "{{iot:identity}}", "contoso.azure-devices.net/MyLeafDevice1", "contoso.azure-devices.net/MyEdgeDevice/MyModule" ] } }, "allow": { "$ref": "#/definitions/policy" }, "deny": { "$ref": "#/definitions/policy" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": ["$edgeHub"], "title": "JSON schema for Azure IoT EdgeHub Deployment version 1.2", "type": "object" }

requirements.json

{ "$defs": { "CollectionModel": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "source": { "title": "Source", "type": "string" }, "type": { "enum": ["galaxy", "url", "file", "git", "dir", "subdirs"], "title": "Type", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "title": "CollectionModel", "type": "object" }, "CollectionStringModel": { "title": "CollectionStringModel", "type": "string" }, "IncludeModel": { "properties": { "include": { "title": "Include", "type": "string" } }, "required": ["include"], "title": "IncludeModel", "type": "object" }, "RequirementsV2Model": { "additionalProperties": false, "anyOf": [ { "required": ["collections"] }, { "required": ["roles"] } ], "properties": { "collections": { "items": { "anyOf": [ { "$ref": "#/$defs/CollectionModel" }, { "$ref": "#/$defs/CollectionStringModel" } ] }, "title": "Collections", "type": "array" }, "roles": { "items": { "$ref": "#/$defs/RoleModel" }, "title": "Roles", "type": "array" } }, "title": "Requirements v2", "type": "object" }, "RoleModel": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "scm": { "anyOf": [ { "enum": ["git"], "type": "string" }, { "enum": ["hg"], "type": "string" } ], "default": "git", "title": "Scm" }, "src": { "title": "Src", "type": "string" }, "version": { "default": "master", "title": "Version", "type": "string" } }, "title": "Role", "type": "object" } }, "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/requirements.json", "$schema": "http://json-schema.org/draft-07/schema", "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/RoleModel" }, { "$ref": "#/$defs/IncludeModel" } ] }, "type": "array" }, { "$ref": "#/$defs/RequirementsV2Model" } ], "examples": ["requirements.yml"], "title": "Ansible Requirements Schema" }

tizen_workspace.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/tizen_workspace.json", "properties": { "auto_gen_build_files": { "type": "boolean" }, "type": { "type": "string", "pattern": "^(native|web|dotnet|hybrid)$" }, "profile": { "type": "string" }, "api_version": { "type": "number", "multipleOf": 0.1 }, "profiles_xml_path": { "type": "string" }, "signing_profile": { "type": "string" }, "build_type": { "type": "string", "pattern": "^(test|debug|release)$" }, "rootstrap": { "type": "string" }, "compiler": { "type": "string", "pattern": "^(llvm|gcc)$" }, "skip_vs_files": { "type": "boolean" }, "dotnet_cli_path": { "type": "string" }, "msbuild_path": { "type": "string" }, "dotnet_build_tool": { "type": "string", "pattern": "^(dotnet-cli|msbuild)$" }, "tizen_net_version": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "tizen_net_sdk_verison": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "xamarin_forms_version": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "msbuild_tasks_version": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "tizen_wearable_circleui_version": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "tizen_opentk_version": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "tizen_nuixaml_version": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "tizen_hotreload_version": { "type": "string", "pattern": "^((?:.?[0-9]+){3,}(?:[-a-z]+)?)$" }, "working_folder": { "type": ["string", "null"] }, "chrome_path": { "type": "string" }, "chrome_simulator_options": { "type": "array", "items": { "type": "string" } }, "chrome_simulator_data_path": { "type": "string" }, "tv_simulator_path": { "type": "string" }, "chrome_inspector_options": { "type": "array", "items": { "type": "string" } }, "chrome_inspector_data_path": { "type": "string" }, "arch": { "type": "string", "pattern": "^(x86|x86_64|arm|aarch64)$" }, "opt": { "type": "boolean" }, "src_file_patterns": { "type": "array", "items": { "type": "string" } }, "test_file_patterns": { "type": "array", "items": { "type": "string" } }, "projects": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "auto_gen_build_files", "type", "profile", "api_version", "profiles_xml_path", "signing_profile", "build_type", "rootstrap", "compiler", "skip_vs_files", "dotnet_cli_path", "msbuild_path", "dotnet_build_tool", "tizen_net_version", "tizen_net_sdk_verison", "xamarin_forms_version", "msbuild_tasks_version", "tizen_wearable_circleui_version", "tizen_opentk_version", "tizen_nuixaml_version", "tizen_hotreload_version", "working_folder", "chrome_path", "chrome_simulator_options", "chrome_simulator_data_path", "tv_simulator_path", "chrome_inspector_options", "chrome_inspector_data_path", "arch", "opt", "src_file_patterns", "test_file_patterns", "projects" ], "type": "object" }

cryproj.55.schema.json

{ "$comment": "JSON Schema for CRYENGINE 5.5", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "cvars": { "$id": "/definitions/cvars", "type": "string", "title": "Variable name", "description": "CVar name", "default": "sys_target_platforms", "enum": [ "a_poseAlignerDebugDraw", "a_poseAlignerEnable", "a_poseAlignerForceLock", "a_poseAlignerForceNoIntersections", "a_poseAlignerForceNoRootOffset", "a_poseAlignerForceTargetSmoothing", "a_poseAlignerForceWeightOne", "ac_ColliderModeAI", "ac_ColliderModePlayer", "ac_debugAnimEffects", "ac_debugAnimTarget", "ac_debugColliderMode", "ac_debugEntityParams", "ac_DebugFilter", "ac_debugLocations", "ac_debugLocationsGraphs", "ac_debugMotionParams", "ac_debugMovementControlMethods", "ac_debugText", "ac_debugXXXValues", "ac_disableSlidingContactEvents", "ac_enableExtraSolidCollider", "ac_entityAnimClamp", "ac_forceSimpleMovement", "ac_frametime", "ac_movementControlMethodFilter", "ac_movementControlMethodHor", "ac_movementControlMethodVer", "ac_templateMCMs", "ac_useMovementPrediction", "ac_useQueuedRotation", "ag_debugExactPos", "ag_defaultAIStance", "ag_travelSpeedSmoothing", "ag_turnAngleSmoothing", "ag_turnSpeedParamScale", "ag_turnSpeedSmoothing", "ai_AdjustPathsAroundDynamicObstacles", "ai_AgentStatsDist", "ai_AllowedToHit", "ai_AllowedToHitPlayer", "ai_AllTime", "ai_AmbientFireEnable", "ai_AmbientFireQuota", "ai_AmbientFireUpdateInterval", "ai_AttemptStraightPath", "ai_BannedNavSoTime", "ai_BeautifyPath", "ai_BubblesSystem", "ai_BubblesSystemAlertnessFilter", "ai_BubblesSystemAllowPrototypeDialogBubbles", "ai_BubblesSystemDecayTime", "ai_BubblesSystemFontSize", "ai_BubblesSystemNameFilter", "ai_BubblesSystemUseDepthTest", "ai_BurstWhileMovingDestinationRange", "ai_CheckWalkabilityOptimalSectionLength", "ai_CollisionAvoidanceAgentExtraFat", "ai_CollisionAvoidanceAgentTimeHorizon", "ai_CollisionAvoidanceClampVelocitiesWithNavigationMesh", "ai_CollisionAvoidanceEnableRadiusIncrement", "ai_CollisionAvoidanceMinSpeed", "ai_CollisionAvoidanceObstacleTimeHorizon", "ai_CollisionAvoidancePathEndCutoffRange", "ai_CollisionAvoidanceRadiusIncrementDecreaseRate", "ai_CollisionAvoidanceRadiusIncrementIncreaseRate", "ai_CollisionAvoidanceRange", "ai_CollisionAvoidanceSmartObjectCutoffRange", "ai_CollisionAvoidanceTargetCutoffRange", "ai_CollisionAvoidanceTimestep", "ai_CollisionAvoidanceUpdateVelocities", "ai_CommunicationForceTestVoicePack", "ai_CommunicationManagerHeighThresholdForTargetPosition", "ai_CompatibilityMode", "ai_CoolMissesBoxHeight", "ai_CoolMissesBoxSize", "ai_CoolMissesCooldown", "ai_CoolMissesMaxLightweightEntityMass", "ai_CoolMissesMinMissDistance", "ai_CoolMissesProbability", "ai_CoverExactPositioning", "ai_CoverMaxEyeCount", "ai_CoverPredictTarget", "ai_CoverSpacing", "ai_CoverSystem", "ai_CrouchVisibleRange", "ai_CrowdControlInPathfind", "ai_DebugCollisionAvoidanceForceSpeed", "ai_DebugDraw", "ai_DebugDrawAdaptiveUrgency", "ai_DebugDrawAmbientFire", "ai_DebugDrawArrowLabelsVisibilityDistance", "ai_DebugDrawAStarOpenList", "ai_DebugDrawAStarOpenListTime", "ai_DebugDrawBannedNavsos", "ai_DebugDrawCollisionAvoidance", "ai_DebugDrawCollisionAvoidanceAgentName", "ai_DebugDrawCommunication", "ai_DebugDrawCommunicationHistoryDepth", "ai_DebugDrawCoolMisses", "ai_DebugDrawCover", "ai_DebugDrawCoverLocations", "ai_DebugDrawCoverOccupancy", "ai_DebugDrawCoverPlanes", "ai_DebugDrawCoverSampler", "ai_DebugDrawCrowdControl", "ai_DebugDrawDamageControl", "ai_DebugDrawDamageParts", "ai_DebugDrawDynamicCoverSampler", "ai_DebugDrawDynamicHideObjectsRange", "ai_DebugDrawEnabledActors", "ai_DebugDrawEnabledPlayers", "ai_DebugDrawExpensiveAccessoryQuota", "ai_DebugDrawFireCommand", "ai_DebugDrawGroups", "ai_DebugDrawHidespotRange", "ai_DebugDrawHideSpotSearchRays", "ai_DebugDrawLightLevel", "ai_DebugDrawNavigation", "ai_DebugDrawNavigationWorldMonitor", "ai_DebugDrawPhysicsAccess", "ai_DebugDrawPlayerActions", "ai_DebugDrawReinforcements", "ai_DebugDrawStanceSize", "ai_DebugDrawVegetationCollisionDist", "ai_DebugDrawVisionMap", "ai_DebugDrawVisionMapObservables", "ai_DebugDrawVisionMapObservers", "ai_DebugDrawVisionMapObserversFOV", "ai_DebugDrawVisionMapStats", "ai_DebugDrawVisionMapVisibilityChecks", "ai_DebugDrawVolumeVoxels", "ai_DebugGlobalPerceptionScale", "ai_DebugInterestSystem", "ai_DebugMovementSystem", "ai_DebugMovementSystemActorRequests", "ai_DebugPathfinding", "ai_DebugPerceptionManager", "ai_DebugRangeSignaling", "ai_DebugSignalTimers", "ai_DebugTacticalPoints", "ai_DebugTacticalPointsBlocked", "ai_DebugTargetSilhouette", "ai_DebugTargetTracksAgent", "ai_DebugTargetTracksConfig", "ai_DebugTargetTracksConfig_Filter", "ai_DebugTargetTracksTarget", "ai_DebugTimestamps", "ai_DrawAgentFOV", "ai_DrawAgentStats", "ai_DrawAgentStatsGroupFilter", "ai_DrawAreas", "ai_DrawAttentionTargetPositions", "ai_DrawBadAnchors", "ai_DrawBulletEvents", "ai_DrawCollisionEvents", "ai_DrawDistanceLUT", "ai_DrawExplosions", "ai_DrawFakeDamageInd", "ai_DrawFakeHitEffects", "ai_DrawFakeTracers", "ai_DrawFireEffectDecayRange", "ai_DrawFireEffectEnabled", "ai_DrawFireEffectMaxAngle", "ai_DrawFireEffectMinDistance", "ai_DrawFireEffectMinTargetFOV", "ai_DrawFireEffectTimeScale", "ai_DrawFormations", "ai_DrawGetEnclosingFailures", "ai_DrawGoals", "ai_DrawGrenadeEvents", "ai_DrawGroupTactic", "ai_DrawHidespots", "ai_DrawModifiers", "ai_DrawModularBehaviorTreeStatistics", "ai_DrawNode", "ai_DrawNodeLinkCutoff", "ai_DrawNodeLinkType", "ai_DrawOffset", "ai_DrawPath", "ai_DrawPathAdjustment", "ai_DrawPathFollower", "ai_DrawPerceptionDebugging", "ai_DrawPerceptionHandlerModifiers", "ai_DrawPerceptionIndicators", "ai_DrawPerceptionModifiers", "ai_DrawPlayerRanges", "ai_DrawProbableTarget", "ai_DrawRadar", "ai_DrawRadarDist", "ai_DrawReadibilities", "ai_DrawRefPoints", "ai_DrawSelectedTargets", "ai_DrawShooting", "ai_DrawSmartObjects", "ai_DrawSoundEvents", "ai_DrawStats", "ai_DrawTargets", "ai_DrawTrajectory", "ai_DrawType", "ai_DrawUpdate", "ai_DynamicHidespotsEnabled", "ai_EnableCoolMisses", "ai_EnableORCA", "ai_EnablePerceptionStanceVisibleRange", "ai_EnableWarningsErrors", "ai_EnableWaterOcclusion", "ai_ExtraForbiddenRadiusDuringBeautification", "ai_ExtraRadiusDuringBeautification", "ai_ExtraVehicleAvoidanceRadiusBig", "ai_ExtraVehicleAvoidanceRadiusSmall", "ai_FilterAgentName", "ai_FlowNodeAlertnessCheck", "ai_ForceAGAction", "ai_ForceAGSignal", "ai_ForceAllowStrafing", "ai_ForceLookAimTarget", "ai_ForcePosture", "ai_ForceSerializeAllObjects", "ai_ForceStance", "ai_IgnoreBulletRainStimulus", "ai_IgnorePlayer", "ai_IgnoreSoundStimulus", "ai_IgnoreVisibilityChecks", "ai_IgnoreVisualStimulus", "ai_InterestSystem", "ai_InterestSystemCastRays", "ai_IntersectionTesterQuota", "ai_IslandConnectionsSystemProfileMemory", "ai_LobThrowMinAllowedDistanceFromFriends", "ai_LobThrowPercentageOfDistanceToTargetUsedForInaccuracySimulation", "ai_LobThrowTimePredictionForFriendPositions", "ai_LobThrowUseRandomForInaccuracySimulation", "ai_Locate", "ai_LogConsoleVerbosity", "ai_LogFileVerbosity", "ai_LogModularBehaviorTreeExecutionStacks", "ai_LogSignals", "ai_MinActorDynamicObstacleAvoidanceRadius", "ai_MNMAllowDynamicRegenInEditor", "ai_MNMDebugAccessibility", "ai_MNMDebugDrawFlag", "ai_MNMDebugTriangleOnCursor", "ai_MNMEditorBackgroundUpdate", "ai_MNMPathfinderConcurrentRequests", "ai_MNMPathFinderDebug", "ai_MNMPathfinderMT", "ai_MNMPathfinderPositionInTrianglePredictionType", "ai_MNMPathFinderQuota", "ai_MNMProfileMemory", "ai_MNMRaycastImplementation", "ai_ModularBehaviorTree", "ai_MovementSystemPathReplanningEnabled", "ai_NavGenThreadJobs", "ai_NavigationSystemMT", "ai_NavmeshStabilizationTimeToUpdate", "ai_NavmeshTileDistanceDraw", "ai_NetworkDebug", "ai_NoUpdate", "ai_ObstacleSizeThreshold", "ai_OutputPersonalLogToConsole", "ai_OverlayMessageDuration", "ai_PathfinderAvoidanceCostForGroupMates", "ai_PathfinderDangerCostForAttentionTarget", "ai_PathfinderDangerCostForExplosives", "ai_PathfinderExplosiveDangerMaxThreatDistance", "ai_PathfinderExplosiveDangerRadius", "ai_PathfinderGroupMatesAvoidanceRadius", "ai_PathfinderUpdateTime", "ai_PathfindTimeLimit", "ai_PathStringPullingIterations", "ai_PlayerAffectedByLight", "ai_PredictivePathFollowing", "ai_ProfileGoals", "ai_ProneVisibleRange", "ai_RayCasterQuota", "ai_RecordCommunicationStats", "ai_Recorder", "ai_Recorder_Auto", "ai_Recorder_Buffer", "ai_RecordLog", "ai_RODAliveTime", "ai_RODAmbientFireInc", "ai_RODCombatRangeMod", "ai_RODCoverFireTimeMod", "ai_RODDirInc", "ai_RODFakeHitChance", "ai_RODKillRangeMod", "ai_RODKillZoneInc", "ai_RODLowHealthMercyTime", "ai_RODMoveInc", "ai_RODReactionDarkIllumInc", "ai_RODReactionDirInc", "ai_RODReactionDistInc", "ai_RODReactionLeanInc", "ai_RODReactionMediumIllumInc", "ai_RODReactionSuperDarkIllumInc", "ai_RODReactionTime", "ai_RODStanceInc", "ai_ShowBehaviorCalls", "ai_SightRangeDarkIllumMod", "ai_SightRangeMediumIllumMod", "ai_SightRangeSuperDarkIllumMod", "ai_SimpleWayptPassability", "ai_SmartPathFollower_decelerationHuman", "ai_SmartPathFollower_decelerationVehicle", "ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathRunAndSprint", "ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathWalk", "ai_SmartPathFollower_useAdvancedPathShortcutting", "ai_SmartPathFollower_useAdvancedPathShortcutting_debug", "ai_SOMSpeedCombat", "ai_SOMSpeedRelaxed", "ai_SoundPerception", "ai_StatsDisplayMode", "ai_StatsTarget", "ai_SteepSlopeAcrossValue", "ai_SteepSlopeUpValue", "ai_SystemUpdate", "ai_TacticalPointsDebugDrawMode", "ai_TacticalPointsDebugFadeMode", "ai_TacticalPointsDebugScaling", "ai_TacticalPointsDebugTime", "ai_TacticalPointsWarnings", "ai_TacticalPointUpdateTime", "ai_TargetTracking", "ai_TargetTracks_GlobalTargetLimit", "ai_UpdateAllAlways", "ai_UpdateInterval", "ai_UpdateProxy", "ai_UseCalculationStopperCounter", "ai_UseSimplePathfindingHeuristic", "ai_UseSmartPathFollower", "ai_UseSmartPathFollower_AABB_based", "ai_UseSmartPathFollower_LookAheadDistance", "ai_VisionMapNumberOfPVSUpdatesPerFrame", "ai_VisionMapNumberOfVisibilityUpdatesPerFrame", "ai_WaterOcclusion", "ban_timeout", "br_breakmaxworldsize", "br_breakworldoffsetx", "br_breakworldoffsety", "c_shakeMult", "ca_AllowMultipleEffectsOfSameName", "ca_AnimWarningLevel", "ca_ApplyJointVelocitiesMode", "ca_AttachmentCullingRation", "ca_AttachmentCullingRationMP", "ca_AttachmentMergingMemoryBudget", "ca_AttachmentTextureMemoryBudget", "ca_CharEditModel", "ca_cloth_air_resistance", "ca_cloth_damping", "ca_cloth_friction", "ca_cloth_max_safe_step", "ca_cloth_max_timestep", "ca_cloth_stiffness", "ca_cloth_stiffness_norm", "ca_cloth_stiffness_tang", "ca_cloth_thickness", "ca_cloth_vars_reset", "ca_ClothBlending", "ca_ClothBypassSimulation", "ca_ClothForceSkinningAfterNFrames", "ca_ClothMaxChars", "ca_DBAUnloadRemoveTime", "ca_DBAUnloadUnregisterTime", "ca_DeathBlendTime", "ca_DebugADIKTargets", "ca_DebugAnimationStreaming", "ca_DebugAnimMemTracking", "ca_DebugAnimUpdates", "ca_DebugAnimUsage", "ca_DebugAnimUsageOnFileAccess", "ca_DebugAttachmentsProxies", "ca_DebugCommandBuffer", "ca_DebugCommandBufferFilter", "ca_DebugCriticalErrors", "ca_DebugFacial", "ca_DebugFacialEyes", "ca_DebugModelCache", "ca_DebugSegmentation", "ca_DebugSkeletonEffects", "ca_DebugSWSkinning", "ca_DecalSizeMultiplier", "ca_disable_thread", "ca_DisableAnimationUnloading", "ca_DisableAuxPhysics", "ca_DrawAimIKVEGrid", "ca_DrawAimPoses", "ca_DrawAllSimulatedSockets", "ca_DrawAttachmentOBB", "ca_DrawAttachmentProjection", "ca_DrawAttachments", "ca_DrawAttachmentsMergedForShadows", "ca_DrawBaseMesh", "ca_DrawBBox", "ca_DrawBinormals", "ca_DrawCC", "ca_DrawCGA", "ca_DrawCHR", "ca_DrawCloth", "ca_DrawDecalsBBoxes", "ca_DrawEmptyAttachments", "ca_DrawLocator", "ca_DrawLookIK", "ca_DrawNormals", "ca_DrawPose", "ca_DrawPositionPost", "ca_DrawSkeleton", "ca_DrawTangents", "ca_DrawVEGInfo", "ca_DrawWireframe", "ca_DumpUsedAnims", "ca_eyes_procedural", "ca_FacialAnimationRadius", "ca_FilterJoints", "ca_ForceAnimationLod", "ca_ForceUpdateSkeletons", "ca_KeepModels", "ca_lipsync_debug", "ca_lipsync_phoneme_crossfade", "ca_lipsync_phoneme_offset", "ca_lipsync_phoneme_strength", "ca_lipsync_vertex_drag", "ca_LoadUncompressedChunks", "ca_LockFeetWithIK", "ca_MemoryDefragEnabled", "ca_MemoryDefragPoolSize", "ca_MemoryUsageLog", "ca_MinInPlaceCAFStreamSize", "ca_MotionBlurMovementThreshold", "ca_NoAnim", "ca_ParametricPoolSize", "ca_physicsProcessImpact", "ca_PrecacheAnimationSets", "ca_PreloadAllCAFs", "ca_ReloadAllCHRPARAMS", "ca_ResetCulledJointsToBindPose", "ca_SampleQuatHemisphereFromCurrentPose", "ca_SaveAABB", "ca_SerializeSkeletonAnim", "ca_SnapToVGrid", "ca_StoreAnimNamesOnLoad", "ca_StreamCHR", "ca_StreamDBAInPlace", "ca_thread", "ca_thread0Affinity", "ca_thread1Affinity", "ca_UnloadAnimationCAF", "ca_UnloadAnimationDBA", "ca_useADIKTargets", "ca_UseAimIK", "ca_UseAssetDefinedLod", "ca_UseDecals", "ca_UseFacialAnimation", "ca_UseIMG_AIM", "ca_UseIMG_CAF", "ca_UseJointMasking", "ca_UseLookIK", "ca_UseMorph", "ca_UsePhysics", "ca_UseRecoil", "ca_UseScaling", "ca_vaBlendCullingDebug", "ca_vaBlendCullingThreshold", "ca_vaBlendEnable", "ca_vaBlendPostSkinning", "ca_vaEnable", "ca_Validate", "ca_vaProfile", "ca_vaScaleFactor", "ca_vaSkipVertexAnimationLOD", "ca_vaUpdateTangents", "ca_VClothMode", "capture_file_format", "capture_file_name", "capture_file_prefix", "capture_folder", "capture_frame_once", "capture_frames", "cl_AISystem", "cl_bandwidth", "cl_camera_noise", "cl_camera_noise_freq", "cl_comment", "cl_DefaultNearPlane", "cl_DisableHUDText", "cl_ETColorOverrideB", "cl_ETColorOverrideEnable", "cl_ETColorOverrideG", "cl_ETColorOverrideR", "cl_ETFontSizeMultiplier", "cl_ETHideAIDebug", "cl_ETHideAll", "cl_ETHideBehaviour", "cl_ETHideFlowgraph", "cl_ETHideReadability", "cl_ETHideScriptBind", "cl_ETLog", "cl_ETMaxDisplayDistance", "cl_nickname", "cl_packetRate", "cl_serveraddr", "cl_serverpassword", "cl_serverport", "cl_tokenid", "cl_useCurrentUserNameAsDefault", "cl_ViewApplyHmdOffset", "cl_ViewSystemDebug", "cl_voice_recording", "cl_voice_volume", "co_coopAnimDebug", "co_slideWhileStreaming", "co_usenewcoopanimsystem", "con_debug", "con_display_last_messages", "con_line_buffer_size", "con_restricted", "con_showonload", "connect_repeatedly_num_attempts", "connect_repeatedly_time_between_attempts", "cvDoVerboseWindowTitle", "d3d11_CBUpdateStats", "d3d11_debugBreakOnce", "d3d11_debugBreakOnMsgID", "d3d11_debugMuteMsgID", "d3d11_debugMuteSeverity", "d3d11_forcedFeatureLevel", "d3d11_preventDriverThreading", "demo_ai", "demo_file", "demo_finish_cmd", "demo_finish_memreplay_sizer", "demo_finish_memreplay_stop", "demo_fixed_timestep", "demo_game_state", "demo_max_frames", "demo_noinfo", "demo_num_orientations", "demo_num_runs", "demo_panoramic", "demo_profile", "demo_quit", "demo_restart_level", "demo_save_every_frame", "demo_savestats", "demo_screenshot_frame", "demo_scroll_pause", "demo_time_of_day", "demo_use_hmd_rotation", "demo_vtune", "dlc_directory", "doc_use_subfolder_for_crash_backup", "doc_validate_surface_types", "drs_dataPath", "drs_dialogAudio", "drs_dialogBinaryFileFormat", "drs_dialogEntityRtpcName", "drs_dialogGlobalRtpcName", "drs_dialogsDefaultMaxQueueTime", "drs_dialogsDefaultPauseAfterLines", "drs_dialogsDefaultTalkAnimation", "drs_dialogsLipsyncAnimationLayer", "drs_dialogsLipsyncTransitionTime", "drs_dialogsSamePriorityCancels", "drs_dialogSubtitles", "drs_fileFormat", "drs_loggingOptions", "ds_AutoReloadScripts", "ds_LevelNameOverride", "ds_LoadExcelScripts", "ds_LoadSoundsSync", "ds_LogLevel", "ds_PrecacheSounds", "ds_WarnOnMissingLoc", "e_3dEngineLogAlways", "e_3dEngineTempPoolSize", "e_AutoPrecacheCameraJumpDist", "e_AutoPrecacheCgf", "e_AutoPrecacheTerrainAndProcVeget", "e_AutoPrecacheTexturesAndShaders", "e_BBoxes", "e_Brushes", "e_BrushUseTerrainColor", "e_CacheNearestCubePicking", "e_CameraFreeze", "e_CameraGoto", "e_CameraRotationSpeed", "e_CGFMaxFileSize", "e_CharLodMin", "e_CheckOcclusion", "e_CheckOcclusionOutputQueueSize", "e_CheckOcclusionQueueSize", "e_CheckOctreeObjectsBoxSize", "e_Clouds", "e_CoverageBuffer", "e_CoverageBufferAABBExpand", "e_CoverageBufferBias", "e_CoverageBufferCullIndividualBrushesMaxNodeSize", "e_CoverageBufferDebug", "e_CoverageBufferDebugFreeze", "e_CoverageBufferDrawOccluders", "e_CoverageBufferEarlyOut", "e_CoverageBufferEarlyOutDelay", "e_CoverageBufferOccludersViewDistRatio", "e_CoverageBufferRastPolyLimit", "e_CoverageBufferReproj", "e_CoverageBufferShowOccluder", "e_CoverageBufferTerrain", "e_CoverageBufferTerrainExpand", "e_CoverCgfDebug", "e_CullVegActivation", "e_DebugDraw", "e_DebugDrawFilter", "e_DebugDrawListBBoxIndex", "e_DebugDrawListFilter", "e_DebugDrawListSize", "e_DebugDrawShowOnlyCompound", "e_DebugDrawShowOnlyLod", "e_DebugGeomPrep", "e_DebugLights", "e_Decals", "e_DecalsAllowGameDecals", "e_DecalsClip", "e_DecalsDeferredDynamic", "e_DecalsDeferredDynamicDepthScale", "e_DecalsDeferredDynamicMinSize", "e_DecalsDeferredStatic", "e_DecalsForceDeferred", "e_DecalsHitCache", "e_DecalsLifeTimeScale", "e_DecalsMaxTrisInObject", "e_DecalsMaxUpdatesPerFrame", "e_DecalsMaxValidFrames", "e_DecalsMerge", "e_DecalsNeighborMaxLifeTime", "e_DecalsOverlapping", "e_DecalsPlacementTestAreaSize", "e_DecalsPlacementTestMinDepth", "e_DecalsPreCreate", "e_DecalsRange", "e_DecalsSpawnDistRatio", "e_DefaultMaterial", "e_DeferredPhysicsEvents", "e_DeformableObjects", "e_DisplayMemoryUsageIcon", "e_DynamicDistanceShadows", "e_DynamicLights", "e_DynamicLightsConsistentSortOrder", "e_DynamicLightsForceDeferred", "e_DynamicLightsFrameIdVisTest", "e_DynamicLightsMaxCount", "e_DynamicLightsMaxEntityLights", "e_Entities", "e_EntitySuppressionLevel", "e_ExecuteRenderAsJobMask", "e_Fog", "e_FogVolumes", "e_FoliageBranchesDamping", "e_FoliageBranchesStiffness", "e_FoliageBranchesTimeout", "e_FoliageBrokenBranchesDamping", "e_FoliageStiffness", "e_FoliageWindActivationDist", "e_ForceDetailLevelForScreenRes", "e_GeomCacheBufferSize", "e_GeomCacheDebug", "e_GeomCacheDebugDrawMode", "e_GeomCacheDebugFilter", "e_GeomCacheDecodeAheadTime", "e_GeomCacheLerpBetweenFrames", "e_GeomCacheMaxBufferAheadTime", "e_GeomCacheMaxPlaybackFromMemorySize", "e_GeomCacheMinBufferAheadTime", "e_GeomCachePreferredDiskRequestSize", "e_GeomCaches", "e_GI", "e_GsmCastFromTerrain", "e_GsmDepthBoundsDebug", "e_GsmLodsNum", "e_GsmRange", "e_GsmRangeStep", "e_GsmStats", "e_HwOcclusionCullingWater", "e_JointStrengthScale", "e_levelStartupFrameDelay", "e_levelStartupFrameNum", "e_LightIlluminanceThreshold", "e_LightVolumes", "e_LightVolumesDebug", "e_LodCompMaxSize", "e_LodFaceArea", "e_LodFaceAreaTargetSize", "e_LodMax", "e_LodMin", "e_LodMinTtris", "e_LodRatio", "e_Lods", "e_LodsForceUse", "e_LodTransitionSpriteDistRatio", "e_LodTransitionSpriteMinDist", "e_LodTransitionTime", "e_MaxDrawCalls", "e_MaxViewDistance", "e_MaxViewDistFullDistCamHeight", "e_MaxViewDistSpecLerp", "e_MergedMeshes", "e_MergedMeshesActiveDist", "e_MergedMeshesBulletLifetime", "e_MergedMeshesBulletScale", "e_MergedMeshesBulletSpeedFactor", "e_MergedMeshesClusterVisualization", "e_MergedMeshesClusterVisualizationDimension", "e_MergedMeshesDebug", "e_MergedMeshesDeformViewDistMod", "e_MergedMeshesInstanceDist", "e_MergedMeshesLodRatio", "e_MergedMeshesMaxTriangles", "e_MergedMeshesOutdoorOnly", "e_MergedMeshesPool", "e_MergedMeshesPoolSpines", "e_MergedMeshesTesselationSupport", "e_MergedMeshesUseSpines", "e_MergedMeshesViewDistRatio", "e_MinMassDistanceCheckRenderMeshCollision", "e_ObjectLayersActivation", "e_ObjectLayersActivationPhysics", "e_Objects", "e_ObjectsTreeBBoxes", "e_ObjectsTreeLevelsDebug", "e_ObjectsTreeNodeMinSize", "e_ObjectsTreeNodeSizeRatio", "e_ObjFastRegister", "e_ObjQuality", "e_ObjShadowCastSpec", "e_ObjStats", "e_OcclusionCullingViewDistRatio", "e_OcclusionLazyHideFrames", "e_OcclusionVolumes", "e_OcclusionVolumesViewDistRatio", "e_OnDemandMaxSize", "e_OnDemandPhysics", "e_Particles", "e_ParticlesAllowRuntimeLoad", "e_ParticlesAnimBlend", "e_ParticlesAudio", "e_ParticlesConvertPfx1", "e_ParticlesCullAgainstOcclusionBuffer", "e_ParticlesCullAgainstViewFrustum", "e_ParticlesDebug", "e_ParticlesDumpMemoryAfterMapLoad", "e_ParticlesForceSeed", "e_ParticlesGI", "e_ParticleShadowsNumGSMs", "e_ParticlesIndexPoolSize", "e_ParticlesJobsPerThread", "e_ParticlesLights", "e_ParticlesLightsViewDistRatio", "e_ParticlesLod", "e_ParticlesMaxDrawScreen", "e_ParticlesMaxScreenFill", "e_ParticlesMinDrawAlpha", "e_ParticlesMinDrawPixels", "e_ParticlesMinPhysicsDynamicBounds", "e_ParticlesMotionBlur", "e_ParticlesObjectCollisions", "e_ParticlesPoolSize", "e_ParticlesPreload", "e_ParticlesProfile", "e_ParticlesProfiler", "e_ParticlesProfilerCountBudget", "e_ParticlesProfilerOutputFolder", "e_ParticlesProfilerOutputName", "e_ParticlesProfilerTimingBudget", "e_ParticlesQuality", "e_ParticlesSerializeNamedFields", "e_ParticlesShadows", "e_ParticlesSoftIntersect", "e_ParticlesSortQuality", "e_ParticlesThread", "e_ParticlesUseLevelSpecificLibs", "e_ParticlesVertexPoolSize", "e_PermanentRenderObjects", "e_PhysFoliage", "e_PhysMinCellSize", "e_PhysOceanCell", "e_PhysProxyTriLimit", "e_Portals", "e_PortalsBigEntitiesFix", "e_PortalsBlend", "e_PortalsMaxRecursion", "e_PrecacheLevel", "e_PreloadDecals", "e_PreloadMaterials", "e_PrepareDeformableObjectsAtLoadTime", "e_ProcVegetation", "e_ProcVegetationMaxCacheLevels", "e_ProcVegetationMaxChunksInCache", "e_ProcVegetationMaxObjectsInChunk", "e_ProcVegetationMaxSectorsInCache", "e_ProcVegetationMaxViewDistance", "e_Recursion", "e_RecursionViewDistRatio", "e_Render", "e_RenderMeshCollisionTolerance", "e_RenderMeshUpdateAsync", "e_RNTmpDataPoolMaxFrames", "e_Roads", "e_Ropes", "e_ScissorDebug", "e_ScreenShot", "e_ScreenShotDebug", "e_ScreenShotFileFormat", "e_ScreenShotHeight", "e_ScreenShotMapCamHeight", "e_ScreenShotMapCenterX", "e_ScreenShotMapCenterY", "e_ScreenShotMapOrientation", "e_ScreenShotMapSizeX", "e_ScreenShotMapSizeY", "e_ScreenShotMinSlices", "e_ScreenShotQuality", "e_ScreenShotWidth", "e_Shadows", "e_ShadowsAdaptScale", "e_ShadowsAutoBias", "e_ShadowsBlendCascades", "e_ShadowsBlendCascadesVal", "e_ShadowsCacheExtendLastCascade", "e_ShadowsCacheMaxNodesPerFrame", "e_ShadowsCacheObjectLod", "e_ShadowsCacheRenderCharacters", "e_ShadowsCacheUpdate", "e_ShadowsCascadesCentered", "e_ShadowsCascadesDebug", "e_ShadowsCastViewDistRatio", "e_ShadowsCastViewDistRatioLights", "e_ShadowsClouds", "e_ShadowsConstBias", "e_ShadowsConstBiasHQ", "e_ShadowsDebug", "e_ShadowsFrustums", "e_ShadowsLodBiasFixed", "e_ShadowsLodBiasInvis", "e_ShadowsMasksLimit", "e_ShadowsMaxTexRes", "e_ShadowsPerObject", "e_ShadowsPerObjectResolutionScale", "e_ShadowsPoolSize", "e_ShadowsResScale", "e_ShadowsSlopeBias", "e_ShadowsSlopeBiasHQ", "e_ShadowsTessellateCascades", "e_ShadowsTessellateDLights", "e_ShadowsUpdateViewDistRatio", "e_SkyBox", "e_SkyQuality", "e_SkyType", "e_SkyUpdateRate", "e_Sleep", "e_SQTestBegin", "e_SQTestCount", "e_SQTestDelay", "e_SQTestDistance", "e_SQTestExitOnFinish", "e_SQTestMip", "e_SQTestMoveSpeed", "e_SQTestTextureName", "e_StaticInstancing", "e_StaticInstancingMinInstNum", "e_StatObjBufferRenderTasks", "e_StatObjMerge", "e_StatObjMergeMaxTrisPerDrawCall", "e_StatObjPreload", "e_StatObjRenderFilter", "e_StatObjRenderFilterMode", "e_StatObjStoreMesh", "e_StatObjTessellationMode", "e_StatObjValidate", "e_StatoscopeAllowFpsOverride", "e_StatoscopeConnectTimeout", "e_StatoscopeCreateLogFilePerLevel", "e_StatoscopeDataGroups", "e_StatoscopeDumpAll", "e_StatoscopeEnabled", "e_StatoscopeFilenameUseBuildInfo", "e_StatoscopeFilenameUseDatagroups", "e_StatoscopeFilenameUseMap", "e_StatoscopeFilenameUseTag", "e_StatoscopeFilenameUseTime", "e_StatoscopeIvDataGroups", "e_StatoscopeLogDestination", "e_StatoscopeMaxNumFuncsPerFrame", "e_StatoscopeMinFuncLengthMs", "e_StatoscopeScreenCapWhenGPULimited", "e_StatoscopeScreenshotCapturePeriod", "e_StatoscopeWriteTimeout", "e_StreamAutoMipFactorMax", "e_StreamAutoMipFactorMaxDVD", "e_StreamAutoMipFactorMin", "e_StreamAutoMipFactorSpeedThreshold", "e_StreamCgf", "e_StreamCgfDebug", "e_StreamCgfDebugFilter", "e_StreamCgfDebugHeatMap", "e_StreamCgfDebugMinObjSize", "e_StreamCgfFastUpdateMaxDistance", "e_StreamCgfGridUpdateDistance", "e_StreamCgfMaxNewTasksPerUpdate", "e_StreamCgfMaxTasksInProgress", "e_StreamCgfPoolSize", "e_StreamCgfUpdatePerNodeDistance", "e_StreamCgfVisObjPriority", "e_StreamInstances", "e_StreamInstancesDistRatio", "e_StreamInstancesMaxTasks", "e_StreamPredictionAhead", "e_StreamPredictionAheadDebug", "e_StreamPredictionAlwaysIncludeOutside", "e_StreamPredictionBoxRadius", "e_StreamPredictionDistanceFar", "e_StreamPredictionDistanceNear", "e_StreamPredictionMaxVisAreaRecursion", "e_StreamPredictionMinFarZoneDistance", "e_StreamPredictionMinReportDistance", "e_StreamPredictionTexelDensity", "e_StreamPredictionUpdateTimeSlice", "e_StreamSaveStartupResultsIntoXML", "e_Sun", "e_SunAngleSnapDot", "e_SunAngleSnapSec", "e_svoDebug", "e_svoDispatchX", "e_svoDispatchY", "e_svoDVR", "e_svoDVR_DistRatio", "e_svoEnabled", "e_svoLoadTree", "e_svoMaxAreaMeshSizeKB", "e_svoMaxAreaSize", "e_svoMaxBricksOnCPU", "e_svoMaxBrickUpdates", "e_svoMaxNodeSize", "e_svoMaxStreamRequests", "e_svoMinNodeSize", "e_svoRender", "e_svoRootless", "e_svoStreamVoxels", "e_svoTI_Active", "e_svoTI_AnalyticalGI", "e_svoTI_AnalyticalOccluders", "e_svoTI_AnalyticalOccludersRange", "e_svoTI_AnalyticalOccludersSoftness", "e_svoTI_Apply", "e_svoTI_AsyncCompute", "e_svoTI_ConeMaxLength", "e_svoTI_ConstantAmbientDebug", "e_svoTI_Diffuse_Cache", "e_svoTI_Diffuse_Spr", "e_svoTI_DiffuseAmplifier", "e_svoTI_DiffuseBias", "e_svoTI_DiffuseConeWidth", "e_svoTI_DistantSsaoAmount", "e_svoTI_DualTracing", "e_svoTI_DynLights", "e_svoTI_EmissiveMultiplier", "e_svoTI_ForceGIForAllLights", "e_svoTI_GsmCascadeLod", "e_svoTI_HalfresKernelPrimary", "e_svoTI_HalfresKernelSecondary", "e_svoTI_HighGlossOcclusion", "e_svoTI_InjectionMultiplier", "e_svoTI_IntegrationMode", "e_svoTI_LowSpecMode", "e_svoTI_MaxSyncUpdateTime", "e_svoTI_MinReflectance", "e_svoTI_MinVoxelOpacity", "e_svoTI_NumberOfBounces", "e_svoTI_NumStreamingThreads", "e_svoTI_ObjectsLod", "e_svoTI_ObjectsMaxViewDistance", "e_svoTI_ObjectsMaxViewDistanceScale", "e_svoTI_PointLightsBias", "e_svoTI_PointLightsMaxDistance", "e_svoTI_PointLightsMultiplier", "e_svoTI_PortalsDeform", "e_svoTI_PortalsInject", "e_svoTI_PropagationBooster", "e_svoTI_Reflect_Vox_Max", "e_svoTI_Reflect_Vox_Max_Overhead", "e_svoTI_Reflect_Vox_MaxEdit", "e_svoTI_ResScaleAir", "e_svoTI_ResScaleBase", "e_svoTI_RsmConeMaxLength", "e_svoTI_RsmUseColors", "e_svoTI_RT_MaxDist", "e_svoTI_Saturation", "e_svoTI_ShadowsFromSun", "e_svoTI_ShadowsSoftness", "e_svoTI_SkipNonGILights", "e_svoTI_SkyColorMultiplier", "e_svoTI_SkyLightBottomMultiplier", "e_svoTI_Specular_FromDiff", "e_svoTI_Specular_Reproj", "e_svoTI_Specular_Sev", "e_svoTI_SpecularAmplifier", "e_svoTI_SSAOAmount", "e_svoTI_SSDepthTrace", "e_svoTI_SunRSMInject", "e_svoTI_TemporalFilteringBase", "e_svoTI_TraceVoxels", "e_svoTI_TranslucentBrightness", "e_svoTI_Troposphere_Active", "e_svoTI_Troposphere_Brightness", "e_svoTI_Troposphere_CloudGen_Freq", "e_svoTI_Troposphere_CloudGen_FreqStep", "e_svoTI_Troposphere_CloudGen_Height", "e_svoTI_Troposphere_CloudGen_Scale", "e_svoTI_Troposphere_CloudGenTurb_Freq", "e_svoTI_Troposphere_CloudGenTurb_Scale", "e_svoTI_Troposphere_Density", "e_svoTI_Troposphere_Ground_Height", "e_svoTI_Troposphere_Layer0_Dens", "e_svoTI_Troposphere_Layer0_Height", "e_svoTI_Troposphere_Layer0_Rand", "e_svoTI_Troposphere_Layer1_Dens", "e_svoTI_Troposphere_Layer1_Height", "e_svoTI_Troposphere_Layer1_Rand", "e_svoTI_Troposphere_Snow_Height", "e_svoTI_Troposphere_Subdivide", "e_svoTI_UpdateGeometry", "e_svoTI_UpdateLighting", "e_svoTI_UseLightProbes", "e_svoTI_UseTODSkyColor", "e_svoTI_VegetationMaxOpacity", "e_svoTI_VoxelizationLODRatio", "e_svoTI_VoxelizationMapBorder", "e_svoTI_VoxelizationPostpone", "e_svoTI_VoxelizeHiddenObjects", "e_svoTI_VoxelizeUnderTerrain", "e_svoTI_VoxelOpacityMultiplier", "e_svoVoxDistRatio", "e_svoVoxelPoolResolution", "e_svoVoxGenRes", "e_svoVoxNodeRatio", "e_Terrain", "e_TerrainAutoGenerateBaseTexture", "e_TerrainAutoGenerateBaseTextureTiling", "e_TerrainBBoxes", "e_TerrainDeformations", "e_TerrainDetailMaterials", "e_TerrainDetailMaterialsDebug", "e_TerrainDetailMaterialsViewDistXY", "e_TerrainDetailMaterialsViewDistZ", "e_TerrainDrawThisSectorOnly", "e_TerrainEditPostponeTexturesUpdate", "e_TerrainIntegrateObjectsMaxHeight", "e_TerrainIntegrateObjectsMaxVertices", "e_TerrainLodDistanceRatio", "e_TerrainLodErrorRatio", "e_TerrainMeshInstancingMinLod", "e_TerrainMeshInstancingShadowBias", "e_TerrainMeshInstancingShadowLodRatio", "e_TerrainOcclusionCulling", "e_TerrainOcclusionCullingDebug", "e_TerrainOcclusionCullingMaxDist", "e_TerrainOcclusionCullingMaxSteps", "e_TerrainOcclusionCullingPrecision", "e_TerrainOcclusionCullingPrecisionDistRatio", "e_TerrainOcclusionCullingStepSize", "e_TerrainOcclusionCullingStepSizeDelta", "e_TerrainTextureLodRatio", "e_TerrainTextureStreamingDebug", "e_TerrainTextureStreamingPoolItemsNum", "e_Tessellation", "e_TessellationMaxDistance", "e_TimeOfDay", "e_TimeOfDayDebug", "e_TimeOfDaySpeed", "e_UseConsoleMtl", "e_Vegetation", "e_VegetationBending", "e_VegetationBillboards", "e_VegetationBoneInfo", "e_VegetationMinSize", "e_VegetationSprites", "e_VegetationSpritesBatching", "e_VegetationSpritesDistanceCustomRatioMin", "e_VegetationSpritesDistanceRatio", "e_VegetationSpritesMinDistance", "e_VegetationSpritesScaleFactor", "e_VegetationUseTerrainColor", "e_VegetationUseTerrainColorDistance", "e_ViewDistCompMaxSize", "e_ViewDistMin", "e_ViewDistRatio", "e_ViewDistRatio3Planar", "e_ViewDistRatioCustom", "e_ViewDistRatioDetail", "e_ViewDistRatioLights", "e_ViewDistRatioModifierGameDecals", "e_ViewDistRatioPortals", "e_ViewDistRatioVegetation", "e_VolObjShadowStrength", "e_VolumetricFog", "e_WaterOcean", "e_WaterOceanBottom", "e_WaterOceanFFT", "e_WaterRipplesDebug", "e_WaterTessellationAmount", "e_WaterTessellationAmountX", "e_WaterTessellationAmountY", "e_WaterTessellationSwathWidth", "e_WaterVolumes", "e_WaterWaves", "e_WaterWavesTessellationAmount", "e_Wind", "e_WindAreas", "e_WindBendingAreaStrength", "e_WindBendingDistRatio", "e_WindBendingStrength", "ed_combineFileChanges", "ed_enableAssetPickers", "ed_generateThumbnails", "ed_indexfiles", "ed_keepEditorActive", "ed_killmemory_size", "ed_logFileChanges", "ed_PhysToolHitExplPress0", "ed_PhysToolHitExplPress1", "ed_PhysToolHitExplR", "ed_PhysToolHitProjMass", "ed_PhysToolHitProjVel0", "ed_PhysToolHitProjVel1", "ed_PhysToolHitVelMax", "ed_PhysToolHitVelMin", "ed_useDevManager", "es_bboxes", "es_DebrisLifetimeScale", "es_debugContainers", "es_debugDrawEntityIDs", "es_debugEntityLifetime", "es_DebugEntityUsage", "es_DebugEntityUsageFilter", "es_DebugEntityUsageSortMode", "es_DebugEvents", "es_DebugFindEntity", "es_DebugTimers", "es_DrawAreaDebug", "es_DrawAreaGrid", "es_DrawAreaGridCells", "es_DrawAreas", "es_enable_full_script_save", "es_EntityUpdatePosDelta", "es_FarPhysTimeout", "es_HitCharacters", "es_HitDeadBodies", "es_ImpulseScale", "es_LayerDebugInfo", "es_LayerSaveLoadSerialization", "es_log_collisions", "es_MaxImpulseAdjMass", "es_MaxJointFx", "es_MaxPhysDist", "es_MaxPhysDistCloth", "es_MaxPhysDistInvisible", "es_MinImpulseVel", "es_profileComponentUpdates", "es_removeEntity", "es_SaveLoadUseLUANoSaveFlag", "es_UpdateEntities", "es_UpdateScript", "es_UsePhysVisibilityChecks", "ExitOnQuit", "ffs_debug", "fg_abortOnLoadError", "fg_debugmodules", "fg_debugmodules_filter", "fg_iDebugNextStep", "fg_iEnableFlowgraphNodeDebugging", "fg_inspectorLog", "fg_noDebugText", "fg_profile", "fg_SystemEnable", "g_aimdebug", "g_allowDisconnectIfUpdateFails", "g_allowSaveLoadInEditor", "g_asynclevelload", "g_breakage_debug", "g_breakage_mem_limit", "g_breakage_particles_limit", "g_breakageFadeDelay", "g_breakageFadeTime", "g_breakagelog", "g_breakageMinAxisInertia", "g_breakageNoDebrisCollisions", "g_breakageTreeDec", "g_breakageTreeInc", "g_breakageTreeIncGlass", "g_breakageTreeMax", "g_breakImpulseScale", "g_breaktimeoutframes", "g_debug_stats", "g_debugAspectChanges", "g_debugAspectFilterClass", "g_debugAspectFilterEntity", "g_debugAspectTrap", "g_debugAspectTrapCount", "g_debugDialogBuffers", "g_debugHardwareMouse", "g_debugRMI", "g_debugSaveLoadMemory", "g_disableInputKeyFlowNodeInDevMode", "g_disableSequencePlayback", "g_disableWinKeys", "g_displayCheckpointName", "g_distanceForceNoIk", "g_distanceForceNoLegRaycasts", "g_enableitems", "g_enableloadingscreen", "g_EnableLoadSave", "g_enableMergedMeshRuntimeAreas", "g_forceFastUpdate", "g_gameplayAnalyst", "g_glassAutoShatter", "g_glassAutoShatterMinArea", "g_glassAutoShatterOnExplosions", "g_glassForceTimeout", "g_glassForceTimeoutSpread", "g_glassMaxPanesToBreakPerFrame", "g_glassNoDecals", "g_glassSystemEnable", "g_groundAlignAll", "g_groundeffectsdebug", "g_handleEvents", "g_hostMigrationServerDelay", "g_immersive", "g_joint_breaking", "g_landingBobLandTimeFactor", "g_landingBobTimeFactor", "g_language", "g_languageAudio", "g_localPacketRate", "g_manualFrameStepFrequency", "g_multiplayerEnableVehicles", "g_no_breaking_by_objects", "g_no_secondary_breaking", "g_playerInteractorRadius", "g_procedural_breaking", "g_saveLoadBasicEntityOptimization", "g_saveLoadExtendedLog", "g_saveLoadUseExportedEntityList", "g_showUpdateState", "g_spectatorCollisions", "g_statisticsMode", "g_syncClassRegistry", "g_tree_cut_reuse_dist", "g_userNeverAutoSignsIn", "g_useSinglePosition", "g_useXMLCPBinForSaveLoad", "g_visibilityTimeout", "g_visibilityTimeoutTime", "g_waterHitOnly", "g_XMLCPBAddExtraDebugInfoToXmlDebugFiles", "g_XMLCPBBlockQueueLimit", "g_XMLCPBGenerateXmlDebugFiles", "g_XMLCPBSizeReportThreshold", "g_XMLCPBUseExtraZLibCompression", "gfx_ampserver", "gfx_debugdraw", "gfx_draw", "gfx_enabled", "gfx_FlashReloadEnabled", "gfx_FlashReloadTime", "gfx_inputevents_triggerrepeat", "gfx_inputevents_triggerstart", "gfx_loadtimethread", "gfx_reloadonlanguagechange", "gfx_uiaction_enable", "gfx_uiaction_folder", "gfx_uiaction_log", "gfx_uiaction_log_filter", "gfx_uievents_editorenabled", "gpu_particle_physics", "gt_show", "gt_showFilter", "gt_showLines", "gt_showPosX", "gt_showPosY", "hmd_device", "hmd_info", "hmd_resolution_scale", "hmd_social_screen", "hmd_social_screen_keep_aspect", "hmd_tracking_origin", "http_password", "i_bufferedkeys", "i_debug", "i_debugDigitalButtons", "i_forcefeedback", "i_inventory_capacity", "i_itemSystemDebugMemStats", "i_kinectDebug", "i_kinectXboxConnect", "i_kinectXboxConnectIP", "i_kinectXboxConnectPort", "i_kinGlobalExpCorrectionFactor", "i_kinGlobalExpDeviationRadius", "i_kinGlobalExpJitterRadius", "i_kinGlobalExpPredictionFactor", "i_kinGlobalExpSmoothFactor", "i_kinSkeletonMovedDistance", "i_kinSkeletonSmoothType", "i_listActionMaps", "i_lying_item_limit_mp", "i_lying_item_limit_sp", "i_mouse_accel", "i_mouse_accel_max", "i_mouse_buffered", "i_mouse_inertia", "i_mouse_scroll_coordinate_origin", "i_mouse_sensitivity", "i_mouse_smooth", "i_precache", "i_seatedTracking", "i_useKinect", "i_xinput", "i_xinput_deadzone_handling", "i_xinput_poll_time", "log_EnableRemoteConsole", "log_IncludeTime", "log_Module", "log_SpamDelay", "log_tick", "log_Verbosity", "log_VerbosityOverridesWriteToFile", "log_WriteToFile", "log_WriteToFileVerbosity", "lua_CodeCoverage", "lua_debugger", "lua_stackonmalloc", "lua_StopOnError", "MemInfo", "MemStats", "MemStatsMaxDepth", "MemStatsThreshold", "mfx_Debug", "mfx_DebugFlowGraphFX", "mfx_DebugVisual", "mfx_DebugVisualFilter", "mfx_Enable", "mfx_EnableAttachedEffects", "mfx_EnableFGEffects", "mfx_ParticleImpactThresh", "mfx_pfx_maxDist", "mfx_pfx_maxScale", "mfx_pfx_minScale", "mfx_RaisedSoundImpactThresh", "mfx_SerializeFGEffects", "mfx_SoundImpactThresh", "mfx_Timeout", "mi_defaultMaterial", "mi_jointSize", "mi_lazyLodGeneration", "mn_allowEditableDatabasesInPureGame", "mn_LogToFile", "mn_override_preview_file", "mn_sequence_path", "mov_cameraPrecacheTime", "mov_debugSequences", "mov_NoCutscenes", "mov_overrideCam", "movie_physicalentity_animation_lerp", "movie_timeJumpTransitionTime", "net_availableBandwidthClient", "net_availableBandwidthServer", "net_backofftimeout", "net_breakage_sync_entities", "net_bw_aggressiveness", "net_channelstats", "net_connectivity_detection_interval", "net_debug_draw_scale", "net_debugChannelIndex", "net_debugEntityInfo", "net_debugEntityInfoClassName", "net_debugInfo", "net_debugVerboseLevel", "net_dedi_scheduler_client_base_port", "net_dedi_scheduler_server_port", "net_defaultBandwidthShares", "net_defaultPacketRate", "net_defaultPacketRateIdle", "net_disconnect_on_rmi_error", "net_enable_tfrc", "net_enable_voice_chat", "net_enable_watchdog_timer", "net_fragment_expiration_time", "net_highlatencythreshold", "net_highlatencytimelimit", "net_inactivitytimeout", "net_inactivitytimeoutDevmode", "net_keepalive_time", "net_lan_scanport_first", "net_lan_scanport_num", "net_lanbrowser", "net_lobbyUpdateFrequency", "net_log", "net_log_remote_methods", "net_max_fragmented_packets_per_source", "net_maxpacketsize", "net_meminfo", "net_minTCPFriendlyBitRate", "net_netMsgDispatcherDebug", "net_netMsgDispatcherLogging", "net_netMsgDispatcherWarnThreshold", "net_new_queue_behaviour", "net_numNetIDHighBitBits", "net_numNetIDLowBitBits", "net_numNetIDMediumBitBits", "net_packet_read_debug_output", "net_packetfragmentlossrate", "net_PacketLagMax", "net_PacketLagMin", "net_PacketLossRate", "net_phys_debug", "net_phys_lagsmooth", "net_phys_pingsmooth", "net_ping_time", "net_profile_budget_logging", "net_profile_budget_logname", "net_profile_deep_bandwidth_logging", "net_profile_deep_bandwidth_logname", "net_profile_enable", "net_profile_logging", "net_profile_logname", "net_profile_show_socket_measurements", "net_profile_untouched_delay", "net_profile_worst_num_channels", "net_receiveQueueSize", "net_remotetimeestimationwarning", "net_safetysleeps", "net_scheduler_debug", "net_scheduler_debug_mode", "net_scheduler_expiration_period", "net_sendQueueSize", "net_sim_loadprofiles", "net_SimUseProfile", "net_socketBoostTimeout", "net_socketMaxTimeout", "net_socketMaxTimeoutMultiplayer", "net_stats_login", "net_stats_pass", "osm_debug", "osm_enabled", "osm_fbMinScale", "osm_fbScaleDeltaDown", "osm_fbScaleDeltaUp", "osm_historyLength", "osm_stress", "osm_targetFPS", "osm_targetFPSTolerance", "p_accuracy_LCPCG", "p_accuracy_LCPCG_no_improvement", "p_accuracy_MC", "p_approx_caps_len", "p_break_on_awake_ent_id", "p_break_on_validation", "p_check_out_of_bounds", "p_collision_mode", "p_cull_distance", "p_damping_group_size", "p_debug_explosions", "p_debug_joints", "p_do_step", "p_draw_helpers", "p_draw_helpers_num", "p_draw_helpers_opacity", "p_enforce_contacts", "p_ent_grid_use_obb", "p_fixed_timestep", "p_fly_mode", "p_force_sync", "p_GEB_max_cells", "p_gravity_z", "p_group_damping", "p_joint_damage_accum", "p_joint_damage_accum_threshold", "p_joint_gravity_step", "p_jump_to_profile_ent", "p_lattice_max_iters", "p_limit_simple_solver_energy", "p_list_active_objects", "p_log_lattice_tension", "p_max_approx_caps", "p_max_bone_velocity", "p_max_contact_gap", "p_max_contact_gap_player", "p_max_contact_gap_simple", "p_max_contacts", "p_max_debris_mass", "p_max_entity_cells", "p_max_LCPCG_contacts", "p_max_LCPCG_fruitless_iters", "p_max_LCPCG_iters", "p_max_LCPCG_microiters", "p_max_LCPCG_microiters_final", "p_max_LCPCG_subiters", "p_max_LCPCG_subiters_final", "p_max_MC_iters", "p_max_MC_mass_ratio", "p_max_MC_vel", "p_max_object_splashes", "p_max_plane_contacts", "p_max_plane_contacts_distress", "p_max_player_velocity", "p_max_substeps", "p_max_substeps_large_group", "p_max_unproj_vel", "p_max_velocity", "p_max_world_step", "p_min_LCPCG_improvement", "p_min_MC_iters", "p_min_separation_speed", "p_net_debugDraw", "p_net_extrapmax", "p_net_interp", "p_net_sequencefrequency", "p_num_bodies_large_group", "p_num_startup_overload_checks", "p_num_threads", "p_penalty_scale", "p_physics_library", "p_players_can_break", "p_profile", "p_profile_entities", "p_profile_functions", "p_prohibit_unprojection", "p_proxy_highlight_range", "p_proxy_highlight_threshold", "p_ray_fadeout", "p_ray_peak_time", "p_rope_collider_size_limit", "p_single_step_mode", "p_skip_redundant_colldet", "p_splash_dist0", "p_splash_dist1", "p_splash_force0", "p_splash_force1", "p_splash_vel0", "p_splash_vel1", "p_tick_breakable", "p_time_granularity", "p_unproj_vel_scale", "p_use_distance_contacts", "p_use_unproj_vel", "p_wireframe_distance", "pp_LoadOnlineAttributes", "pp_RichSaveGames", "pp_RSFDebugWrite", "pp_RSFDebugWriteOnLoad", "profile", "profile_additionalsub", "profile_callstack", "profile_col", "profile_deep", "profile_disk", "profile_disk_budget", "profile_disk_max_draw_items", "profile_disk_max_items", "profile_disk_timeframe", "profile_disk_type_filter", "profile_filter", "profile_filter_thread", "profile_graph", "profile_graphScale", "profile_log", "profile_min_display_ms", "profile_network", "profile_pagefaults", "profile_peak", "profile_peak_display", "profile_row", "profile_sampler", "profile_sampler_max_samples", "profile_smooth", "profile_weighting", "profileStreaming", "q_Renderer", "q_ShaderFX", "q_ShaderGeneral", "q_ShaderGlass", "q_ShaderHDR", "q_ShaderIce", "q_ShaderMetal", "q_ShaderPostProcess", "q_ShaderShadow", "q_ShaderSky", "q_ShaderTerrain", "q_ShaderVegetation", "q_ShaderWater", "r_3MonHack", "r_3MonHackHUDFOVX", "r_3MonHackHUDFOVY", "r_3MonHackLeftCGFOffsetX", "r_3MonHackRightCGFOffsetX", "r_AllowLiveMoCap", "r_AntialiasingMode", "r_AntialiasingModeDebug", "r_AntialiasingModeEditor", "r_AntialiasingModeSCull", "r_AntialiasingTAAFalloffHiFreq", "r_AntialiasingTAAFalloffLowFreq", "r_AntialiasingTAAPattern", "r_AntialiasingTAASharpening", "r_AntialiasingTSAAMipBias", "r_AntialiasingTSAASmoothness", "r_AntialiasingTSAASubpixelDetection", "r_ArmourPulseSpeedMultiplier", "r_auxGeom", "r_Batching", "r_BatchType", "r_BreakOnError", "r_Brightness", "r_buffer_banksize", "r_buffer_enable_lockless_updates", "r_buffer_pool_defrag_dynamic", "r_buffer_pool_defrag_max_moves", "r_buffer_pool_defrag_static", "r_buffer_pool_max_allocs", "r_buffer_sli_workaround", "r_CBufferUseNativeDepth", "r_Character_NoDeform", "r_ChromaticAberration", "r_CloakFadeByDist", "r_CloakFadeLightScale", "r_CloakFadeMaxDistSq", "r_CloakFadeMinDistSq", "r_CloakFadeMinValue", "r_CloakHeatScale", "r_cloakHighlightStrength", "r_CloakInterferenceSparksAlpha", "r_CloakLightScale", "r_CloakMinAmbientIndoors", "r_CloakMinAmbientOutdoors", "r_CloakMinLightValue", "r_CloakRefractionFadeByDist", "r_CloakRefractionFadeMaxDistSq", "r_CloakRefractionFadeMinDistSq", "r_CloakRefractionFadeMinValue", "r_CloakRenderInThermalVision", "r_CloakSparksAlpha", "r_CloakTransitionLightScale", "r_ColorBits", "r_ColorGrading", "r_ColorGradingCharts", "r_ColorGradingChartsCache", "r_ColorGradingFilters", "r_ColorGradingLevels", "r_ColorGradingSelectiveColor", "r_ColorRangeCompression", "r_ComputeSkinning", "r_ComputeSkinningDebugDraw", "r_ComputeSkinningMorphs", "r_ComputeSkinningTangents", "r_ConditionalRendering", "r_constantbuffer_banksize", "r_constantbuffer_watermarm", "r_Contrast", "r_CustomResHeight", "r_CustomResMaxSize", "r_CustomResPreview", "r_CustomResWidth", "r_CustomVisions", "r_D3D12AsynchronousCompute", "r_D3D12BatchResourceBarriers", "r_D3D12EarlyResourceBarriers", "r_D3D12HardwareComputeQueue", "r_D3D12HardwareCopyQueue", "r_D3D12SubmissionThread", "r_D3D12WaitableSwapChain", "r_DebugFontRendering", "r_DebugGBuffer", "r_DebugLayerEffect", "r_DebugLights", "r_DebugLightVolumes", "r_DebugRefraction", "r_DebugRenderMode", "r_DeferredDecals", "r_deferredDecalsDebug", "r_DeferredShadingAmbient", "r_DeferredShadingAmbientLights", "r_DeferredShadingAreaLights", "r_DeferredShadingDBTstencil", "r_DeferredShadingDepthBoundsTest", "r_DeferredShadingEnvProbes", "r_DeferredShadingFilterGBuffer", "r_DeferredShadingLBuffersFmt", "r_DeferredShadingLightLodRatio", "r_DeferredShadingLights", "r_DeferredShadingLightStencilRatio", "r_DeferredShadingLightVolumes", "r_DeferredShadingScissor", "r_DeferredShadingSortLights", "r_DeferredShadingSSS", "r_DeferredShadingStencilPrepass", "r_DeferredShadingTiled", "r_DeferredShadingTiledDebug", "r_DeferredShadingTiledHairQuality", "r_DepthBits", "r_DepthOfField", "r_DepthOfFieldBokehQuality", "r_DepthOfFieldDilation", "r_DepthOfFieldMode", "r_DetailDistance", "r_DetailTextures", "r_DisplayInfo", "r_displayinfoTargetFPS", "r_dofMinZ", "r_dofMinZBlendMult", "r_dofMinZScale", "r_DrawNearFarPlane", "r_DrawNearFoV", "r_DrawNearShadows", "r_DrawNearZRange", "r_Driver", "r_durango_async_dips", "r_durango_async_dips_sync", "r_DynTexAtlasCloudsMaxSize", "r_DynTexAtlasDynTexSrcSize", "r_DynTexAtlasSpritesMaxSize", "r_DynTexAtlasVoxTerrainMaxSize", "r_DynTexMaxSize", "r_DynTexSourceSharedRTHeight", "r_DynTexSourceSharedRTWidth", "r_DynTexSourceUseSharedRT", "r_enable_full_gpu_sync", "r_enableAltTab", "r_enableAuxGeom", "r_EnableDebugLayer", "r_EnvCMResolution", "r_EnvTexResolution", "r_EnvTexUpdateInterval", "r_ExcludeMesh", "r_ExcludeShader", "r_FlareHqShafts", "r_Flares", "r_FlaresChromaShift", "r_FlaresEnableColorGrading", "r_FlaresIrisShaftMaxPolyNum", "r_FlaresTessellationRatio", "r_FlashMatTexResQuality", "r_FogDepthTest", "r_FogShadows", "r_FogShadowsMode", "r_FogShadowsWater", "r_Fullscreen", "r_FullscreenNativeRes", "r_FullscreenPreemption", "r_Gamma", "r_GeomCacheInstanceThreshold", "r_GeomInstancing", "r_GeomInstancingDebug", "r_GeomInstancingThreshold", "r_GetScreenShot", "r_GpuParticles", "r_GpuParticlesConstantRadiusBoundingBoxes", "r_GpuPhysicsFluidDynamicsDebug", "r_GrainEnableExposureThreshold", "r_GraphicsPipeline", "r_GraphicsPipelineMobile", "r_GraphicsPipelinePassScheduler", "r_GraphStyle", "r_HDRBloom", "r_HDRBloomQuality", "r_HDRDebug", "r_HDREyeAdaptationMode", "r_HDREyeAdaptationSpeed", "r_HDRGrainAmount", "r_HDRRangeAdapt", "r_HDRRangeAdaptationSpeed", "r_HDRRangeAdaptLBufferMax", "r_HDRRangeAdaptLBufferMaxRange", "r_HDRRangeAdaptMax", "r_HDRRangeAdaptMaxRange", "r_HDRRendering", "r_HDRTexFormat", "r_HDRVignetting", "r_Height", "r_HeightMapAO", "r_HeightMapAOAmount", "r_HeightMapAORange", "r_HeightMapAOResolution", "r_HideSunInCubemaps", "r_LightsSinglePass", "r_Log", "r_LogShaders", "r_LogTexStreaming", "r_LogVBuffers", "r_LogVidMem", "r_MaterialsBatching", "r_MaxSuitPulseSpeedMultiplier", "r_MeasureOverdrawScale", "r_MergeShadowDrawcalls", "r_MeshInstancePoolSize", "r_MeshPoolSize", "r_MeshPrecache", "r_minimizeLatency", "r_MotionBlur", "r_MotionBlurCameraMotionScale", "r_MotionBlurGBufferVelocity", "r_MotionBlurMaxViewDist", "r_MotionBlurQuality", "r_MotionBlurShutterSpeed", "r_MotionBlurThreshold", "r_MotionVectors", "r_MouseCursorTexture", "r_MultiGPU", "r_MultiThreaded", "r_MultiThreadedDrawing", "r_MultiThreadedDrawingMinJobSize", "r_NightVision", "r_NightVisionBrightLevel", "r_NightVisionCamMovNoiseAmount", "r_NightVisionCamMovNoiseBlendSpeed", "r_NightVisionFinalMul", "r_NightVisionSonarLifetime", "r_NightVisionSonarMultiplier", "r_NightVisionSonarRadius", "r_NoDraw", "r_NoDrawNear", "r_NoHWGamma", "r_NormalsLength", "r_overrideDXGIAdapter", "r_overrideRefreshRate", "r_overrideScanlineOrder", "r_OverscanBorderScaleX", "r_OverscanBorderScaleY", "r_OverscanBordersDrawDebugView", "r_ParticlesAmountGI", "r_ParticlesDebug", "r_ParticlesHalfRes", "r_ParticlesHalfResAmount", "r_ParticlesHalfResBlendMode", "r_ParticlesInstanceVertices", "r_ParticlesRefraction", "r_ParticlesSoftIsec", "r_ParticlesTessellation", "r_ParticlesTessellationTriSize", "r_ParticleVerticePoolSize", "r_PostProcessEffects", "r_PostProcessFilters", "r_PostProcessGameFx", "r_PostProcessHUD3D", "r_PostProcessHUD3DCache", "r_PostProcessHUD3DDebugView", "r_PostProcessHUD3DGlowAmount", "r_PostProcessHUD3DShadowAmount", "r_PostProcessHUD3DStencilClear", "r_PostProcessNanoGlassDebugView", "r_PostProcessParamsBlending", "r_PostprocessParamsBlendingTimeScale", "r_PostProcessReset", "r_PrintMemoryLeaks", "r_profiler", "r_profilerSmoothingWeight", "r_profilerTargetFPS", "r_Rain", "r_RainAmount", "r_RainDistMultiplier", "r_RainDropsEffect", "r_RainIgnoreNearest", "r_RainMaxViewDist", "r_RainMaxViewDist_Deferred", "r_RainOccluderSizeTreshold", "r_RC_AutoInvoke", "r_ReadZBufferDirectlyFromVMEM", "r_Reflections", "r_ReflectionsOffset", "r_ReflectionsQuality", "r_ReflectTextureSlots", "r_Refraction", "r_RefractionPartialResolves", "r_RefractionPartialResolvesDebug", "r_ReleaseAllResourcesOnExit", "r_ReloadShaders", "r_RenderMeshHashGridUnitSize", "r_RenderTargetPoolSize", "r_ReprojectOnlyStaticObjects", "r_ReverseDepth", "r_Scissor", "r_ShaderCompilerDontCache", "r_ShaderCompilerFolderName", "r_ShaderCompilerFolderSuffix", "r_ShaderCompilerPort", "r_ShaderCompilerServer", "r_ShaderEmailCCs", "r_ShaderEmailTags", "r_ShadersAllowCompilation", "r_ShadersAsyncActivation", "r_ShadersAsyncCompiling", "r_ShadersAsyncMaxThreads", "r_ShadersCacheDeterministic", "r_ShadersCacheInMemory", "r_ShadersCompileAutoActivate", "r_ShadersCompileCompatible", "r_ShadersCompileStrict", "r_ShadersDebug", "r_ShadersEditing", "r_ShadersExport", "r_ShadersIgnoreIncludesChanging", "r_ShadersImport", "r_ShadersLazyUnload", "r_ShadersLogCacheMisses", "r_ShadersPrecacheAllLights", "r_ShadersRemoteCompiler", "r_ShadersSubmitRequestline", "r_ShaderTarget", "r_ShadowBluriness", "r_ShadowCastingLightsMaxCount", "r_ShadowGen", "r_ShadowGenDepthClip", "r_ShadowGenMode", "r_ShadowJittering", "r_ShadowMaskStencilPrepass", "r_ShadowPass", "r_ShadowPoolMaxFrames", "r_ShadowPoolMaxTimeslicedUpdatesPerFrame", "r_ShadowsAdaptionMin", "r_ShadowsAdaptionRangeClamp", "r_ShadowsAdaptionSize", "r_ShadowsBias", "r_ShadowsCache", "r_ShadowsCacheFormat", "r_ShadowsCacheResolutions", "r_ShadowsDepthBoundNV", "r_ShadowsGridAligned", "r_ShadowsMaskDownScale", "r_ShadowsMaskResolution", "r_ShadowsNearestMapResolution", "r_ShadowsParticleAnimJitterAmount", "r_ShadowsParticleJitterAmount", "r_ShadowsParticleKernelSize", "r_ShadowsParticleNormalEffect", "r_ShadowsPCFiltering", "r_ShadowsScreenSpace", "r_ShadowsScreenSpaceLength", "r_ShadowsStencilPrePass", "r_ShadowsUseClipVolume", "r_ShadowTexFormat", "r_Sharpening", "r_ShowBufferUsage", "r_ShowDynTextures", "r_ShowDynTexturesFilter", "r_ShowDynTexturesMaxCount", "r_ShowLightBounds", "r_ShowLines", "r_ShowNormals", "r_ShowTangents", "r_ShowTexture", "r_ShowTimeGraph", "r_ShowVideoMemoryStats", "r_SilhouettePOM", "r_SkipAlphaTested", "r_Snow", "r_SnowDisplacement", "r_SnowFlakeClusters", "r_SnowHalfRes", "r_SonarVision", "r_ssdo", "r_ssdoAmountAmbient", "r_ssdoAmountDirect", "r_ssdoAmountReflection", "r_ssdoColorBleeding", "r_ssdoHalfRes", "r_ssdoRadius", "r_ssdoRadiusMax", "r_ssdoRadiusMin", "r_SSReflections", "r_SSReflHalfRes", "r_Stats", "r_statsMinDrawCalls", "r_StencilBits", "r_StereoDevice", "r_StereoEnableMgpu", "r_StereoEyeDist", "r_StereoFlipEyes", "r_StereoGammaAdjustment", "r_StereoHudScreenDist", "r_stereoMirrorProjection", "r_StereoMode", "r_StereoNearGeoScale", "r_StereoOutput", "r_stereoScaleCoefficient", "r_StereoScreenDist", "r_StereoStrength", "r_sunshafts", "r_Supersampling", "r_SupersamplingFilter", "r_SyncToFrameFence", "r_TessellationDebug", "r_TessellationTriangleSize", "r_TexAtlasSize", "r_TexBindMode", "r_TexelsPerMeter", "r_TexLog", "r_TexMaxAnisotropy", "r_TexMinAnisotropy", "r_TexNoAnisoAlphaTest", "r_TexNoLoad", "r_TexPostponeLoading", "r_TexPreallocateAtlases", "r_TextureCompiling", "r_TextureCompilingIndicator", "r_TextureCompressor", "r_TextureLodDistanceRatio", "r_TexturesStreaming", "r_TexturesStreamingDebug", "r_TexturesStreamingDebugDumpIntoLog", "r_TexturesStreamingDebugFilter", "r_TexturesStreamingDebugMinMip", "r_TexturesStreamingDebugMinSize", "r_texturesstreamingDeferred", "r_TexturesStreamingDisableNoStreamDuringLoad", "r_texturesstreamingJobUpdate", "r_TexturesStreamingMaxRequestedJobs", "r_TexturesStreamingMaxRequestedMB", "r_TexturesStreamingMinReadSizeKB", "r_texturesstreamingMinUsableMips", "r_TexturesStreamingMipBias", "r_TexturesStreamingMipClampDVD", "r_TexturesStreamingMipFading", "r_TexturesStreamingNoUpload", "r_TexturesStreamingOnlyVideo", "r_TexturesStreamingPostponeMips", "r_TexturesStreamingPostponeThresholdKB", "r_texturesstreamingPostponeThresholdMip", "r_TexturesStreamingPrecacheRounds", "r_texturesstreamingSkipMips", "r_TexturesStreamingSuppress", "r_TexturesStreamingUpdateType", "r_texturesstreampooldefragmentation", "r_texturesstreampooldefragmentationmaxamount", "r_texturesstreampooldefragmentationmaxmoves", "r_TexturesStreamPoolSecondarySize", "r_TexturesStreamPoolSize", "r_ThermalVision", "r_ThermalVisionViewCloakFlickerMaxIntensity", "r_ThermalVisionViewCloakFlickerMinIntensity", "r_ThermalVisionViewCloakFrequencyPrimary", "r_ThermalVisionViewCloakFrequencySecondary", "r_ThermalVisionViewDistance", "r_transient_pool_size", "r_TransparentPasses", "r_TranspDepthFixup", "r_Unlit", "r_UpdateInstances", "r_UseDisplacementFactor", "r_UseESRAM", "r_UseHWSkinning", "r_UseMaterialLayers", "r_UseMergedPosts", "r_UsePersistentRTForModelHUD", "r_UseShadowsPool", "r_UseZPass", "r_ValidateDraw", "r_VegetationSpritesDebug", "r_VegetationSpritesGenAlways", "r_VegetationSpritesMaxLightingUpdates", "r_VegetationSpritesNoGen", "r_VegetationSpritesTexRes", "r_VisAreaClipLightsPerPixel", "r_VolumetricClouds", "r_VolumetricCloudsPipeline", "r_VolumetricCloudsRaymarchStepNum", "r_VolumetricCloudsShadowResolution", "r_VolumetricCloudsStereoReprojection", "r_VolumetricCloudsTemporalReprojection", "r_VolumetricFogDownscaledSunShadow", "r_VolumetricFogDownscaledSunShadowRatio", "r_VolumetricFogMinimumLightBulbSize", "r_VolumetricFogReprojectionBlendFactor", "r_VolumetricFogReprojectionMode", "r_VolumetricFogSample", "r_VolumetricFogShadow", "r_VolumetricFogSunLightCorrection", "r_VolumetricFogTexDepth", "r_VolumetricFogTexScale", "r_VrProjectionPreset", "r_VrProjectionType", "r_VSync", "r_WaterCaustics", "r_WaterCausticsDeferred", "r_WaterCausticsDistance", "r_WaterGodRays", "r_WaterGodRaysDistortion", "r_WaterReflections", "r_WaterReflectionsMGPU", "r_WaterReflectionsMinVisiblePixelsUpdate", "r_WaterReflectionsMinVisUpdateDistanceMul", "r_WaterReflectionsMinVisUpdateFactorMul", "r_WaterReflectionsQuality", "r_WaterReflectionsUseMinOffset", "r_WaterTessellationHW", "r_WaterUpdateDistance", "r_WaterUpdateFactor", "r_WaterUpdateThread", "r_WaterVolumeCaustics", "r_WaterVolumeCausticsDensity", "r_WaterVolumeCausticsMaxDist", "r_WaterVolumeCausticsRes", "r_WaterVolumeCausticsSnapFactor", "r_Width", "r_WindowIconTexture", "r_WindowType", "r_wireframe", "r_ZFightingDepthScale", "r_ZFightingExtrude", "r_ZPassDepthSorting", "r_ZPassOnly", "r_ZPrepassMaxDist", "rc_debugVerboseLevel", "rcon_password", "s_AccumulateOcclusion", "s_AudioEventPoolSize", "s_AudioImplName", "s_AudioObjectPoolSize", "s_AudioObjectsRayType", "s_AudioStandaloneFilePoolSize", "s_DebugDistance", "s_DebugFilter", "s_DefaultStandaloneFilesAudioTrigger", "s_DrawAudioDebug", "s_FileCacheManagerDebugFilter", "s_FileCacheManagerSize", "s_FullObstructionMaxDistance", "s_HideInactiveAudioObjects", "s_IgnoreWindowFocus", "s_ListenerOcclusionPlaneSize", "s_LoggingOptions", "s_OcclusionHighDistance", "s_OcclusionMaxDistance", "s_OcclusionMaxSyncDistance", "s_OcclusionMediumDistance", "s_OcclusionMinDistance", "s_OcclusionRayLengthOffset", "s_PositionUpdateThresholdMultiplier", "s_SDLMixerStandaloneFileExtension", "s_VelocityTrackingThreshold", "sc_allowFlowGraphNodes", "sc_DiscardOnSave", "sc_DisplayCriticalErrors", "sc_EnableScriptPartitioning", "sc_EntityDebugConfig", "sc_EntityDebugFilter", "sc_EntityDebugTextPos", "sc_ExperimentalFeatures", "sc_FileFormat", "sc_FunctionTimeLimit", "sc_IgnorePAKFiles", "sc_IgnoreUnderscoredFolders", "sc_LogFileMessageTypes", "sc_LogFileStreams", "sc_LogToFile", "sc_MaxRecursionDepth", "sc_RelevanceGridCellSize", "sc_RelevanceGridDebugStatic", "sc_RootFolder", "sc_RunUnitTests", "sc_Update", "sc_UseNewGraphPipeline", "sensor_Debug", "sensor_DebugRange", "STAP_DEBUG", "STAP_DISABLE", "STAP_LOCK_EFFECTOR", "STAP_OVERRIDE_TRACK_FACTOR", "STAP_TRANSLATION_FEATHER", "STAP_TRANSLATION_FUDGE", "stats_FpsBuckets", "stats_PakFile", "stats_Particles", "stats_RenderBatchStats", "stats_RenderSummary", "stats_Warnings", "sv_AISystem", "sv_autoconfigurl", "sv_bandwidth", "sv_bind", "sv_DedicatedCPUPercent", "sv_DedicatedCPUVariance", "sv_DedicatedMaxRate", "sv_dumpstats", "sv_dumpstatsperiod", "sv_gamerules", "sv_gamerulesdefault", "sv_lanonly", "sv_levelrotation", "sv_LoadAllLayersForResList", "sv_map", "sv_maxmemoryusage", "sv_maxplayers", "sv_maxspectators", "sv_packetRate", "sv_password", "sv_port", "sv_ranked", "sv_requireinputdevice", "sv_servername", "sv_timeofdayenable", "sv_timeofdaylength", "sv_timeofdaystart", "sv_timeout_disconnect", "sys_AI", "sys_archive_host_xml_version", "sys_asserts", "sys_audio_disable", "sys_bp_enabled", "sys_bp_format", "sys_bp_frames", "sys_bp_frames_sample_period", "sys_bp_frames_sample_period_rnd", "sys_bp_frames_threshold", "sys_bp_frames_worker_thread", "sys_bp_level_load", "sys_bp_time_threshold", "sys_budget_frametime", "sys_budget_numdrawcalls", "sys_budget_numpolys", "sys_budget_soundchannels", "sys_budget_soundCPU", "sys_budget_soundmem", "sys_budget_streamingthroughput", "sys_budget_sysmem", "sys_budget_videomem", "sys_build_folder", "sys_crashrpt", "sys_crashrpt_appname", "sys_crashrpt_appversion", "sys_crashrpt_email", "sys_crashrpt_privacypolicy", "sys_crashrpt_server", "sys_DeactivateConsole", "sys_debugger_adjustments", "sys_deferAudioUpdateOptim", "sys_display_threads", "sys_dll_ai", "sys_dll_game", "sys_dll_response_system", "sys_dump_aux_threads", "sys_dump_type", "sys_enable_budgetmonitoring", "sys_enable_crash_handler", "sys_entities", "sys_error_debugbreak", "sys_filesystemCaseSensitivity", "sys_firstlaunch", "sys_flash", "sys_flash_address_space", "sys_flash_allow_reset_mesh_cache", "sys_flash_check_filemodtime", "sys_flash_curve_tess_error", "sys_flash_debugdraw", "sys_flash_debugdraw_depth", "sys_flash_debuglog", "sys_flash_edgeaa", "sys_flash_info", "sys_flash_info_histo_scale", "sys_flash_info_peak_exclude", "sys_flash_info_peak_tolerance", "sys_flash_log_options", "sys_flash_reset_mesh_cache", "sys_flash_static_pool_size", "sys_flash_stereo_maxparallax", "sys_flash_use_arenas", "sys_flash_video_soundvolume", "sys_flash_video_subaudiovolume", "sys_flash_warning_level", "sys_float_exceptions", "sys_force_installtohdd_mode", "sys_game_folder", "sys_game_name", "sys_highrestimer", "sys_ime", "sys_initpreloadpacks", "sys_intromoviesduringinit", "sys_job_system_enable", "sys_job_system_filter", "sys_job_system_max_worker", "sys_job_system_profiler", "sys_keyboard", "sys_keyboard_break", "sys_limit_phys_thread_count", "sys_livecreate", "sys_LoadFrontendShaderCache", "sys_localization_debug", "sys_localization_encode", "sys_localization_folder", "sys_LocalMemoryDiagramAlpha", "sys_LocalMemoryDiagramDistance", "sys_LocalMemoryDiagramRadius", "sys_LocalMemoryDiagramStreamingSpeedDistance", "sys_LocalMemoryDiagramStreamingSpeedRadius", "sys_LocalMemoryDiagramWidth", "sys_LocalMemoryDrawText", "sys_LocalMemoryGeometryLimit", "sys_LocalMemoryGeometryStreamingSpeedLimit", "sys_LocalMemoryInnerViewDistance", "sys_LocalMemoryLogText", "sys_LocalMemoryMaxMSecBetweenCalls", "sys_LocalMemoryObjectAlpha", "sys_LocalMemoryObjectHeight", "sys_LocalMemoryObjectWidth", "sys_LocalMemoryOptimalMSecPerSec", "sys_LocalMemoryOuterViewDistance", "sys_LocalMemoryStreamingSpeedObjectLength", "sys_LocalMemoryStreamingSpeedObjectWidth", "sys_LocalMemoryTextureLimit", "sys_LocalMemoryTextureStreamingSpeedLimit", "sys_LocalMemoryWarningRatio", "sys_log_asserts", "sys_logallocations", "sys_max_step", "sys_MaxFPS", "sys_maxTimeStepForMovieSystem", "sys_memory_debug", "sys_MemoryDeadListSize", "sys_menupreloadpacks", "sys_min_step", "sys_no_crash_dialog", "sys_noupdate", "sys_PakDisableNonLevelRelatedPaks", "sys_PakInMemorySizeLimit", "sys_PakLoadCache", "sys_PakLoadModePaks", "sys_PakLogAllFileAccess", "sys_PakLogInvalidFileAccess", "sys_PakLogMissingFiles", "sys_PakMessageInvalidFileAccess", "sys_PakPriority", "sys_PakReadSlice", "sys_PakSaveFastLoadResourceList", "sys_PakSaveLevelResourceList", "sys_PakSaveMenuCommonResourceList", "sys_PakSaveTotalResourceList", "sys_PakStreamCache", "sys_PakTotalInMemorySizeLimit", "sys_PakValidateFileHash", "sys_perfhud", "sys_perfhud_fpsBucketsExclusive", "sys_perfhud_pause", "sys_physics", "sys_physics_enable_MT", "sys_preload", "sys_ProfileLevelLoading", "sys_ProfileLevelLoadingDump", "sys_project", "sys_resource_cache_folder", "sys_root", "sys_scale3DMouseTranslation", "sys_Scale3DMouseYPR", "sys_SchematycPlugin", "sys_screensaver_allowed", "sys_simple_http_base_port", "sys_SimulateTask", "sys_spec", "sys_spec_full", "sys_spec_gameeffects", "sys_spec_light", "sys_spec_objectdetail", "sys_spec_particles", "sys_spec_physics", "sys_spec_postprocessing", "sys_spec_quality", "sys_spec_shading", "sys_spec_shadows", "sys_spec_sound", "sys_spec_texture", "sys_spec_textureresolution", "sys_spec_volumetriceffects", "sys_spec_water", "sys_splashscreen", "sys_SSInfo", "sys_streaming_debug", "sys_streaming_debug_filter", "sys_streaming_debug_filter_file_name", "sys_streaming_debug_filter_min_time", "sys_streaming_in_blocks", "sys_streaming_max_bandwidth", "sys_streaming_max_finalize_per_frame", "sys_streaming_memory_budget", "sys_streaming_requests_grouping_time_period", "sys_streaming_resetstats", "sys_streaming_use_optical_drive_thread", "sys_system_timer_resolution", "sys_target_platforms", "sys_trackview", "sys_UncachedStreamReads", "sys_update_profile_time", "sys_use_mono", "sys_usePlatformSavingAPI", "sys_usePlatformSavingAPIEncryption", "sys_user_folder", "sys_UserAnalyticsCollect", "sys_UserAnalyticsLogging", "sys_UserAnalyticsServerAddress", "sys_version", "sys_vr_support", "sys_vtune", "sys_warnings", "sys_WER", "t_Debug", "t_FixedStep", "t_MaxStep", "t_Scale", "t_Smoothing", "v_autoDisable", "v_clientPredict", "v_clientPredictAdditionalTime", "v_clientPredictMaxTime", "v_clientPredictSmoothing", "v_clientPredictSmoothingConst", "v_debug_flip_over", "v_debug_mem", "v_debug_reorient", "v_debugCollisionDamage", "v_debugdraw", "v_debugSuspensionIK", "v_debugVehicle", "v_debugViewAbove", "v_debugViewAboveH", "v_debugViewDetach", "v_disable_hull", "v_disableEntry", "v_draw_components", "v_draw_helpers", "v_draw_passengers", "v_draw_seats", "v_draw_tm", "v_driverControlledMountedGuns", "v_enableMannequin", "v_FlippedExplosionPlayerMinDistance", "v_FlippedExplosionRetryTimeMS", "v_FlippedExplosionTimeToExplode", "v_goliathMode", "v_independentMountedGuns", "v_lights", "v_lights_enable_always", "v_playerTransitions", "v_ragdollPassengers", "v_serverControlled", "v_set_passenger_tm", "v_show_all", "v_slipFrictionModFront", "v_slipFrictionModRear", "v_slipSlopeFront", "v_slipSlopeRear", "v_staticTreadDeform", "v_testClientPredict", "v_transitionAnimations", "v_vehicle_quality", "watchdog" ] }, "commands": { "$id": "/definitions/commands", "type": "string", "title": "Command name", "description": "Console command name", "default": "", "enum": [ "_TestFormatMessage", "ai_CheckGoalpipes", "ai_commTest", "ai_commTestStop", "ai_DebugAgent", "ai_debugMNMAgentType", "ai_MNMCalculateAccessibility", "ai_MNMComputeConnectedIslands", "ai_NavigationReloadConfig", "ai_Recorder_Start", "ai_Recorder_Stop", "ai_reload", "ai_resetCommStats", "ai_writeCommStats", "audit_cvars", "ban", "ban_remove", "ban_status", "Bind", "ca_DebugText", "ca_DefaultTransitionInterpolationType", "connect", "connect_repeatedly", "ConsoleHide", "ConsoleShow", "demo", "demo_StartDemoChain", "demo_StartDemoLevel", "disconnect", "disconnectchannel", "drs_sendSignal", "ds_Dump", "ds_DumpSessions", "ds_Reload", "dump_action_maps", "dump_maps", "dump_stats", "DumpCommandsVars", "DumpVars", "e_DebugDrawListCMD", "e_ParticleListEffects", "e_ParticleListEmitters", "e_ParticleMemory", "e_ReloadSurfaces", "e_StatoscopeAddUserMarker", "ed_disable_game_mode", "ed_GenerateBillboardTextures", "ed_goto", "ed_killmemory", "ed_randomize_variations", "eqp_DumpPacks", "es_compile_area_grid", "es_debugAnim", "es_dump_entities", "es_dump_entity_classes_in_use", "es_togglelayer", "exec", "ffs_PlayEffect", "ffs_Reload", "ffs_StopAllEffects", "fg_InspectAction", "fg_InspectEntity", "fg_Inspector", "fg_reloadClasses", "fg_writeDocumentation", "g_dump_stats", "g_dumpClassRegistry", "g_saveLoadDumpEntity", "gamedata_playback", "gamedata_record", "gamedata_stop_record_or_playback", "gfx_reload_all", "gt_AddToDebugList", "gt_RemoveFromDebugList", "hmd_recenter_pose", "http_startserver", "http_stopserver", "i_dropitem", "i_giveallitems", "i_giveammo", "i_givedebugitems", "i_giveitem", "i_listitems", "i_reloadActionMaps", "i_saveweaponposition", "kick", "kickid", "load", "LoadConfig", "LocalizationDumpLoadedInfo", "log_flush", "lua_debugger_show", "lua_dump_coverage", "lua_dump_state", "lua_garbagecollect", "lua_reload_script", "map", "memDumpAllocs", "memReplayAddSizerTree", "memReplayDumpSymbols", "memReplayInfo", "memReplayLabel", "memReplayPause", "memReplayResume", "memReplayStop", "memResetAllocs", "mfx_Reload", "mfx_ReloadFGEffects", "mn_DebugAI", "mn_listAssets", "mn_reload", "mono_reload", "mov_goToFrameEditor", "net_dump_object_state", "net_DumpMessageApproximations", "net_getChannelPerformanceMetrics", "net_netMsgDispatcherClearStats", "net_pb_cl_enable", "net_pb_sv_enable", "net_set_cdkey", "net_setChannelPerformanceMetrics", "open_url", "osm_setFBScale", "play", "py", "q_Quality", "r_ColorGradingChartImage", "r_DumpFontNames", "r_DumpFontTexture", "r_getposteffectparamf", "r_OptimiseShaders", "r_OverscanBorders", "r_PrecacheShaderList", "r_setposteffectparamf", "r_ShowRenderTarget", "r_StatsShaderList", "rcon_command", "rcon_connect", "rcon_disconnect", "rcon_startserver", "rcon_stopserver", "readabilityReload", "record", "RecordClip", "ReloadDialogData", "RunUnitTests", "s_ExecuteTrigger", "s_SetParameter", "s_SetSwitchState", "s_StopTrigger", "save", "save_genstrings", "SaveLevelStats", "sc_CriticalError", "sc_FatalError", "sc_rpcShow", "sc_SaveAllScriptFiles", "Screenshot", "sensor_SetOctreeBounds", "sensor_SetOctreeDepth", "status", "stopdemo", "stoprecording", "sys_crashrpt_generate", "sys_crashtest", "sys_crashtest_thread", "sys_dump_cvars", "sys_ignore_asserts_from_module", "sys_job_system_dump_job_list", "sys_LvlRes_finalstep", "sys_LvlRes_findunused", "sys_RestoreSpec", "sys_StroboscopeDumpResults", "sys_StroboscopeStart", "sys_StroboscopeStop", "sys_threads_dump_thread_config_list", "test_delegate", "test_playersBounds", "test_profile", "test_reset", "unload", "v_dump_classes", "v_exit_player", "v_reload_system", "version", "VisRegTest", "voice_mute", "wait_frames", "wait_seconds" ] } }, "id": "https://json.schemastore.org/cryproj.55.schema", "properties": { "console_variables": { "$id": "/properties/console_variables", "type": "array", "uniqueItems": true, "items": { "$id": "/properties/console_variables/items", "type": "object", "properties": { "name": { "$id": "/properties/console_variables/items/properties/name", "$ref": "#/definitions/cvars" }, "value": { "$id": "/properties/console_variables/items/properties/value", "type": "string", "title": "Value of the CVar", "description": "The default value of the CVar", "default": "pc,ps4,xboxone,linux" } }, "required": ["name", "value"] } }, "content": { "$id": "/properties/content", "type": "object", "properties": { "assets": { "$id": "/properties/content/properties/assets", "type": "array", "items": { "$id": "/properties/content/properties/assets/items", "type": "string", "title": "Assets folder", "description": "This indicates where the assets are stored", "default": "Assets", "examples": ["Assets"] } }, "code": { "$id": "/properties/content/properties/code", "type": "array", "items": { "$id": "/properties/content/properties/code/items", "type": "string", "title": "Code folder", "description": "This indicates where the code is stored", "default": "Code", "examples": ["Code"] } }, "libs": { "$id": "/properties/content/properties/libs", "type": "array", "items": { "$id": "/properties/content/properties/libs/items", "type": "object", "properties": { "name": { "$id": "/properties/content/properties/libs/items/properties/name", "type": "string", "title": "Lib's name", "default": "", "examples": ["Blank"] }, "shared": { "$id": "/properties/content/properties/libs/items/properties/shared", "type": "object", "properties": { "any": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/any", "type": "string", "title": "Lib's name to import for all the supported platforms", "default": "", "examples": ["CryGameSDK"] }, "win_x64": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x64", "type": "string", "title": "Lib's name to import for the win_x64 platform", "default": "", "examples": ["bin/win_x64/Game.dll"] }, "win_x86": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x86", "type": "string", "title": "Lib's name to import for the win_x86 platform", "default": "", "examples": ["bin/win_x86/Game.dll"] } } } } } } }, "required": ["code"] }, "info": { "$id": "/properties/info", "type": "object", "properties": { "name": { "$id": "/properties/info/properties/name", "type": "string", "title": "Project name", "description": "This indicates the project name", "default": "", "examples": ["MyFancyProject"] }, "guid": { "$id": "/properties/info/properties/guid", "type": "string", "title": "Project GUID", "default": "", "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" } }, "required": ["name"] }, "require": { "$id": "/properties/require", "type": "object", "properties": { "engine": { "$id": "/properties/require/properties/engine", "type": "string", "title": "Engine version", "description": "This indicates which engine version will be used", "default": "", "examples": ["engine-5.4"], "enum": ["engine-5.5"] }, "plugins": { "$id": "/properties/require/properties/plugins", "type": "array", "items": { "$id": "/properties/require/properties/plugins/items", "type": "object", "properties": { "path": { "$id": "/properties/require/properties/plugins/items/properties/path", "type": "string", "title": "Plugin name", "description": "Required plugin's name", "examples": [ "CryDefaultEntities", "CrySensorSystem", "CryPerceptionSystem", "CryUserAnalytics", "CryOSVR", "CryOculusVR", "CryOpenVR", "CryLobby" ] }, "type": { "$id": "/properties/require/properties/plugins/items/properties/type", "type": "string", "title": "Plugin type", "description": "EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one", "default": "", "examples": ["EPluginType::Native", "EPluginType::Managed"], "enum": ["EPluginType::Native", "EPluginType::Managed"] }, "platforms": { "$id": "/properties/plugins/items/properties/platforms", "type": "array", "items": { "$id": "/properties/plugins/items/properties/platforms/items", "type": "string", "title": "This plugin will be used only by these platforms", "default": "", "examples": ["PS4"], "enum": ["pc", "ps4", "xboxone", "linux"] } } }, "required": ["path", "type"] } } }, "required": ["engine"] }, "type": { "$id": "/properties/type", "type": "string", "title": "", "default": "", "examples": [""] }, "version": { "$id": "/properties/version", "type": "integer", "title": "Project version", "default": 1, "examples": [1] }, "console_commands": { "$id": "/properties/console_commands", "type": "array", "uniqueItems": true, "items": { "$id": "/properties/console_commands/items", "type": "object", "properties": { "name": { "$id": "/properties/console_commands/items/properties/name", "$ref": "#/definitions/commands" }, "value": { "$id": "/properties/console_commands/items/properties/value", "type": "string", "title": "Value of the command", "description": "Arguments that has to be passed to the command. Leave empty if it has not parameters", "default": "" } }, "required": ["name", "value"] } } }, "required": ["content", "info", "require", "version"], "title": "CryProj schema", "type": "object" }

huskyrc.json

{ "$id": "https://json.schemastore.org/huskyrc.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "hook": { "type": "string", "x-intellij-language-injection": "Shell Script" } }, "description": "Husky can prevent bad `git commit`, `git push` and more 🐶 woof!", "properties": { "$schema": { "type": "string" }, "skipCI": { "title": "Skipping Git hooks installation.", "type": "boolean", "default": false }, "hooks": { "title": "Git hooks.", "type": "object", "properties": { "applypatch-msg": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_applypatch_msg", "description": "This hook is invoked by git-am. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes git am to abort before applying the patch.\n\nThe hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.\n\nThe default applypatch-msg hook, when enabled, runs the commit-msg hook, if the latter is enabled.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-am\">git-am</a>. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes <code>git am</code> to abort before applying the patch.</p>\n<p>The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.</p>\n<p>The default <em>applypatch-msg</em> hook, when enabled, runs the <em>commit-msg</em> hook, if the latter is enabled.</p>", "markdownDescription": "This hook is invoked by [git-am](https://git-scm.com/docs/git-am). It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes `git am` to abort before applying the patch.\n\nThe hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.\n\nThe default **applypatch-msg** hook, when enabled, runs the **commit-msg** hook, if the latter is enabled." }, "pre-applypatch": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_pre_applypatch", "description": "This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied, but before a commit is made.\n\nIf it exits with non-zero status, then the working tree will not be committed after applying the patch.\n\nIt can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.\n\nThe default pre-applypatch hook, when enabled, runs the pre-commit hook, if the latter is enabled.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-am\">git-am</a>. It takes no parameter, and is invoked after the patch is applied, but before a commit is made.</p>\n<p>If it exits with non-zero status, then the working tree will not be committed after applying the patch.</p>\n<p>It can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.</p>\n<p>The default <em>pre-applypatch</em> hook, when enabled, runs the <em>pre-commit</em> hook, if the latter is enabled.</p>", "markdownDescription": "This hook is invoked by [git-am](https://git-scm.com/docs/git-am). It takes no parameter, and is invoked after the patch is applied, but before a commit is made.\n\nIf it exits with non-zero status, then the working tree will not be committed after applying the patch.\n\nIt can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.\n\nThe default **pre-applypatch** hook, when enabled, runs the **pre-commit** hook, if the latter is enabled." }, "post-applypatch": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_post_applypatch", "description": "This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied and a commit is made.\n\nThis hook is meant primarily for notification, and cannot affect the outcome of git am.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-am\">git-am</a>. It takes no parameter, and is invoked after the patch is applied and a commit is made.</p>\n<p>This hook is meant primarily for notification, and cannot affect the outcome of <code>git am</code>.</p>", "markdownDescription": "This hook is invoked by [git-am](https://git-scm.com/docs/git-am). It takes no parameter, and is invoked after the patch is applied and a commit is made.\n\nThis hook is meant primarily for notification, and cannot affect the outcome of `git am`." }, "pre-commit": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_pre_commit", "description": "This hook is invoked by git-commit, and can be bypassed with the --no-verify option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the git commit command to abort before creating a commit.\n\nThe default pre-commit hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.\n\nAll the git commit hooks are invoked with the environment variable GIT_EDITOR=: if the command will not bring up an editor to modify the commit message.\n\nThe default pre-commit hook, when enabled—​and with the hooks.allownonascii config option unset or set to false—​prevents the use of non-ASCII filenames.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a>, and can be bypassed with the <code>--no-verify</code> option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the <code>git commit</code> command to abort before creating a commit.</p>\n<p>The default <em>pre-commit</em> hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.</p>\n<p>All the <code>git commit</code> hooks are invoked with the environment variable <code>GIT_EDITOR=:</code> if the command will not bring up an editor to modify the commit message.</p>\n<p>The default <em>pre-commit</em> hook, when enabled—​and with the <code>hooks.allownonascii</code> config option unset or set to false—​prevents the use of non-ASCII filenames.</p>", "markdownDescription": "This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit), and can be bypassed with the `--no-verify` option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the `git commit` command to abort before creating a commit.\n\nThe default **pre-commit** hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.\n\nAll the `git commit` hooks are invoked with the environment variable `GIT_EDITOR=:` if the command will not bring up an editor to modify the commit message.\n\nThe default **pre-commit** hook, when enabled—​and with the `hooks.allownonascii` config option unset or set to false—​prevents the use of non-ASCII filenames." }, "prepare-commit-msg": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_prepare_commit_msg", "description": "This hook is invoked by git-commit right after preparing the default log message, and before the editor is started.\n\nIt takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: message (if a -m or -F option was given); template (if a -t option was given or the configuration option commit.template is set); merge (if the commit is a merge or a .git/MERGE_MSG file exists); squash (if a .git/SQUASH_MSG file exists); or commit, followed by a commit SHA-1 (if a -c, -C or --amend option was given).\n\nIf the exit status is non-zero, git commit will abort.\n\nThe purpose of the hook is to edit the message file in place, and it is not suppressed by the --no-verify option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.\n\nThe sample prepare-commit-msg hook that comes with Git removes the help message found in the commented portion of the commit template.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a> right after preparing the default log message, and before the editor is started.</p>\n<p>It takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: <code>message</code> (if a <code>-m</code> or <code>-F</code> option was given); <code>template</code> (if a <code>-t</code> option was given or the configuration option <code>commit.template</code> is set); <code>merge</code> (if the commit is a merge or a <code>.git/MERGE_MSG</code> file exists); <code>squash</code> (if a <code>.git/SQUASH_MSG</code> file exists); or <code>commit</code>, followed by a commit SHA-1 (if a <code>-c</code>, <code>-C</code> or <code>--amend</code> option was given).</p>\n<p>If the exit status is non-zero, <code>git commit</code> will abort.</p>\n<p>The purpose of the hook is to edit the message file in place, and it is not suppressed by the <code>--no-verify</code> option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.</p>\n<p>The sample <code>prepare-commit-msg</code> hook that comes with Git removes the help message found in the commented portion of the commit template.</p>", "markdownDescription": "This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit) right after preparing the default log message, and before the editor is started.\n\nIt takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: `message` (if a `-m` or `-F` option was given); `template` (if a `-t` option was given or the configuration option `commit.template` is set); `merge` (if the commit is a merge or a `.git/MERGE_MSG` file exists); `squash` (if a `.git/SQUASH_MSG` file exists); or `commit`, followed by a commit SHA-1 (if a `-c`, `-C` or `--amend` option was given).\n\nIf the exit status is non-zero, `git commit` will abort.\n\nThe purpose of the hook is to edit the message file in place, and it is not suppressed by the `--no-verify` option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.\n\nThe sample `prepare-commit-msg` hook that comes with Git removes the help message found in the commented portion of the commit template." }, "commit-msg": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_commit_msg", "description": "This hook is invoked by git-commit and git-merge, and can be bypassed with the --no-verify option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.\n\nThe hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.\n\nThe default commit-msg hook, when enabled, detects duplicate \"Signed-off-by\" lines, and aborts the commit if one is found.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a> and <a href=\"https://git-scm.com/docs/git-merge\">git-merge</a>, and can be bypassed with the <code>--no-verify</code> option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.</p>\n<p>The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.</p>\n<p>The default <em>commit-msg</em> hook, when enabled, detects duplicate \"Signed-off-by\" lines, and aborts the commit if one is found.</p>", "markdownDescription": "This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit) and [git-merge](https://git-scm.com/docs/git-merge), and can be bypassed with the `--no-verify` option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.\n\nThe hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.\n\nThe default **commit-msg** hook, when enabled, detects duplicate \"Signed-off-by\" lines, and aborts the commit if one is found." }, "post-commit": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_post_commit", "description": "This hook is invoked by git-commit. It takes no parameters, and is invoked after a commit is made.\n\nThis hook is meant primarily for notification, and cannot affect the outcome of git commit.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a>. It takes no parameters, and is invoked after a commit is made.</p>\n<p>This hook is meant primarily for notification, and cannot affect the outcome of <code>git commit</code>.</p>", "markdownDescription": "This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit). It takes no parameters, and is invoked after a commit is made.\n\nThis hook is meant primarily for notification, and cannot affect the outcome of `git commit`." }, "pre-rebase": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_pre_rebase", "description": "This hook is called by git-rebase and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch.", "x-intellij-html-description": "<p>This hook is called by <a href=\"https://git-scm.com/docs/git-rebase\">git-rebase</a> and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch.</p>", "markdownDescription": "This hook is called by [git-rebase](https://git-scm.com/docs/git-rebase) and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch." }, "post-checkout": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_post_checkout", "description": "This hook is invoked when a git-checkout or git-switch is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of git switch or git checkout.\n\nIt is also run after git-clone, unless the --no-checkout (-n) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for git worktree add unless --no-checkout is used.\n\nThis hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties.", "x-intellij-html-description": "<p>This hook is invoked when a <a href=\"https://git-scm.com/docs/git-checkout\">git-checkout</a> or <a href=\"https://git-scm.com/docs/git-switch\">git-switch</a> is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of <code>git switch</code> or <code>git checkout</code>.</p>\n<p>It is also run after <a href=\"https://git-scm.com/docs/git-clone\">git-clone</a>, unless the <code>--no-checkout</code> (<code>-n</code>) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for <code>git worktree add</code> unless <code>--no-checkout</code> is used.</p>\n<p>This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties.</p>", "markdownDescription": "This hook is invoked when a [git-checkout](https://git-scm.com/docs/git-checkout) or [git-switch](https://git-scm.com/docs/git-switch) is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of `git switch` or `git checkout`.\n\nIt is also run after [git-clone](https://git-scm.com/docs/git-clone), unless the `--no-checkout` (`-n`) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for `git worktree add` unless `--no-checkout` is used.\n\nThis hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties." }, "post-merge": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_post_merge", "description": "This hook is invoked by git-merge, which happens when a git pull is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of git merge and is not executed, if the merge failed due to conflicts.\n\nThis hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-merge\">git-merge</a>, which happens when a <code>git pull</code> is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of <code>git merge</code> and is not executed, if the merge failed due to conflicts.</p>\n<p>This hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this.</p>", "markdownDescription": "This hook is invoked by [git-merge](https://git-scm.com/docs/git-merge), which happens when a `git pull` is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of `git merge` and is not executed, if the merge failed due to conflicts.\n\nThis hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this." }, "pre-push": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_pre_push", "description": "This hook is called by git-push and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.\n\nInformation about what is to be pushed is provided on the hook's standard input with lines of the form:\n\n<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF\nFor instance, if the command git push origin master:foreign were run the hook would receive a line like the following:\n\nrefs/heads/master 67890 refs/heads/foreign 12345\nalthough the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the <remote SHA-1> will be 40 0. If a ref is to be deleted, the <local ref> will be supplied as (delete) and the <local SHA-1> will be 40 0. If the local commit was specified by something other than a name which could be expanded (such as HEAD~, or a SHA-1) it will be supplied as it was originally given.\n\nIf this hook exits with a non-zero status, git push will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error.", "x-intellij-html-description": "<p>This hook is called by <a href=\"https://git-scm.com/docs/git-push\">git-push</a> and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.</p>\n<p>Information about what is to be pushed is provided on the hook's standard input with lines of the form:</p>\n<pre>&lt;local ref&gt; SP &lt;local sha1&gt; SP &lt;remote ref&gt; SP &lt;remote sha1&gt; LF</pre>\n<p>For instance, if the command <code>git push origin master:foreign</code> were run the hook would receive a line like the following:</p>\n<pre>refs/heads/master 67890 refs/heads/foreign 12345</pre>\n<p>although the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the <code>&lt;remote SHA-1&gt;</code> will be 40 <code>0</code>. If a ref is to be deleted, the <code>&lt;local ref&gt;</code> will be supplied as <code>(delete)</code> and the <code>&lt;local SHA-1&gt;</code> will be 40 <code>0</code>. If the local commit was specified by something other than a name which could be expanded (such as <code>HEAD~</code>, or a SHA-1) it will be supplied as it was originally given.</p>\n<p>If this hook exits with a non-zero status, <code>git push</code> will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error.</p>", "markdownDescription": "This hook is called by [git-push](https://git-scm.com/docs/git-push) and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.\n\nInformation about what is to be pushed is provided on the hook's standard input with lines of the form:\n```\n<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF\n```\nFor instance, if the command `git push origin master:foreign` were run the hook would receive a line like the following:\n```\nrefs/heads/master 67890 refs/heads/foreign 12345\n```\nalthough the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the `<remote SHA-1>` will be 40 `0`. If a ref is to be deleted, the `<local ref>` will be supplied as `(delete)` and the `<local SHA-1>` will be 40 `0`. If the local commit was specified by something other than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be supplied as it was originally given.\n\nIf this hook exits with a non-zero status, `git push` will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error." }, "post-update": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_post_update", "description": "This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.\n\nIt takes a variable number of parameters, each of which is the name of ref that was actually updated.\n\nThis hook is meant primarily for notification, and cannot affect the outcome of git receive-pack.\n\nThe post-update hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The post-receive hook does get both original and updated values of the refs. You might consider it instead if you need them.\n\nWhen enabled, the default post-update hook runs git update-server-info to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.\n\nBoth standard output and standard error output are forwarded to git send-pack on the other end, so you can simply echo messages for the user.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-receive-pack\">git-receive-pack</a> when it reacts to <code>git push</code> and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.</p>\n<p>It takes a variable number of parameters, each of which is the name of ref that was actually updated.</p>\n<p>This hook is meant primarily for notification, and cannot affect the outcome of <code>git receive-pack</code>.</p>\n<p>The <em>post-update</em> hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The <a href=\"https://git-scm.com/docs/githooks#post-receive\"><em>post-receive</em></a> hook does get both original and updated values of the refs. You might consider it instead if you need them.</p>\n<p>When enabled, the default <em>post-update</em> hook runs <code>git update-server-info</code> to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.</p>\n<p>Both standard output and standard error output are forwarded to <code>git send-pack</code> on the other end, so you can simply <code>echo</code> messages for the user.</p>", "markdownDescription": "This hook is invoked by [git-receive-pack](https://git-scm.com/docs/git-receive-pack) when it reacts to `git push` and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.\n\nIt takes a variable number of parameters, each of which is the name of ref that was actually updated.\n\nThis hook is meant primarily for notification, and cannot affect the outcome of `git receive-pack`.\n\nThe **post-update** hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The **post-receive** hook does get both original and updated values of the refs. You might consider it instead if you need them.\n\nWhen enabled, the default **post-update** hook runs `git update-server-info` to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.\n\nBoth standard output and standard error output are forwarded to `git send-pack` on the other end, so you can simply `echo` messages for the user." }, "push-to-checkout": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_push_to_checkout", "description": "This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the receive.denyCurrentBranch configuration variable is set to updateInstead. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.\n\nThe hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.\n\nFor example, the hook can simply run git read-tree -u -m HEAD \"$1\" in order to emulate git fetch that is run in the reverse direction with git push, as the two-tree form of git read-tree -u -m is essentially the same as git switch or git checkout that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-receive-pack\">git-receive-pack</a> when it reacts to <code>git push</code> and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the <code>receive.denyCurrentBranch</code> configuration variable is set to <code>updateInstead</code>. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.</p>\n<p>The hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.</p>\n<p>For example, the hook can simply run <code>git read-tree -u -m HEAD \"$1\"</code> in order to emulate <code>git fetch</code> that is run in the reverse direction with <code>git push</code>, as the two-tree form of <code>git read-tree -u -m</code> is essentially the same as <code>git switch</code> or <code>git checkout</code> that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches.</p>", "markdownDescription": "This hook is invoked by [git-receive-pack](https://git-scm.com/docs/git-receive-pack) when it reacts to `git push` and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the `receive.denyCurrentBranch` configuration variable is set to `updateInstead`. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.\n\nThe hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.\n\nFor example, the hook can simply run `git read-tree -u -m HEAD \"$1\"` in order to emulate `git fetch` that is run in the reverse direction with `git push`, as the two-tree form of `git read-tree -u -m` is essentially the same as `git switch` or `git checkout` that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches." }, "pre-auto-gc": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_pre_auto_gc", "description": "This hook is invoked by git gc --auto (see git-gc). It takes no parameter, and exiting with non-zero status from this script causes the git gc --auto to abort.", "x-intellij-html-description": "<p>This hook is invoked by <code>git gc --auto</code> (see <a href=\"https://git-scm.com/docs/git-gc\">git-gc</a>). It takes no parameter, and exiting with non-zero status from this script causes the <code>git gc --auto</code> to abort.</p>", "markdownDescription": "This hook is invoked by `git gc --auto` (see [git-gc](https://git-scm.com/docs/git-gc)). It takes no parameter, and exiting with non-zero status from this script causes the `git gc --auto` to abort." }, "post-rewrite": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_post_rewrite", "description": "This hook is invoked by commands that rewrite commits (git-commit when called with --amend and git-rebase; however, full-history (re)writing tools like git-fast-import or git-filter-repo typically do not call it!). Its first argument denotes the command it was invoked by: currently one of amend or rebase. Further command-dependent arguments may be passed in the future.\n\nThe hook receives a list of the rewritten commits on stdin, in the format\n\n<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF\nThe extra-info is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any extra-info.\n\nThe hook always runs after the automatic note copying (see \"notes.rewrite.<command>\" in git-config) has happened, and thus has access to these notes.\n\nThe following command-specific comments apply:\n\nrebase\nFor the squash and fixup operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same new-sha1.\n\nThe commits are guaranteed to be listed in the order that they were processed by rebase.", "x-intellij-html-description": "<p>This hook is invoked by commands that rewrite commits (<a href=\"https://git-scm.com/docs/git-commit\">git-commit</a> when called with <code>--amend</code> and <a href=\"https://git-scm.com/docs/git-rebase\">git-rebase</a>; however, full-history (re)writing tools like <a href=\"https://git-scm.com/docs/git-fast-import\">git-fast-import</a> or <a href=\"https://github.com/newren/git-filter-repo\">git-filter-repo</a> typically do not call it!). Its first argument denotes the command it was invoked by: currently one of <code>amend</code> or <code>rebase</code>. Further command-dependent arguments may be passed in the future.</p>\n<p>The hook receives a list of the rewritten commits on stdin, in the format</p>\n<pre>&lt;old-sha1&gt; SP &lt;new-sha1&gt; [ SP &lt;extra-info&gt; ] LF</pre>\n<p>The <em>extra-info</em> is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any <em>extra-info</em>.</p>\n<p>The hook always runs after the automatic note copying (see \"notes.rewrite.&lt;command&gt;\" in <a href=\"https://git-scm.com/docs/git-config\">git-config</a>) has happened, and thus has access to these notes.</p>\n<p>The following command-specific comments apply:</p>\n<dl>\n <dt>rebase</dt>\n <dd>\n <p>For the <em>squash</em> and <em>fixup</em> operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same <em>new-sha1</em>.</p>\n <p>The commits are guaranteed to be listed in the order that they were processed by rebase.</p>\n </dd>\n</dl>", "markdownDescription": "This hook is invoked by commands that rewrite commits ([git-commit](https://git-scm.com/docs/git-commit) when called with `--amend` and [git-rebase](https://git-scm.com/docs/git-rebase); however, full-history (re)writing tools like [git-fast-import](https://git-scm.com/docs/git-fast-import) or [git-filter-repo](https://github.com/newren/git-filter-repo) typically do not call it!). Its first argument denotes the command it was invoked by: currently one of `amend` or `rebase`. Further command-dependent arguments may be passed in the future.\n\nThe hook receives a list of the rewritten commits on stdin, in the format\n```\n<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF\n```\nThe **extra-info** is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any **extra-info**.\n\nThe hook always runs after the automatic note copying (see \"notes.rewrite.\\<command\\>\" in [git-config](https://git-scm.com/docs/git-config)) has happened, and thus has access to these notes.\n\nThe following command-specific comments apply:\n\n**rebase** \nFor the **squash** and **fixup** operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same **new-sha1**. \nThe commits are guaranteed to be listed in the order that they were processed by rebase." }, "sendemail-validate": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_sendemail_validate", "description": "This hook is invoked by git-send-email. It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes git send-email to abort before sending any e-mails.", "x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-send-email\">git-send-email</a>. It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes <code>git send-email</code> to abort before sending any e-mails.</p>", "markdownDescription": "This hook is invoked by [git-send-email](https://git-scm.com/docs/git-send-email). It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes `git send-email` to abort before sending any e-mails." }, "fsmonitor-watchman": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_fsmonitor_watchman", "description": "This hook is invoked when the configuration option core.fsmonitor is set to .git/hooks/fsmonitor-watchman. It takes two arguments, a version (currently 1) and the time in elapsed nanoseconds since midnight, January 1, 1970.\n\nThe hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.\n\nIt is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.\n\nGit will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.\n\nAn optimized way to tell git \"all files have changed\" is to return the filename /.\n\nThe exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.", "x-intellij-html-description": "<p>This hook is invoked when the configuration option <code>core.fsmonitor</code> is set to <code>.git/hooks/fsmonitor-watchman</code> or <code>.git/hooks/fsmonitor-watchmanv2</code> depending on the version of the hook to use.</p>\n<p>Version 1 takes two arguments, a version (1) and the time in elapsed nanoseconds since midnight, January 1, 1970.</p>\n<p>Version 2 takes two arguments, a version (2) and a token that is used for identifying changes since the token. For watchman this would be a clock id. This version must output to stdout the new token followed by a NUL before the list of files.</p>\n<p>The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.</p>\n<p>It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.</p>\n<p>Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.</p>\n<p>An optimized way to tell git \"all files have changed\" is to return the filename <code>/</code>.</p>\n<p>The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.</p>", "markdownDescription": "This hook is invoked when the configuration option `core.fsmonitor` is set to `.git/hooks/fsmonitor-watchman`. It takes two arguments, a version (currently 1) and the time in elapsed nanoseconds since midnight, January 1, 1970.\n\nThe hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.\n\nIt is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.\n\nGit will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.\n\nAn optimized way to tell git \"all files have changed\" is to return the filename `/`.\n\nThe exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders." }, "p4-pre-submit": { "$ref": "#/definitions/hook", "$comment": "https://git-scm.com/docs/githooks#_p4_pre_submit", "description": "This hook is invoked by git-p4 submit. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent git-p4 submit from launching. Run git-p4 submit --help for details.", "x-intellij-html-description": "<p>This hook is invoked by <code>git-p4 submit</code>. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent <code>git-p4 submit</code> from launching. Run <code>git-p4 submit --help</code> for details.</p>", "markdownDescription": "This hook is invoked by `git-p4 submit`. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent `git-p4 submit` from launching. Run `git-p4 submit --help` for details." } }, "additionalProperties": false } }, "required": ["hooks"], "title": "Husky configuration.", "type": "object" }

ops.schema.json

{ "$schema": "https://json-schema.org/draft-07/schema", "$id": "https://github.com/LeShaunJ/ops-schema/blob/main/ops.schema.json", "title": "ops.yaml", "type": "object", "description": "Confirguration for `ops`", "minProperties": 1, "if": { "required": [ "revision" ] }, "then": { "oneOf": [ { "$ref": "./var/src/rev.035.json" }, { "$ref": "./var/src/rev.034.json" }, { "$ref": "./var/src/rev.033.json" }, { "$ref": "./var/src/rev.032.json" }, { "$ref": "./var/src/rev.031.json" }, { "$ref": "./var/src/rev.030.json" }, { "$ref": "./var/src/rev.029.json" }, { "$ref": "./var/src/rev.028.json" }, { "$ref": "./var/src/rev.027.json" }, { "$ref": "./var/src/rev.026.json" }, { "$ref": "./var/src/rev.025.json" }, { "$ref": "./var/src/rev.024.json" }, { "$ref": "./var/src/rev.023.json" }, { "$ref": "./var/src/rev.022.json" }, { "$ref": "./var/src/rev.021.json" }, { "$ref": "./var/src/rev.020.json" }, { "$ref": "./var/src/rev.019.json" }, { "$ref": "./var/src/rev.018.json" }, { "$ref": "./var/src/rev.017.json" }, { "$ref": "./var/src/rev.016.json" }, { "$ref": "./var/src/rev.015.json" }, { "$ref": "./var/src/rev.014.json" }, { "$ref": "./var/src/rev.013.json" }, { "$ref": "./var/src/rev.012.json" }, { "$ref": "./var/src/rev.011.json" }, { "$ref": "./var/src/rev.010.json" }, { "$ref": "./var/src/rev.009.json" }, { "$ref": "./var/src/rev.008.json" }, { "$ref": "./var/src/rev.007.json" }, { "$ref": "./var/src/rev.006.json" }, { "$ref": "./var/src/rev.005.json" }, { "$ref": "./var/src/rev.004.json" }, { "$ref": "./var/src/rev.003.json" }, { "$ref": "./var/src/rev.002.json" }, { "$ref": "./var/src/rev.001.json" } ] }, "else": { "allOf": [ { "not": { "properties": { "revision": {} }, "required": [ "revision" ] } }, { "$ref": "#/then/oneOf/0" } ] } }

apibuilder.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "apidoc": { "title": "API documentation", "type": "object", "properties": { "version": { "type": "string", "description": "Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec." } }, "required": ["version"], "additionalProperties": false }, "info": { "title": "contact information", "type": "object", "properties": { "contact": { "description": "Specifies contact information for this service.", "$ref": "#/definitions/contact" }, "license": { "description": "Specifies the license under which this service is released.", "$ref": "#/definitions/license" } }, "additionalProperties": false }, "contact": { "title": "contact information", "type": "object", "description": "Specifies contact information for this service", "properties": { "name": { "type": "string", "description": "Identifying name of the contact person/organization" }, "url": { "type": "string", "description": "URL pointing to the contact information" }, "email": { "type": "string", "description": "Email address of the contact person/organization" } }, "additionalProperties": false }, "license": { "title": "license", "type": "object", "description": "specifies the license under which this service is released", "properties": { "name": { "type": "string", "description": "Name of the license - e.g. MIT" }, "url": { "type": "string", "description": "URL of the license itself" } }, "required": ["name"], "additionalProperties": false }, "import": { "title": "import", "type": "object", "properties": { "uri": { "type": "string", "description": "The complete URI to the service specification that we are importing. Within API Builder, you can find the URL to the service specification by clicking on the \"service.json\" link for a service." } }, "required": ["uri"], "additionalProperties": false }, "header": { "title": "header", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the header." }, "type": { "type": "string", "description": "The type of this header. Acceptable values are either the name of an enum or string. To specify a collection (meaning multiple values for this header can be provided), the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\"." }, "required": { "type": "boolean", "default": true, "description": "boolean: true|false. By default, all headers are considered required. To make a parameter optional, set \"required\" to false." }, "default": { "description": "The default value for this header. If specified, generated clients will automatically include this header in all requests. Default values must be specified as strings." }, "description": { "type": "string", "description": "Optional description for what this header provides. Supports GFM." }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this header for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["name", "type"], "additionalProperties": false }, "annotation": { "title": "annotation", "type": "object", "patternProperties": { "^[a-zA-Z0-9_]*$": { "title": "annotation", "type": "object", "description": "An annotation is just a short key that can be used to tag any field in any model of this API.", "properties": { "description": { "type": "string", "description": "Describes what the annotation is used for." }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "additionalProperties": false } } }, "attribute": { "title": "attribute", "type": "object", "properties": { "name": { "type": "string", "description": "the name and identifier of the attribute." }, "value": { "title": "json object", "type": "object", "description": "a JSON object that is usually utilized by a downstream Generator." }, "description": { "type": "string" } }, "required": ["name", "value"], "additionalProperties": false }, "deprecation": { "title": "json object", "type": "object", "description": "JSON Object that indicates that this object is deprecated.", "properties": { "description": { "type": "string", "description": "Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM." } }, "additionalProperties": false }, "enum": { "title": "enumeration", "type": "object", "patternProperties": { "^[a-zA-Z0-9_]*$": { "title": "name", "type": "object", "description": "The name of the enum. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.", "properties": { "plural": { "type": "string", "description": "Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural." }, "description": { "type": "string", "description": "Optional longer description for this enum." }, "values": { "type": "array", "description": "JSON Array of EnumValue objects. Each element defines a valid value and an optional description.", "items": { "$ref": "#/definitions/enumvalues" } }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this enum for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["values"], "additionalProperties": false } } }, "enumvalues": { "title": "evaluates", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the value. Names must start with a letter." }, "value": { "type": "string", "description": "The actual string representation of this value when serializing. If not specified, defaults to 'name'." }, "description": { "type": "string", "description": "Optional description for what this enum value provides. Supports GFM." }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this enum value for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["name"], "additionalProperties": false }, "interface": { "title": "interface", "type": "object", "patternProperties": { "^[a-zA-Z0-9_]*$": { "title": "name", "type": "object", "description": "Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, or models. Note you may define an interface and a union of the same name.", "properties": { "plural": { "type": "string", "description": "Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural." }, "description": { "type": "string", "description": "Optional description for what this model provides. Supports GFM." }, "fields": { "type": "array", "description": "JSON Array of 0 or more Fields.", "items": { "$ref": "#/definitions/field" } }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this model for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "additionalProperties": false } } }, "field": { "title": "field", "type": "object", "properties": { "name": { "type": "string", "description": "Specifies the name of the field. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.", "pattern": "^[a-zA-Z0-9_]*$" }, "type": { "type": "string", "description": "Specifies the type of this field. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)." }, "description": { "type": "string", "description": "Optional description for what this field provides. Supports GFM." }, "required": { "type": "boolean", "default": true, "description": "By default, all fields are considered required. To make a field optional, set \"required\" to false. When a field is marked as required, it must be present in any form of a model for that form to be valid. In client-server scenario, this means that any defaults that are present in the model must be applied by the client. If you want a default to be applied by the receiver, you should mark the field as \"required\": false" }, "default": { "description": "Optional default value. The value must be valid for the type specified for this field. For example, if you specify a field named 'limit' with type 'integer', an acceptable default would be 10." }, "example": { "type": "string", "description": "Optional - an example value for this field used only in the produced documentation" }, "minimum": { "type": "integer", "description": "Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element." }, "maximum": { "type": "integer", "description": "Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element." }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this field for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" }, "annotations": { "type": "array", "description": "JSON Array of type string where each value indicates the name of a declared annotation (optional),", "items": { "type": "string" } } }, "required": ["name", "type"], "additionalProperties": false }, "model": { "title": "model", "type": "object", "description": "specifies the name of the model. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.", "patternProperties": { "^[a-zA-Z0-9_]*$": { "title": "model", "type": "object", "properties": { "description": { "type": "string", "description": "Description for what this model provides." }, "plural": { "type": "string", "description": "Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural." }, "interfaces": { "type": "array", "description": "JSON Array of type string where each value indicates the name of a declared interface", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "$ref": "#/definitions/field" } }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } } } }, "additionalProperties": false }, "union": { "title": "union", "type": "object", "patternProperties": { "^[a-zA-Z0-9_]*$": { "type": "object", "description": "Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, unions, or models. Note you may define an interface and a union of the same name, but in this case it is required to list that interface in the interfaces field.", "properties": { "plural": { "type": "string", "description": "Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural." }, "discriminator": { "type": "string", "description": "Specifies an optional, but recommended, name for a type discriminator field which can then be used in serialization / deserialization to identify the type of object. For example, if not specified, a code generator may serialize the union type into a JSON structure of { \"type\" => object }. If a discriminator is provided, the same code generator can flatten the JSON representation to, for example: { \"discriminator\" => \"xxx\", \"field1\" => \"yyy\" }. If provided, the name of the discriminator field must be unique across all of the fields across all of the types of this union." }, "description": { "type": "string", "description": "Optional description for what this union provides. Supports GFM." }, "interfaces": { "type": "array", "description": "JSON Array of type string where each value indicates the name of a declared interface", "items": { "type": "string" } }, "types": { "type": "array", "description": "Specifies the individual types that are part of this union type.", "items": { "$ref": "#/definitions/uniontype" } }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this union for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["types"], "additionalProperties": false } }, "additionalProperties": false }, "uniontype": { "title": "union type", "type": "object", "properties": { "type": { "type": "string", "description": "Specifies the type to include in this union type. Acceptable values include the name of either an enum, a model, or a (primitive type).\ndescription optional description for what this type provides. Supports GFM." }, "description": { "type": "string" }, "default": { "type": "boolean", "description": "If true, indicates that this type should be used as the default when deserializing union types. This field is only used by union types that require a discriminator and sets the default value for that discriminator during deserialization." }, "discriminator_value": { "type": "string", "description": "The discriminator value defines the string to use in the discriminator field to identify this type. If not specified, the discriminator value will default to the name of the type itself." }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this union type for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["type"], "additionalProperties": false }, "resource": { "title": "resource", "type": "object", "patternProperties": { "^[a-zA-Z0-9_.]*$": { "title": "name", "type": "object", "description": "The name of the model or enum that this resource represents", "properties": { "path": { "type": "string", "description": "Optional path where this resource is located. If not provided, defaults to the plural of the typeName, with some assumptions of formatting for web (e.g. lower case, dash separated). Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that all operations for this path will require a parameter named 'guid' of type 'string'" }, "description": { "type": "string", "description": "Optional description for what this resource provides. Supports GFM." }, "operations": { "type": "array", "description": "One or more operations is required.", "items": { "$ref": "#/definitions/operation" } }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this resource for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["operations"], "additionalProperties": false } }, "additionalProperties": false }, "operation": { "title": "operation", "type": "object", "description": "", "properties": { "method": { "type": "string", "description": "The HTTP method for this operation" }, "path": { "type": "string", "description": "Optional path for this particular operation. If not provided, defaults to no additional path. Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that this operation is available at /resource_path/:guid. Path parameter types are inferred by looking for a field with that name on the model associated with this resource. If not found, the datatype of any path parameter will be string." }, "description": { "type": "string", "description": "Optional description for what this operation provides. Supports GFM." }, "body": { "description": "Optional specification for the type of the body of this request. For all operations that support bodies (e.g. POST, PUT, PATCH), allows you to specify the type of the body.", "$ref": "#/definitions/body" }, "parameters": { "type": "array", "description": "Optional JSON Array of the parameters to this method. By default, for GET methods, parameters are assumed to be in the path or in the query. For other methods, parameters are assumed to be in the path or form body, unless you have explicitly specified a body in which case parameters can be provided in the path or the query.", "items": { "$ref": "#/definitions/parameter" } }, "responses": { "description": "Optional JSON Object of HTTP Response Code to Response. If not provided, an HTTP NoContent response is assumed. Only responses for HTTP status codes that are interesting should be documented.", "$ref": "#/definitions/response" }, "attributes": { "type": "array", "description": "JSON array defining additional meta data about this operation for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["method"], "additionalProperties": false }, "parameter": { "title": "parameter", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the parameter. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.", "pattern": "^[a-zA-Z0-9_]*$" }, "type": { "type": "string", "description": "Specifies the type of this parameter. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)." }, "location": { "type": "string", "description": "One of: path, query, form, header. Defines the location of this parameter. Default location varies based on the context of the parameter (e.g. if the operation method is a POST, the default will be Form; if a GET, the default will be Query)" }, "description": { "type": "string", "description": "Optional description for what this parameter provides. Supports GFM." }, "required": { "type": "boolean", "default": true, "description": "By default all parameters are considered required. To make a parameter optional, set \"required\" to false." }, "default": { "description": "Optional default value. The value must be valid for the type specified for this parameter. For example, if you specify a parameter named 'limit' with type 'integer', an acceptable default would be 10" }, "example": { "type": "string", "description": "Optional - an example value for this parameter used only in the produced documentation" }, "minimum": { "type": "integer", "description": "Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element." }, "maximum": { "type": "integer", "description": "Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element." }, "attributes": { "type": "array", "description": "JSON array defining additional meta data about this parameter for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["name", "type"], "additionalProperties": false }, "response": { "title": "response", "type": "object", "patternProperties": { "^[0-9]*$": { "title": "HTTP status", "type": "object", "description": "A valid HTTP status code for this response (e.g. 200). Only status codes that have interesting return types should be documented. You can also specify an HTTP status code of 'default' to map to all other non documented types. This is useful to capture a generic error type that would be returned for non documented response codes.\n\nThere are a few conventions enforced:\n- HTTP Response codes of 5xx cannot be explicitly specified and are handled automatically to ensure consistent behavior in generated client libraries.\n- HTTP Response codes of 204 and 304 indicate that no content is returned, so they must use a type of unit.", "properties": { "type": { "type": "string", "description": "Specifies the type of this response. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)." }, "headers": { "type": "array", "items": { "$ref": "#/definitions/header" } }, "description": { "type": "string", "description": "Optional description for what this response provides. Supports GFM." }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["type"], "additionalProperties": false } }, "additionalProperties": false }, "body": { "title": "body", "type": "object", "properties": { "type": { "type": "string", "description": "Specifies the type of this body. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)." }, "description": { "type": "string", "description": "Optional description for what this body provides. Supports GFM." }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this body for use by generators.", "items": { "$ref": "#/definitions/attribute" } }, "deprecation": { "$ref": "#/definitions/deprecation" } }, "required": ["type"], "additionalProperties": false } }, "description": "JSON Schema for API Builder's api.json format from https://app.apibuilder.io/doc/apiJson", "id": "https://json.schemastore.org/apibuilder.json", "properties": { "$schema": { "type": "string", "description": "A JSON schema URL" }, "name": { "type": "string", "description": "The human readable name of this service. Used for display, and as the basis for generating a unique key for URL." }, "apidoc": { "description": "Optionally specify the specific version of API Builder for which your service is written. If not provided, we automatically default to the current production version.", "$ref": "#/definitions/apidoc" }, "info": { "description": "Optionally specify additional metadata about this service (e.g. contact info, license).", "$ref": "#/definitions/info" }, "namespace": { "type": "string", "description": "Specifies the namespace for this service. Namespace is primarily used when other services import definitions from your service and in the code generators when defining things like package names. If not specified, we will automatically generate a namespace based on [organization namespace].[formatted service name].[major version number]. Note that by default API Builder includes the major version number in the package name which allows service authors and clients to interact with multiple versions of the service where changes have been made in a non backwards compatible way." }, "base_url": { "type": "string", "description": "The base URL where this service is hosted. Must start with http." }, "description": { "type": "string", "description": "optional description for what this service provides. Supports GFM." }, "imports": { "type": "array", "description": "JSON Array defining any other services whose schema definitions we would like to import into our service.", "items": { "$ref": "#/definitions/import" } }, "headers": { "type": "array", "description": "JSON Array defining any HTTP Headers that the service understands or expects.", "items": { "$ref": "#/definitions/header" } }, "enums": { "description": "JSON object defining all of the enums in this API. The key of each object is the enum name.", "$ref": "#/definitions/enum" }, "interfaces": { "$ref": "#/definitions/interface" }, "models": { "description": "JSON object defining all of the models in this API. The key of each object is the model name.", "$ref": "#/definitions/model" }, "unions": { "$ref": "#/definitions/union" }, "resources": { "description": "JSON object defining all of the resources in this API. The key of each object is the name of a type that this resource represents. The type must be the name of a model or an enum.", "$ref": "#/definitions/resource" }, "attributes": { "type": "array", "description": "JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.", "items": { "$ref": "#/definitions/attribute" } }, "annotations": { "description": "JSON object defining all of the annotations in this API. The key of each object is the annotation name.", "$ref": "#/definitions/annotation" } }, "required": ["name"], "title": "API Builder Schema" }

loobin-1.0.json

{ "$id": "https://json.schemastore.org/loobin-1.0.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "ExampleUseCase": { "title": "ExampleUseCase", "description": "Use case base class", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "description": { "title": "Description", "type": "string" }, "code": { "title": "Code", "type": "string" }, "tactics": { "title": "Tactics", "type": "array", "items": { "enum": [ "Reconnaissance", "Resource Development", "Initial Access", "Execution", "Persistence", "Privilege Escalation", "Defense Evasion", "Credential Access", "Discovery", "Lateral Movement", "Collection", "Exfiltration", "Command and Control", "Impact" ], "type": "string" } }, "tags": { "title": "Tags", "type": "array", "items": { "type": "string" } } }, "required": ["name", "description"] }, "Detection": { "title": "Detection", "description": "Detection base class", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": ["name", "url"] }, "Resource": { "title": "Resource", "description": "External reference base class", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": ["name", "url"] } }, "description": "LOOBin base class", "properties": { "name": { "title": "Name", "description": "Name of the LOOBin", "type": "string" }, "author": { "title": "Author", "description": "Author of the LOOBin", "type": "string" }, "short_description": { "title": "Short Description", "description": "A short description of the LOOBin.This will display in the LOOBin card list and the LOOBins website search results.", "type": "string" }, "full_description": { "title": "Full Description", "description": "A full description of the LOOBin.This will display on the LOOBin's single page.", "type": "string" }, "created": { "title": "Created", "description": "Date the LOOBin was created", "type": "string", "format": "date" }, "example_use_cases": { "title": "Example Use Cases", "description": "A list of example use cases for the LOOBin", "type": "array", "items": { "$ref": "#/definitions/ExampleUseCase" } }, "paths": { "title": "Paths", "description": "A list of paths to the LOOBin", "type": "array", "items": { "type": "string" } }, "detections": { "title": "Detections", "description": "A list of detections for the LOOBin", "type": "array", "items": { "$ref": "#/definitions/Detection" } }, "resources": { "title": "Resource", "description": "A list of useful resources for the LOOBin", "type": "array", "items": { "$ref": "#/definitions/Resource" } }, "acknowledgements": { "title": "Acknowledgements", "description": "Acknowledgements for the LOOBin", "type": "array", "items": { "type": "string" } } }, "required": [ "name", "author", "short_description", "full_description", "created", "example_use_cases", "paths", "detections" ], "title": "LOOBin", "type": "object" }

commands.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "commands": { "type": "object", "description": "The friendly name of the command.", "required": ["fileName"], "properties": { "fileName": { "type": "string", "description": "The name of the executable file name. Example: \"cmd.exe\"." }, "workingDirectory": { "type": "string", "description": "Specify a relative or absolute directory path." }, "arguments": { "type": "string", "description": "The arguments to pass to the executable file." } } }, "vsbindings": { "type": "array", "description": "A Visual Studio event that a command can be bound to.", "items": { "type": "string" } } }, "description": "Schema for bundleconfig.json files", "id": "https://json.schemastore.org/commands.json", "properties": { "commands": { "description": "A list of commands.", "additionalProperties": { "$ref": "#/definitions/commands" } }, "-vs-binding": { "type": "object", "description": "Specify any Visual Studio event bindings.", "properties": { "AfterBuild": { "$ref": "#/definitions/vsbindings" }, "BeforeBuild": { "$ref": "#/definitions/vsbindings" }, "Clean": { "$ref": "#/definitions/vsbindings" }, "ProjectOpen": { "$ref": "#/definitions/vsbindings" } } } }, "type": "object" }

babelrc.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "#/definitions/Options" }, { "properties": { "env": { "description": "This is an object of keys that represent different environments. For example, you may have: `{ env: { production: { /* specific options */ } } }` which will use those options when the environment variable BABEL_ENV is set to \"production\". If BABEL_ENV isn't set then NODE_ENV will be used, if it's not set then it defaults to \"development\"", "type": "object", "additionalProperties": { "$ref": "#/definitions/Options" }, "default": {} } } } ], "definitions": { "Options": { "type": "object", "properties": { "ast": { "description": "Include the AST in the returned object", "type": "boolean", "default": true }, "auxiliaryCommentAfter": { "description": "Attach a comment after all non-user injected code.", "type": "string" }, "auxiliaryCommentBefore": { "description": "Attach a comment before all non-user injected code.", "type": "string" }, "code": { "description": "Enable code generation", "type": "boolean", "default": true }, "comments": { "description": "Output comments in generated output.", "type": "boolean", "default": true }, "compact": { "description": "Do not include superfluous whitespace characters and line terminators. When set to \"auto\" compact is set to true on input sizes of >500KB.", "type": ["string", "boolean"], "enum": ["auto", true, false], "default": "auto" }, "extends": { "description": "A path to a .babelrc file to extend", "type": "string" }, "filename": { "description": "Filename for use in errors etc.", "type": "string", "default": "unknown" }, "filenameRelative": { "description": "Filename relative to sourceRoot (defaults to \"filename\")", "type": "string" }, "highlightCode": { "description": "ANSI highlight syntax error code frames", "type": "boolean" }, "ignore": { "description": "Opposite of the \"only\" option", "type": ["string", "array"], "items": { "type": "string" } }, "inputSourceMap": { "description": "If true, attempt to load an input sourcemap from the file itself. If an object is provided, it will be treated as the source map object itself.", "type": ["boolean", "object"], "default": true }, "keepModuleIdExtensions": { "description": "Keep extensions in module ids", "type": "boolean", "default": false }, "moduleId": { "description": "Specify a custom name for module ids.", "type": "string" }, "moduleIds": { "description": "If truthy, insert an explicit id for modules. By default, all modules are anonymous. (Not available for common modules)", "type": "string", "default": false }, "moduleRoot": { "description": "Optional prefix for the AMD module formatter that will be prepend to the filename on module definitions. (defaults to \"sourceRoot\")", "type": "string" }, "only": { "description": "A glob, regex, or mixed array of both, matching paths to only compile. Can also be an array of arrays containing paths to explicitly match. When attempting to compile a non-matching file it's returned verbatim.", "type": ["string", "array"], "items": { "type": "string" } }, "plugins": { "description": "List of plugins to load and use", "type": "array", "items": { "type": ["string", "array"], "items": [ { "description": "The name of the plugin.", "type": "string" }, { "description": "The options of the plugin.", "type": "object" } ] } }, "presets": { "description": "List of presets (a set of plugins) to load and use", "type": "array", "items": { "type": ["string", "array"], "items": [ { "description": "The name of the preset.", "type": "string" }, { "description": "The options of the preset.", "type": "object" } ] } }, "retainLines": { "default": false, "description": "Retain line numbers. This will lead to wacky code but is handy for scenarios where you can't use source maps. NOTE: This will obviously not retain the columns.", "type": "boolean" }, "sourceFileName": { "description": "Set sources[0] on returned source map. (defaults to \"filenameRelative\")", "type": "string" }, "sourceMaps": { "default": false, "description": "If truthy, adds a map property to returned output. If set to \"inline\", a comment with a sourceMappingURL directive is added to the bottom of the returned code. If set to \"both\" then a map property is returned as well as a source map comment appended.", "type": ["string", "boolean"], "enum": ["both", "inline", true, false] }, "sourceMapTarget": { "description": "Set file on returned source map. (defaults to \"filenameRelative\")", "type": "string" }, "sourceRoot": { "description": "The root from which all sources are relative. (defaults to \"moduleRoot\")", "type": "string" } } } }, "id": "https://json.schemastore.org/babelrc.json", "title": "JSON schema for Babel 6+ configuration files", "type": "object" }

azure-devops-extension-manifest-1.0.json

{ "$id": "https://json.schemastore.org/azure-devops-extension-manifest-1.0.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "Badge": { "description": "A link to external metadata badge.", "properties": { "href": { "description": "Link the user navigates to when selecting the badge.", "type": "string" }, "uri": { "description": "The absolute URL of the badge image to be displayed.", "type": "string" }, "description": { "description": "Description of the badge, to be displayed on hover.", "type": "string" } }, "required": ["uri"], "title": "badge", "type": "object" }, "Content": { "description": "A content file that describes the extension to users.", "properties": { "path": { "description": "The path to the file in the extension.", "type": "string" } }, "required": ["path"], "title": "content", "type": "object" }, "Contribution": { "description": "An individual contribution made by an extension", "properties": { "constraints": { "description": "List of constraints (filters) that should be applied to the availability of this contribution", "items": { "$ref": "#/definitions/ContributionConstraint" }, "type": "array" }, "description": { "description": "Description of the contribution/type", "type": "string" }, "id": { "description": "Fully qualified identifier of the contribution/type", "type": "string" }, "includes": { "description": "Includes is a set of contributions that should have this contribution included in their targets list.", "items": { "type": "string" }, "type": "array" }, "properties": { "description": "Properties/attributes of this contribution" }, "restrictedTo": { "description": "List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).", "items": { "type": "string" }, "type": "array" }, "targets": { "description": "The ids of the contribution(s) that this contribution targets. (parent contributions)", "items": { "type": "string" }, "type": "array" }, "type": { "description": "Id of the Contribution Type", "type": "string" }, "visibleTo": { "description": "VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: \"ms\" - Means only the \"ms\" publisher can reference this. \"ms.vss-web\" - Means only the \"vss-web\" extension from the \"ms\" publisher can reference this.", "items": { "type": "string" }, "type": "array" } }, "required": ["id", "targets", "type"], "title": "contribution", "type": "object" }, "ContributionConstraint": { "description": "Specifies a constraint that can be used to dynamically include/exclude a given contribution", "properties": { "group": { "description": "An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).", "type": "number" }, "id": { "description": "Fully qualified identifier of a shared constraint", "type": "string" }, "inverse": { "description": "If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)", "type": "boolean" }, "name": { "description": "Name of the IContributionFilter plugin", "type": "string" }, "properties": { "description": "Properties that are fed to the contribution filter class" }, "relationships": { "description": "Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ContributionLicensingBehaviorType": { "description": "Represents different ways of including contributions based on licensing", "enum": [0, 1, 2], "type": "number" }, "ContributionPropertyDescription": { "description": "Description about a property of a contribution type", "properties": { "description": { "description": "Description of the property", "type": "string" }, "name": { "description": "Name of the property", "type": "string" }, "required": { "description": "True if this property is required", "type": "boolean" }, "type": { "$ref": "#/definitions/ContributionPropertyType", "description": "The type of value used for this property" } }, "type": "object" }, "ContributionPropertyType": { "description": "The type of value used for a property", "enum": [0, 1, 128, 16, 2, 256, 32, 4, 512, 64, 8], "type": "number" }, "ContributionType": { "description": "A contribution type, given by a json schema", "properties": { "description": { "description": "Description of the contribution/type", "type": "string" }, "id": { "description": "Fully qualified identifier of the contribution/type", "type": "string" }, "indexed": { "description": "Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type. NOTE: Only TrustedPartners are allowed to specify indexed contribution types.", "type": "boolean" }, "name": { "description": "Friendly name of the contribution/type", "type": "string" }, "properties": { "additionalProperties": { "$ref": "#/definitions/ContributionPropertyDescription" }, "description": "Describes the allowed properties for this contribution type", "type": "object" }, "visibleTo": { "description": "VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: \"ms\" - Means only the \"ms\" publisher can reference this. \"ms.vss-web\" - Means only the \"vss-web\" extension from the \"ms\" publisher can reference this.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ExtensionEventCallback": { "description": "Base class for an event callback for an extension", "properties": { "uri": { "description": "The uri of the endpoint that is hit when an event occurs", "type": "string" } }, "type": "object" }, "ExtensionEventCallbackCollection": { "description": "Collection of event callbacks - endpoints called when particular extension events occur.", "properties": { "postDisable": { "$ref": "#/definitions/ExtensionEventCallback", "description": "Optional. Defines an endpoint that gets called via a POST request to notify that an extension disable has occurred." }, "postEnable": { "$ref": "#/definitions/ExtensionEventCallback", "description": "Optional. Defines an endpoint that gets called via a POST request to notify that an extension enable has occurred." }, "postInstall": { "$ref": "#/definitions/ExtensionEventCallback", "description": "Optional. Defines an endpoint that gets called via a POST request to notify that an extension install has completed." }, "postUninstall": { "$ref": "#/definitions/ExtensionEventCallback", "description": "Optional. Defines an endpoint that gets called via a POST request to notify that an extension uninstall has occurred." }, "postUpdate": { "$ref": "#/definitions/ExtensionEventCallback", "description": "Optional. Defines an endpoint that gets called via a POST request to notify that an extension update has occurred." }, "preInstall": { "$ref": "#/definitions/ExtensionEventCallback", "description": "Optional. Defines an endpoint that gets called via a POST request to notify that an extension install is about to occur. Response indicates whether to proceed or abort." }, "versionCheck": { "$ref": "#/definitions/ExtensionEventCallback", "description": "For multi-version extensions, defines an endpoint that gets called via an OPTIONS request to determine the particular version of the extension to be used" } }, "type": "object" }, "ExtensionLicensing": { "description": "How an extension should handle including contributions based on licensing", "properties": { "overrides": { "description": "A list of contributions which deviate from the default licensing behavior", "items": { "$ref": "#/definitions/LicensingOverride" }, "type": "array" } }, "type": "object" }, "File": { "properties": { "path": { "description": "Path to resource on disk, which can be relative to your root directory.", "type": "string" }, "addressable": { "description": "(optional) Set to true if you want your file to be URL-addressable. Defaults to false.", "type": "boolean" }, "packagePath": { "description": "(optional) Path to the resource within the package. Defaults to the relative path on disk from your root directory.", "type": "string" }, "contentType": { "description": "(optional) MIME type of the file. Defaults to a best guess based on the file extension and OS settings.", "type": "string" }, "assetType": { "description": "(optional) Specify the value of the Type attribute of the asset entry in the VSIX manifest. Can also be an array of strings, in which case multiple asset entries get added for this file. Defaults to the packagePath.", "type": "string" }, "lang": { "description": "(optional) Language of this asset. Localized files are served based on the Accept-Language header. Leave blank to signify this file is in the default (or fallback) language. Localized versions of the same file should have the same assetType.", "type": "string" } }, "required": ["path"], "title": "file", "type": "object" }, "LicensingOverride": { "description": "Maps a contribution to a licensing behavior", "properties": { "behavior": { "$ref": "#/definitions/ContributionLicensingBehaviorType", "description": "How the inclusion of this contribution should change based on licensing" }, "id": { "description": "Fully qualified contribution id which we want to define licensing behavior for", "type": "string" } }, "type": "object" }, "Link": { "properties": { "uri": { "description": "The absolute URL of the link.", "type": "string" } }, "title": "link", "type": "object" }, "Target": { "properties": { "id": { "type": "string", "enum": [ "Microsoft.VisualStudio.Services", "Microsoft.TeamFoundation.Server", "Microsoft.VisualStudio.Services.Integration", "Microsoft.TeamFoundation.Server.Integration" ] } }, "required": ["id"], "title": "target", "type": "object" } }, "description": "Base class for extension properties which are shared by the extension manifest and the extension model", "properties": { "badges": { "description": "Array of links to external metadata badges like TravisCI, Appveyor, and so on, from the approved badges sites.", "type": "array", "items": { "$ref": "#/definitions/Badge" } }, "baseUri": { "description": "Uri used as base for other relative uri's defined in extension", "type": "string" }, "branding": { "description": "Dictionary of brand-related properties.", "properties": { "color": { "description": "Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).", "type": "string" }, "theme": { "description": "Complements the color; use dark for dark branding colors, or light for lighter branding colors.", "type": "string", "enum": ["dark", "light"] } }, "title": "branding", "type": "object" }, "categories": { "description": "Array of strings representing the categories your extension belongs to. At least one category must be provided and there's no limit to how many categories you may include. Valid values: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plans, and Azure Artifacts.", "type": "array", "items": { "type": "string", "enum": [ "Azure Repos", "Azure Boards", "Azure Pipelines", "Azure Test Plans", "Azure Artifacts" ] }, "minItems": 1 }, "constraints": { "description": "List of shared constraints defined by this extension", "items": { "$ref": "#/definitions/ContributionConstraint" }, "type": "array" }, "content": { "description": "Dictionary of content files that describe your extension to users.", "properties": { "details": { "$ref": "#/definitions/Content" } }, "additionalProperties": { "$ref": "#/definitions/Content" }, "title": "content", "type": "object" }, "contributionTypes": { "description": "List of contribution types defined by this extension", "items": { "$ref": "#/definitions/ContributionType" }, "type": "array" }, "contributions": { "description": "List of contributions made by this extension", "items": { "$ref": "#/definitions/Contribution" }, "type": "array" }, "demands": { "description": "List of explicit demands required by this extension", "items": { "type": "string" }, "type": "array" }, "description": { "description": "A few sentences describing the extensions. Limited to 200 characters.", "type": "string", "maxLength": 200 }, "eventCallbacks": { "$ref": "#/definitions/ExtensionEventCallbackCollection", "description": "Collection of endpoints that get called when particular extension events occur" }, "fallbackBaseUri": { "description": "Secondary location that can be used as base for other relative uri's defined in extension", "type": "string" }, "files": { "description": "The files section is where you reference any files you wish to include in your extension.", "type": "array", "items": { "$ref": "#/definitions/File" } }, "icons": { "description": "Dictionary of icons representing the extension.", "type": "object", "properties": { "default": { "description": "128x128 pixels", "type": "string" } }, "additionalProperties": { "type": "string" } }, "id": { "description": "The extension's identifier.", "type": "string" }, "language": { "description": "Language Culture Name set by the Gallery", "type": "string" }, "licensing": { "$ref": "#/definitions/ExtensionLicensing", "description": "How this extension behaves with respect to licensing" }, "manifestVersion": { "description": "Version of the extension manifest format/content. Should be 1.", "type": "number" }, "name": { "description": "A short, human-readable name of the extension. Limited to 200 characters.", "type": "string", "maxLength": 200 }, "links": { "description": "Dictionary of links that help users learn more about your extension, get support, and move.", "type": "object", "properties": { "getstarted": { "$ref": "#/definitions/Link" }, "learn": { "$ref": "#/definitions/Link" }, "license": { "$ref": "#/definitions/Link" }, "privacypolicy": { "$ref": "#/definitions/Link" }, "support": { "$ref": "#/definitions/Link" } }, "additionalProperties": { "$ref": "#/definitions/Link" } }, "publisher": { "description": "The identifier of the publisher. This identifier must match the identifier the extension is published under.", "type": "string" }, "repository": { "description": "Dictionary of properties describing the source code repository for the extension.", "type": "object", "properties": { "type": { "description": "Type of repository. Example: git.", "type": "string" }, "uri": { "description": "Absolute URL of the repository.", "type": "string" } } }, "restrictedTo": { "description": "Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.", "items": { "type": "string" }, "type": "array" }, "scopes": { "description": "List of all oauth scopes required by this extension", "items": { "type": "string" }, "type": "array" }, "screenshots": { "description": "Array of images that couldn't be included in your content.", "type": "array", "items": { "$ref": "#/definitions/Content" } }, "serviceInstanceType": { "description": "The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed", "type": "string" }, "tags": { "description": "Array of string tags to help users find your extension.", "type": "array", "items": { "type": "string" } }, "targets": { "description": "The products and services supported by your integration or extension.", "type": "array", "items": { "$ref": "#/definitions/Target" }, "minItems": 1 }, "version": { "description": "A string specifying the version of an extension. Should be in the format major.minor.patch.", "type": "string" } }, "type": "object" }

bower.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/bower.json", "patternProperties": { "^_": { "description": "Any property starting with _ is valid.", "additionalProperties": true } }, "properties": { "name": { "description": "The name of your package.", "type": "string", "maxLength": 50, "minLength": 1 }, "description": { "description": "Help users identify and search for your package with a brief description.", "type": "string", "maxLength": 140 }, "version": { "description": "A semantic version number.", "type": "string" }, "main": { "description": "The primary acting files necessary to use your package.", "type": ["string", "array"] }, "license": { "description": "SPDX license identifier or path/url to a license.", "type": ["string", "array"], "maxLength": 140 }, "ignore": { "description": "A list of files for Bower to ignore when installing your package.", "type": ["string", "array"] }, "keywords": { "description": "Used for search by keyword. Helps make your package easier to discover without people needing to know its name.", "type": "array", "items": { "type": "string", "maxLength": 50 } }, "authors": { "description": "A list of people that authored the contents of the package.", "type": "array", "items": { "type": ["string", "object"] } }, "homepage": { "description": "URL to learn more about the package. Falls back to GitHub project if not specified and it's a GitHub endpoint.", "type": "string", "format": "uri" }, "repository": { "description": "The repository in which the source code can be found.", "type": "object", "properties": { "type": { "type": "string", "enum": ["git"] }, "url": { "type": "string", "format": "uri" } } }, "dependencies": { "description": "Dependencies are specified with a simple hash of package name to a semver compatible identifier or URL.", "type": "object", "additionalProperties": { "type": "string" } }, "devDependencies": { "description": "Dependencies that are only needed for development of the package, e.g., test framework or building documentation.", "type": "object", "additionalProperties": { "type": "string" } }, "resolutions": { "description": "Dependency versions to automatically resolve with if conflicts occur between packages.", "type": "object" }, "private": { "description": "If you set it to true it will refuse to publish it. This is a way to prevent accidental publication of private repositories.", "type": "boolean" }, "exportsOverride": { "description": "Used by grunt-bower-task to specify custom install locations.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": ["string", "array"] } } }, "moduleType": { "description": "The types of modules this package exposes", "type": ["array", "string"], "items": { "enum": ["amd", "es6", "globals", "node", "yui"] } } }, "required": ["name"], "title": "JSON schema for Bower configuration files", "type": "object" }

importmap.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "https://json.schemastore.org/importmap.json", "properties": { "imports": { "description": "The Imports field", "type": "object", "additionalProperties": { "type": "string" } }, "scopes": { "description": "The Scopes field", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "title": "JSON schema for Import Maps files", "type": "object" }

function.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "bindingBase": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "direction": { "type": "string", "enum": ["in", "out", "inout"] }, "dataType": { "enum": ["string", "binary", "stream"], "description": "The data type hint for the binding parameter (string, binary, or stream)." } }, "required": ["name", "type", "direction"] }, "dynamicBinding": { "properties": { "type": { "not": { "enum": [ "serviceBusTrigger", "serviceBus", "blobTrigger", "blob", "manualTrigger", "eventHubTrigger", "eventHub", "timerTrigger", "queueTrigger", "queue", "httpTrigger", "http", "mobileTable", "documentDB", "table", "notificationHub", "twilioSms", "sendGrid", "sql", "sqlTrigger", "kusto" ] } }, "direction": { "enum": ["in", "out", "inout"] } } }, "serviceBusBinding": { "properties": { "queueName": { "type": "string", "description": "The service bus queue to monitor (if using a queue)" }, "topicName": { "type": "string", "description": "The service bus topic to monitor (if using a queue)" }, "subscriptionName": { "type": "string", "description": "The topic subscription name" }, "connection": { "type": "string", "description": "An app setting (or environment variable) with the service bus connection string to be used by this binding." }, "accessRights": { "type": "string", "description": "The permission level of the service bus connection string used by this binding.", "enum": ["manage", "listen", "send"] } }, "oneOf": [ { "properties": { "type": { "enum": ["serviceBusTrigger"] }, "direction": { "enum": ["in"] } } }, { "properties": { "type": { "enum": ["serviceBus"] }, "direction": { "enum": ["out"] } } } ] }, "blobBinding": { "properties": { "path": { "type": "string", "description": "The path to the blob container" }, "connection": { "type": "string", "description": "An app setting (or environment variable) with the storage connection string to be used by this binding." } }, "oneOf": [ { "properties": { "type": { "enum": ["blobTrigger"] }, "direction": { "enum": ["in"] } } }, { "properties": { "type": { "enum": ["blob"] } } } ] }, "manualTriggerBinding": { "properties": { "type": { "enum": ["manualTrigger"] }, "direction": { "enum": ["in"] } } }, "eventHubBinding": { "properties": { "path": { "type": "string", "description": "The event hub path." }, "connection": { "type": "string", "description": "The event hub connection string setting." } }, "oneOf": [ { "properties": { "type": { "enum": ["eventHubTrigger"] }, "direction": { "enum": ["in"] }, "consumerGroup": { "type": "string", "description": "The event hub consumer group." }, "cardinality": { "enum": ["one", "many"], "description": "The cardinality hint for the input binding parameter (single message or array of messages)." } } }, { "properties": { "type": { "enum": ["eventHub"] }, "direction": { "enum": ["out"] } } } ] }, "timerTriggerBinding": { "properties": { "type": { "enum": ["timerTrigger"] }, "direction": { "enum": ["in"] }, "schedule": { "type": "string", "description": "A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule.", "pattern": "^(\\*|((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?)(,((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?))*)(/\\d+)? (\\*|((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?)(,((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?))*)(/\\d+)? (\\*|(((1\\d)|(2[0-3])|\\d)(-((1\\d)|(2[0-3])|\\d)(/\\d+)?)?)(,(((1\\d)|(2[0-3])|\\d)(-((1\\d)|(2[0-3])|\\d)(/\\d+)?)?))*)(/\\d+)? (\\*|((([1-2]\\d)|(3[0-1])|[1-9])(-(([1-2]\\d)|(3[0-1])|[1-9])(/\\d+)?)?)(,((([1-2]\\d)|(3[0-1])|[1-9])(-(([1-2]\\d)|(3[0-1])|[1-9])(/\\d+)?)?))*)(/\\d+)? (\\*|(([A-Za-z]+|(1[0-2])|[1-9])(-([A-Za-z]+|(1[0-2])|[1-9])(/\\d+)?)?)(,(([A-Za-z]+|(1[0-2])|[1-9])(-([A-Za-z]+|(1[0-2])|[1-9])(/\\d+)?)?))*)(/\\d+)? (\\*|(([A-Za-z]+|[0-6])(-([A-Za-z]+|[0-6])(/\\d+)?)?)(,(([A-Za-z]+|[0-6])(-([A-Za-z]+|[0-6])(/\\d+)?)?))*)(/\\d+)?$" }, "runOnStartup": { "type": "boolean", "description": "When true, your timer function will be invoked immediately after a runtime restart and on-schedule thereafter." }, "useMonitor": { "type": "boolean", "description": "When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute." } } }, "queueBinding": { "properties": { "queueName": { "type": "string", "description": "The queue name." }, "connection": { "type": "string", "description": "An app setting (or environment variable) with the storage connection string to be used by this binding." } }, "oneOf": [ { "properties": { "type": { "enum": ["queueTrigger"] }, "direction": { "enum": ["in"] } } }, { "properties": { "type": { "enum": ["queue"] }, "direction": { "enum": ["out"] } } } ] }, "httpTrigger": {}, "httpBinding": { "oneOf": [ { "properties": { "type": { "enum": ["httpTrigger"] }, "direction": { "enum": ["in"] }, "route": { "type": "string", "description": "The function HTTP route template." }, "webHookType": { "type": "string", "description": "The type of WebHook handled by the trigger (if handling a pre-defined WebHook)." }, "authLevel": { "type": "string", "default": "function", "enum": ["anonymous", "function", "admin"], "description": "The function HTTP authorization level." }, "methods": { "type": "array", "items": [ { "type": "string", "enum": [ "get", "post", "delete", "head", "patch", "put", "options", "trace" ] } ] } } }, { "properties": { "type": { "enum": ["http"] }, "direction": { "enum": ["out"] } } } ] }, "mobileBinding": { "properties": { "type": { "enum": ["mobileTable"] }, "tableName": { "type": "string", "description": "This is the name of the table within your Mobile App to which data will be written." }, "connection": { "type": "string", "description": "This is the app setting name that specifies the URL of your Mobile App." }, "apiKey": { "type": "string", "description": "This is app setting name that specifies the API Key for your Mobile App." } }, "oneOf": [ { "properties": { "direction": { "enum": ["in"] }, "id": { "type": "string", "description": "This is the id for the record to retrieve." } } }, { "properties": { "direction": { "enum": ["out"] } } } ] }, "documentDBBinding": { "properties": { "type": { "enum": ["documentDB"] }, "connection": { "type": "string", "description": "This is the connection string for your DocumentDB account." }, "databaseName": { "type": "string", "description": "This is the name of the database within your DocumentDB account to which data will be written." }, "collectionName": { "type": "string", "description": "This is the name of the collection within your database to which data will be written." } }, "oneOf": [ { "properties": { "direction": { "enum": ["in"] }, "id": { "type": "string", "description": "This is the id for the record to retrieve." }, "sqlQuery": { "type": "string", "description": "This is the query to run against the collection." } } }, { "properties": { "direction": { "enum": ["out"] }, "createIfNotExists": { "type": "boolean", "description": "When true, your database and collection will be created automatically." } } } ] }, "tableBinding": { "properties": { "type": { "enum": ["table"] }, "tableName": { "type": "string", "description": "The name of the storage table." }, "partitionKey": { "type": "string", "description": "The partition key." }, "rowKey": { "type": "string", "description": "The table row key." }, "connection": { "type": "string", "description": "An app setting (or environment variable) with the storage connection string to be used by this binding." } }, "oneOf": [ { "properties": { "direction": { "enum": ["in"] }, "take": { "type": "string", "description": "The number or records to retrieve." }, "filter": { "type": "string", "description": "A filter expression to be applied when retrieving rows." } } }, { "properties": { "direction": { "enum": ["out"] } } } ] }, "notificationHubBinding": { "properties": { "type": { "enum": ["notificationHub"] }, "direction": { "enum": ["out"] }, "tagExpression": { "type": "string", "description": "The tag to send the notification to." }, "hubName": { "type": "string", "description": "The name of the notification hub." }, "connection": { "type": "string", "description": "The name of the app setting which contains the notification hub connection string." }, "platform": { "type": "string", "description": "The notification platform to target. Sends template notification if platform is omitted.", "enum": ["apns", "adm", "gcm", "wns", "mpns"] } } }, "twilioSmsBinding": { "properties": { "type": { "enum": ["twilioSms"] }, "direction": { "enum": ["out"] }, "accountSid": { "type": "string", "description": "The name of the app setting which contains your Twilio Account Sid." }, "authToken": { "type": "string", "description": "The name of the app setting which contains your Twilio authentication token." }, "to": { "type": "string", "description": "The phone number the SMS text is sent to." }, "from": { "type": "string", "description": "The phone number the SMS text is sent from." }, "body": { "type": "string", "description": "Optional body of SMS text message." } } }, "sendGridBinding": { "properties": { "type": { "enum": ["sendGrid"] }, "direction": { "enum": ["out"] }, "apiKey": { "type": "string", "description": "The name of the app setting which contains your SendGrid api key." }, "to": { "type": "string", "description": "The email address to send to." }, "from": { "type": "string", "description": "The email address to send from." }, "subject": { "type": "string", "description": "The subject of the email." }, "text": { "type": "string", "description": "The text of the email." } } }, "sqlBinding": { "properties": { "connectionStringSetting": { "type": "string", "description": "The name of the app setting that contains the SQL connection string used to connect to the database." } }, "oneOf": [ { "properties": { "type": { "enum": ["sqlTrigger"] }, "tableName": { "type": "string", "description": "The name of the table to be monitored for changes." } } }, { "properties": { "type": { "enum": ["sql"] }, "direction": { "enum": ["in"] }, "commandText": { "type": "string", "description": "Either a query string or the name of a stored procedure to execute." }, "commandType": { "enum": ["text", "storedProcedure"], "description": "Whether the commandText is a query (text) or a stored procedure (storedProcedure)." }, "parameters": { "type": "string", "description": "The parameters to the query or stored procedure." } } }, { "properties": { "type": { "const": "sql" }, "direction": { "const": "out" }, "commandText": { "type": "string", "description": "The name of the table into which rows will be upserted." } } } ] }, "kustoBinding": { "properties": { "connection": { "type": "string", "description": "Name of the app setting that contains the kusto connection string used to connect to kusto." }, "database": { "type": "string", "description": "Name of the database within your kusto account to which data will be read/written." }, "managedServiceIdentity": { "type": "string", "description": "A managed service identity that has to be attached to use the bindings." }, "type": { "enum": ["kusto"] } }, "oneOf": [ { "properties": { "direction": { "enum": ["in"] }, "kqlCommand": { "type": "string", "description": "The Kusto command to execute.Can be a KQL query or a KQL function with optional parameters." }, "kqlParameters": { "type": "string", "description": "The parameters to the query or function. Named parameters are of the form @paramName=paramValue." } } }, { "properties": { "direction": { "enum": ["out"] }, "tableName": { "type": "string", "description": "The table to ingest the data into." }, "mappingRef": { "type": "string", "description": "An ingestion mapping ref that points to the mapping created in kusto and referenced in ingestion (optional)." }, "dataFormat": { "type": "string", "description": "Dataformat to use in ingestion.The default dataformat is `multijson/json`. This has been tested for text formats" } } } ] } }, "id": "https://json.schemastore.org/function.json", "properties": { "disabled": { "type": "boolean", "description": "If set to true, marks the function as disabled (it cannot be triggered)." }, "excluded": { "type": "boolean", "description": "If set to true, the function will not be loaded, compiled, or triggered." }, "scriptFile": { "type": "string", "description": "Optional path to function script file." }, "entryPoint": { "type": "string", "description": "Optional named entry point." }, "configurationSource": { "enum": ["attributes", "config"], "description": "For C# precompiled functions only. If set to 'attributes', use WebJobs attributes to specify bindings. Otherwise, use the 'bindings' property of this function.json." }, "retry": { "description": "Retry policy of function execution failures.", "type": "object", "properties": { "strategy": { "description": "Retry strategy to use for retrying function executions", "enum": ["exponentialBackoff", "fixedDelay"], "default": "exponentialBackoff" }, "maxRetryCount": { "description": "The maximum number of retries allowed per function execution. -1 means to retry indefinitely.", "type": "integer" }, "delayInterval": { "description": "Value indicating the delayInterval for function execution retries when using FixedDelay strategy.", "oneOf": [ { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$" }, { "enum": [null] } ] }, "minimumInterval": { "description": "Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy.", "oneOf": [ { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$" }, { "enum": [null] } ] }, "maximumInterval": { "description": "Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy.", "oneOf": [ { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$" }, { "enum": [null] } ] } } }, "bindings": { "type": "array", "description": "A list of function bindings.", "items": { "oneOf": [ { "$ref": "#/definitions/dynamicBinding" }, { "oneOf": [ { "$ref": "#/definitions/serviceBusBinding" }, { "$ref": "#/definitions/blobBinding" }, { "$ref": "#/definitions/manualTriggerBinding" }, { "$ref": "#/definitions/eventHubBinding" }, { "$ref": "#/definitions/timerTriggerBinding" }, { "$ref": "#/definitions/queueBinding" }, { "$ref": "#/definitions/httpBinding" }, { "$ref": "#/definitions/mobileBinding" }, { "$ref": "#/definitions/documentDBBinding" }, { "$ref": "#/definitions/tableBinding" }, { "$ref": "#/definitions/notificationHubBinding" }, { "$ref": "#/definitions/twilioSmsBinding" }, { "$ref": "#/definitions/sendGridBinding" }, { "$ref": "#/definitions/sqlBinding" }, { "$ref": "#/definitions/kustoBinding" } ] } ], "allOf": [ { "$ref": "#/definitions/bindingBase" } ] } } }, "title": "JSON schema for Azure Functions function.json files", "type": "object" }

cluster.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/RancherKubernetesEngineConfig", "definitions": { "AESConfiguration": { "required": [ "keys" ], "properties": { "keys": { "items": { "$ref": "#/definitions/Key" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "AWSCloudProvider": { "required": [ "global" ], "properties": { "global": { "$ref": "#/definitions/GlobalAwsOpts" }, "serviceOverride": { "patternProperties": { ".*": { "$ref": "#/definitions/ServiceOverride" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "AWSElasticBlockStoreVolumeSource": { "required": [ "volumeID" ], "properties": { "volumeID": { "type": "string" }, "fsType": { "type": "string" }, "partition": { "type": "integer" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "AciNetworkProvider": { "properties": { "systemId": { "type": "string" }, "apicHosts": { "items": { "type": "string" }, "type": "array" }, "token": { "type": "string" }, "apicUserName": { "type": "string" }, "apicUserKey": { "type": "string" }, "apicUserCrt": { "type": "string" }, "apicRefreshTime": { "type": "string" }, "vmmDomain": { "type": "string" }, "vmmController": { "type": "string" }, "encapType": { "type": "string" }, "nodeSubnet": { "type": "string" }, "mcastRangeStart": { "type": "string" }, "mcastRangeEnd": { "type": "string" }, "aep": { "type": "string" }, "vrfName": { "type": "string" }, "vrfTenant": { "type": "string" }, "l3out": { "type": "string" }, "l3outExternalNetworks": { "items": { "type": "string" }, "type": "array" }, "externDynamic": { "type": "string" }, "externStatic": { "type": "string" }, "nodeSvcSubnet": { "type": "string" }, "kubeApiVlan": { "type": "string" }, "serviceVlan": { "type": "string" }, "infraVlan": { "type": "string" }, "tenant": { "type": "string" }, "ovsMemoryLimit": { "type": "string" }, "imagePullPolicy": { "type": "string" }, "imagePullSecret": { "type": "string" }, "serviceMonitorInterval": { "type": "string" }, "pbrTrackingNonSnat": { "type": "string" }, "installIstio": { "type": "string" }, "istioProfile": { "type": "string" }, "dropLogEnable": { "type": "string" }, "controllerLogLevel": { "type": "string" }, "hostAgentLogLevel": { "type": "string" }, "opflexLogLevel": { "type": "string" }, "useAciCniPriorityClass": { "type": "string" }, "noPriorityClass": { "type": "string" }, "maxNodesSvcGraph": { "type": "string" }, "snatContractScope": { "type": "string" }, "podSubnetChunkSize": { "type": "string" }, "enableEndpointSlice": { "type": "string" }, "snatNamespace": { "type": "string" }, "epRegistry": { "type": "string" }, "opflexMode": { "type": "string" }, "snatPortRangeStart": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "snatPortRangeEnd": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "snatPortsPerNode": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "opflexClientSsl": { "type": "string" }, "usePrivilegedContainer": { "type": "string" }, "useHostNetnsVolume": { "type": "string" }, "useOpflexServerVolume": { "type": "string" }, "subnetDomainName": { "type": "string" }, "kafkaBrokers": { "items": { "type": "string" }, "type": "array" }, "kafkaClientCrt": { "type": "string" }, "kafkaClientKey": { "type": "string" }, "capic": { "type": "string" }, "useAciAnywhereCrd": { "type": "string" }, "overlayVrfName": { "type": "string" }, "gbpPodSubnet": { "type": "string" }, "runGbpContainer": { "type": "string" }, "runOpflexServerContainer": { "type": "string" }, "opflexServerPort": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "additionalProperties": false, "type": "object" }, "AdmissionConfiguration": { "required": [ "TypeMeta", "plugins" ], "properties": { "TypeMeta": { "$ref": "#/definitions/TypeMeta" }, "plugins": { "items": { "$ref": "#/definitions/AdmissionPluginConfiguration" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "AdmissionPluginConfiguration": { "required": [ "name", "path", "configuration" ], "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "configuration": { "$ref": "#/definitions/Unknown" } }, "additionalProperties": false, "type": "object" }, "AuditLog": { "properties": { "enabled": { "type": "boolean" }, "configuration": { "$ref": "#/definitions/AuditLogConfig" } }, "additionalProperties": false, "type": "object" }, "AuditLogConfig": { "properties": { "maxAge": { "type": "integer" }, "maxBackup": { "type": "integer" }, "maxSize": { "type": "integer" }, "path": { "type": "string" }, "format": { "type": "string" }, "policy": { "$ref": "#/definitions/Policy" } }, "additionalProperties": false, "type": "object" }, "AuthWebhookConfig": { "properties": { "configFile": { "type": "string", "description": "ConfigFile is a multiline string that represent a custom webhook config file" }, "cacheTimeout": { "type": "string", "description": "CacheTimeout controls how long to cache authentication decisions" } }, "additionalProperties": false, "type": "object" }, "AuthnConfig": { "properties": { "strategy": { "type": "string", "description": "Authentication strategy that will be used in kubernetes cluster" }, "sans": { "items": { "type": "string" }, "type": "array", "description": "List of additional hostnames and IPs to include in the api server PKI cert" }, "webhook": { "$ref": "#/definitions/AuthWebhookConfig", "description": "Webhook configuration options" } }, "additionalProperties": false, "type": "object" }, "AuthzConfig": { "properties": { "mode": { "type": "string", "description": "Authorization mode used by kubernetes" }, "options": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "Authorization mode options" } }, "additionalProperties": false, "type": "object" }, "AzureCloudProvider": { "required": [ "cloud", "tenantId", "subscriptionId", "resourceGroup", "location", "vnetName", "vnetResourceGroup", "subnetName", "securityGroupName", "routeTableName", "primaryAvailabilitySetName", "vmType", "primaryScaleSetName", "aadClientId", "aadClientSecret", "aadClientCertPath", "aadClientCertPassword", "cloudProviderBackoff", "cloudProviderBackoffRetries", "cloudProviderBackoffExponent", "cloudProviderBackoffDuration", "cloudProviderBackoffJitter", "cloudProviderRateLimit", "cloudProviderRateLimitQPS", "cloudProviderRateLimitBucket", "useInstanceMetadata", "useManagedIdentityExtension", "maximumLoadBalancerRuleCount" ], "properties": { "cloud": { "type": "string", "description": "The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13" }, "tenantId": { "type": "string", "description": "The AAD Tenant ID for the Subscription that the cluster is deployed in" }, "subscriptionId": { "type": "string", "description": "The ID of the Azure Subscription that the cluster is deployed in" }, "resourceGroup": { "type": "string", "description": "The name of the resource group that the cluster is deployed in" }, "location": { "type": "string", "description": "The location of the resource group that the cluster is deployed in" }, "vnetName": { "type": "string", "description": "The name of the VNet that the cluster is deployed in" }, "vnetResourceGroup": { "type": "string", "description": "The name of the resource group that the Vnet is deployed in" }, "subnetName": { "type": "string", "description": "The name of the subnet that the cluster is deployed in" }, "securityGroupName": { "type": "string", "description": "The name of the security group attached to the cluster's subnet" }, "routeTableName": { "type": "string", "description": "(Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in" }, "primaryAvailabilitySetName": { "type": "string", "description": "(Optional) The name of the availability set that should be used as the load balancer backend\nIf this is set, the Azure cloudprovider will only add nodes from that availability set to the load\nbalancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then\nthe cloudprovider will try to add all nodes to a single backend pool which is forbidden.\nIn other words, if you use multiple agent pools (availability sets), you MUST set this field." }, "vmType": { "type": "string", "description": "The type of azure nodes. Candidate valudes are: vmss and standard.\nIf not set, it will be default to standard." }, "primaryScaleSetName": { "type": "string", "description": "The name of the scale set that should be used as the load balancer backend.\nIf this is set, the Azure cloudprovider will only add nodes from that scale set to the load\nbalancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then\nthe cloudprovider will try to add all nodes to a single backend pool which is forbidden.\nIn other words, if you use multiple agent pools (scale sets), you MUST set this field." }, "aadClientId": { "type": "string", "description": "The ClientID for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md" }, "aadClientSecret": { "type": "string", "description": "The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md" }, "aadClientCertPath": { "type": "string", "description": "The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service" }, "aadClientCertPassword": { "type": "string", "description": "The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service" }, "cloudProviderBackoff": { "type": "boolean", "description": "Enable exponential backoff to manage resource request retries" }, "cloudProviderBackoffRetries": { "type": "integer", "description": "Backoff retry limit" }, "cloudProviderBackoffExponent": { "type": "integer", "description": "Backoff exponent" }, "cloudProviderBackoffDuration": { "type": "integer", "description": "Backoff duration" }, "cloudProviderBackoffJitter": { "type": "integer", "description": "Backoff jitter" }, "cloudProviderRateLimit": { "type": "boolean", "description": "Enable rate limiting" }, "cloudProviderRateLimitQPS": { "type": "integer", "description": "Rate limit QPS" }, "cloudProviderRateLimitBucket": { "type": "integer", "description": "Rate limit Bucket Size" }, "useInstanceMetadata": { "type": "boolean", "description": "Use instance metadata service where possible" }, "useManagedIdentityExtension": { "type": "boolean", "description": "Use managed service identity for the virtual machine to access Azure ARM APIs\nThis's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview\nFor user-assigned managed identity, need to set the below UserAssignedIdentityID" }, "userAssignedIdentityID": { "type": "string", "description": "The Client ID of the user assigned MSI which is assigned to the underlying VMs\nThis's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview" }, "maximumLoadBalancerRuleCount": { "type": "integer", "description": "Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148" }, "loadBalancerSku": { "type": "string", "description": "Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`" }, "excludeMasterFromStandardLB": { "type": "boolean", "description": "Excludes master nodes (labeled with `node-role.kubernetes.io/master`) from the backend pool of Azure standard loadbalancer, default(nil) to `true`\nIf want adding the master nodes to ALB, this should be set to `false` and remove the `node-role.kubernetes.io/master` label from master nodes" } }, "additionalProperties": false, "type": "object" }, "AzureDiskVolumeSource": { "required": [ "diskName", "diskURI" ], "properties": { "diskName": { "type": "string" }, "diskURI": { "type": "string" }, "cachingMode": { "type": "string" }, "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "kind": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "AzureFileVolumeSource": { "required": [ "secretName", "shareName" ], "properties": { "secretName": { "type": "string" }, "shareName": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "BackupConfig": { "required": [ "s3BackupConfig" ], "properties": { "enabled": { "type": "boolean" }, "intervalHours": { "type": "integer" }, "retention": { "type": "integer" }, "s3BackupConfig": { "$ref": "#/definitions/S3BackupConfig" }, "safeTimestamp": { "type": "boolean" }, "timeout": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "BastionHost": { "properties": { "address": { "type": "string", "description": "Address of Bastion Host" }, "port": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "SSH Port of Bastion Host" }, "user": { "type": "string", "description": "ssh User to Bastion Host" }, "sshAgentAuth": { "type": "boolean", "description": "SSH Agent Auth enable" }, "sshKey": { "type": "string", "description": "SSH Private Key" }, "sshKeyPath": { "type": "string", "description": "SSH Private Key Path" }, "sshCert": { "type": "string", "description": "SSH Certificate" }, "sshCertPath": { "type": "string", "description": "SSH Certificate Path" }, "ignoreProxyEnvVars": { "type": "boolean", "description": "Ignore proxy environment variables" } }, "additionalProperties": false, "type": "object" }, "BlockStorageOpenstackOpts": { "required": [ "bs-version", "trust-device-path", "ignore-volume-az" ], "properties": { "bs-version": { "type": "string", "description": "overrides autodetection. v1 or v2. Defaults to auto" }, "trust-device-path": { "type": "boolean", "description": "See Issue #33128" }, "ignore-volume-az": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "CSIVolumeSource": { "required": [ "driver" ], "properties": { "driver": { "type": "string" }, "readOnly": { "type": "boolean" }, "fsType": { "type": "string" }, "volumeAttributes": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "nodePublishSecretRef": { "$ref": "#/definitions/LocalObjectReference" } }, "additionalProperties": false, "type": "object" }, "CalicoNetworkProvider": { "required": [ "cloudProvider" ], "properties": { "cloudProvider": { "type": "string", "description": "Cloud provider type used with calico" } }, "additionalProperties": false, "type": "object" }, "CanalNetworkProvider": { "required": [ "iface" ], "properties": { "iface": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "CephFSVolumeSource": { "required": [ "monitors" ], "properties": { "monitors": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" }, "user": { "type": "string" }, "secretFile": { "type": "string" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "CinderVolumeSource": { "required": [ "volumeID" ], "properties": { "volumeID": { "type": "string" }, "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" } }, "additionalProperties": false, "type": "object" }, "CloudProvider": { "properties": { "name": { "type": "string", "description": "Name of the Cloud Provider" }, "awsCloudProvider": { "$ref": "#/definitions/AWSCloudProvider", "description": "AWSCloudProvider" }, "azureCloudProvider": { "$ref": "#/definitions/AzureCloudProvider", "description": "AzureCloudProvider" }, "openstackCloudProvider": { "$ref": "#/definitions/OpenstackCloudProvider", "description": "OpenstackCloudProvider" }, "vsphereCloudProvider": { "$ref": "#/definitions/VsphereCloudProvider", "description": "VsphereCloudProvider" }, "customCloudProvider": { "type": "string", "description": "CustomCloudProvider is a multiline string that represent a custom cloud config file" } }, "additionalProperties": false, "type": "object" }, "ConfigMapKeySelector": { "required": [ "LocalObjectReference", "key" ], "properties": { "LocalObjectReference": { "$ref": "#/definitions/LocalObjectReference" }, "key": { "type": "string" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "ConfigMapProjection": { "required": [ "LocalObjectReference" ], "properties": { "LocalObjectReference": { "$ref": "#/definitions/LocalObjectReference" }, "items": { "items": { "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "ConfigMapVolumeSource": { "required": [ "LocalObjectReference" ], "properties": { "LocalObjectReference": { "$ref": "#/definitions/LocalObjectReference" }, "items": { "items": { "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "defaultMode": { "type": "integer" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "Configuration": { "required": [ "TypeMeta", "limits" ], "properties": { "TypeMeta": { "$ref": "#/definitions/TypeMeta" }, "limits": { "items": { "$ref": "#/definitions/Limit" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "DNSConfig": { "properties": { "provider": { "type": "string", "description": "DNS provider" }, "options": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "DNS config options" }, "upstreamnameservers": { "items": { "type": "string" }, "type": "array", "description": "Upstream nameservers" }, "reversecidrs": { "items": { "type": "string" }, "type": "array", "description": "ReverseCIDRs" }, "stubdomains": { "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "description": "Stubdomains" }, "nodeSelector": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "NodeSelector key pair" }, "nodelocal": { "$ref": "#/definitions/Nodelocal", "description": "Nodelocal DNS" }, "updateStrategy": { "$ref": "#/definitions/DeploymentStrategy", "description": "Update strategy" }, "linearAutoscalerParams": { "$ref": "#/definitions/LinearAutoscalerParams", "description": "Autoscaler fields to determine number of dns replicas" }, "tolerations": { "items": { "$ref": "#/definitions/Toleration" }, "type": "array", "description": "Tolerations for Deployments" } }, "additionalProperties": false, "type": "object" }, "DaemonSetUpdateStrategy": { "properties": { "strategy": { "type": "string" }, "rollingUpdate": { "$ref": "#/definitions/RollingUpdateDaemonSet" } }, "additionalProperties": false, "type": "object" }, "DeploymentStrategy": { "properties": { "strategy": { "type": "string" }, "rollingUpdate": { "$ref": "#/definitions/RollingUpdateDeployment" } }, "additionalProperties": false, "type": "object" }, "DiskVsphereOpts": { "properties": { "scsicontrollertype": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "DownwardAPIProjection": { "properties": { "items": { "items": { "$ref": "#/definitions/DownwardAPIVolumeFile" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "DownwardAPIVolumeFile": { "required": [ "path" ], "properties": { "path": { "type": "string" }, "fieldRef": { "$ref": "#/definitions/ObjectFieldSelector" }, "resourceFieldRef": { "$ref": "#/definitions/ResourceFieldSelector" }, "mode": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "DownwardAPIVolumeSource": { "properties": { "items": { "items": { "$ref": "#/definitions/DownwardAPIVolumeFile" }, "type": "array" }, "defaultMode": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Duration": { "properties": {}, "additionalProperties": false, "type": "object" }, "ECRCredentialPlugin": { "properties": { "awsAccessKeyId": { "type": "string" }, "awsSecretAccessKey": { "type": "string" }, "awsAccessToken": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ETCDService": { "properties": { "image": { "type": "string" }, "extraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "extraBinds": { "items": { "type": "string" }, "type": "array" }, "extraEnv": { "items": { "type": "string" }, "type": "array" }, "winExtraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "winExtraBinds": { "items": { "type": "string" }, "type": "array" }, "winExtraEnv": { "items": { "type": "string" }, "type": "array" }, "externalUrls": { "items": { "type": "string" }, "type": "array", "description": "List of etcd urls" }, "caCert": { "type": "string", "description": "External CA certificate" }, "cert": { "type": "string", "description": "External Client certificate" }, "key": { "type": "string", "description": "External Client key" }, "path": { "type": "string", "description": "External etcd prefix" }, "uid": { "type": "integer", "description": "UID to run etcd container as" }, "gid": { "type": "integer", "description": "GID to run etcd container as" }, "snapshot": { "type": "boolean", "description": "Etcd Recurring snapshot Service, used by rke only" }, "retention": { "type": "string", "description": "Etcd snapshot Retention period" }, "creation": { "type": "string", "description": "Etcd snapshot Creation period" }, "backupConfig": { "$ref": "#/definitions/BackupConfig", "description": "Backup backend for etcd snapshots" } }, "additionalProperties": false, "type": "object" }, "EmptyDirVolumeSource": { "properties": { "medium": { "type": "string" }, "sizeLimit": { "$ref": "#/definitions/Quantity" } }, "additionalProperties": false, "type": "object" }, "EncryptionConfiguration": { "required": [ "resources" ], "properties": { "kind": { "type": "string" }, "apiVersion": { "type": "string" }, "resources": { "items": { "$ref": "#/definitions/ResourceConfiguration" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "EnvVarSource": { "properties": { "fieldRef": { "$ref": "#/definitions/ObjectFieldSelector" }, "resourceFieldRef": { "$ref": "#/definitions/ResourceFieldSelector" }, "configMapKeyRef": { "$ref": "#/definitions/ConfigMapKeySelector" }, "secretKeyRef": { "$ref": "#/definitions/SecretKeySelector" } }, "additionalProperties": false, "type": "object" }, "EphemeralVolumeSource": { "properties": { "volumeClaimTemplate": { "$ref": "#/definitions/PersistentVolumeClaimTemplate" } }, "additionalProperties": false, "type": "object" }, "EventRateLimit": { "properties": { "enabled": { "type": "boolean" }, "configuration": { "$ref": "#/definitions/Configuration" } }, "additionalProperties": false, "type": "object" }, "ExtraEnv": { "required": [ "name" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "valueFrom": { "$ref": "#/definitions/EnvVarSource" } }, "additionalProperties": false, "type": "object" }, "ExtraVolume": { "required": [ "name", "VolumeSource" ], "properties": { "name": { "type": "string" }, "VolumeSource": { "$ref": "#/definitions/VolumeSource" } }, "additionalProperties": false, "type": "object" }, "ExtraVolumeMount": { "required": [ "name", "mountPath" ], "properties": { "name": { "type": "string" }, "readOnly": { "type": "boolean" }, "mountPath": { "type": "string" }, "subPath": { "type": "string" }, "mountPropagation": { "type": "string" }, "subPathExpr": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "FCVolumeSource": { "properties": { "targetWWNs": { "items": { "type": "string" }, "type": "array" }, "lun": { "type": "integer" }, "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "wwids": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FieldsV1": { "properties": {}, "additionalProperties": false, "type": "object" }, "FlannelNetworkProvider": { "required": [ "iface" ], "properties": { "iface": { "type": "string", "description": "Alternate cloud interface for flannel" } }, "additionalProperties": false, "type": "object" }, "FlexVolumeSource": { "required": [ "driver" ], "properties": { "driver": { "type": "string" }, "fsType": { "type": "string" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "readOnly": { "type": "boolean" }, "options": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "FlockerVolumeSource": { "properties": { "datasetName": { "type": "string" }, "datasetUUID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GCEPersistentDiskVolumeSource": { "required": [ "pdName" ], "properties": { "pdName": { "type": "string" }, "fsType": { "type": "string" }, "partition": { "type": "integer" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "GitRepoVolumeSource": { "required": [ "repository" ], "properties": { "repository": { "type": "string" }, "revision": { "type": "string" }, "directory": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GlobalAwsOpts": { "required": [ "zone", "vpc", "subnet-id", "routetable-id", "role-arn", "kubernetes-cluster-tag", "kubernetes-cluster-id", "disable-security-group-ingress", "elb-security-group", "disable-strict-zone-check" ], "properties": { "zone": { "type": "string", "description": "TODO: Is there any use for this? We can get it from the instance metadata service\nMaybe if we're not running on AWS, e.g. bootstrap; for now it is not very useful" }, "vpc": { "type": "string", "description": "The AWS VPC flag enables the possibility to run the master components\non a different aws account, on a different cloud provider or on-premises.\nIf the flag is set also the KubernetesClusterTag must be provided" }, "subnet-id": { "type": "string", "description": "SubnetID enables using a specific subnet to use for ELB's" }, "routetable-id": { "type": "string", "description": "RouteTableID enables using a specific RouteTable" }, "role-arn": { "type": "string", "description": "RoleARN is the IAM role to assume when interaction with AWS APIs." }, "kubernetes-cluster-tag": { "type": "string", "description": "KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources" }, "kubernetes-cluster-id": { "type": "string", "description": "KubernetesClusterID is the cluster id we'll use to identify our cluster resources" }, "disable-security-group-ingress": { "type": "boolean", "description": "The aws provider creates an inbound rule per load balancer on the node security\ngroup. However, this can run into the AWS security group rule limit of 50 if\nmany LoadBalancers are created.\n\nThis flag disables the automatic ingress creation. It requires that the user\nhas setup a rule that allows inbound traffic on kubelet ports from the\nlocal VPC subnet (so load balancers can access it). E.g. 10.82.0.0/16 30000-32000." }, "elb-security-group": { "type": "string", "description": "AWS has a hard limit of 500 security groups. For large clusters creating a security group for each ELB\ncan cause the max number of security groups to be reached. If this is set instead of creating a new\nSecurity group for each ELB this security group will be used instead." }, "disable-strict-zone-check": { "type": "boolean", "description": "During the instantiation of an new AWS cloud provider, the detected region\nis validated against a known set of regions.\n\nIn a non-standard, AWS like environment (e.g. Eucalyptus), this check may\nbe undesirable. Setting this to true will disable the check and provide\na warning that the check was skipped. Please note that this is an\nexperimental feature and work-in-progress for the moment. If you find\nyourself in an non-AWS cloud and open an issue, please indicate that in the\nissue body." } }, "additionalProperties": false, "type": "object" }, "GlobalOpenstackOpts": { "required": [ "auth-url", "username", "user-id", "password", "tenant-id", "tenant-name", "trust-id", "domain-id", "domain-name", "region", "ca-file" ], "properties": { "auth-url": { "type": "string" }, "username": { "type": "string" }, "user-id": { "type": "string" }, "password": { "type": "string" }, "tenant-id": { "type": "string" }, "tenant-name": { "type": "string" }, "trust-id": { "type": "string" }, "domain-id": { "type": "string" }, "domain-name": { "type": "string" }, "region": { "type": "string" }, "ca-file": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GlobalVsphereOpts": { "properties": { "user": { "type": "string" }, "password": { "type": "string" }, "server": { "type": "string" }, "port": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "insecure-flag": { "type": "boolean" }, "datacenter": { "type": "string" }, "datacenters": { "type": "string" }, "datastore": { "type": "string" }, "working-dir": { "type": "string" }, "soap-roundtrip-count": { "type": "integer" }, "vm-uuid": { "type": "string" }, "vm-name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GlusterfsVolumeSource": { "required": [ "endpoints", "path" ], "properties": { "endpoints": { "type": "string" }, "path": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "GroupResources": { "properties": { "group": { "type": "string" }, "resources": { "items": { "type": "string" }, "type": "array" }, "resourceNames": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "HostPathVolumeSource": { "required": [ "path" ], "properties": { "path": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ISCSIVolumeSource": { "required": [ "targetPortal", "iqn", "lun" ], "properties": { "targetPortal": { "type": "string" }, "iqn": { "type": "string" }, "lun": { "type": "integer" }, "iscsiInterface": { "type": "string" }, "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "portals": { "items": { "type": "string" }, "type": "array" }, "chapAuthDiscovery": { "type": "boolean" }, "chapAuthSession": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "initiatorName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "IdentityConfiguration": { "properties": {}, "additionalProperties": false, "type": "object" }, "IngressConfig": { "properties": { "provider": { "type": "string", "description": "Ingress controller type used by kubernetes" }, "options": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "These options are NOT for configuring Ingress's addon template.\nThey are used for its ConfigMap options specifically." }, "nodeSelector": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "NodeSelector key pair" }, "extraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "Ingress controller extra arguments" }, "dnsPolicy": { "type": "string", "description": "DNS Policy" }, "extraEnvs": { "items": { "$ref": "#/definitions/ExtraEnv" }, "type": "array", "description": "Extra Env vars" }, "extraVolumes": { "items": { "$ref": "#/definitions/ExtraVolume" }, "type": "array", "description": "Extra volumes" }, "extraVolumeMounts": { "items": { "$ref": "#/definitions/ExtraVolumeMount" }, "type": "array", "description": "Extra volume mounts" }, "updateStrategy": { "$ref": "#/definitions/DaemonSetUpdateStrategy", "description": "nginx daemonset upgrade strategy" }, "httpPort": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Http port for ingress controller daemonset" }, "httpsPort": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Https port for ingress controller daemonset" }, "networkMode": { "type": "string", "description": "NetworkMode selector for ingress controller pods. Default is HostNetwork" }, "tolerations": { "items": { "$ref": "#/definitions/Toleration" }, "type": "array", "description": "Tolerations for Deployments" }, "defaultBackend": { "type": "boolean", "description": "Enable or disable nginx default-http-backend" }, "defaultHttpBackendPriorityClassName": { "type": "string", "description": "Priority class name for Nginx-Ingress's \"default-http-backend\" deployment" }, "nginxIngressControllerPriorityClassName": { "type": "string", "description": "Priority class name for Nginx-Ingress's \"nginx-ingress-controller\" daemonset" } }, "additionalProperties": false, "type": "object" }, "IntOrString": { "required": [ "Type", "IntVal", "StrVal" ], "properties": { "Type": { "type": "integer" }, "IntVal": { "type": "integer" }, "StrVal": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "KMSConfiguration": { "required": [ "name", "endpoint" ], "properties": { "name": { "type": "string" }, "cachesize": { "type": "integer" }, "endpoint": { "type": "string" }, "timeout": { "$ref": "#/definitions/Duration" } }, "additionalProperties": false, "type": "object" }, "Key": { "required": [ "name", "secret" ], "properties": { "name": { "type": "string" }, "secret": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "KeyToPath": { "required": [ "key", "path" ], "properties": { "key": { "type": "string" }, "path": { "type": "string" }, "mode": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "KubeAPIService": { "properties": { "image": { "type": "string" }, "extraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "extraBinds": { "items": { "type": "string" }, "type": "array" }, "extraEnv": { "items": { "type": "string" }, "type": "array" }, "winExtraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "winExtraBinds": { "items": { "type": "string" }, "type": "array" }, "winExtraEnv": { "items": { "type": "string" }, "type": "array" }, "serviceClusterIpRange": { "type": "string", "description": "Virtual IP range that will be used by Kubernetes services" }, "serviceNodePortRange": { "type": "string", "description": "Port range for services defined with NodePort type" }, "podSecurityPolicy": { "type": "boolean", "description": "Enabled/Disable PodSecurityPolicy" }, "alwaysPullImages": { "type": "boolean", "description": "Enable/Disable AlwaysPullImages admissions plugin" }, "secretsEncryptionConfig": { "$ref": "#/definitions/SecretsEncryptionConfig", "description": "Secrets encryption provider config" }, "auditLog": { "$ref": "#/definitions/AuditLog", "description": "Audit Log Configuration" }, "admissionConfiguration": { "$ref": "#/definitions/AdmissionConfiguration", "description": "AdmissionConfiguration" }, "eventRateLimit": { "$ref": "#/definitions/EventRateLimit", "description": "Event Rate Limit configuration" } }, "additionalProperties": false, "type": "object" }, "KubeControllerService": { "properties": { "image": { "type": "string" }, "extraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "extraBinds": { "items": { "type": "string" }, "type": "array" }, "extraEnv": { "items": { "type": "string" }, "type": "array" }, "winExtraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "winExtraBinds": { "items": { "type": "string" }, "type": "array" }, "winExtraEnv": { "items": { "type": "string" }, "type": "array" }, "clusterCidr": { "type": "string", "description": "CIDR Range for Pods in cluster" }, "serviceClusterIpRange": { "type": "string", "description": "Virtual IP range that will be used by Kubernetes services" } }, "additionalProperties": false, "type": "object" }, "KubeletService": { "properties": { "image": { "type": "string" }, "extraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "extraBinds": { "items": { "type": "string" }, "type": "array" }, "extraEnv": { "items": { "type": "string" }, "type": "array" }, "winExtraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "winExtraBinds": { "items": { "type": "string" }, "type": "array" }, "winExtraEnv": { "items": { "type": "string" }, "type": "array" }, "clusterDomain": { "type": "string", "description": "Domain of the cluster (default: \"cluster.local\")" }, "infraContainerImage": { "type": "string", "description": "The image whose network/ipc namespaces containers in each pod will use" }, "clusterDnsServer": { "type": "string", "description": "Cluster DNS service ip" }, "failSwapOn": { "type": "boolean", "description": "Fail if swap is enabled" }, "generateServingCertificate": { "type": "boolean", "description": "Generate per node kubelet serving certificates created using kube-ca" } }, "additionalProperties": false, "type": "object" }, "KubeproxyService": { "properties": { "image": { "type": "string" }, "extraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "extraBinds": { "items": { "type": "string" }, "type": "array" }, "extraEnv": { "items": { "type": "string" }, "type": "array" }, "winExtraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "winExtraBinds": { "items": { "type": "string" }, "type": "array" }, "winExtraEnv": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "LabelSelector": { "properties": { "matchLabels": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "matchExpressions": { "items": { "$ref": "#/definitions/LabelSelectorRequirement" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "LabelSelectorRequirement": { "required": [ "key", "operator" ], "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Limit": { "required": [ "type", "qps", "burst" ], "properties": { "type": { "type": "string" }, "qps": { "type": "integer" }, "burst": { "type": "integer" }, "cacheSize": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "LinearAutoscalerParams": { "properties": { "coresPerReplica": { "type": "number" }, "nodesPerReplica": { "type": "number" }, "min": { "type": "integer" }, "max": { "type": "integer" }, "preventSinglePointFailure": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "LoadBalancerOpenstackOpts": { "required": [ "lb-version", "use-octavia", "subnet-id", "floating-network-id", "lb-method", "lb-provider", "create-monitor", "monitor-delay", "monitor-timeout", "monitor-max-retries", "manage-security-groups" ], "properties": { "lb-version": { "type": "string", "description": "overrides autodetection. Only support v2." }, "use-octavia": { "type": "boolean", "description": "uses Octavia V2 service catalog endpoint" }, "subnet-id": { "type": "string", "description": "overrides autodetection." }, "floating-network-id": { "type": "string", "description": "If specified, will create floating ip for loadbalancer, or do not create floating ip." }, "lb-method": { "type": "string", "description": "default to ROUND_ROBIN." }, "lb-provider": { "type": "string" }, "create-monitor": { "type": "boolean" }, "monitor-delay": { "type": "string" }, "monitor-timeout": { "type": "string" }, "monitor-max-retries": { "type": "integer" }, "manage-security-groups": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "LocalObjectReference": { "properties": { "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ManagedFieldsEntry": { "properties": { "manager": { "type": "string" }, "operation": { "type": "string" }, "apiVersion": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "fieldsType": { "type": "string" }, "fieldsV1": { "$ref": "#/definitions/FieldsV1" } }, "additionalProperties": false, "type": "object" }, "MetadataOpenstackOpts": { "required": [ "search-order", "request-timeout" ], "properties": { "search-order": { "type": "string" }, "request-timeout": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "MonitoringConfig": { "properties": { "provider": { "type": "string", "description": "Monitoring server provider" }, "options": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "These options are NOT for configuring the Metrics-Server's addon template.\nThey are used to pass command args to the metric-server's deployment containers specifically." }, "nodeSelector": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "NodeSelector key pair" }, "updateStrategy": { "$ref": "#/definitions/DeploymentStrategy", "description": "Update strategy" }, "replicas": { "type": "integer", "description": "Number of monitoring addon pods" }, "tolerations": { "items": { "$ref": "#/definitions/Toleration" }, "type": "array", "description": "Tolerations for Deployments" }, "metricsServerPriorityClassName": { "type": "string", "description": "Priority class name for Metrics-Server's \"metrics-server\" deployment" } }, "additionalProperties": false, "type": "object" }, "NFSVolumeSource": { "required": [ "server", "path" ], "properties": { "server": { "type": "string" }, "path": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "NetworkConfig": { "properties": { "plugin": { "type": "string", "description": "Network Plugin That will be used in kubernetes cluster" }, "options": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "Plugin options to configure network properties" }, "mtu": { "type": "integer", "description": "Set MTU for CNI provider" }, "calicoNetworkProvider": { "$ref": "#/definitions/CalicoNetworkProvider", "description": "CalicoNetworkProvider" }, "canalNetworkProvider": { "$ref": "#/definitions/CanalNetworkProvider", "description": "CanalNetworkProvider" }, "flannelNetworkProvider": { "$ref": "#/definitions/FlannelNetworkProvider", "description": "FlannelNetworkProvider" }, "weaveNetworkProvider": { "$ref": "#/definitions/WeaveNetworkProvider", "description": "WeaveNetworkProvider" }, "aciNetworkProvider": { "$ref": "#/definitions/AciNetworkProvider", "description": "AciNetworkProvider" }, "nodeSelector": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "NodeSelector key pair" }, "updateStrategy": { "$ref": "#/definitions/DaemonSetUpdateStrategy", "description": "Network plugin daemonset upgrade strategy" }, "tolerations": { "items": { "$ref": "#/definitions/Toleration" }, "type": "array", "description": "Tolerations for Deployments" } }, "additionalProperties": false, "type": "object" }, "NetworkVshpereOpts": { "properties": { "public-network": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NodeDrainInput": { "required": [ "timeout" ], "properties": { "force": { "type": "boolean", "description": "Drain node even if there are pods not managed by a ReplicationController, Job, or DaemonSet\nDrain will not proceed without Force set to true if there are such pods" }, "ignoreDaemonSets": { "type": "boolean", "description": "If there are DaemonSet-managed pods, drain will not proceed without IgnoreDaemonSets set to true\n(even when set to true, kubectl won't delete pods - so setting default to true)" }, "deleteLocalData": { "type": "boolean", "description": "Continue even if there are pods using emptyDir" }, "gracePeriod": { "type": "integer", "description": "Period of time in seconds given to each pod to terminate gracefully.\nIf negative, the default value specified in the pod will be used" }, "timeout": { "type": "integer", "description": "Time to wait (in seconds) before giving up for one try" } }, "additionalProperties": false, "type": "object" }, "NodeUpgradeStrategy": { "properties": { "maxUnavailableWorker": { "type": "string", "description": "MaxUnavailableWorker input can be a number of nodes or a percentage of nodes (example, max_unavailable_worker: 2 OR max_unavailable_worker: 20%)" }, "maxUnavailableControlplane": { "type": "string", "description": "MaxUnavailableControlplane input can be a number of nodes or a percentage of nodes" }, "drain": { "type": "boolean" }, "nodeDrainInput": { "$ref": "#/definitions/NodeDrainInput" } }, "additionalProperties": false, "type": "object" }, "Nodelocal": { "properties": { "ipAddress": { "type": "string", "description": "link-local IP for nodelocal DNS" }, "updateStrategy": { "$ref": "#/definitions/DaemonSetUpdateStrategy", "description": "Nodelocal DNS daemonset upgrade strategy" }, "nodeSelector": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "NodeSelector key pair" }, "nodeLocalDnsPriorityClassName": { "type": "string", "description": "Priority class name for NodeLocal's \"node-local-dns\" daemonset" } }, "additionalProperties": false, "type": "object" }, "ObjectFieldSelector": { "required": [ "fieldPath" ], "properties": { "apiVersion": { "type": "string" }, "fieldPath": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ObjectMeta": { "properties": { "name": { "type": "string" }, "generateName": { "type": "string" }, "namespace": { "type": "string" }, "selfLink": { "type": "string" }, "uid": { "type": "string" }, "resourceVersion": { "type": "string" }, "generation": { "type": "integer" }, "creationTimestamp": { "$ref": "#/definitions/Time" }, "deletionTimestamp": { "type": "string", "format": "date-time" }, "deletionGracePeriodSeconds": { "type": "integer" }, "labels": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "annotations": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "ownerReferences": { "items": { "$ref": "#/definitions/OwnerReference" }, "type": "array" }, "finalizers": { "items": { "type": "string" }, "type": "array" }, "clusterName": { "type": "string" }, "managedFields": { "items": { "$ref": "#/definitions/ManagedFieldsEntry" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "OpenstackCloudProvider": { "required": [ "global", "loadBalancer", "blockStorage", "route", "metadata" ], "properties": { "global": { "$ref": "#/definitions/GlobalOpenstackOpts" }, "loadBalancer": { "$ref": "#/definitions/LoadBalancerOpenstackOpts" }, "blockStorage": { "$ref": "#/definitions/BlockStorageOpenstackOpts" }, "route": { "$ref": "#/definitions/RouteOpenstackOpts" }, "metadata": { "$ref": "#/definitions/MetadataOpenstackOpts" } }, "additionalProperties": false, "type": "object" }, "OwnerReference": { "required": [ "apiVersion", "kind", "name", "uid" ], "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "uid": { "type": "string" }, "controller": { "type": "boolean" }, "blockOwnerDeletion": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "PersistentVolumeClaimSpec": { "properties": { "accessModes": { "items": { "type": "string" }, "type": "array" }, "selector": { "$ref": "#/definitions/LabelSelector" }, "resources": { "$ref": "#/definitions/ResourceRequirements" }, "volumeName": { "type": "string" }, "storageClassName": { "type": "string" }, "volumeMode": { "type": "string" }, "dataSource": { "$ref": "#/definitions/TypedLocalObjectReference" } }, "additionalProperties": false, "type": "object" }, "PersistentVolumeClaimTemplate": { "required": [ "spec" ], "properties": { "metadata": { "$ref": "#/definitions/ObjectMeta" }, "spec": { "$ref": "#/definitions/PersistentVolumeClaimSpec" } }, "additionalProperties": false, "type": "object" }, "PersistentVolumeClaimVolumeSource": { "required": [ "claimName" ], "properties": { "claimName": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "PhotonPersistentDiskVolumeSource": { "required": [ "pdID" ], "properties": { "pdID": { "type": "string" }, "fsType": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Policy": { "required": [ "TypeMeta", "rules" ], "properties": { "TypeMeta": { "$ref": "#/definitions/TypeMeta" }, "metadata": { "$ref": "#/definitions/ObjectMeta" }, "rules": { "items": { "$ref": "#/definitions/PolicyRule" }, "type": "array" }, "omitStages": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "PolicyRule": { "required": [ "level" ], "properties": { "level": { "type": "string" }, "users": { "items": { "type": "string" }, "type": "array" }, "userGroups": { "items": { "type": "string" }, "type": "array" }, "verbs": { "items": { "type": "string" }, "type": "array" }, "resources": { "items": { "$ref": "#/definitions/GroupResources" }, "type": "array" }, "namespaces": { "items": { "type": "string" }, "type": "array" }, "nonResourceURLs": { "items": { "type": "string" }, "type": "array" }, "omitStages": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "PortworxVolumeSource": { "required": [ "volumeID" ], "properties": { "volumeID": { "type": "string" }, "fsType": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "PrivateRegistry": { "properties": { "url": { "type": "string", "description": "URL for the registry" }, "user": { "type": "string", "description": "User name for registry acces" }, "password": { "type": "string", "description": "Password for registry access" }, "isDefault": { "type": "boolean", "description": "Default registry" }, "ecrCredentialPlugin": { "$ref": "#/definitions/ECRCredentialPlugin", "description": "ECRCredentialPlugin" } }, "additionalProperties": false, "type": "object" }, "ProjectedVolumeSource": { "required": [ "sources" ], "properties": { "sources": { "items": { "$ref": "#/definitions/VolumeProjection" }, "type": "array" }, "defaultMode": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "ProviderConfiguration": { "properties": { "aesgcm": { "$ref": "#/definitions/AESConfiguration" }, "aescbc": { "$ref": "#/definitions/AESConfiguration" }, "secretbox": { "$ref": "#/definitions/SecretboxConfiguration" }, "identity": { "$ref": "#/definitions/IdentityConfiguration" }, "kms": { "$ref": "#/definitions/KMSConfiguration" } }, "additionalProperties": false, "type": "object" }, "Quantity": { "properties": {}, "additionalProperties": false, "type": "object" }, "QuobyteVolumeSource": { "required": [ "registry", "volume" ], "properties": { "registry": { "type": "string" }, "volume": { "type": "string" }, "readOnly": { "type": "boolean" }, "user": { "type": "string" }, "group": { "type": "string" }, "tenant": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "RBDVolumeSource": { "required": [ "monitors", "image" ], "properties": { "monitors": { "items": { "type": "string" }, "type": "array" }, "image": { "type": "string" }, "fsType": { "type": "string" }, "pool": { "type": "string" }, "user": { "type": "string" }, "keyring": { "type": "string" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "RKEConfigNode": { "properties": { "nodeName": { "type": "string", "description": "Name of the host provisioned via docker machine" }, "address": { "type": "string", "description": "IP or FQDN that is fully resolvable and used for SSH communication" }, "port": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "description": "Port used for SSH communication" }, "internalAddress": { "type": "string", "description": "Optional - Internal address that will be used for components communication" }, "role": { "items": { "type": "string" }, "type": "array", "description": "Node role in kubernetes cluster (controlplane, worker, or etcd)" }, "hostnameOverride": { "type": "string", "description": "Optional - Hostname of the node" }, "user": { "type": "string", "description": "SSH usesr that will be used by RKE" }, "dockerSocket": { "type": "string", "description": "Optional - Docker socket on the node that will be used in tunneling" }, "sshAgentAuth": { "type": "boolean", "description": "SSH Agent Auth enable" }, "sshKey": { "type": "string", "description": "SSH Private Key" }, "sshKeyPath": { "type": "string", "description": "SSH Private Key Path" }, "sshCert": { "type": "string", "description": "SSH Certificate" }, "sshCertPath": { "type": "string", "description": "SSH Certificate Path" }, "labels": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object", "description": "Node Labels" }, "taints": { "items": { "$ref": "#/definitions/RKETaint" }, "type": "array", "description": "Node Taints" } }, "additionalProperties": false, "type": "object" }, "RKEConfigServices": { "properties": { "etcd": { "$ref": "#/definitions/ETCDService", "description": "Etcd Service" }, "kubeApi": { "$ref": "#/definitions/KubeAPIService", "description": "KubeAPI Service" }, "kubeController": { "$ref": "#/definitions/KubeControllerService", "description": "KubeController Service" }, "scheduler": { "$ref": "#/definitions/SchedulerService", "description": "Scheduler Service" }, "kubelet": { "$ref": "#/definitions/KubeletService", "description": "Kubelet Service" }, "kubeproxy": { "$ref": "#/definitions/KubeproxyService", "description": "KubeProxy Service" } }, "additionalProperties": false, "type": "object" }, "RKESystemImages": { "properties": { "etcd": { "type": "string", "description": "etcd image" }, "alpine": { "type": "string", "description": "Alpine image" }, "nginxProxy": { "type": "string", "description": "rke-nginx-proxy image" }, "certDownloader": { "type": "string", "description": "rke-cert-deployer image" }, "kubernetesServicesSidecar": { "type": "string", "description": "rke-service-sidekick image" }, "kubedns": { "type": "string", "description": "KubeDNS image" }, "dnsmasq": { "type": "string", "description": "DNSMasq image" }, "kubednsSidecar": { "type": "string", "description": "KubeDNS side car image" }, "kubednsAutoscaler": { "type": "string", "description": "KubeDNS autoscaler image" }, "coredns": { "type": "string", "description": "CoreDNS image" }, "corednsAutoscaler": { "type": "string", "description": "CoreDNS autoscaler image" }, "nodelocal": { "type": "string", "description": "Nodelocal image" }, "kubernetes": { "type": "string", "description": "Kubernetes image" }, "flannel": { "type": "string", "description": "Flannel image" }, "flannelCni": { "type": "string", "description": "Flannel CNI image" }, "calicoNode": { "type": "string", "description": "Calico Node image" }, "calicoCni": { "type": "string", "description": "Calico CNI image" }, "calicoControllers": { "type": "string", "description": "Calico Controllers image" }, "calicoCtl": { "type": "string", "description": "Calicoctl image" }, "calicoFlexVol": { "type": "string", "description": "CalicoFlexVol image" }, "canalNode": { "type": "string", "description": "Canal Node Image" }, "canalCni": { "type": "string", "description": "Canal CNI image" }, "canalControllers": { "type": "string", "description": "Canal Controllers Image needed for Calico/Canal v3.14.0+" }, "canalFlannel": { "type": "string", "description": "CanalFlannel image" }, "canalFlexVol": { "type": "string", "description": "CanalFlexVol image" }, "weaveNode": { "type": "string", "description": "Weave Node image" }, "weaveCni": { "type": "string", "description": "Weave CNI image" }, "podInfraContainer": { "type": "string", "description": "Pod infra container image" }, "ingress": { "type": "string", "description": "Ingress Controller image" }, "ingressBackend": { "type": "string", "description": "Ingress Controller Backend image" }, "ingressWebhook": { "type": "string", "description": "Ingress Webhook image" }, "metricsServer": { "type": "string", "description": "Metrics Server image" }, "windowsPodInfraContainer": { "type": "string", "description": "Pod infra container image for Windows" }, "aciCniDeployContainer": { "type": "string", "description": "Cni deployer container image for Cisco ACI" }, "aciHostContainer": { "type": "string", "description": "host container image for Cisco ACI" }, "aciOpflexContainer": { "type": "string", "description": "opflex agent container image for Cisco ACI" }, "aciMcastContainer": { "type": "string", "description": "mcast daemon container image for Cisco ACI" }, "aciOvsContainer": { "type": "string", "description": "OpenvSwitch container image for Cisco ACI" }, "aciControllerContainer": { "type": "string", "description": "Controller container image for Cisco ACI" }, "aciGbpServerContainer": { "type": "string", "description": "GBP Server container image for Cisco ACI" }, "aciOpflexServerContainer": { "type": "string", "description": "Opflex Server container image for Cisco ACI" } }, "additionalProperties": false, "type": "object" }, "RKETaint": { "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "effect": { "type": "string" }, "timeAdded": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "type": "object" }, "RancherKubernetesEngineConfig": { "properties": { "nodes": { "items": { "$ref": "#/definitions/RKEConfigNode" }, "type": "array", "description": "Kubernetes nodes" }, "services": { "$ref": "#/definitions/RKEConfigServices", "description": "Kubernetes components" }, "network": { "$ref": "#/definitions/NetworkConfig", "description": "Network configuration used in the kubernetes cluster (flannel, calico)" }, "authentication": { "$ref": "#/definitions/AuthnConfig", "description": "Authentication configuration used in the cluster (default: x509)" }, "addons": { "type": "string", "description": "YAML manifest for user provided addons to be deployed on the cluster" }, "addonsInclude": { "items": { "type": "string" }, "type": "array", "description": "List of urls or paths for addons" }, "systemImages": { "$ref": "#/definitions/RKESystemImages", "description": "List of images used internally for proxy, cert download and kubedns" }, "sshKeyPath": { "type": "string", "description": "SSH Private Key Path" }, "sshCertPath": { "type": "string", "description": "SSH Certificate Path" }, "sshAgentAuth": { "type": "boolean", "description": "SSH Agent Auth enable" }, "authorization": { "$ref": "#/definitions/AuthzConfig", "description": "Authorization mode configuration used in the cluster" }, "ignoreDockerVersion": { "type": "boolean", "description": "Enable/disable strict docker version checking" }, "enableCriDockerd": { "type": "boolean", "description": "Enable/disable using cri-dockerd" }, "kubernetesVersion": { "type": "string", "description": "Kubernetes version to use (if kubernetes image is specified, image version takes precedence)" }, "privateRegistries": { "items": { "$ref": "#/definitions/PrivateRegistry" }, "type": "array", "description": "List of private registries and their credentials" }, "ingress": { "$ref": "#/definitions/IngressConfig", "description": "Ingress controller used in the cluster" }, "clusterName": { "type": "string", "description": "Cluster Name used in the kube config" }, "cloudProvider": { "$ref": "#/definitions/CloudProvider", "description": "Cloud Provider options" }, "prefixPath": { "type": "string", "description": "kubernetes directory path" }, "winPrefixPath": { "type": "string", "description": "kubernetes directory path for windows" }, "addonJobTimeout": { "type": "integer", "description": "Timeout in seconds for status check on addon deployment jobs" }, "bastionHost": { "$ref": "#/definitions/BastionHost", "description": "Bastion/Jump Host configuration" }, "monitoring": { "$ref": "#/definitions/MonitoringConfig", "description": "Monitoring Config" }, "restore": { "$ref": "#/definitions/RestoreConfig", "description": "RestoreCluster flag" }, "rotateCertificates": { "$ref": "#/definitions/RotateCertificates", "description": "Rotating Certificates Option" }, "rotateEncryptionKey": { "type": "boolean", "description": "Rotate Encryption Key Option" }, "dns": { "$ref": "#/definitions/DNSConfig", "description": "DNS Config" }, "upgradeStrategy": { "$ref": "#/definitions/NodeUpgradeStrategy", "description": "Upgrade Strategy for the cluster" } }, "additionalProperties": false, "type": "object" }, "ResourceConfiguration": { "required": [ "resources", "providers" ], "properties": { "resources": { "items": { "type": "string" }, "type": "array" }, "providers": { "items": { "$ref": "#/definitions/ProviderConfiguration" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "ResourceFieldSelector": { "required": [ "resource" ], "properties": { "containerName": { "type": "string" }, "resource": { "type": "string" }, "divisor": { "$ref": "#/definitions/Quantity" } }, "additionalProperties": false, "type": "object" }, "ResourceRequirements": { "properties": { "limits": { "patternProperties": { ".*": { "$ref": "#/definitions/Quantity" } }, "type": "object" }, "requests": { "patternProperties": { ".*": { "$ref": "#/definitions/Quantity" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "RestoreConfig": { "properties": { "restore": { "type": "boolean" }, "snapshotName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "RollingUpdateDaemonSet": { "properties": { "maxUnavailable": { "$ref": "#/definitions/IntOrString" }, "maxSurge": { "$ref": "#/definitions/IntOrString" } }, "additionalProperties": false, "type": "object" }, "RollingUpdateDeployment": { "properties": { "maxUnavailable": { "$ref": "#/definitions/IntOrString" }, "maxSurge": { "$ref": "#/definitions/IntOrString" } }, "additionalProperties": false, "type": "object" }, "RotateCertificates": { "properties": { "caCertificates": { "type": "boolean", "description": "Rotate CA Certificates" }, "services": { "items": { "type": "string" }, "type": "array", "description": "Services to rotate their certs" } }, "additionalProperties": false, "type": "object" }, "RouteOpenstackOpts": { "required": [ "router-id" ], "properties": { "router-id": { "type": "string", "description": "required" } }, "additionalProperties": false, "type": "object" }, "S3BackupConfig": { "required": [ "endpoint" ], "properties": { "accessKey": { "type": "string" }, "secretKey": { "type": "string" }, "bucketName": { "type": "string" }, "region": { "type": "string" }, "endpoint": { "type": "string" }, "customCa": { "type": "string" }, "folder": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ScaleIOVolumeSource": { "required": [ "gateway", "system", "secretRef" ], "properties": { "gateway": { "type": "string" }, "system": { "type": "string" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "sslEnabled": { "type": "boolean" }, "protectionDomain": { "type": "string" }, "storagePool": { "type": "string" }, "storageMode": { "type": "string" }, "volumeName": { "type": "string" }, "fsType": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "SchedulerService": { "properties": { "image": { "type": "string" }, "extraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "extraBinds": { "items": { "type": "string" }, "type": "array" }, "extraEnv": { "items": { "type": "string" }, "type": "array" }, "winExtraArgs": { "patternProperties": { ".*": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "type": "object" }, "winExtraBinds": { "items": { "type": "string" }, "type": "array" }, "winExtraEnv": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "SecretKeySelector": { "required": [ "LocalObjectReference", "key" ], "properties": { "LocalObjectReference": { "$ref": "#/definitions/LocalObjectReference" }, "key": { "type": "string" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "SecretProjection": { "required": [ "LocalObjectReference" ], "properties": { "LocalObjectReference": { "$ref": "#/definitions/LocalObjectReference" }, "items": { "items": { "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "SecretVolumeSource": { "properties": { "secretName": { "type": "string" }, "items": { "items": { "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "defaultMode": { "type": "integer" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "SecretboxConfiguration": { "required": [ "keys" ], "properties": { "keys": { "items": { "$ref": "#/definitions/Key" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "SecretsEncryptionConfig": { "properties": { "enabled": { "type": "boolean", "description": "Enable/disable secrets encryption provider config" }, "customConfig": { "$ref": "#/definitions/EncryptionConfiguration", "description": "Custom Encryption Provider configuration object" } }, "additionalProperties": false, "type": "object" }, "ServiceAccountTokenProjection": { "required": [ "path" ], "properties": { "audience": { "type": "string" }, "expirationSeconds": { "type": "integer" }, "path": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ServiceOverride": { "required": [ "service", "region", "url", "signing-region", "signing-method", "signing-name" ], "properties": { "service": { "type": "string" }, "region": { "type": "string" }, "url": { "type": "string" }, "signing-region": { "type": "string" }, "signing-method": { "type": "string" }, "signing-name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "StorageOSVolumeSource": { "properties": { "volumeName": { "type": "string" }, "volumeNamespace": { "type": "string" }, "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" } }, "additionalProperties": false, "type": "object" }, "Time": { "properties": {}, "additionalProperties": false, "type": "object" }, "Toleration": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "effect": { "type": "string" }, "tolerationSeconds": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "TypeMeta": { "properties": { "kind": { "type": "string" }, "apiVersion": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "TypedLocalObjectReference": { "required": [ "apiGroup", "kind", "name" ], "properties": { "apiGroup": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Unknown": { "required": [ "TypeMeta", "Raw", "ContentEncoding", "ContentType" ], "properties": { "TypeMeta": { "$ref": "#/definitions/TypeMeta" }, "Raw": { "type": "string" }, "ContentEncoding": { "type": "string" }, "ContentType": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "VirtualCenterConfig": { "properties": { "user": { "type": "string" }, "password": { "type": "string" }, "port": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "datacenters": { "type": "string" }, "soap-roundtrip-count": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "VolumeProjection": { "properties": { "secret": { "$ref": "#/definitions/SecretProjection" }, "downwardAPI": { "$ref": "#/definitions/DownwardAPIProjection" }, "configMap": { "$ref": "#/definitions/ConfigMapProjection" }, "serviceAccountToken": { "$ref": "#/definitions/ServiceAccountTokenProjection" } }, "additionalProperties": false, "type": "object" }, "VolumeSource": { "properties": { "hostPath": { "$ref": "#/definitions/HostPathVolumeSource" }, "emptyDir": { "$ref": "#/definitions/EmptyDirVolumeSource" }, "gcePersistentDisk": { "$ref": "#/definitions/GCEPersistentDiskVolumeSource" }, "awsElasticBlockStore": { "$ref": "#/definitions/AWSElasticBlockStoreVolumeSource" }, "gitRepo": { "$ref": "#/definitions/GitRepoVolumeSource" }, "secret": { "$ref": "#/definitions/SecretVolumeSource" }, "nfs": { "$ref": "#/definitions/NFSVolumeSource" }, "iscsi": { "$ref": "#/definitions/ISCSIVolumeSource" }, "glusterfs": { "$ref": "#/definitions/GlusterfsVolumeSource" }, "persistentVolumeClaim": { "$ref": "#/definitions/PersistentVolumeClaimVolumeSource" }, "rbd": { "$ref": "#/definitions/RBDVolumeSource" }, "flexVolume": { "$ref": "#/definitions/FlexVolumeSource" }, "cinder": { "$ref": "#/definitions/CinderVolumeSource" }, "cephfs": { "$ref": "#/definitions/CephFSVolumeSource" }, "flocker": { "$ref": "#/definitions/FlockerVolumeSource" }, "downwardAPI": { "$ref": "#/definitions/DownwardAPIVolumeSource" }, "fc": { "$ref": "#/definitions/FCVolumeSource" }, "azureFile": { "$ref": "#/definitions/AzureFileVolumeSource" }, "configMap": { "$ref": "#/definitions/ConfigMapVolumeSource" }, "vsphereVolume": { "$ref": "#/definitions/VsphereVirtualDiskVolumeSource" }, "quobyte": { "$ref": "#/definitions/QuobyteVolumeSource" }, "azureDisk": { "$ref": "#/definitions/AzureDiskVolumeSource" }, "photonPersistentDisk": { "$ref": "#/definitions/PhotonPersistentDiskVolumeSource" }, "projected": { "$ref": "#/definitions/ProjectedVolumeSource" }, "portworxVolume": { "$ref": "#/definitions/PortworxVolumeSource" }, "scaleIO": { "$ref": "#/definitions/ScaleIOVolumeSource" }, "storageos": { "$ref": "#/definitions/StorageOSVolumeSource" }, "csi": { "$ref": "#/definitions/CSIVolumeSource" }, "ephemeral": { "$ref": "#/definitions/EphemeralVolumeSource" } }, "additionalProperties": false, "type": "object" }, "VsphereCloudProvider": { "properties": { "global": { "$ref": "#/definitions/GlobalVsphereOpts" }, "virtualCenter": { "patternProperties": { ".*": { "$ref": "#/definitions/VirtualCenterConfig" } }, "type": "object" }, "network": { "$ref": "#/definitions/NetworkVshpereOpts" }, "disk": { "$ref": "#/definitions/DiskVsphereOpts" }, "workspace": { "$ref": "#/definitions/WorkspaceVsphereOpts" } }, "additionalProperties": false, "type": "object" }, "VsphereVirtualDiskVolumeSource": { "required": [ "volumePath" ], "properties": { "volumePath": { "type": "string" }, "fsType": { "type": "string" }, "storagePolicyName": { "type": "string" }, "storagePolicyID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "WeaveNetworkProvider": { "properties": { "password": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "WorkspaceVsphereOpts": { "properties": { "server": { "type": "string" }, "datacenter": { "type": "string" }, "folder": { "type": "string" }, "default-datastore": { "type": "string" }, "resourcepool-path": { "type": "string" } }, "additionalProperties": false, "type": "object" } } }

shopware-project-schema.json

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "shopware-cli", "description": "shopware cli project configuration definition file", "$ref": "#/definitions/Config", "definitions": { "Config": { "type": "object", "title": ".shopware-project.yml", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "URL to Shopware instance" }, "admin_api": { "$ref": "#/definitions/AdminApi" }, "dump": { "$ref": "#/definitions/Dump" }, "sync": { "$ref": "#/definitions/Sync" }, "build": { "$ref": "#/definitions/Build" } } }, "Build": { "type": "object", "title": "Project Build Settings", "additionalProperties": false, "properties": { "disable_asset_copy": { "type": "boolean", "description": "When enabled, the assets will not be copied to the public folder", "default": false }, "remove_extension_assets": { "type": "boolean", "description": "When enabled, the assets of extensions will be removed from the extension public folder. (Requires Shopware 6.5.2.0)", "default": false }, "cleanup_paths": { "type": "array", "items": {"type": "string"}, "description": "Paths to delete for the final build" } } }, "AdminApi": { "type": "object", "title": "Admin API credentials", "additionalProperties": false, "properties": { "client_id": { "type": "string", "description": "Client ID of integration" }, "client_secret": { "type": "string", "description": "Client Secret of integration" }, "username": { "type": "string", "description": "Username of admin user" }, "password": { "type": "string", "description": "Password of admin user" }, "disable_ssl_check": { "type": "boolean", "description": "Disable SSL check for API requests", "default": false } } }, "Dump": { "type": "object", "title": "MySQL dump configuration", "additionalProperties": false, "properties": { "rewrite": { "type": "object" }, "nodata": { "type": "array", "items": {"type": "string"} }, "ignore": { "type": "array", "items": {"type": "string"} }, "where": { "type": "object" } } }, "Sync": { "type": "object", "title": "Sync Settings", "additionalProperties": false, "properties": { "config": { "type": "array", "items": {"$ref": "#/definitions/SyncConfigItem"} }, "theme": { "type": "array", "items": {"$ref": "#/definitions/ThemeConfigItem"} }, "mail_template": { "type": "array", "items": {"$ref": "#/definitions/MailTemplateItem"} }, "entity": { "type": "array", "items": {"$ref": "#/definitions/EntitySyncItem"} } } }, "SyncConfigItem": { "type": "object", "title": "System Config Sync", "additionalProperties": false, "properties": { "sales_channel": { "title": "Sales Channel to apply", "type": "string" }, "settings": { "type": "object" } }, "required": ["settings"] }, "ThemeConfigItem": { "type": "object", "title": "Theme Config Sync", "additionalProperties": false, "properties": { "name": { "type": "string" }, "settings": { "type": "object" } } }, "MailTemplateItem": { "type": "object", "title": "Mail Template Sync", "additionalProperties": false, "properties": { "id": { "type": "string" }, "translations": { "type": "array", "items": {"$ref": "#/definitions/MailTemplateItemTranslation"} } } }, "MailTemplateItemTranslation": { "type": "object", "title": "Mail Template Single Translation", "additionalProperties": false, "properties": { "language": { "type": "string" }, "sender_name": { "type": "string" }, "subject": { "type": "string" }, "html": { "type": "string" }, "plain": { "type": "string" }, "custom_fields": { "type": ["object", "null"] } } }, "EntitySyncItem": { "type": "object", "title": "Entity Sync", "additionalProperties": false, "properties": { "entity": { "type": "string" }, "exists": { "type": "array", "items": {"$ref": "#/definitions/EntitySyncFilter"} }, "payload": { "type": "object", "description": "API payload" } }, "required": ["entity", "payload"] }, "EntitySyncFilter": { "type": "object", "title": "Entity Sync Filter", "additionalProperties": false, "properties": { "type": { "type": "string", "enum": ["equals", "multi", "contains", "prefix", "suffix", "not", "range", "until", "equalsAll" ,"equalsAny"], "description": "filter type" }, "field": { "type": "string", "description": "field" }, "value": { "type": ["string", "integer", "array", "boolean", "null"], "description": "value" }, "operator": { "type": "string", "enum": ["AND", "OR", "XOR"] }, "queries": { "type": "array", "items": {"$ref": "#/definitions/EntitySyncFilterInner"} } }, "required": ["type", "field"], "allOf": [ { "if": { "properties": { "type": { "const": "multi" } } }, "then": { "required": ["type", "queries"] } } ] }, "EntitySyncFilterInner": { "type": "object", "title": "Entity Sync Filter", "additionalProperties": false, "properties": { "type": { "type": "string", "enum": ["equals", "multi", "contains", "prefix", "suffix", "not", "range", "until", "equalsAll" ,"equalsAny"], "description": "filter type" }, "field": { "type": "string", "description": "field" }, "value": { "type": ["string", "integer", "array", "boolean", "null"], "description": "value" }, "operator": { "type": "string", "enum": ["AND", "OR", "XOR"] } }, "required": ["type", "field"], "allOf": [ { "if": { "properties": { "type": { "const": "multi" } } }, "then": { "required": ["type", "queries"] } } ] } } }

version.schema.json

{ "$id": "https://github.com/ory/hydra/.schema/versions.config.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "oneOf": [ { "allOf": [ { "properties": { "version": { "const": "v2.2.0-rc.3" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.2.0-rc.3/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v2.2.0-rc.2" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.2.0-rc.2/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v2.1.2" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.1.2/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v2.1.1" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.1.1/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v2.1.0" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.1.0/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v2.0.3" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.0.3/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v2.0.2" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.0.2/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v2.0.1" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v2.0.1/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.11.7" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.11.7/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.7.0" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.7.0/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.7.4" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.7.4/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.8.5" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.8.5/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.9.0-alpha.1" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.9.0-alpha.1/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.9.0-alpha.2" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.9.0-alpha.2/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.9.0-alpha.3" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.9.0-alpha.3/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.9.0-rc.0" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.9.0-rc.0/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.9.0" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.9.0/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.9.1" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.9.1/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.9.2" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.9.2/.schema/config.schema.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.10.1" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.10.1/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.10.2" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.10.2/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.10.3" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.10.3/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.10.5" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.10.5/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.10.6" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.10.6/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.10.7" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.10.7/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.11.0" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.11.0/spec/config.json" } ] }, { "allOf": [ { "properties": { "version": { "const": "v1.11.6" } }, "required": [ "version" ] }, { "$ref": "https://raw.githubusercontent.com/ory/hydra/v1.11.6/spec/config.json" } ] }, { "allOf": [ { "oneOf": [ { "properties": { "version": { "type": "string", "maxLength": 0 } }, "required": [ "version" ] }, { "not": { "properties": { "version": {} }, "required": [ "version" ] } } ] }, { "$ref": "#/oneOf/0/allOf/1" } ] } ], "title": "All Versions of the ORY Hydra Configuration", "type": "object" }

jsbeautifyrc-nested.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/CHJProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/HJProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/CProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/HProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/JProperties" }, { "properties": { "css": { "type": "object", "allOf": [ { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/CHJProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/CProperties" } ] }, "js": { "type": "object", "allOf": [ { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/CHJProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/HJProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/JProperties" } ] }, "html": { "type": "object", "allOf": [ { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/CHJProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/HJProperties" }, { "$ref": "https://json.schemastore.org/jsbeautifyrc#/definitions/HProperties" } ] } } } ], "id": "https://json.schemastore.org/jsbeautifyrc-nested", "title": "JSON schema for beautifyrc", "type": "object" }

openrewrite.json

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "OpenRewrite Resource", "description": "Contains OpenRewrite resource descriptors like recipes and styles", "type": "object", "properties": { "type": { "description": "Identifies the resource type", "enum": [ "specs.openrewrite.org/v1beta/recipe", "specs.openrewrite.org/v1beta/style", "specs.openrewrite.org/v1beta/category", "specs.openrewrite.org/v1beta/example" ], "default": "specs.openrewrite.org/v1beta/recipe" } }, "required": [ "type" ], "allOf": [ { "if": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/recipe" } } }, "then": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/recipe" }, "name": { "type": "string" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "tags": { "$ref": "#/$defs/tags" }, "estimatedEffortPerOccurrence": { "type": "string", "format": "duration" }, "causesAnotherCycle": { "type": "boolean", "default": false }, "recipeList": { "$ref": "#/$defs/recipeList" } }, "required": [ "name" ], "additionalProperties": false } }, { "if": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/category" } } }, "then": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/category" }, "name": { "type": "string" }, "packageName": { "type": "string" }, "description": { "type": "string" }, "tags": { "$ref": "#/$defs/tags" }, "root": { "type": "boolean", "default": false }, "priority": { "type": "integer", "default": 0 } }, "required": [ "packageName" ], "additionalProperties": false } }, { "if": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/style" } } }, "then": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/style" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "tags": { "$ref": "#/$defs/tags" }, "styleConfigs": { "type": "array", "items": { "$ref": "#/$defs/style" } } }, "required": [ "name" ], "additionalProperties": false } }, { "if": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/example" } } }, "then": { "properties": { "type": { "const": "specs.openrewrite.org/v1beta/example" }, "recipe": { "type": "string" }, "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false } } ], "$defs": { "tags": { "type": "array", "items": { "type": "string" } }, "recipeList": { "type": "array", "items": { "$ref": "#/$defs/recipe" } }, "recipe": { "oneOf": [ { "type": "string" }, { "type": "object" } ] }, "style": { "oneOf": [ { "type": "string" }, { "type": "object" } ] } } }

configuration.json

{ "title": "DstackConfiguration", "discriminator": { "propertyName": "type", "mapping": { "dev-environment": "#/definitions/DevEnvironmentConfiguration", "task": "#/definitions/TaskConfiguration", "service": "#/definitions/ServiceConfiguration" } }, "oneOf": [ { "$ref": "#/definitions/DevEnvironmentConfiguration" }, { "$ref": "#/definitions/TaskConfiguration" }, { "$ref": "#/definitions/ServiceConfiguration" } ], "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "RegistryAuth": { "title": "RegistryAuth", "type": "object", "properties": { "username": { "title": "Username", "description": "Username", "type": "string" }, "password": { "title": "Password", "description": "Password or access token", "type": "string" } }, "required": [ "password" ], "additionalProperties": false }, "PythonVersion": { "title": "PythonVersion", "description": "An enumeration.", "enum": [ "3.7", "3.8", "3.9", "3.10", "3.11" ], "type": "string" }, "PortMapping": { "title": "PortMapping", "type": "object", "properties": { "local_port": { "title": "Local Port", "exclusiveMinimum": 0, "maximum": 65536, "type": "integer" }, "container_port": { "title": "Container Port", "exclusiveMinimum": 0, "maximum": 65536, "type": "integer" } }, "required": [ "container_port" ], "additionalProperties": false }, "DevEnvironmentConfiguration": { "title": "DevEnvironmentConfiguration", "type": "object", "properties": { "type": { "title": "Type", "default": "dev-environment", "enum": [ "dev-environment" ], "type": "string" }, "image": { "title": "Image", "description": "The name of the Docker image to run", "type": "string" }, "entrypoint": { "title": "Entrypoint", "description": "The Docker entrypoint", "type": "string" }, "home_dir": { "title": "Home Dir", "description": "The absolute path to the home directory inside the container", "default": "/root", "type": "string" }, "registry_auth": { "title": "Registry Auth", "description": "Credentials for pulling a private container", "allOf": [ { "$ref": "#/definitions/RegistryAuth" } ] }, "python": { "description": "The major version of Python\nMutually exclusive with the image", "allOf": [ { "$ref": "#/definitions/PythonVersion" } ] }, "env": { "title": "Env", "description": "The mapping or the list of environment variables", "default": {}, "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*=.*$" } }, { "type": "object", "additionalProperties": { "type": "string" } } ] }, "build": { "title": "Build", "description": "The bash commands to run during build stage", "default": [], "type": "array", "items": { "type": "string" } }, "setup": { "title": "Setup", "description": "The bash commands to run on the boot", "default": [], "type": "array", "items": { "type": "string" } }, "cache": { "title": "Cache", "description": "The directories to be cached between configuration runs", "default": [], "type": "array", "items": { "type": "string" } }, "ports": { "title": "Ports", "description": "Port numbers/mapping to expose", "default": [], "type": "array", "items": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 }, { "type": "string", "pattern": "^(?:[0-9]+|\\*):[0-9]+$" }, { "$ref": "#/definitions/PortMapping" } ] } }, "ide": { "title": "Ide", "description": "The IDE to run", "enum": [ "vscode" ], "type": "string" }, "init": { "title": "Init", "description": "The bash commands to run", "default": [], "type": "array", "items": { "type": "string" } } }, "required": [ "ide" ], "additionalProperties": false }, "Artifact": { "title": "Artifact", "type": "object", "properties": { "path": { "title": "Path", "description": "The path to the folder that must be stored as an output artifact", "type": "string" }, "mount": { "title": "Mount", "description": "Must be set to `true` if the artifact files must be saved in real-time", "default": false, "type": "boolean" } }, "required": [ "path" ], "additionalProperties": false }, "TaskConfiguration": { "title": "TaskConfiguration", "type": "object", "properties": { "type": { "title": "Type", "default": "task", "enum": [ "task" ], "type": "string" }, "image": { "title": "Image", "description": "The name of the Docker image to run", "type": "string" }, "entrypoint": { "title": "Entrypoint", "description": "The Docker entrypoint", "type": "string" }, "home_dir": { "title": "Home Dir", "description": "The absolute path to the home directory inside the container", "default": "/root", "type": "string" }, "registry_auth": { "title": "Registry Auth", "description": "Credentials for pulling a private container", "allOf": [ { "$ref": "#/definitions/RegistryAuth" } ] }, "python": { "description": "The major version of Python\nMutually exclusive with the image", "allOf": [ { "$ref": "#/definitions/PythonVersion" } ] }, "env": { "title": "Env", "description": "The mapping or the list of environment variables", "default": {}, "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*=.*$" } }, { "type": "object", "additionalProperties": { "type": "string" } } ] }, "build": { "title": "Build", "description": "The bash commands to run during build stage", "default": [], "type": "array", "items": { "type": "string" } }, "setup": { "title": "Setup", "description": "The bash commands to run on the boot", "default": [], "type": "array", "items": { "type": "string" } }, "cache": { "title": "Cache", "description": "The directories to be cached between configuration runs", "default": [], "type": "array", "items": { "type": "string" } }, "ports": { "title": "Ports", "description": "Port numbers/mapping to expose", "default": [], "type": "array", "items": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 }, { "type": "string", "pattern": "^(?:[0-9]+|\\*):[0-9]+$" }, { "$ref": "#/definitions/PortMapping" } ] } }, "commands": { "title": "Commands", "description": "The bash commands to run", "type": "array", "items": { "type": "string" } }, "artifacts": { "title": "Artifacts", "description": "The list of output artifacts", "default": [], "type": "array", "items": { "$ref": "#/definitions/Artifact" } } }, "required": [ "commands" ], "additionalProperties": false }, "ServiceConfiguration": { "title": "ServiceConfiguration", "type": "object", "properties": { "type": { "title": "Type", "default": "service", "enum": [ "service" ], "type": "string" }, "image": { "title": "Image", "description": "The name of the Docker image to run", "type": "string" }, "entrypoint": { "title": "Entrypoint", "description": "The Docker entrypoint", "type": "string" }, "home_dir": { "title": "Home Dir", "description": "The absolute path to the home directory inside the container", "default": "/root", "type": "string" }, "registry_auth": { "title": "Registry Auth", "description": "Credentials for pulling a private container", "allOf": [ { "$ref": "#/definitions/RegistryAuth" } ] }, "python": { "description": "The major version of Python\nMutually exclusive with the image", "allOf": [ { "$ref": "#/definitions/PythonVersion" } ] }, "env": { "title": "Env", "description": "The mapping or the list of environment variables", "default": {}, "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*=.*$" } }, { "type": "object", "additionalProperties": { "type": "string" } } ] }, "build": { "title": "Build", "description": "The bash commands to run during build stage", "default": [], "type": "array", "items": { "type": "string" } }, "setup": { "title": "Setup", "description": "The bash commands to run on the boot", "default": [], "type": "array", "items": { "type": "string" } }, "cache": { "title": "Cache", "description": "The directories to be cached between configuration runs", "default": [], "type": "array", "items": { "type": "string" } }, "commands": { "title": "Commands", "description": "The bash commands to run", "type": "array", "items": { "type": "string" } }, "port": { "title": "Port", "description": "The port, that application listens to or the mapping", "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 }, { "type": "string", "pattern": "^[0-9]+:[0-9]+$" }, { "$ref": "#/definitions/PortMapping" } ] }, "gateway": { "title": "Gateway", "description": "The gateway IP address or domain to publish the service", "type": "string" } }, "required": [ "commands", "port", "gateway" ], "additionalProperties": false } } }

gherking.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://gherking.github.io/gherking/gherking.schema.json", "title": "GherKing configuration", "properties": { "$schema": { "type": "string", "description": "The explicit schema set. It is optional, as GherKing is supported by schemastore.org, thus most IDE." }, "source": { "type": "string", "description": "The source folder or glob pattern of the input feature files.", "minLength": 1 }, "base": { "type": "string", "description": "The base folder of the input feature files.", "minLength": 1 }, "destination": { "type": "string", "description": "The destination folder to put the output feature files.", "minLength": 1 }, "clean": { "type": "boolean", "description": "Whether the destination directory should be clean in advance.", "default": false }, "verbose": { "type": "boolean", "description": "Whether some information should be displayed on the screen.", "default": false }, "install": { "type": "boolean", "description": "Whether the missing precompilers (gpc-* packages) should be installed and save to the package.json. Packages will be installed in the current folder, and package.json created if it is not there yet.", "default": false }, "compilers": { "type": "array", "description": "The precompilers to use and their configuration.", "items": { "anyOf": [ { "$ref": "#/definitions/gpcCustom" }, { "$ref": "#/definitions/gpcFilter" }, { "$ref": "#/definitions/gpcForLoop" }, { "$ref": "#/definitions/gpcLicense" }, { "$ref": "#/definitions/gpcMacro" }, { "$ref": "#/definitions/gpcRemoveComments" }, { "$ref": "#/definitions/gpcRemoveDuplicates" }, { "$ref": "#/definitions/gpcReplacer" }, { "$ref": "#/definitions/gpcScenarioNumbering" }, { "$ref": "#/definitions/gpcScenarioOutlineExpander" }, { "$ref": "#/definitions/gpcScenarioOutlineNumbering" }, { "$ref": "#/definitions/gpcStepGroups" }, { "$ref": "#/definitions/gpcTestData" } ] }, "minItems": 1 }, "formatOptions": { "$ref": "#/definitions/formatOptions" } }, "required": [ "compilers" ], "additionalProperties": false, "definitions": { "gpcCustom": { "title": "custom precompiler", "description": "A custom precompiler configuration, implemented either as an object or a PreCompiler class.", "type": "object", "properties": { "path": { "type": "string", "description": "Either the NPM package name to use, or the path to a JS file containing a PreCompiler.", "minLength": 1 }, "configuration": { "type": "object", "description": "The configuration object, if necessary, to be passed to the custom precompiler class." } }, "required": [ "path" ], "additionalProperties": false }, "gpcReplacer": { "title": "gpc-replacer", "description": "This GherKing Precompiler is responsible to replace keys in feature files with given values.", "type": "object", "properties": { "path": { "const": "gpc-replacer" }, "configuration": { "type": "object", "description": "The key-value pairs to replace in the feature files.", "minProperties": 1, "patternProperties": { "^[a-zA-Z0-9_-]+$": { "type": [ "string", "integer", "boolean", "number" ] } } } }, "required": [ "path", "configuration" ], "additionalProperties": false }, "gpcFilter": { "title": "gpc-filter", "description": "The Filter precompiler is responsible for including or excluding the elements of a feature file in the result, which match a cucumber-tag-expression (e.g., has a given tag, does not have a given tag).", "type": "object", "properties": { "path": { "const": "gpc-filter" }, "configuration": { "type": "string", "description": "Cucumber-tag-expression the filtering is based on", "default": "not @wip", "minLength": 1, "pattern": "^.*@[^ ]+.*$", "$comment": "The pattern must contain at least one cucumber tag." } }, "required": [ "path" ], "additionalProperties": false }, "gpcForLoop": { "title": "gpc-for-loop", "description": "A precompiler of GherKing to loop scenarios and scenario outlines to repeat them.", "type": "object", "properties": { "path": { "const": "gpc-for-loop" }, "configuration": { "type": "object", "properties": { "maxValue": { "type": "integer", "description": "Maximum value of iteration.", "default": 10, "minimum": 0 }, "tagName": { "type": "string", "description": "Tag used to mark scenarios or outlines to be repeated.", "default": "loop", "pattern": "^[^ ]+$", "minLength": 1 }, "format": { "type": "string", "description": "Format of the scenario or outline name after repeating. These tokens must be used: ${name}, ${i}.", "default": "${name} (${i})", "minLength": 11, "allOf": [ { "pattern": "^.*\\$\\{name\\}.*$" }, { "pattern": "^.*\\$\\{i\\}.*$" } ] }, "limitToMaxValue": { "type": "boolean", "description": "Whether higher iteration values than the max should be limited to the max or error should be thrown (false).", "default": true } }, "additionalProperties": false } }, "required": [ "path" ], "additionalProperties": false }, "gpcMacro": { "title": "gpc-macro", "description": "This precompiler is responsible for defining macros in feature files and then executing them.", "type": "object", "properties": { "path": { "const": "gpc-macro" } }, "required": [ "path" ], "additionalProperties": false }, "gpcRemoveComments": { "title": "gpc-remove-comments", "description": "This precompiler removes all or particular type of semantic comments from the feature file.", "type": "object", "properties": { "path": { "const": "gpc-remove-comments" }, "configuration": { "type": "object", "properties": { "keep": { "type": "array", "description": "To set which comment types should be kept, not removed.", "items": { "type": "string", "enum": [ "NONE", "BEFORE_TAGS", "PRECEDING", "DESCRIPTION", "TAG", "ROW", "DOC_STRING", "STEP", "START", "END", "ALL" ] }, "minItems": 1 } }, "additionalProperties": false } }, "required": [ "path" ], "additionalProperties": false }, "gpcRemoveDuplicates": { "title": "gpc-remove-duplicates", "description": "The RemoveDuplicates precompiler is responsible for having only a reasonable amount of tags and/or rows in each feature file.", "type": "object", "properties": { "path": { "const": "gpc-remove-duplicates" }, "configuration": { "type": "object", "properties": { "processTags": { "type": "boolean", "description": "Should tags on the same level and from parent be de-duplicated.", "default": true }, "processRows": { "type": "boolean", "description": "Should table rows be de-duplicated.", "default": false } }, "additionalProperties": false } }, "required": [ "path" ], "additionalProperties": false }, "gpcScenarioNumbering": { "title": "gpc-scenario-numbering", "description": "The ScenarioNumbering precompiler is responsible for adding an index to all scenarios and scenario outlines.", "type": "object", "properties": { "path": { "const": "gpc-scenario-numbering" }, "configuration": { "type": "object", "properties": { "format": { "type": "string", "description": "The format, how index should be added to the name of the scenario/scenairo outline. Possible tokens: ${name} the original name, ${i} the index", "default": "${i}. ${name}", "minLength": 11, "allOf": [ { "pattern": "^.*\\$\\{name\\}.*$" }, { "pattern": "^.*\\$\\{i\\}.*$" } ] } }, "additionalProperties": false } }, "required": [ "path" ], "additionalProperties": false }, "gpcScenarioOutlineExpander": { "title": "gpc-scenario-outline-expander", "description": "This precompiler is responsible for converting Scenario Outlines to single Scenarios as Cucumber would do and adds the first column as a tag.", "type": "object", "properties": { "path": { "const": "gpc-scenario-outline-expander" }, "configuration": { "type": "object", "properties": { "ignoreTag": { "type": "string", "description": "Tag used to mark scenarios to be ignored during expanding Scenario Outlines.", "default": "@notExpand", "minLength": 2, "pattern": "^@[^ ]+$" } }, "additionalProperties": false } }, "required": [ "path" ], "additionalProperties": false }, "gpcScenarioOutlineNumbering": { "title": "gpc-scenario-outline-numbering", "description": "This precompiler can add numbering column to Examples tables, and apply formatting to the name of the Scenario Outline.", "type": "object", "properties": { "path": { "const": "gpc-scenario-outline-numbering" }, "configuration": { "type": "object", "properties": { "addParameters": { "type": "boolean", "description": "Should the example parameters be added to the name of the Scenario Outline.", "default": false }, "parameterDelimiter": { "type": "string", "description": "The delimiter to use when adding the parameters to the name of the Scenario Outline.", "default": ",", "minLength": 1 }, "parameterFormat": { "type": "string", "description": "The format how the output Scenario Outline name should look with the parameters. Tokens to use: ${name}, ${parameters}", "default": "${name} - ${parameters}", "minLength": 20, "allOf": [ { "pattern": "^.*\\$\\{name\\}.*$" }, { "pattern": "^.*\\$\\{parameters\\}.*$" } ] }, "addNumbering": { "type": "boolean", "description": "Should an index be added to the name of the Scenario Outline.", "default": true }, "numberingFormat": { "type": "string", "description": "The format how the output Scenario Outline name should look with the index. Tokens to use: ${name}, ${i}", "default": "${i} - ${name}", "minLength": 11, "allOf": [ { "pattern": "^.*\\$\\{name\\}.*$" }, { "pattern": "^.*\\$\\{i\\}.*$" } ] }, "strictNaming": { "type": "boolean", "description": "Should the existing numbering field (num) block execution (true) or be used for numbering (false).", "default": false } }, "additionalProperties": false } }, "required": [ "path" ], "additionalProperties": false }, "gpcStepGroups": { "title": "gpc-step-groups", "description": "The StepGroups precompiler is responsible for correcting the gherkin keywords of steps to make the tests more readable.", "type": "object", "properties": { "path": { "const": "gpc-step-groups" } }, "required": [ "path" ], "additionalProperties": false }, "gpcTestData": { "title": "gpc-test-data", "description": "This precompiler can load external data (JSON, CSV, or XLS/XLSX) into exmaples table.", "type": "object", "properties": { "path": { "const": "gpc-test-data" }, "configuration": { "type": "object", "properties": { "keepTag": { "type": "boolean", "description": "Whether the load-tags should be kept or removed.", "default": false }, "defaultValue": { "type": [ "string", "number" ], "description": "The default value to be added to the table if a column/value is not found.", "default": "" }, "appendData": { "type": "boolean", "description": "Whether the loaded data should be appended to the existing rows of the examples table or overwritten.", "default": true }, "ignoreKeyCase": { "type": "boolean", "description": "Whether the casing of the example columns and data columns should be ignored.", "default": true } }, "additionalProperties": false } }, "required": [ "path" ], "additionalProperties": false }, "gpcLicense": { "title": "gpc-license", "description": "This precompiler can be used to inject License statement into the feature files.", "type": "object", "properties": { "path": { "const": "gpc-license" }, "configuration": { "type": "object", "properties": { "licenseFile": { "type": "string", "description": "The file's path where the license is stored.", "minLength": 1 }, "licenseText": { "type": "string", "description": "The exact license text. It can contain the ${LICENSE} token to set the content of the license file.", "minLength": 1 }, "placement": { "type": "string", "description": "The place to inject the license text, either in start or end comment.", "enum": [ "start", "end" ] } }, "$comment": "Either licenseFile or licenseText must be set!", "additionalProperties": false, "anyOf": [ { "required": [ "licenseFile" ] }, { "required": [ "licenseText" ] } ] } }, "required": [ "path", "configuration" ], "additionalProperties": false }, "formatOptions": { "type": "object", "description": "Options to pass to gherkin-formatter, on how to format the output feature files.", "properties": { "oneTagPerLine": { "type": "boolean", "description": "Should the tags be rendered separately, one by line?", "default": false }, "separateStepGroups": { "type": "boolean", "description": "Should step groups (when-then) be separated?", "default": false }, "compact": { "type": "boolean", "description": "Should empty lines be skipped, removed from the result?", "default": false }, "lineBreak": { "type": [ "string", "null" ], "description": "The line break character(s).", "default": null }, "indentation": { "type": "string", "description": "The indentation character(s).", "default": " " } }, "additionalProperties": false } } }

prettierrc.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "optionsDefinition": { "type": "object", "properties": { "arrowParens": { "description": "Include parentheses around a sole arrow function parameter.", "default": "always", "oneOf": [ { "enum": ["always"], "description": "Always include parens. Example: `(x) => x`" }, { "enum": ["avoid"], "description": "Omit parens when possible. Example: `x => x`" } ] }, "bracketSameLine": { "description": "Put > of opening tags on the last line instead of on a new line.", "default": false, "type": "boolean" }, "bracketSpacing": { "description": "Print spaces between brackets.", "default": true, "type": "boolean" }, "cursorOffset": { "description": "Print (to stderr) where a cursor at the given position would move to after formatting.\nThis option cannot be used with --range-start and --range-end.", "default": -1, "type": "integer" }, "editorconfig": { "description": "Whether parse the .editorconfig file in your project and convert its properties to the corresponding Prettier configuration. This configuration will be overridden by .prettierrc, etc.", "default": false, "type": "boolean" }, "embeddedLanguageFormatting": { "description": "Control how Prettier formats quoted code embedded in the file.", "default": "auto", "oneOf": [ { "enum": ["auto"], "description": "Format embedded code if Prettier can automatically identify it." }, { "enum": ["off"], "description": "Never automatically format embedded code." } ] }, "endOfLine": { "description": "Which end of line characters to apply.", "default": "lf", "oneOf": [ { "enum": ["lf"], "description": "Line Feed only (\\n), common on Linux and macOS as well as inside git repos" }, { "enum": ["crlf"], "description": "Carriage Return + Line Feed characters (\\r\\n), common on Windows" }, { "enum": ["cr"], "description": "Carriage Return character only (\\r), used very rarely" }, { "enum": ["auto"], "description": "Maintain existing\n(mixed values within one file are normalised by looking at what's used after the first line)" } ] }, "filepath": { "description": "Specify the input filepath. This will be used to do parser inference.", "type": "string" }, "htmlWhitespaceSensitivity": { "description": "How to handle whitespaces in HTML.", "default": "css", "oneOf": [ { "enum": ["css"], "description": "Respect the default value of CSS display property." }, { "enum": ["strict"], "description": "Whitespaces are considered sensitive." }, { "enum": ["ignore"], "description": "Whitespaces are considered insensitive." } ] }, "insertPragma": { "description": "Insert @format pragma into file's first docblock comment.", "default": false, "type": "boolean" }, "jsxSingleQuote": { "description": "Use single quotes in JSX.", "default": false, "type": "boolean" }, "parser": { "description": "Which parser to use.", "anyOf": [ { "enum": ["flow"], "description": "Flow" }, { "enum": ["babel"], "description": "JavaScript" }, { "enum": ["babel-flow"], "description": "Flow" }, { "enum": ["babel-ts"], "description": "TypeScript" }, { "enum": ["typescript"], "description": "TypeScript" }, { "enum": ["acorn"], "description": "JavaScript" }, { "enum": ["espree"], "description": "JavaScript" }, { "enum": ["meriyah"], "description": "JavaScript" }, { "enum": ["css"], "description": "CSS" }, { "enum": ["less"], "description": "Less" }, { "enum": ["scss"], "description": "SCSS" }, { "enum": ["json"], "description": "JSON" }, { "enum": ["json5"], "description": "JSON5" }, { "enum": ["json-stringify"], "description": "JSON.stringify" }, { "enum": ["graphql"], "description": "GraphQL" }, { "enum": ["markdown"], "description": "Markdown" }, { "enum": ["mdx"], "description": "MDX" }, { "enum": ["vue"], "description": "Vue" }, { "enum": ["yaml"], "description": "YAML" }, { "enum": ["glimmer"], "description": "Ember / Handlebars" }, { "enum": ["html"], "description": "HTML" }, { "enum": ["angular"], "description": "Angular" }, { "enum": ["lwc"], "description": "Lightning Web Components" }, { "type": "string", "description": "Custom parser" } ] }, "pluginSearchDirs": { "description": "Custom directory that contains prettier plugins in node_modules subdirectory.\nOverrides default behavior when plugins are searched relatively to the location of Prettier.\nMultiple values are accepted.", "default": [], "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "enum": [false], "description": "Disable plugin autoloading." } ] }, "plugins": { "description": "Add a plugin. Multiple plugins can be passed as separate `--plugin`s.", "default": [], "type": "array", "items": { "type": "string" } }, "printWidth": { "description": "The line length where Prettier will try wrap.", "default": 80, "type": "integer" }, "proseWrap": { "description": "How to wrap prose.", "default": "preserve", "oneOf": [ { "enum": ["always"], "description": "Wrap prose if it exceeds the print width." }, { "enum": ["never"], "description": "Do not wrap prose." }, { "enum": ["preserve"], "description": "Wrap prose as-is." } ] }, "quoteProps": { "description": "Change when properties in objects are quoted.", "default": "as-needed", "oneOf": [ { "enum": ["as-needed"], "description": "Only add quotes around object properties where required." }, { "enum": ["consistent"], "description": "If at least one property in an object requires quotes, quote all properties." }, { "enum": ["preserve"], "description": "Respect the input use of quotes in object properties." } ] }, "rangeEnd": { "description": "Format code ending at a given character offset (exclusive).\nThe range will extend forwards to the end of the selected statement.\nThis option cannot be used with --cursor-offset.", "default": null, "type": "integer" }, "rangeStart": { "description": "Format code starting at a given character offset.\nThe range will extend backwards to the start of the first line containing the selected statement.\nThis option cannot be used with --cursor-offset.", "default": 0, "type": "integer" }, "requirePragma": { "description": "Require either '@prettier' or '@format' to be present in the file's first docblock comment\nin order for it to be formatted.", "default": false, "type": "boolean" }, "semi": { "description": "Print semicolons.", "default": true, "type": "boolean" }, "singleAttributePerLine": { "description": "Enforce single attribute per line in HTML, Vue and JSX.", "default": false, "type": "boolean" }, "singleQuote": { "description": "Use single quotes instead of double quotes.", "default": false, "type": "boolean" }, "tabWidth": { "description": "Number of spaces per indentation level.", "default": 2, "type": "integer" }, "trailingComma": { "description": "Print trailing commas wherever possible when multi-line.", "default": "es5", "oneOf": [ { "enum": ["es5"], "description": "Trailing commas where valid in ES5 (objects, arrays, etc.)" }, { "enum": ["none"], "description": "No trailing commas." }, { "enum": ["all"], "description": "Trailing commas wherever possible (including function arguments)." } ] }, "useTabs": { "description": "Indent with tabs instead of spaces.", "default": false, "type": "boolean" }, "vueIndentScriptAndStyle": { "description": "Indent script and style tags in Vue files.", "default": false, "type": "boolean" } } }, "overridesDefinition": { "type": "object", "properties": { "overrides": { "type": "array", "description": "Provide a list of patterns to override prettier configuration.", "items": { "type": "object", "required": ["files"], "properties": { "files": { "description": "Include these files in this override.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "excludeFiles": { "description": "Exclude these files from this override.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "options": { "type": "object", "description": "The options to apply for this override.", "$ref": "#/definitions/optionsDefinition" } }, "additionalProperties": false } } } } }, "id": "https://json.schemastore.org/prettierrc.json", "oneOf": [ { "type": "object", "allOf": [ { "$ref": "#/definitions/optionsDefinition" }, { "$ref": "#/definitions/overridesDefinition" } ] }, { "type": "string" } ], "title": "Schema for .prettierrc" }

lotus.yaml.json

{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://github.com/grnhse/lotus/pkg/types/lotus-manifest","$ref":"#/$defs/LotusManifest","$defs":{"Autoscaling":{"properties":{"metrics":{"items":{"$ref":"#/$defs/AutoscalingMetrics"},"type":"array"}},"additionalProperties":false,"type":"object","required":["metrics"]},"AutoscalingMetrics":{"properties":{"name":{"type":"string"},"query":{"type":"string"},"average_value":{"type":"integer"}},"additionalProperties":false,"type":"object","required":["name","query","average_value"]},"ClientOf":{"properties":{"name":{"type":"string"},"type":{"type":"string"},"application":{"type":"string"}},"additionalProperties":false,"type":"object","required":["name","type","application"]},"Component":{"properties":{"livenessProbe":{"$ref":"#/$defs/Probe","description":"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"},"readinessProbe":{"$ref":"#/$defs/Probe","description":"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"},"name":{"type":"string","maxLength":24,"pattern":"^[a-z][a-z\\d-\\.]*[a-z\\d]$","description":"Unique name for the component. It must be DNS-friendly"},"type":{"type":"string","enum":["http","worker","predeploy","grpc-sso-proxy","cron"],"description":"The type of component."},"service_name":{"type":"string","description":"The service name is only useful for grpc-sso-proxy components. If present,\na health service will be spun up for the service name, and it can be\npossible to perform auto updates of binaries."},"command":{"type":"string","description":"Command describes how to run the workload"},"rollingUpdate":{"$ref":"#/$defs/RollingUpdateDeployment"},"sso_proxy":{"$ref":"#/$defs/SSOProxy","description":"SSO Proxy settings for http components (grpc-sso-proxy has it enabled by default)"},"autoscaling":{"$ref":"#/$defs/Autoscaling","description":"Autoscaling settings for components of type http, grpc-sso-proxy or worker"}},"additionalProperties":false,"type":"object","required":["name","type","command"]},"Datastore":{"properties":{"name":{"type":"string","maxLength":24,"pattern":"^[a-z][a-z\\d-\\.]*[a-z\\d]$"},"type":{"type":"string"},"className":{"type":"string"},"disableFirewallRules":{"type":"boolean"},"postgresOptions":{"type":"object"},"elasticsearchOptions":{"type":"object"},"kafkaOptions":{"type":"object"},"kafkaClientOptions":{"type":"object"},"kafkaConnectorOptions":{"type":"object"},"opensearchOptions":{"type":"object"},"clientOf":{"$ref":"#/$defs/ClientOf","description":"datastores that connect to otherones need to pass in the reference claim here"}},"additionalProperties":false,"type":"object","required":["name","type"]},"ExecAction":{"properties":{"command":{"items":{"type":"string"},"type":"array"}},"additionalProperties":false,"type":"object"},"GRPCAction":{"properties":{"port":{"type":"integer"},"service":{"type":"string"}},"additionalProperties":false,"type":"object","required":["port","service"]},"HTTPGetAction":{"properties":{"path":{"type":"string"},"port":{"$ref":"#/$defs/IntOrString"},"host":{"type":"string"},"scheme":{"type":"string"},"httpHeaders":{"items":{"$ref":"#/$defs/HTTPHeader"},"type":"array"}},"additionalProperties":false,"type":"object","required":["port"]},"HTTPHeader":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false,"type":"object","required":["name","value"]},"IntOrString":{"properties":{"Type":{"type":"integer"},"IntVal":{"type":"integer"},"StrVal":{"type":"string"}},"additionalProperties":false,"type":"object","required":["Type","IntVal","StrVal"]},"LotusManifest":{"properties":{"name":{"type":"string","maxLength":24,"pattern":"^[a-z][a-z\\d-\\.]*[a-z\\d]$","title":"application name","description":"The application name should match the repository's"},"components":{"items":{"$ref":"#/$defs/Component"},"type":"array","description":"Workloads to run"},"auth_tokens":{"items":{"type":"string"},"type":"array","description":"Tokens minted to securely interact with other applications"},"firewall_rules":{"items":{"type":"string"},"type":"array","description":"Named egress rules"},"datastores":{"items":{"$ref":"#/$defs/Datastore"},"type":"array","description":"List of datastores to provision"}},"additionalProperties":false,"type":"object","required":["name","components"]},"Probe":{"properties":{"exec":{"$ref":"#/$defs/ExecAction"},"httpGet":{"$ref":"#/$defs/HTTPGetAction"},"tcpSocket":{"$ref":"#/$defs/TCPSocketAction"},"grpc":{"$ref":"#/$defs/GRPCAction"},"initialDelaySeconds":{"type":"integer"},"timeoutSeconds":{"type":"integer"},"periodSeconds":{"type":"integer"},"successThreshold":{"type":"integer"},"failureThreshold":{"type":"integer"},"terminationGracePeriodSeconds":{"type":"integer"}},"additionalProperties":false,"type":"object"},"RollingUpdateDeployment":{"properties":{"maxUnavailable":{"$ref":"#/$defs/IntOrString"},"maxSurge":{"$ref":"#/$defs/IntOrString"}},"additionalProperties":false,"type":"object"},"SSOProxy":{"properties":{"enabled":{"type":"boolean"},"pass_auth_header":{"type":"boolean","description":"pass OIDC IDToken to upstream via Authorization Bearer header"},"allow_bearer_auth":{"type":"boolean","description":"skip requests that have verified JWT bearer tokens"},"skip_auth":{"items":{"type":"string"},"type":"array","description":"bypass authentication for requests that match the method \u0026 path. Format: method=path_regex OR path_regex alone for all methods"}},"additionalProperties":false,"type":"object"},"TCPSocketAction":{"properties":{"port":{"$ref":"#/$defs/IntOrString"},"host":{"type":"string"}},"additionalProperties":false,"type":"object","required":["port"]}}}

api.json

{"openapi":"3.0.2","components":{"parameters":{"$filter":{"name":"$filter","in":"query","description":"\n An OData filter\n\n http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter\n ","schema":{"type":"string"}},"$orderby":{"name":"$orderby","in":"query","description":"\n An OData filter\n\n http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter\n ","schema":{"type":"string"}},"$select":{"name":"$select","in":"query","description":"\n The OData `$select` query option.\n\n This is a comma separated string of fields to select. Only filtering flat properties is\n supported.\n\n http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect\n ","schema":{"type":"string"}},"$team":{"name":"$team","in":"query","description":"A custom filter for filtering the query by teams the requesting user is a member of.","schema":{"enum":["member","manager"]}},"$top":{"name":"$top","in":"query","description":"Limit the number of entities returned.","schema":{"type":"string"}},"appId":{"name":"appId","in":"path","description":"The ID of the app on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/App/properties/id"}},"appOAuth2SecretId":{"name":"appOAuth2SecretId","in":"path","description":"The ID of the app OAuth2 secret on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/AppOAuth2Secret/properties/id"}},"appSamlSecretId":{"name":"appSamlSecretId","in":"path","description":"The ID of the app SAML secret on which to perform an operation","required":true,"schema":{"type":"string"}},"appServiceId":{"name":"appServiceId","in":"path","description":"The id of the app service secret on which to perform an operation","required":true,"schema":{"type":"string"}},"assetId":{"name":"assetId","in":"path","description":"The ID of the asset on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/Asset/properties/id"}},"blockId":{"name":"blockId","in":"path","description":"The ID of the block on which to perform an operation, but without the organization scope.","required":true,"schema":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}},"blockVersion":{"name":"blockVersion","in":"path","description":"The version of the block on which to perform an operation.","required":true,"schema":{"$ref":"#/components/schemas/BlockVersion/properties/version"}},"endpoint":{"name":"endpoint","in":"query","description":"The URL of the endpoint associated with the subscription.","required":true,"schema":{"type":"string","format":"uri"}},"language":{"name":"language","in":"path","description":"The language on which to perform an operation","required":true,"schema":{"type":"string"}},"organizationId":{"name":"organizationId","in":"path","description":"The ID of the organization on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/Organization/properties/id"}},"resourceId":{"name":"resourceId","in":"path","description":"The ID of the resource on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/Resource/properties/id"}},"resourceType":{"name":"resourceType","in":"path","description":"The type of the resource on which to perform an operation","required":true,"schema":{"type":"string"}},"screenshotId":{"name":"screenshotId","in":"path","description":"The ID of the app an app screenshot","required":true,"schema":{"type":"number"}},"view":{"name":"view","in":"query","description":"The view of the resource to fetch.","schema":{"type":"string"}}},"requestBodies":{"oauth2Consent":{"description":"The OAuth2 client credentials","required":true,"content":{"application/json":{"schema":{"type":"object","required":["appId","redirectUri","scope"],"description":"A representation of a user’s OAuth2 consent when logging in to an app.","additionalProperties":false,"properties":{"appId":{"type":"number","description":"The app ID to manage the OAuth2 consent for"},"redirectUri":{"type":"string","format":"uri","description":"The URI to redirect the user back to."},"scope":{"type":"string","description":"The OAuth2 scope requested by the app."}}}}}},"resource":{"description":"A resource definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}},"multipart/form-data":{"schema":{"type":"object","required":["resource"],"description":"A `multipart/form-data` representation of a resource.","additionalProperties":false,"properties":{"resource":{"$ref":"#/components/schemas/Resource"},"assets":{"type":"array","description":"A list of assets that should be linked to the resource.","items":{"type":"string","format":"binary"}}}}}}},"user":{"description":"A user profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"responses":{"app":{"description":"An app response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"blockVersion":{"description":"A block definition response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockVersion"}}}},"default":{"description":"The default error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"invite":{"description":"An invite response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"oauth2AuthorizationCode":{"description":"An OAuth2 authorization code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"organization":{"description":"An organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"resource":{"description":"A resource response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}},"text/csv":{"schema":{"type":"string"}}}},"subscriptions":{"description":"A subscription response.","content":{"application/json":{"schema":{"type":"object","description":"A mapping of resources names to resource subscriptions.","additionalProperties":{"$ref":"#/components/schemas/ResourceSubscription"}}}}}},"schemas":{"ActionDefinition":{"allOf":[{"type":"object","description":"The base properties of an action definition.","additionalProperties":true,"properties":{"remapBefore":{"$ref":"#/components/schemas/RemapperDefinition","description":"This may be used to remap data before it is passed into the action function."},"remapAfter":{"$ref":"#/components/schemas/RemapperDefinition","description":"This may be used to remap data after it is passed into the action function."},"onSuccess":{"$ref":"#/components/schemas/ActionDefinition","description":"Another action that is dispatched when the action has been dispatched successfully."},"onError":{"$ref":"#/components/schemas/ActionDefinition","description":"Another action that is dispatched when the action has failed to dispatch successfully."}}},{"anyOf":[{"$ref":"#/components/schemas/AnalyticsActionDefinition"},{"$ref":"#/components/schemas/ConditionActionDefinition"},{"$ref":"#/components/schemas/DialogActionDefinition"},{"$ref":"#/components/schemas/DialogErrorActionDefinition"},{"$ref":"#/components/schemas/DialogOkActionDefinition"},{"$ref":"#/components/schemas/DownloadActionDefinition"},{"$ref":"#/components/schemas/EachActionDefinition"},{"$ref":"#/components/schemas/EmailActionDefinition"},{"$ref":"#/components/schemas/EventActionDefinition"},{"$ref":"#/components/schemas/FlowBackActionDefinition"},{"$ref":"#/components/schemas/FlowFinishActionDefinition"},{"$ref":"#/components/schemas/FlowNextActionDefinition"},{"$ref":"#/components/schemas/FlowToActionDefinition"},{"$ref":"#/components/schemas/LinkActionDefinition"},{"$ref":"#/components/schemas/LinkBackActionDefinition"},{"$ref":"#/components/schemas/LinkNextActionDefinition"},{"$ref":"#/components/schemas/LogActionDefinition"},{"$ref":"#/components/schemas/MatchActionDefinition"},{"$ref":"#/components/schemas/MessageActionDefinition"},{"$ref":"#/components/schemas/NoopActionDefinition"},{"$ref":"#/components/schemas/NotifyActionDefinition"},{"$ref":"#/components/schemas/RequestActionDefinition"},{"$ref":"#/components/schemas/ResourceCountActionDefinition"},{"$ref":"#/components/schemas/ResourceCreateActionDefinition"},{"$ref":"#/components/schemas/ResourceDeleteActionDefinition"},{"$ref":"#/components/schemas/ResourceGetActionDefinition"},{"$ref":"#/components/schemas/ResourceQueryActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionStatusActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionSubscribeActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionToggleActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionUnsubscribeActionDefinition"},{"$ref":"#/components/schemas/ResourceUpdateActionDefinition"},{"$ref":"#/components/schemas/ResourcePatchActionDefinition"},{"$ref":"#/components/schemas/ShareActionDefinition"},{"$ref":"#/components/schemas/StaticActionDefinition"},{"$ref":"#/components/schemas/StorageAppendActionDefinition"},{"$ref":"#/components/schemas/StorageSubtractActionDefinition"},{"$ref":"#/components/schemas/StorageReadActionDefinition"},{"$ref":"#/components/schemas/StorageWriteActionDefinition"},{"$ref":"#/components/schemas/StorageUpdateActionDefinition"},{"$ref":"#/components/schemas/StorageDeleteActionDefinition"},{"$ref":"#/components/schemas/TeamInviteActionDefinition"},{"$ref":"#/components/schemas/TeamJoinActionDefinition"},{"$ref":"#/components/schemas/TeamListActionDefinition"},{"$ref":"#/components/schemas/TeamMembersActionDefinition"},{"$ref":"#/components/schemas/ThrowActionDefinition"},{"$ref":"#/components/schemas/UserLoginActionDefinition"},{"$ref":"#/components/schemas/UserRegisterActionDefinition"},{"$ref":"#/components/schemas/UserUpdateActionDefinition"}]}]},"AnalyticsActionDefinition":{"type":"object","additionalProperties":false,"required":["type","target"],"properties":{"type":{"enum":["analytics"],"description":"This action sends a Google Analytics event.\n\nIt returns the input data.\n"},"target":{"type":"string","description":"The name of the analytics target event to send."},"config":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper whose result will be sent to Google Analytics as additional context"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"App":{"type":"object","description":"An app definition defines what an app will look like.","additionalProperties":false,"properties":{"id":{"type":"number","minimum":0,"readOnly":true,"description":"The unique identifier for the app.\n\nThis value will be generated automatically by the API.\n"},"OrganizationId":{"$ref":"#/components/schemas/Organization/properties/id"},"path":{"type":"string","minLength":1,"maxLength":30,"pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The URL path segment on which this app is reachable.\n\nThis may only contain lower case characters, numbers, and hyphens. By default this is a\nnormalized version of the app name.\n"},"domain":{"anyOf":[{"type":"string","maxLength":0},{"type":"string","format":"hostname"}],"description":"The domain name on which this app should be served.\n\nIf this is unspecified, the app will be served from the path on the domain of the server\n`HOSTNAME` variable.\n"},"visibility":{"description":"Determine the app visibility of the app in the Appsemble app store.\n\nThis doesn’t affect whether or not the app can be accessed on its own domain.\n\n- **public**: The app is publicly listed in the Appsemble app store.\n- **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the\n Appsemble app store.\n- **private**: The app is only visible to people who are part of the organization.\n","default":"unlisted","enum":["public","unlisted","private"]},"showAppDefinition":{"type":"boolean","description":"Whether or not people who have access to the app may see the app definition."},"locked":{"type":"boolean","description":"Determines whether this app should be locked from being updated.\n\nThis must be set to `false` before any other changes can be made to an app.\n"},"template":{"type":"boolean","description":"Determines whether this app should be included when fetching for templates."},"longDescription":{"type":"string","description":"\nA long description for the app.\n\nThe long desciption will be rendered on the app details page. Markdown content is supported.\n"},"definition":{"$ref":"#/components/schemas/AppDefinition"},"screenshotUrls":{"type":"array","description":"A list of URLs referencing app screenshots","items":{"type":"string"}},"googleAnalyticsID":{"type":"string","description":"If this is specified, Google analytics will be applied to the app","pattern":"^(|UA-\\d{4,10}-\\d{1,4}|G-[\\dA-Z]{4,})$"},"sentryDsn":{"type":"string","description":"The Sentry DSN to use for this app.\n\nIf this is specified, the given Sentry DSN will be used for error tracking. Apps without a custom\ndomain fall back to use the Appsemble server Sentry DSN.\n","format":"url"},"sentryEnvironment":{"type":"string","description":"The name that should be used as the sentry environment.\n\n This is only applied when `sentryDsn` is specified."}}},"AppAccount":{"type":"object","description":"An user account connected to an app","additionalProperties":false,"properties":{"name":{"type":"string","description":"The name as it is available in the app."},"email":{"type":"string","format":"email","description":"The email address as it is available in the app."},"email_verified":{"type":"boolean","description":"Whether this email address has been verified."},"role":{"type":"string","description":"The role of the user within the app"},"app":{"$ref":"#/components/schemas/AppDefinition"},"sso":{"type":"array","description":"The single sign on configurations which link the user to an external account.","items":{"$ref":"#/components/schemas/SSOConfiguration"}},"avatar":{"type":"string","format":"url","description":"The URL of the avatar of the member."}}},"AppDefinition":{"type":"object","required":["name","defaultPage","pages"],"additionalProperties":false,"description":"An app definition describes what an Appsemble app looks like.","properties":{"name":{"type":"string","minLength":1,"maxLength":30,"description":"The human readable name of the app.\n\nThis will be displayed for example on the home screen or in the browser tab.\n"},"roles":{"type":"array","description":"The list of roles that are allowed to view this app.\n\nThis list is used as the default roles for the roles property on pages and blocks, which can be\noverridden by defining them for a specific page or block. Note that these roles must be defined in\n`security.roles`.\n","items":{"type":"string"}},"description":{"type":"string","maxLength":80,"description":"A short description describing the app.\n\nThis will be displayed on the app store.\n"},"layout":{"$ref":"#/components/schemas/AppLayoutDefinition","description":"Properties related to the layout of the app."},"notifications":{"enum":["login","opt-in","startup"],"description":"The strategy to use for apps to subscribe to push notifications.\n\nIf specified, push notifications can be sent to subscribed users via the _Notifications_ tab in the\napp details page in Appsemble Studio. Setting this to `opt-in` allows for users to opt into\nreceiving push notifications by pressing the subscribe button in the App settings page. Setting this\nto `startup` will cause Appsemble to immediately request for the permission upon opening the app.\nIf this is set to `login`, the app will request permissions for push notification once the user\nlogs in.\n\n> **Note**: Setting `notifications` to `startup` is not recommended, due to its invasive nature.\n"},"defaultPage":{"type":"string","description":"The name of the page that should be displayed when the app is initially loaded.\n\nThis **must** match the name of a page defined for the app.\n"},"defaultLanguage":{"type":"string","default":"en","minLength":2,"description":"The default language for the app."},"resources":{"type":"object","description":"Resources define how Appsemble can store data for an app.\n\nThe most basic resource has a `schema` property and defines the minimal security rules.\n","additionalProperties":{"description":"A single resource definition.","$ref":"#/components/schemas/ResourceDefinition"}},"security":{"$ref":"#/components/schemas/SecurityDefinition","description":"Role definitions that may be used by the app."},"pages":{"type":"array","minItems":1,"description":"The pages of the app.","items":{"anyOf":[{"$ref":"#/components/schemas/PageDefinition"},{"$ref":"#/components/schemas/TabsPageDefinition"},{"$ref":"#/components/schemas/FlowPageDefinition"},{"$ref":"#/components/schemas/LoopPageDefinition"}]}},"theme":{"$ref":"#/components/schemas/Theme"},"cron":{"type":"object","minProperties":1,"description":"A list of cron jobs that are associated with this app.","additionalProperties":{"$ref":"#/components/schemas/CronDefinition"}},"anchors":{"type":"array","minItems":1,"description":"Helper property that can be used to store YAML anchors.","items":{}}}},"AppLayoutDefinition":{"type":"object","description":"The layout definition allows you to tweak several layout elements of the app.","additionalProperties":false,"minProperties":1,"properties":{"login":{"enum":["navbar","navigation","hidden"],"default":"navbar","description":"The location of the login button."},"settings":{"enum":["navbar","navigation","hidden"],"default":"navbar","description":"The location of the settings button.\n\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\n"},"feedback":{"enum":["navbar","navigation","hidden"],"default":"navigation","description":"The location of the feedback button.\n\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\n"},"navigation":{"enum":["bottom","left-menu","hidden"],"default":"left-menu","description":"The navigation type to use.\n\nIf this is omitted, a collapsable side navigation menu will be rendered on the left.\n"}}},"AppMessages":{"type":"object","description":"The response object of an messages create call.","required":["language","messages"],"additionalProperties":false,"properties":{"language":{"type":"string","description":"The language the messages represent."},"messages":{"$ref":"#/components/schemas/AppsembleMessages"},"force":{"type":"boolean","writeOnly":true,"description":"If this is true, the app lock is ignored."}}},"AppOAuth2Secret":{"type":"object","description":"Settings for login in apps using third party OAuth2 providers","required":["authorizationUrl","clientId","clientSecret","icon","name","scope","tokenUrl"],"additionalProperties":false,"properties":{"id":{"type":"number","description":"An autogenerated ID","readOnly":true},"authorizationUrl":{"type":"string","format":"uri","description":"The OAuth2 redirect URL."},"tokenUrl":{"type":"string","format":"uri","description":"The URL to request access tokens from."},"clientId":{"type":"string","description":"The public client id which identifies Appsemble to the authorization server."},"clientSecret":{"type":"string","description":"The OAuth2 client secret."},"icon":{"type":"string","description":"A Font Awesome icon which represents the OAuth2 provider."},"name":{"type":"string","description":"A display name which represents the OAuth2 provider."},"scope":{"type":"string","description":"The login scope that will be requested from the authorization server."},"userInfoUrl":{"type":"string","format":"uri","description":"The URL to request user info from"},"remapper":{"type":"array","description":"A remapper to apply on retrieved user information from the user info endpoint.","items":{}},"created":{"type":"string","format":"date-time","description":"When the secret was created originally."},"updated":{"type":"string","format":"date-time","description":"When the secret was last updated."}}},"AppServiceSecret":{"type":"object","description":"App service secret settings","required":["urlPatterns","authenticationMethod"],"additionalProperties":false,"properties":{"id":{"type":"number","description":"An autogenerated ID.","readOnly":true},"serviceName":{"type":"string","description":"An optional name to give extra clarity what the secret is used for."},"urlPatterns":{"type":"string","description":"The url pattern that is matched when a proxied request action is called."},"authenticationMethod":{"enum":["http-basic","client-certificate","client-credentials","cookie","custom-header","query-parameter"],"description":"The method to authenticate the request action with."},"identifier":{"type":"string","description":"The parameter name, header name, username or certificate that goes with the secret."},"secret":{"type":"string","description":"The secret to authenticate the proxied outgoing request with."},"tokenUrl":{"type":"string","description":"The URL to request access tokens from."}}},"AppsembleMessages":{"type":"object","description":"A mapping of the messages for this language","additionalProperties":false,"properties":{"core":{"type":"object","description":"Translations for the core of the app.","additionalProperties":{"type":"string"}},"app":{"type":"object","description":"Translations for global block messages and meta properties of the app.","additionalProperties":{"type":"string"}},"blocks":{"type":"object","description":"Translations for the core of the app.","additionalProperties":{"type":"object","description":"The name of the block type.","pattern":"^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","additionalProperties":{"type":"object","description":"The version of the block.","pattern":"^\\d+\\.\\d+\\.\\d+$","additionalProperties":{"type":"string"}}}},"messageIds":{"type":"object","description":"A list of custom message IDs used by the app.","additionalProperties":{"type":"string"}}}},"ArrayRemapperDefinition":{"type":"array","description":"If a remapper is an array, it represents a chain of remappers.\n\nEach item represents a remapper which is called with the result of the remapper before it.\n\nIf an array is nested, it will be flattened. This allows you to create reusable remappers and\nreference them using YAML anchors.\n","minItems":1,"items":{"anyOf":[{"$ref":"#/components/schemas/ObjectRemapperDefinition"},{"$ref":"#/components/schemas/ArrayRemapperDefinition"}]}},"Asset":{"type":"object","description":"The response object of an asset create call.","additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true,"description":"The unique identifier for the asset.","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"},"mime":{"type":"string","readOnly":true,"description":"The IANA MIME type of the asset."},"filename":{"type":"string","readOnly":true,"description":"The filename of the asset."},"name":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The given name of the asset. Assets may be referenced by their name or ID in the API."}}},"BlockDefinition":{"type":"object","description":"A block that is displayed on a page.","required":["type","version"],"additionalProperties":false,"properties":{"theme":{"$ref":"#/components/schemas/Theme"},"type":{"type":"string","pattern":"^(@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/)?([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The type of the block.\n\nA block type follows the format `@organization/name`. If the organization is _appsemble_, it may\nbe omitted.\n\nSome examples:\n\n- `form`\n- `@amsterdam/splash`\n"},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+$","description":"The version of the block to use.\n\nSince blocks may change over time, a version must be specified in order to ensure that the block\nwill remain the same until it is manually updated.\n"},"layout":{"description":"An override of the block’s default.","enum":["float","grow","static"]},"header":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional header to render above the block."},"roles":{"type":"array","description":"The list of roles that are allowed to view this block.\n\nIf a user does not have the right role, the block is not rendered.\n","items":{"type":"string"}},"position":{"description":"For floating blocks this propert defines where the block should float.","default":"bottom right","enum":["top left","top","top right","left","right","bottom left","bottom","bottom right"]},"parameters":{"type":"object","description":"A free form mapping of named parameters.\n\nThe exact meaning of the parameters depends on the block type.\n","additionalProperties":true},"actions":{"type":"object","description":"A mapping of actions that can be fired by the block to action handlers.","additionalProperties":{"$ref":"#/components/schemas/ActionDefinition"}},"events":{"$ref":"#/components/schemas/EventsDefinition"}}},"BlockVersion":{"type":"object","description":"A version of a block definition\n\nBlock versions can’t be updated or deleted. This ensures apps that use a block version can never\nbe broken by alterations of block definitions.\n","required":["name","version","files"],"additionalProperties":false,"properties":{"name":{"type":"string","readOnly":true,"description":"The name of a block.\n\nThis uses the same form as scoped npm packages. For example, `@appsemble/form`.\n","pattern":"^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"},"description":{"type":"string","description":"The description of the block.","maxLength":160},"longDescription":{"type":"string","description":"The long description of the block."},"icon":{"type":"string","format":"binary","description":"An icon to represent the block in Appsemble studio."},"iconUrl":{"type":"string","format":"uri","description":"The relative URL on which the icon is served","readOnly":true},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+$","description":"A [semver](https://semver.org) representation of the block version."},"visibility":{"enum":["public","unlisted"],"default":"public","description":"Whether the block should be listed publicly for users who aren’t part of the block’s organization.\n\n- **`public`**: The block is visible for everyone.\n- **`unlisted`**: The block will only be visible if the user is logged in and is part of the block’s organization."},"layout":{"description":"How the block will be displayed on the screen.\n\n- **`float`**: The block will float somewhere on the screen.\n- **`grow`**: The block will be positioned in the main page. It will grow to fill up remaining\n space on the page.\n- **`static`**: The block will be positioned in the main page. It will take up a fixed amount of\n space.\n- **`hidden`**: The block will not be rendered at all.\n","default":"grow","enum":["float","grow","static","hidden"]},"actions":{"type":"object","description":"An object which describes the actions a block can trigger.\n\nThis will be used to validate app definitions.\n","additionalProperties":true},"parameters":{"$ref":"#/components/schemas/JSONSchemaRoot","description":"A draft 7 JSON schema to use for block parameter validation.\n\nIf the parameters of a block definition don’t conform to this schema, the app definition will be\nconsidered invalid.\n"},"events":{"type":"object","description":"An object describing the names of the events the block can listen and emit to.","additionalProperties":false,"properties":{"listen":{"type":"object","description":"A mapping of events this block may listen on","additionalProperties":{"description":"A mapping of events this block may listen on","type":"object","additionalProperties":false,"properties":{"description":{"type":"string"}}}},"emit":{"type":"object","description":"A mapping of events this block may emit","additionalProperties":{"description":"A mapping of events this block may emit","type":"object","additionalProperties":false,"properties":{"description":{"type":"string"}}}}}},"resources":{"type":"object","description":"deprecated","additionalProperties":true},"messages":{"type":"object","description":"The translated messages for the block.\n\nEnglish (`en`) messages are required.\n","required":["en"],"properties":{"en":{"type":"object","description":"A mapping of language IDs to their English translation","additionalProperties":{"type":"string","description":"The default translations to use.","minLength":1}}},"additionalProperties":{"type":"object","description":"A mapping of language IDs to their internationalized translation","additionalProperties":{"type":"string","description":"The translated messages for this language."}}},"files":{"type":"array","description":"A list of file assets that belong to the app version.","minLength":1,"items":{"type":"string","format":"binary"}},"examples":{"type":"array","description":"A list of exmples how the block can be used within an app definition.","items":{"type":"string"}}}},"ConditionActionDefinition":{"type":"object","additionalProperties":false,"required":["type","if"],"properties":{"type":{"enum":["condition"],"description":"Run another action if a certain contition is met."},"if":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper to determine the condition to check.\n\nIf this yields a truthy value, the `then` action is called. Otherwise the `else` action is\ncalled.\n"},"then":{"description":"This action is called if the `if` remapper yields a truthy value.","$ref":"#/components/schemas/ActionDefinition"},"else":{"description":"This action is called if the `if` remapper yields a falsy value.","$ref":"#/components/schemas/ActionDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"CronDefinition":{"type":"object","required":["schedule"],"description":"A cron definition defines tasks that Appsemble will run periodically for the app.","additionalProperties":false,"properties":{"schedule":{"description":"A crontab string to define when the action should be run.\n\nSee [Crontab guru](https://crontab.guru) for details\n","type":"string"},"action":{"description":"The action to run when the cronjob is triggered.","$ref":"#/components/schemas/ActionDefinition"}}},"CustomFontDefinition":{"type":"object","description":"A custom font definition.","additionalProperties":false,"required":["source","family"],"properties":{"source":{"description":"Use a custom font.","enum":["custom"]},"family":{"type":"string","description":"The font family to use in the app.\n\nMake sure the font is available using custom CSS.\n"}}},"DialogActionDefinition":{"type":"object","additionalProperties":false,"required":["type","blocks"],"properties":{"type":{"enum":["dialog"],"description":"This action opens a pop-up dialog that can be used to seamlessly transition to a new set of blocks temporarily.\n\nDialogs can be closed by calling the [`dialog.ok`](#DialogOkActionDefinition) or\n[`dialog.error`](#DialogErrorActionDefinition). Users can still manually close dialogs, which\nshould be supported by the app.\n\nBlocks with the layout type `float` (e.g. `action-button`) do not work in this action.\n"},"title":{"description":"An optional title to set in the dialog header.","$ref":"#/components/schemas/RemapperDefinition"},"closable":{"type":"boolean","default":true,"description":"Whether users are allowed to close the dialog by clicking outside of it or on the close button."},"fullscreen":{"type":"boolean","default":false,"description":"Whether the dialog should be displayed full screen as if it’s a new page, or as a pop-up."},"blocks":{"type":"array","description":"A list of blocks to display in the dialog.","items":{"$ref":"#/components/schemas/BlockDefinition"}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"DialogErrorActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["dialog.error"],"description":"Close an open dialog.\n\nThe dialog action that opened the dialog will be rejected with the data passed to this action.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"DialogOkActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["dialog.ok"],"description":"Close an open dialog.\n\nThe dialog action that opened the dialog will be rejected with the data passed to this action.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"DownloadActionDefinition":{"type":"object","required":["type","filename"],"additionalProperties":false,"properties":{"type":{"enum":["download"],"description":"Download the data as a file."},"filename":{"type":"string","description":"The filename to save the file as. This must include a file extension.","pattern":"\\."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"EachActionDefinition":{"type":"object","additionalProperties":false,"required":["type","do"],"properties":{"type":{"enum":["each"],"description":"Run an action for each entry in an array.\n\nThe actions are run in parallel.\n\nIf the input is not an array, the action will be applied to the input instead."},"serial":{"description":"Runs the action in series instead of parallel","type":"boolean"},"do":{"description":"This action is called for each item in the input array.","$ref":"#/components/schemas/ActionDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"EmailActionDefinition":{"type":"object","additionalProperties":false,"required":["type","subject","body"],"properties":{"type":{"enum":["email"],"description":"The email action can be used to send emails via the Appsemble server.\n\nIf `to`, `cc`, and `bcc` all end up being empty, no emails will be sent but the action will still continue as normal.\n"},"to":{"$ref":"#/components/schemas/RemapperDefinition","description":"The address the email should be sent to. Can be either in the format of `[email protected]`, or `John Doe <[email protected]>`"},"from":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the sender of the email."},"cc":{"$ref":"#/components/schemas/RemapperDefinition","description":"The list of additional email addresses email should be sent to. Uses the same format as `to`. Every email address in the CC is visible to all recipients."},"bcc":{"$ref":"#/components/schemas/RemapperDefinition","description":"The list of additional email addresses email should be sent to. Uses the same format as `to`. Email addresses in the BCC are hidden from other recipients."},"subject":{"$ref":"#/components/schemas/RemapperDefinition","description":"The subject of the email."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"The body of the email. The content of the body is converted to HTML using the Markdown syntax."},"attachments":{"$ref":"#/components/schemas/RemapperDefinition","description":"The attachments to include in the email.\n\nThe remapper must resolve to an object containing the following properties:\n\n- `target`: The asset ID or link to download contents from to add as an attachment. This is mutually exclusive with `content`.\n- `content`: The raw content to include as the file content. This is mutually exclusive with `target`.\n- `filename`: The filename to include the attachment as.\n- `accept` If the target is a URL, this will be set as the HTTP `Accept` header when downloading the file.\n\nIf the attachment is a string, it will be treated as the target."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"Error":{"type":"object","description":"The generic error object returned by any expected API errors.","readOnly":true,"additionalProperties":false,"properties":{"statusCode":{"type":"number","description":"Matches the HTTP response status code.","example":404},"error":{"type":"string","description":"Matches the HTTP response status description.","example":"Not Found"},"message":{"type":"string","description":"A message describing the error.","example":"Entity not found"}}},"EventActionDefinition":{"type":"object","additionalProperties":false,"required":["type","event"],"properties":{"type":{"enum":["event"],"description":"This action allows for other blocks to emit data upon triggering the action.\n\nThis can be used to make blocks interact with each other, such as triggering the `data-loader`\nblock to refresh itself by sending an event action that matches the name of what the block is\nlistening to.\n"},"event":{"type":"string","description":"The name of the event to emit."},"waitFor":{"type":"string","description":"If specified, the action will wait for this event to have been emitted and respond with its data."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"EventsDefinition":{"type":"object","description":"An object describing the names of the events the block can listen and emit to.","additionalProperties":false,"minProperties":1,"properties":{"listen":{"type":"object","description":"This property defines the events this block will listen on.\n\nThe key is the name of the event will listen on. The value is a user defined event name which should\nmatch the name of an emitted event on the same page.\n","minProperties":1,"additionalProperties":{"type":"string"}},"emit":{"type":"object","description":"This property defines the events this block will emit.\n\nThe key is the name of the event will emit. The value is a user defined event name which should\nmatch the name of a event on the same page that’s being listened on.\n","minProperties":1,"additionalProperties":{"type":"string"}}}},"FlowBackActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["flow.back"],"description":"On [flow pages](#flow-page-definition-sub-pages), return to the previous page if\nit is present. If this is called on the first page, nothing happens.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"FlowFinishActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["flow.finish"],"description":"On [flow pages](#flow-page-definition-sub-pages), triggers the\n[`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action on the page.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"FlowNextActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["flow.next"],"description":"On [flow pages](#flow-page-definition-sub-pages), proceed to the next page if it\nis present. Otherwise, the flow is considered to be complete and [`flow.finish`](#flowfinish) will\nbe called instead.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"FlowPageActionsDefinition":{"type":"object","description":"These actions are fired on a flow page.","additionalProperties":false,"properties":{"onFlowCancel":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when `flow.cancel` gets called."},"onFlowFinish":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when a flow is finished.\n\nA flow is finished when `flow.finish` gets called, or when `flow.next` gets called on the final\nsubpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action."}}},"FlowPageDefinition":{"type":"object","description":"This describes what a page will look like in the app.","required":["type","steps","name"],"additionalProperties":false,"properties":{"type":{"enum":["flow"]},"steps":{"type":"array","minItems":2,"description":"Steps belonging to this page's flow.","items":{"$ref":"#/components/schemas/SubPage"}},"actions":{"$ref":"#/components/schemas/FlowPageActionsDefinition"},"progress":{"description":"The method that should be used to display the status of flow pages.","enum":["corner-dots","hidden"]},"retainFlowData":{"type":"boolean","description":"Whether to retain the flow data when navigating away to another page outside the flow.\n\nBy default the flow page retains it's data after navigating once. Set to false to clear it.\n","default":true},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren’t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"}}},"FlowToActionDefinition":{"type":"object","additionalProperties":false,"required":["type","step"],"properties":{"type":{"enum":["flow.to"],"description":"On [flow pages](#flow-page-definition-sub-pages), move to a specific step."},"step":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the step to move to.\n\nThis is a remapper which gets called with the action input and context.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"GoogleFontDefinition":{"type":"object","description":"A Google font definition.","additionalProperties":false,"required":["family"],"properties":{"source":{"description":"Use a font from [Google Fonts](https://fonts.google.com).","enum":["google"]},"family":{"enum":["ABeeZee","Abel","Abhaya Libre","Abril Fatface","Aclonica","Acme","Actor","Adamina","Advent Pro","Aguafina Script","Akaya Kanadaka","Akaya Telivigala","Akronim","Aladin","Alata","Alatsi","Aldrich","Alef","Alegreya","Alegreya SC","Alegreya Sans","Alegreya Sans SC","Aleo","Alex Brush","Alfa Slab One","Alice","Alike","Alike Angular","Allan","Allerta","Allerta Stencil","Allison","Allura","Almarai","Almendra","Almendra Display","Almendra SC","Alumni Sans","Amarante","Amaranth","Amatic SC","Amethysta","Amiko","Amiri","Amita","Anaheim","Andada Pro","Andika","Andika New Basic","Angkor","Annie Use Your Telescope","Anonymous Pro","Antic","Antic Didone","Antic Slab","Anton","Antonio","Arapey","Arbutus","Arbutus Slab","Architects Daughter","Archivo","Archivo Black","Archivo Narrow","Are You Serious","Aref Ruqaa","Arima Madurai","Arimo","Arizonia","Armata","Arsenal","Artifika","Arvo","Arya","Asap","Asap Condensed","Asar","Asset","Assistant","Astloch","Asul","Athiti","Atkinson Hyperlegible","Atma","Atomic Age","Aubrey","Audiowide","Autour One","Average","Average Sans","Averia Gruesa Libre","Averia Libre","Averia Sans Libre","Averia Serif Libre","Azeret Mono","B612","B612 Mono","Bad Script","Bahiana","Bahianita","Bai Jamjuree","Ballet","Baloo 2","Baloo Bhai 2","Baloo Bhaina 2","Baloo Chettan 2","Baloo Da 2","Baloo Paaji 2","Baloo Tamma 2","Baloo Tammudu 2","Baloo Thambi 2","Balsamiq Sans","Balthazar","Bangers","Barlow","Barlow Condensed","Barlow Semi Condensed","Barriecito","Barrio","Basic","Baskervville","Battambang","Baumans","Bayon","Be Vietnam","Be Vietnam Pro","Bebas Neue","Belgrano","Bellefair","Belleza","Bellota","Bellota Text","BenchNine","Benne","Bentham","Berkshire Swash","Besley","Beth Ellen","Bevan","Big Shoulders Display","Big Shoulders Inline Display","Big Shoulders Inline Text","Big Shoulders Stencil Display","Big Shoulders Stencil Text","Big Shoulders Text","Bigelow Rules","Bigshot One","Bilbo","Bilbo Swash Caps","BioRhyme","BioRhyme Expanded","Birthstone","Birthstone Bounce","Biryani","Bitter","Black And White Picture","Black Han Sans","Black Ops One","Blinker","Bodoni Moda","Bokor","Bona Nova","Bonbon","Bonheur Royale","Boogaloo","Bowlby One","Bowlby One SC","Brawler","Bree Serif","Brygada 1918","Bubblegum Sans","Bubbler One","Buda","Buenard","Bungee","Bungee Hairline","Bungee Inline","Bungee Outline","Bungee Shade","Butcherman","Butterfly Kids","Cabin","Cabin Condensed","Cabin Sketch","Caesar Dressing","Cagliostro","Cairo","Caladea","Calistoga","Calligraffitti","Cambay","Cambo","Candal","Cantarell","Cantata One","Cantora One","Capriola","Caramel","Carattere","Cardo","Carme","Carrois Gothic","Carrois Gothic SC","Carter One","Castoro","Catamaran","Caudex","Caveat","Caveat Brush","Cedarville Cursive","Ceviche One","Chakra Petch","Changa","Changa One","Chango","Charm","Charmonman","Chathura","Chau Philomene One","Chela One","Chelsea Market","Chenla","Cherish","Cherry Cream Soda","Cherry Swash","Chewy","Chicle","Chilanka","Chivo","Chonburi","Cinzel","Cinzel Decorative","Clicker Script","Coda","Coda Caption","Codystar","Coiny","Combo","Comfortaa","Comic Neue","Coming Soon","Commissioner","Concert One","Condiment","Content","Contrail One","Convergence","Cookie","Copse","Corben","Cormorant","Cormorant Garamond","Cormorant Infant","Cormorant SC","Cormorant Unicase","Cormorant Upright","Courgette","Courier Prime","Cousine","Coustard","Covered By Your Grace","Crafty Girls","Creepster","Crete Round","Crimson Pro","Crimson Text","Croissant One","Crushed","Cuprum","Cute Font","Cutive","Cutive Mono","DM Mono","DM Sans","DM Serif Display","DM Serif Text","Damion","Dancing Script","Dangrek","Darker Grotesque","David Libre","Dawning of a New Day","Days One","Dekko","Dela Gothic One","Delius","Delius Swash Caps","Delius Unicase","Della Respira","Denk One","Devonshire","Dhurjati","Didact Gothic","Diplomata","Diplomata SC","Do Hyeon","Dokdo","Domine","Donegal One","Doppio One","Dorsa","Dosis","DotGothic16","Dr Sugiyama","Duru Sans","Dynalight","EB Garamond","Eagle Lake","East Sea Dokdo","Eater","Economica","Eczar","El Messiri","Electrolize","Elsie","Elsie Swash Caps","Emblema One","Emilys Candy","Encode Sans","Encode Sans Condensed","Encode Sans Expanded","Encode Sans SC","Encode Sans Semi Condensed","Encode Sans Semi Expanded","Engagement","Englebert","Enriqueta","Ephesis","Epilogue","Erica One","Esteban","Euphoria Script","Ewert","Exo","Exo 2","Expletus Sans","Explora","Fahkwang","Fanwood Text","Farro","Farsan","Fascinate","Fascinate Inline","Faster One","Fasthand","Fauna One","Faustina","Federant","Federo","Felipa","Fenix","Festive","Finger Paint","Fira Code","Fira Mono","Fira Sans","Fira Sans Condensed","Fira Sans Extra Condensed","Fjalla One","Fjord One","Flamenco","Flavors","Fleur De Leah","Fondamento","Fontdiner Swanky","Forum","Francois One","Frank Ruhl Libre","Fraunces","Freckle Face","Fredericka the Great","Fredoka One","Freehand","Fresca","Frijole","Fruktur","Fugaz One","Fuggles","GFS Didot","GFS Neohellenic","Gabriela","Gaegu","Gafata","Galada","Galdeano","Galindo","Gamja Flower","Gayathri","Gelasio","Gemunu Libre","Gentium Basic","Gentium Book Basic","Geo","Georama","Geostar","Geostar Fill","Germania One","Gideon Roman","Gidugu","Gilda Display","Girassol","Give You Glory","Glass Antiqua","Glegoo","Gloria Hallelujah","Glory","Gluten","Goblin One","Gochi Hand","Goldman","Gorditas","Gothic A1","Gotu","Goudy Bookletter 1911","Gowun Batang","Gowun Dodum","Graduate","Grand Hotel","Grandstander","Gravitas One","Great Vibes","Grechen Fuemen","Grenze","Grenze Gotisch","Grey Qo","Griffy","Gruppo","Gudea","Gugi","Gupter","Gurajada","Habibi","Hachi Maru Pop","Hahmlet","Halant","Hammersmith One","Hanalei","Hanalei Fill","Handlee","Hanuman","Happy Monkey","Harmattan","Headland One","Heebo","Henny Penny","Hepta Slab","Herr Von Muellerhoff","Hi Melody","Hina Mincho","Hind","Hind Guntur","Hind Madurai","Hind Siliguri","Hind Vadodara","Holtwood One SC","Homemade Apple","Homenaje","IBM Plex Mono","IBM Plex Sans","IBM Plex Sans Arabic","IBM Plex Sans Condensed","IBM Plex Sans Devanagari","IBM Plex Sans Hebrew","IBM Plex Sans KR","IBM Plex Sans Thai","IBM Plex Sans Thai Looped","IBM Plex Serif","IM Fell DW Pica","IM Fell DW Pica SC","IM Fell Double Pica","IM Fell Double Pica SC","IM Fell English","IM Fell English SC","IM Fell French Canon","IM Fell French Canon SC","IM Fell Great Primer","IM Fell Great Primer SC","Ibarra Real Nova","Iceberg","Iceland","Imbue","Imprima","Inconsolata","Inder","Indie Flower","Inika","Inknut Antiqua","Inria Sans","Inria Serif","Inter","Irish Grover","Istok Web","Italiana","Italianno","Itim","Jacques Francois","Jacques Francois Shadow","Jaldi","JetBrains Mono","Jim Nightshade","Jockey One","Jolly Lodger","Jomhuria","Jomolhari","Josefin Sans","Josefin Slab","Jost","Joti One","Jua","Judson","Julee","Julius Sans One","Junge","Jura","Just Another Hand","Just Me Again Down Here","K2D","Kadwa","Kaisei Decol","Kaisei HarunoUmi","Kaisei Opti","Kaisei Tokumin","Kalam","Kameron","Kanit","Kantumruy","Karantina","Karla","Karma","Katibeh","Kaushan Script","Kavivanar","Kavoon","Kdam Thmor","Keania One","Kelly Slab","Kenia","Khand","Khmer","Khula","Kirang Haerang","Kite One","Kiwi Maru","Klee One","Knewave","KoHo","Kodchasan","Koh Santepheap","Kosugi","Kosugi Maru","Kotta One","Koulen","Kranky","Kreon","Kristi","Krona One","Krub","Kufam","Kulim Park","Kumar One","Kumar One Outline","Kumbh Sans","Kurale","La Belle Aurore","Lacquer","Laila","Lakki Reddy","Lalezar","Lancelot","Langar","Lateef","Lato","League Script","Leckerli One","Ledger","Lekton","Lemon","Lemonada","Lexend","Lexend Deca","Lexend Exa","Lexend Giga","Lexend Mega","Lexend Peta","Lexend Tera","Lexend Zetta","Libre Barcode 128","Libre Barcode 128 Text","Libre Barcode 39","Libre Barcode 39 Extended","Libre Barcode 39 Extended Text","Libre Barcode 39 Text","Libre Barcode EAN13 Text","Libre Baskerville","Libre Caslon Display","Libre Caslon Text","Libre Franklin","Life Savers","Lilita One","Lily Script One","Limelight","Linden Hill","Literata","Liu Jian Mao Cao","Livvic","Lobster","Lobster Two","Londrina Outline","Londrina Shadow","Londrina Sketch","Londrina Solid","Long Cang","Lora","Love Ya Like A Sister","Loved by the King","Lovers Quarrel","Luckiest Guy","Lusitana","Lustria","M PLUS 1p","M PLUS Rounded 1c","Ma Shan Zheng","Macondo","Macondo Swash Caps","Mada","Magra","Maiden Orange","Maitree","Major Mono Display","Mako","Mali","Mallanna","Mandali","Manjari","Manrope","Mansalva","Manuale","Marcellus","Marcellus SC","Marck Script","Margarine","Markazi Text","Marko One","Marmelad","Martel","Martel Sans","Marvel","Mate","Mate SC","Maven Pro","McLaren","Meddon","MedievalSharp","Medula One","Meera Inimai","Megrim","Meie Script","Merienda","Merienda One","Merriweather","Merriweather Sans","Metal","Metal Mania","Metamorphous","Metrophobic","Michroma","Milonga","Miltonian","Miltonian Tattoo","Mina","Miniver","Miriam Libre","Mirza","Miss Fajardose","Mitr","Modak","Modern Antiqua","Mogra","Molengo","Molle","Monda","Monofett","Monoton","Monsieur La Doulaise","Montaga","MonteCarlo","Montez","Montserrat","Montserrat Alternates","Montserrat Subrayada","Moul","Moulpali","Mountains of Christmas","Mouse Memoirs","Mr Bedfort","Mr Dafoe","Mr De Haviland","Mrs Saint Delafield","Mrs Sheppards","Mukta","Mukta Mahee","Mukta Malar","Mukta Vaani","Mulish","MuseoModerno","Mystery Quest","NTR","Nanum Brush Script","Nanum Gothic","Nanum Gothic Coding","Nanum Myeongjo","Nanum Pen Script","Nerko One","Neucha","Neuton","New Rocker","New Tegomin","News Cycle","Newsreader","Niconne","Niramit","Nixie One","Nobile","Nokora","Norican","Nosifer","Notable","Nothing You Could Do","Noticia Text","Noto Kufi Arabic","Noto Music","Noto Naskh Arabic","Noto Nastaliq Urdu","Noto Rashi Hebrew","Noto Sans","Noto Sans Adlam","Noto Sans Adlam Unjoined","Noto Sans Anatolian Hieroglyphs","Noto Sans Arabic","Noto Sans Armenian","Noto Sans Avestan","Noto Sans Balinese","Noto Sans Bamum","Noto Sans Bassa Vah","Noto Sans Batak","Noto Sans Bengali","Noto Sans Bhaiksuki","Noto Sans Brahmi","Noto Sans Buginese","Noto Sans Buhid","Noto Sans Canadian Aboriginal","Noto Sans Carian","Noto Sans Caucasian Albanian","Noto Sans Chakma","Noto Sans Cham","Noto Sans Cherokee","Noto Sans Coptic","Noto Sans Cuneiform","Noto Sans Cypriot","Noto Sans Deseret","Noto Sans Devanagari","Noto Sans Display","Noto Sans Duployan","Noto Sans Egyptian Hieroglyphs","Noto Sans Elbasan","Noto Sans Elymaic","Noto Sans Georgian","Noto Sans Glagolitic","Noto Sans Gothic","Noto Sans Grantha","Noto Sans Gujarati","Noto Sans Gunjala Gondi","Noto Sans Gurmukhi","Noto Sans HK","Noto Sans Hanifi Rohingya","Noto Sans Hanunoo","Noto Sans Hatran","Noto Sans Hebrew","Noto Sans Imperial Aramaic","Noto Sans Indic Siyaq Numbers","Noto Sans Inscriptional Pahlavi","Noto Sans Inscriptional Parthian","Noto Sans JP","Noto Sans Javanese","Noto Sans KR","Noto Sans Kaithi","Noto Sans Kannada","Noto Sans Kayah Li","Noto Sans Kharoshthi","Noto Sans Khmer","Noto Sans Khojki","Noto Sans Khudawadi","Noto Sans Lao","Noto Sans Lepcha","Noto Sans Limbu","Noto Sans Linear A","Noto Sans Linear B","Noto Sans Lisu","Noto Sans Lycian","Noto Sans Lydian","Noto Sans Mahajani","Noto Sans Malayalam","Noto Sans Mandaic","Noto Sans Manichaean","Noto Sans Marchen","Noto Sans Masaram Gondi","Noto Sans Math","Noto Sans Mayan Numerals","Noto Sans Medefaidrin","Noto Sans Meroitic","Noto Sans Miao","Noto Sans Modi","Noto Sans Mongolian","Noto Sans Mono","Noto Sans Mro","Noto Sans Multani","Noto Sans Myanmar","Noto Sans N Ko","Noto Sans Nabataean","Noto Sans New Tai Lue","Noto Sans Newa","Noto Sans Nushu","Noto Sans Ogham","Noto Sans Ol Chiki","Noto Sans Old Hungarian","Noto Sans Old Italic","Noto Sans Old North Arabian","Noto Sans Old Permic","Noto Sans Old Persian","Noto Sans Old Sogdian","Noto Sans Old South Arabian","Noto Sans Old Turkic","Noto Sans Oriya","Noto Sans Osage","Noto Sans Osmanya","Noto Sans Pahawh Hmong","Noto Sans Palmyrene","Noto Sans Pau Cin Hau","Noto Sans Phags Pa","Noto Sans Phoenician","Noto Sans Psalter Pahlavi","Noto Sans Rejang","Noto Sans Runic","Noto Sans SC","Noto Sans Samaritan","Noto Sans Saurashtra","Noto Sans Sharada","Noto Sans Shavian","Noto Sans Siddham","Noto Sans Sinhala","Noto Sans Sogdian","Noto Sans Sora Sompeng","Noto Sans Soyombo","Noto Sans Sundanese","Noto Sans Syloti Nagri","Noto Sans Symbols","Noto Sans Symbols 2","Noto Sans Syriac","Noto Sans TC","Noto Sans Tagalog","Noto Sans Tagbanwa","Noto Sans Tai Le","Noto Sans Tai Tham","Noto Sans Tai Viet","Noto Sans Takri","Noto Sans Tamil","Noto Sans Tamil Supplement","Noto Sans Telugu","Noto Sans Thaana","Noto Sans Thai","Noto Sans Thai Looped","Noto Sans Tifinagh","Noto Sans Tirhuta","Noto Sans Ugaritic","Noto Sans Vai","Noto Sans Wancho","Noto Sans Warang Citi","Noto Sans Yi","Noto Sans Zanabazar Square","Noto Serif","Noto Serif Ahom","Noto Serif Armenian","Noto Serif Balinese","Noto Serif Bengali","Noto Serif Devanagari","Noto Serif Display","Noto Serif Dogra","Noto Serif Ethiopic","Noto Serif Georgian","Noto Serif Grantha","Noto Serif Gujarati","Noto Serif Gurmukhi","Noto Serif Hebrew","Noto Serif JP","Noto Serif KR","Noto Serif Kannada","Noto Serif Khmer","Noto Serif Lao","Noto Serif Malayalam","Noto Serif Myanmar","Noto Serif Nyiakeng Puachue Hmong","Noto Serif SC","Noto Serif Sinhala","Noto Serif TC","Noto Serif Tamil","Noto Serif Tangut","Noto Serif Telugu","Noto Serif Thai","Noto Serif Tibetan","Noto Serif Yezidi","Noto Traditional Nushu","Nova Cut","Nova Flat","Nova Mono","Nova Oval","Nova Round","Nova Script","Nova Slim","Nova Square","Numans","Nunito","Nunito Sans","Odibee Sans","Odor Mean Chey","Offside","Oi","Old Standard TT","Oldenburg","Oleo Script","Oleo Script Swash Caps","Open Sans","Open Sans Condensed","Oranienbaum","Orbitron","Oregano","Orelega One","Orienta","Original Surfer","Oswald","Otomanopee One","Over the Rainbow","Overlock","Overlock SC","Overpass","Overpass Mono","Ovo","Oxanium","Oxygen","Oxygen Mono","PT Mono","PT Sans","PT Sans Caption","PT Sans Narrow","PT Serif","PT Serif Caption","Pacifico","Padauk","Palanquin","Palanquin Dark","Palette Mosaic","Pangolin","Paprika","Parisienne","Passero One","Passion One","Pathway Gothic One","Patrick Hand","Patrick Hand SC","Pattaya","Patua One","Pavanam","Paytone One","Peddana","Peralta","Permanent Marker","Petit Formal Script","Petrona","Philosopher","Piazzolla","Piedra","Pinyon Script","Pirata One","Plaster","Play","Playball","Playfair Display","Playfair Display SC","Podkova","Poiret One","Poller One","Poly","Pompiere","Pontano Sans","Poor Story","Poppins","Port Lligat Sans","Port Lligat Slab","Potta One","Pragati Narrow","Prata","Preahvihear","Press Start 2P","Pridi","Princess Sofia","Prociono","Prompt","Prosto One","Proza Libre","Public Sans","Puritan","Purple Purse","Qahiri","Quando","Quantico","Quattrocento","Quattrocento Sans","Questrial","Quicksand","Quintessential","Qwigley","Racing Sans One","Radley","Rajdhani","Rakkas","Raleway","Raleway Dots","Ramabhadra","Ramaraja","Rambla","Rammetto One","Rampart One","Ranchers","Rancho","Ranga","Rasa","Rationale","Ravi Prakash","Recursive","Red Hat Display","Red Hat Text","Red Rose","Redressed","Reem Kufi","Reenie Beanie","Reggae One","Revalia","Rhodium Libre","Ribeye","Ribeye Marrow","Righteous","Risque","Roboto","Roboto Condensed","Roboto Mono","Roboto Slab","Rochester","Rock Salt","RocknRoll One","Rokkitt","Romanesco","Ropa Sans","Rosario","Rosarivo","Rouge Script","Rowdies","Rozha One","Rubik","Rubik Beastly","Rubik Mono One","Ruda","Rufina","Ruge Boogie","Ruluko","Rum Raisin","Ruslan Display","Russo One","Ruthie","Rye","STIX Two Text","Sacramento","Sahitya","Sail","Saira","Saira Condensed","Saira Extra Condensed","Saira Semi Condensed","Saira Stencil One","Salsa","Sanchez","Sancreek","Sansita","Sansita Swashed","Sarabun","Sarala","Sarina","Sarpanch","Satisfy","Sawarabi Gothic","Sawarabi Mincho","Scada","Scheherazade","Scheherazade New","Schoolbell","Scope One","Seaweed Script","Secular One","Sedgwick Ave","Sedgwick Ave Display","Sen","Sevillana","Seymour One","Shadows Into Light","Shadows Into Light Two","Shanti","Share","Share Tech","Share Tech Mono","Shippori Mincho","Shippori Mincho B1","Shojumaru","Short Stack","Shrikhand","Siemreap","Sigmar One","Signika","Signika Negative","Simonetta","Single Day","Sintony","Sirin Stencil","Six Caps","Skranji","Slabo 13px","Slabo 27px","Slackey","Smokum","Smythe","Sniglet","Snippet","Snowburst One","Sofadi One","Sofia","Solway","Song Myung","Sonsie One","Sora","Sorts Mill Goudy","Source Code Pro","Source Sans Pro","Source Serif Pro","Space Grotesk","Space Mono","Spartan","Special Elite","Spectral","Spectral SC","Spicy Rice","Spinnaker","Spirax","Squada One","Sree Krushnadevaraya","Sriracha","Srisakdi","Staatliches","Stalemate","Stalinist One","Stardos Stencil","Stick","Stick No Bills","Stint Ultra Condensed","Stint Ultra Expanded","Stoke","Strait","Style Script","Stylish","Sue Ellen Francisco","Suez One","Sulphur Point","Sumana","Sunflower","Sunshiney","Supermercado One","Sura","Suranna","Suravaram","Suwannaphum","Swanky and Moo Moo","Syncopate","Syne","Syne Mono","Syne Tactile","Tajawal","Tangerine","Taprom","Tauri","Taviraj","Teko","Telex","Tenali Ramakrishna","Tenor Sans","Text Me One","Texturina","Thasadith","The Girl Next Door","Tienne","Tillana","Timmana","Tinos","Titan One","Titillium Web","Tomorrow","Tourney","Trade Winds","Train One","Trirong","Trispace","Trocchi","Trochut","Truculenta","Trykker","Tulpen One","Turret Road","Ubuntu","Ubuntu Condensed","Ubuntu Mono","Uchen","Ultra","Uncial Antiqua","Underdog","Unica One","UnifrakturCook","UnifrakturMaguntia","Unkempt","Unlock","Unna","Urbanist","VT323","Vampiro One","Varela","Varela Round","Varta","Vast Shadow","Vesper Libre","Viaoda Libre","Vibes","Vibur","Vidaloka","Viga","Voces","Volkhov","Vollkorn","Vollkorn SC","Voltaire","Waiting for the Sunrise","Wallpoet","Walter Turncoat","Warnes","Wellfleet","Wendy One","WindSong","Wire One","Work Sans","Xanh Mono","Yaldevi","Yanone Kaffeesatz","Yantramanav","Yatra One","Yellowtail","Yeon Sung","Yeseva One","Yesteryear","Yomogi","Yrsa","Yusei Magic","ZCOOL KuaiLe","ZCOOL QingKe HuangYou","ZCOOL XiaoWei","Zen Dots","Zen Loop","Zen Tokyo Zoo","Zeyada","Zhi Mang Xing","Zilla Slab","Zilla Slab Highlight"],"description":"The font to use in the app.\n\nAny font available on [Google Fonts](https://fonts.google.com) may be used.\n","default":{"family":"Open Sans","source":"google"}}}},"Health":{"type":"object","description":"A health check status","readOnly":true,"additionalProperties":false,"properties":{"database":{"type":"boolean","description":"Whether or not the database status is healthy"}}},"JSONPointer":{"type":"object","description":"A JSON pointer which may be used to reference a JSON schema.","additionalProperties":false,"required":["$ref"],"properties":{"$ref":{"type":"string","description":"A JSON schema reference.","pattern":"^#\\/definitions\\/","example":"#/definitions/MyReusableSchema"},"default":{"description":"The default value that will be used."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchema":{"anyOf":[{"$ref":"#/components/schemas/JSONPointer"},{"$ref":"#/components/schemas/JSONSchemaAnyOf"},{"$ref":"#/components/schemas/JSONSchemaArray"},{"$ref":"#/components/schemas/JSONSchemaBoolean"},{"$ref":"#/components/schemas/JSONSchemaConst"},{"$ref":"#/components/schemas/JSONSchemaEnum"},{"$ref":"#/components/schemas/JSONSchemaInteger"},{"$ref":"#/components/schemas/JSONSchemaMultiType"},{"$ref":"#/components/schemas/JSONSchemaNot"},{"$ref":"#/components/schemas/JSONSchemaNull"},{"$ref":"#/components/schemas/JSONSchemaNumber"},{"$ref":"#/components/schemas/JSONSchemaObject"},{"$ref":"#/components/schemas/JSONSchemaOneOf"},{"$ref":"#/components/schemas/JSONSchemaRemapper"},{"$ref":"#/components/schemas/JSONSchemaString"}]},"JSONSchemaAnyOf":{"type":"object","description":"A JSON schema which determines the value must match one or more of the given schemas.","additionalProperties":false,"required":["anyOf"],"properties":{"anyOf":{"type":"array","description":"The JSON schema must match one or more of the given schemas.","items":{"$ref":"#/components/schemas/JSONSchema"}},"examples":{"type":"array","description":"An example value which is valid according to this schema.","items":{}},"default":{"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaArray":{"type":"object","description":"A JSON schema for an array.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["array"],"description":"The type of the JSON schema. An array means a list of data."},"example":{"type":"array","description":"An example array which is valid according to this schema.","items":{"type":"array","items":{}}},"default":{"type":"array","description":"The default value which is used if no value is supplied.","items":{}},"maxItems":{"type":"integer","description":"The minimum amount of items the array is allowed to have.","minimum":1},"minItems":{"type":"integer","description":"The maximum amount of items the array is allowed to have.","minimum":0},"uniqueItems":{"type":"boolean","description":"If true, all items in the array need to be unique","default":false},"items":{"$ref":"#/components/schemas/JSONSchema","description":"This property describes what the items in an array should look like."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaBoolean":{"type":"object","description":"A JSON schema for a boolean.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["boolean"],"description":"The type of the JSON schema. A boolean means either true or false."},"examples":{"type":"array","items":{"type":"boolean","description":"An example boolean which is valid according to this schema."}},"default":{"type":"boolean","description":"The default value which is used if no value is supplied."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"boolean"}},"const":{"type":"boolean","description":"If const is specified, the type can be safely removed."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaConst":{"type":"object","description":"A JSON schema which describes a constant","additionalProperties":false,"required":["const"],"properties":{"const":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}],"description":"The given value must exactly match one the value specified here."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaEnum":{"type":"object","description":"A JSON schema for an enum.","additionalProperties":false,"required":["enum"],"properties":{"enum":{"type":"array","description":"A specific set of values this property is allowed to have.","items":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}]}},"enumDescriptions":{"type":"array","description":"An array is descriptions for the enum values.\n\nThe description is applied to the enum value at the same index.","items":{"type":"string"}},"examples":{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}],"description":"An example which is valid according to this schema."}},"default":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}],"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaInteger":{"type":"object","description":"A JSON schema for an integer.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["integer"],"description":"The type of the JSON schema. An integer means a fractionless number."},"examples":{"type":"array","items":{"type":"integer","description":"An example integer which is valid according to this schema."}},"default":{"type":"integer","description":"The default value which is used if no value is supplied."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"integer"}},"const":{"type":"integer","description":"If const is specified, the type can be safely removed."},"minimum":{"type":"integer","description":"The minimum value of the number.","example":0},"maximum":{"type":"integer","description":"The maximum value of the number.","example":100},"multipleOf":{"type":"integer","description":"The value must be a multiple of this number.\n\nFor example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,\n5, 7, 8, etc.\n"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaMultiType":{"type":"object","description":"A JSON schema which defines multiple types.","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"array","uniqueItems":true,"minItems":2,"description":"The type of the JSON schema. It’s recommended to use only one.","items":{"enum":["array","boolean","integer","null","number","string"]}},"examples":{"type":"array","description":"An example which is valid according to this schema.","items":{}},"default":{"description":"The default value which is used if no value is supplied."},"maxItems":{"type":"integer","description":"The minimum amount of items the array is allowed to have.","minimum":1},"minItems":{"type":"integer","description":"The maximum amount of items the array is allowed to have.","minimum":0},"uniqueItems":{"type":"boolean","description":"If true, all items in the array need to be unique","default":false},"items":{"$ref":"#/components/schemas/JSONSchema","description":"This property describes what the items in an array should look like."},"minimum":{"type":"integer","description":"The minimum value of the number.","example":0},"maximum":{"type":"integer","description":"The maximum value of the number.","example":100},"multipleOf":{"type":"integer","description":"The value must be a multiple of this number.\n\nFor example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,\n5, 7, 8, etc.\n"},"maxProperties":{"type":"integer","description":"The maximum number of properties the object is allowed to have.","minimum":0},"minProperties":{"type":"integer","description":"The minimum number of properties the object is must have.","minimum":1},"properties":{"type":"object","description":"A mapping of object keys for the object to nested JSON schemas.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"required":{"type":"array","description":"A list of properties that are required.","minItems":1,"items":{"type":"string","description":"A property name which is required on the object."}},"additionalProperties":{"description":"Describe if this object is allowed to have properties besides those defined in `properties`\n\nIt’s recommended to set this to `false`.\n","example":false,"anyOf":[{"type":"boolean","description":"If false, the object may not have any additional properties.\n\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\n"},{"$ref":"#/components/schemas/JSONSchema","description":"If this is a JSON schema, it describes any additional properties."}]},"format":{"enum":["date-time","time","date","duration","email","idn-email","hostname","idn-hostname","ipv4","ipv6","uuid","uri","uri-reference","iri","iri-reference","uri-template","json-pointer","relative-json-pointer","regex","action","binary","event-emitter","event-listener","fontawesome"],"description":"The format values should adhere to."},"minLength":{"type":"integer","description":"The minimum length of the string.","minimum":1},"maxLength":{"type":"integer","description":"The maximum length of the string.\n\nIt’s highly recommended to set this property, even if it’s a big number. For example 5000 characters\nis plenty for most larger input fields. Not doing so may result in extremely large user input, which\nresults in a bad user experience.\n","minimum":1,"example":5000},"pattern":{"type":"string","description":"A regular expression to describe user input.\n\nRegular expressions are a powerful way to enforce proper user input, but the learning curve is high.\nIf you don’t know what this is, we recommend to omit this field for now.\n","minLength":1,"format":"regex"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaNot":{"type":"object","description":"A JSON schema which may not be matched.","additionalProperties":false,"required":["not"],"properties":{"not":{"$ref":"#/components/schemas/JSONSchema","description":"The JSON schema which the value may not match."},"examples":{"type":"array","description":"An example value which is valid according to this schema.","items":{}},"default":{"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaNull":{"type":"object","description":"A JSON schema of type null only accepts a null value","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["null"],"description":"Only accept a null value."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaNumber":{"type":"object","description":"A JSON schema for a number which has fractions.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["number"],"description":"The type of the JSON schema. A number represents a number which has fractions. For fractionless numbers, use `integer` instead."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"number"}},"const":{"type":"number","description":"If const is specified, the type can be safely removed."},"examples":{"type":"array","items":{"type":"number","description":"An example number which is valid according to this schema."}},"default":{"type":"number","description":"The default value which is used if no value is supplied."},"minimum":{"type":"number","description":"The minimum value of the number.","example":0},"maximum":{"type":"number","description":"The maximum value of the number.","example":100},"exclusiveMinimum":{"type":"number","description":"The value must be bigger than this number. The given value itself is not allowed."},"exclusiveMaximum":{"type":"number","description":"The value must be smaller than this number. The given value itself is not allowed."},"multipleOf":{"type":"number","description":"The value must be a multiple of this number.\n\nFor example, if this is set to 0.5, then the values 0, 0.5, 1, 1.5, 2, 2.5, etc. will be allowed,\nbut not 0.3, 1.7, etc.\n"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaObject":{"type":"object","description":"A JSON schema for an object.","additionalProperties":false,"required":["type","additionalProperties"],"properties":{"type":{"enum":["object"],"description":"The type of the JSON schema."},"examples":{"type":"array","items":{"type":"object","description":"An example object which is valid according to this schema.","additionalProperties":true}},"default":{"type":"object","description":"The default value which is used if no value is supplied.","additionalProperties":true},"maxProperties":{"type":"integer","description":"The maximum number of properties the object is allowed to have.","minimum":0},"minProperties":{"type":"integer","description":"The minimum number of properties the object is must have.","minimum":1},"required":{"type":"array","description":"A list of properties that are required.","minItems":1,"items":{"type":"string","description":"A property name which is required on the object."}},"properties":{"type":"object","description":"A mapping of object keys for the object to nested JSON schemas.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"additionalProperties":{"description":"Describe if this object is allowed to have properties besides those defined in `properties`\n\nIt’s recommended to set this to `false`.\n","example":false,"anyOf":[{"type":"boolean","description":"If false, the object may not have any additional properties.\n\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\n"},{"$ref":"#/components/schemas/JSONSchema","description":"If this is a JSON schema, it describes any additional properties."}]},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaOneOf":{"type":"object","description":"A JSON schema which determines the value must match exactly one of the given schemas.","additionalProperties":false,"required":["oneOf"],"properties":{"oneOf":{"type":"array","description":"The JSON schema must match exactly one of the given schemas.","items":{"$ref":"#/components/schemas/JSONSchema"}},"example":{"description":"An example value which is valid according to this schema."},"default":{"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaRemapper":{"type":"object","description":"A JSON schema which allows a format of remapper without a type.","additionalProperties":false,"required":["format"],"properties":{"format":{"enum":["remapper"],"description":"Allow a remapper definition. This is supported for blocks only."},"default":{"$ref":"#/components/schemas/RemapperDefinition"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaRoot":{"type":"object","description":"A top level JSON schema.","additionalProperties":false,"properties":{"definitions":{"description":"This property may be used to store JSON schemas that may be referenced from other places.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"$schema":{"description":"The JSON schema meta schema. You probably don’t need to specify this explicitly.","enum":["http://json-schema.org/draft-04/schema#","http://json-schema.org/draft-07/schema#"],"default":"http://json-schema.org/draft-07/schema#"},"type":{"enum":["object"],"description":"The type of the JSON schema."},"examples":{"type":"array","items":{"type":"object","description":"An example object which is valid according to this schema.","additionalProperties":true}},"default":{"type":"object","description":"The default value which is used if no value is supplied.","additionalProperties":true},"maxProperties":{"type":"integer","description":"The maximum number of properties the object is allowed to have.","minimum":0},"minProperties":{"type":"integer","description":"The minimum number of properties the object is must have.","minimum":1},"required":{"type":"array","description":"A list of properties that are required.","minItems":1,"items":{"type":"string","description":"A property name which is required on the object."}},"properties":{"type":"object","description":"A mapping of object keys for the object to nested JSON schemas.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"additionalProperties":{"description":"Describe if this object is allowed to have properties besides those defined in `properties`\n\nIt’s recommended to set this to `false`.\n","example":false,"anyOf":[{"type":"boolean","description":"If false, the object may not have any additional properties.\n\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\n"},{"$ref":"#/components/schemas/JSONSchema","description":"If this is a JSON schema, it describes any additional properties."}]},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}},"required":["type","additionalProperties"]},"JSONSchemaString":{"type":"object","description":"A JSON schema for a string.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["string"],"description":"The type of the JSON schema. A string is the technical term for a piece of text."},"examples":{"type":"array","items":{"type":"string","description":"An example string which is valid according to this schema."}},"default":{"type":"string","description":"The default value which is used if no value is supplied."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"string"}},"const":{"type":"string","description":"If const is specified, the type can be safely removed."},"format":{"enum":["date-time","time","date","duration","email","idn-email","hostname","idn-hostname","ipv4","ipv6","uuid","uri","uri-reference","iri","iri-reference","uri-template","json-pointer","relative-json-pointer","regex","action","binary","event-emitter","event-listener","fontawesome"],"description":"The format values should adhere to."},"minLength":{"type":"integer","description":"The minimum length of the string.","minimum":1},"maxLength":{"type":"integer","description":"The maximum length of the string.\n\nIt’s highly recommended to set this property, even if it’s a big number. For example 5000 characters\nis plenty for most larger input fields. Not doing so may result in extremely large user input, which\nresults in a bad user experience.\n","minimum":1,"example":5000},"pattern":{"type":"string","description":"A regular expression to describe user input.\n\nRegular expressions are a powerful way to enforce proper user input, but the learning curve is high.\nIf you don’t know what this is, we recommend to omit this field for now.\n","minLength":1,"format":"regex"},"multiline":{"type":"boolean","description":"If true, Appsemble renders a textarea in the graphical JSON editor.","default":false},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"LinkActionDefinition":{"type":"object","additionalProperties":false,"required":["type","to"],"properties":{"type":{"enum":["link"],"description":"The link action can be used to redirect the user to other pages or absolute URLs."},"to":{"description":"The name of the page to link to. Subpages can be referred to using arrays. If this matches with an absolute URL, link will open this instead of matching it with a page or subpage.","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LinkBackActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["link.back"],"description":"Link back to the previous page in the browser history."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LinkNextActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["link.next"],"description":"Link to the next page in the browser history."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LogActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["log"],"description":"Output the result of the action into the console.\n\nThis is mostly useful for debugging blocks during development.\n"},"level":{"enum":["error","info","warn"],"default":"info","description":"The logging level on which to log."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LoopPageActionsDefinition":{"type":"object","description":"These actions are fired on a loop page.","required":["onLoad"],"additionalProperties":false,"properties":{"onLoad":{"$ref":"#/components/schemas/ActionDefinition","description":"This action is used to define the data to pass onto the loop type array"},"onFlowCancel":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when `flow.cancel` gets called."},"onFlowFinish":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when a flow is finished.\n\nA flow is finished when `flow.finish` gets called, or when `flow.next` gets called on the final\nsubpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action."}}},"LoopPageDefinition":{"type":"object","description":"This describes what a loop page will look like in the app.\n\n!!\nThis feature is still under development and is very unstable\n!!\n\n ","required":["type","foreach","actions","name"],"additionalProperties":false,"properties":{"type":{"enum":["loop"]},"actions":{"$ref":"#/components/schemas/LoopPageActionsDefinition"},"foreach":{"$ref":"#/components/schemas/SubPage"},"progress":{"description":"The method that should be used to display the status of flow pages.","enum":["corner-dots","hidden"]},"retainFlowData":{"type":"boolean","description":"Whether to retain the flow data when navigating away to another page outside the flow.\n\nBy default the flow page retains it's data after navigating once. Set to false to clear it.\n","default":true},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren’t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"}}},"MatchActionDefinition":{"type":"object","additionalProperties":false,"required":["type","match"],"properties":{"type":{"enum":["match"],"description":"Run another action if one of the cases is true.\n\nOnly the first case that equals true is called."},"match":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["case","action"],"description":"","properties":{"case":{"$ref":"#/components/schemas/RemapperDefinition","description":"The case to be matched."},"action":{"$ref":"#/components/schemas/ActionDefinition","description":"Action to be called if the case equals true."}}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"Member":{"type":"object","description":"A member of an organization.","required":["id"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/User/properties/id"},"name":{"$ref":"#/components/schemas/User/properties/name"},"primaryEmail":{"type":"string","format":"email","description":"The primary email address of the user."},"role":{"enum":["Member","Translator","APIReader","APIUser","AppEditor","Maintainer","Owner"]},"properties":{"type":"object","description":"Additional custom properties that a user might have.","additionalProperties":{"type":"string"}}}},"MessageActionDefinition":{"type":"object","additionalProperties":false,"required":["type","body"],"properties":{"type":{"enum":["message"],"description":"Display a message to the user.\n\nThis is useful in combination with action chaining to notify users they have performed a certain action.\n"},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"The body of the message."},"color":{"enum":["dark","primary","link","success","info","warning","danger"],"default":"info","description":"The Bulma color to apply to the message."},"layout":{"enum":["bottom","top"],"default":"bottom","description":"The position of the message on the screen."},"dismissable":{"type":"boolean","description":"Boolean value indicating whether the user is able to dismiss the message manually."},"timeout":{"type":"integer","default":5000,"description":"The time in milliseconds how long the message should be visible."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"NoopActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["noop"],"description":"Do nothing when this action is triggered.\n\nThis is the default action for block actions that are not required.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"NotificationHookDataDefinition":{"type":"object","description":"The data used to display the content of the notification.","additionalProperties":true,"minProperties":1,"properties":{"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title of the notification."},"content":{"$ref":"#/components/schemas/RemapperDefinition","description":"The body of the notification."},"link":{"type":"string","description":"The URL of the page the user gets redirected to after being clicked.\n\nIf the URL is relative, it will be relative to the app.\n"}}},"NotificationHookDefinition":{"type":"object","description":"The strategy used to notify users.","additionalProperties":false,"minProperties":1,"properties":{"to":{"type":"array","description":"The list of roles to notify.\n\nAside from roles, `$author` can also be used to notify the author of the resource.\n","minItems":1,"items":{"type":"string"}},"subscribe":{"description":"If set, allows users to manually subscribe for notifications for this resource regardless of roles.\n\nThe following values are allowed:\n- `all`: Allows users to be notified about actions on all of the resources of this type.\n- `single`: Allows users to be notified about actions a single instance of a resource of this\n type.\n- `both`: Allows users to be notified about all resources or a single resource of this type.\n","enum":["all","single","both"]},"data":{"$ref":"#/components/schemas/NotificationHookDataDefinition"}}},"NotifyActionDefinition":{"type":"object","additionalProperties":false,"required":["type","title","body","to"],"properties":{"type":{"enum":["notify"],"description":"Send notifications to one or all the users of an app."},"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title of the notification."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"The description of the notification."},"to":{"$ref":"#/components/schemas/RemapperDefinition","description":"To whom the notification should be sent.\n\nUse `all` to send the notification to all app subscribed users.\nOr notify specific users by passing either a single user id or an array of user ids.\n\nNothing is sent if the value is **not** a valid user id.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"OAuth2AuthorizationCode":{"type":"object","description":"OAuth2 client credentials","required":["code"],"additionalProperties":false,"properties":{"code":{"type":"string","description":"The OAuth2 authorization code.","readOnly":true}}},"OAuth2ClientCredentials":{"type":"object","description":"OAuth2 client credentials","required":["description","scopes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The generated client id","readOnly":true},"secret":{"type":"string","description":"The generated client secret","readOnly":true},"description":{"type":"string","description":"A description for the user to recognize the client.","maxLength":50},"expires":{"type":"string","description":"When the client credentials expire automatically.","format":"date-time"},"scopes":{"type":"array","description":"The scopes that have been granted to the client.","items":{"enum":["apps:write","blocks:write","organizations:write","resources:read","resources:write","assets:write","teams:read","teams:write"]}}}},"ObjectRemapperDefinition":{"type":"object","description":"An object based remapper is defined by a specific implementation\n\nObject based remappers may only define 1 key. The allowed value depends on the remapper.\n","minProperties":1,"maxProperties":1,"additionalProperties":false,"properties":{"array.map":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nThe remapper goes through the given array and applies the given remappers on each individual item.\nThis can be very handy when sorting arrays by certain data. The remapper always returns an array.\nOutput can be an empty array if the supplied data isn’t an array.\n\nFor example, if you want to sort through a list of people and only get their occupations you can do\nthe following:\n\nInput:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\"\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\"\n }\n]\n```\n\n```yaml\narray.map:\n object.omit:\n - name\n```\n\nResult:\n\n```json\n[{ \"occupation\": \"Delivery driver\" }, { \"occupation\": \"Scientist\" }, { \"occupation\": \"CEO\" }]\n```\n\nAnother great use for `array.map` is to combine it with the `if` remapper and sort your arrays on\nspecific values.\n\nUsing the same input data from the previous example, look at how you can change the code to get\npeople from a specific occupation:\n\n```yaml\n- array.map:\n if:\n condition: { equals: [{ prop: occupation }, Scientist] }\n then:\n object.from:\n name:\n prop: name\n occupation:\n prop: occupation\n else: null\n- null.strip: null\n```\n\nResult:\n\n```json\n[\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\"\n }\n]\n```\n\nBecause `array.map` returns an array, every item has to return something. This is why we have to\nreturn the full object with the data we want in the `then` section. It’s also why we return `null`.\nThis results in an array consisting of `null` values and objects with actual data in them. To solve\nthis problem, we use the `null.strip` remapper to remove any null values which results in a clean\narray.\n"},"array.unique":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nFilters out unique values from an array. The value Remapper is applied to each entry in the array\nusing its result to determine uniqueness.\n\nIf the value Remapper results in undefined or null, the entire entry is used for uniqueness.\n\nIf the input is not an array, the input is returned without any modifications.\n\nInput:\n\n```json\n[1, 1, 2, 3]\n```\n\n```yaml\narray.unique: null\n```\n\nResult:\n\n```json\n[1, 2, 3]\n```\n\nYou can also check for more complex values in arrays. The remapper accepts remappers as well, so you\ncan also use entire objects to check for unique values.\n\nFor this example, we have the following extended data with some duplicate values:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\",\n \"age\": 19\n },\n {\n \"name\": \"Peter\",\n \"occupation\": \"Photographer\",\n \"age\": 19\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\",\n \"age\": 50\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\",\n \"age\": 20\n }\n]\n```\n\nWe can be fairly sure in this list of people the first two Peters are the same person but with a\ndifferent occupation. To get more complex unique values from here, we can do the following:\n\n```yaml\narray.unique:\n object.from:\n name: { prop: name }\n age: { prop: age }\n```\n\nThis then checks the array for unique values in both the `name` and `age` fields. The result of this\nremapper is a filtered list:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\",\n \"age\": 19\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\",\n \"age\": 50\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\",\n \"age\": 20\n }\n]\n```\n "},"array.from":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\nCreates a new array based on a provided array of remappers. This array can also consist of static\nvalues.\n\nFor example:\n\n```yaml\narray.from:\n - Peter\n - Otto\n - Harry\n```\n\n```json\n[\"Peter\", \"Otto\", \"Harry\"]\n```\n\nThis remapper can also be used to convert given data into an array.\n\nInput:\n\n```json\n{\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n}\n```\n\n```yaml\narray.from:\n - root: null # Takes the data passed to this remapper, explained more in the 'Data' page\n```\n\nResult:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n }\n]\n```\n "},"array.append":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\nAppend new values to the end of an array. If the input is not an array an empty array is returned.\n\nUsing the array from the previous example, we can add a new object on top of it using this remapper:\n\n```yaml\narray.append:\n - object.from:\n name: James\n occupation: News reporter\n```\n\nResult:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\"\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\"\n },\n {\n \"name\": \"James\",\n \"occupation\": \"News reporter\"\n }\n]\n```\n "},"array.omit":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\nRemove values from an array. The input is expected to be the index(es) of the items to be deleted.\nAccepts an array of static or remapper values.\n\nWith the previous example we added a new person to the list of people, so now we can remove that\nperson. We already know the index of this person in the array is `3`, so it’s easy:\n\n```yaml\narray.omit:\n - 3\n```\n\nResult:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\"\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\"\n }\n]\n```\n\nHowever, usually we don’t know the exact index of the item we want to delete. Because the remapper\naccepts remappers as input we can get the desired item’s ID from another source as well. Take the\nfollowing example:\n\nIn this example we assume the data from the previous example is passed to this table block using a\ndata loader’s emitting event called “people”. When the user clicks on one of the people in the\ntable, it gets the list of people again. Using the index of this person, and the `array.omit`\nremapper, the person gets removed from the list.\n\n```yaml\ntype: table\nversion: 0.20.38\nevents:\n listen:\n data: people\nparameters:\n fields:\n - label: Name\n value: { prop: name }\n onClick: removePerson\n - label: Occupation\n value: { prop: occupation }\nactions:\n removePerson:\n type: resource.query\n resource: citizensNYC\n remapAfter:\n array.omit:\n - context: index # This gets the index of the item in the table, explained more in the 'Data' page.\n onSuccess:\n type: resource.update\n resource: citizensNYC\n```\n "},"if":{"type":"object","description":"Check if condition results in a truthy value.\n\nReturns value of `then` if condition is truthy, otherwise it returns the value of `else`.\n\nFor example:\n\n```yaml\nif:\n condition: { equals: [{ prop: inputValue }, 4] }\n then:\n static: You guessed right!\n else:\n static: You guessed wrong!\n```\n\nIf the `inputValue` is `4`, it goes to the `then` remapper and returns:\n```\nYou guessed right!\n```\n\nIf the `inputValue` is something other than `4`, it goes to the `else` remapper and returns:\n```\nYou guessed wrong!\n```\n","additionalProperties":false,"required":["condition","then","else"],"properties":{"condition":{"$ref":"#/components/schemas/RemapperDefinition","description":"The condition to check."},"then":{"$ref":"#/components/schemas/RemapperDefinition","description":"This remapper is used if the condition returns true."},"else":{"$ref":"#/components/schemas/RemapperDefinition","description":"This remapper is used if the condition returns false."}}},"equals":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"Compare all computed remapper values against each other.\n\nReturns `true` if all entries are equal, otherwise `false`.\n\nIn the following example, if the `inputValue` and `expectedValue` are of the same value, the\ncondition will return `true` and the `then` remapper will fire.\n\n```yaml\ncondition:\n equals:\n - prop: inputValue\n - prop: expectedValue\n```\n"},"gt":{"type":"array","description":"**(gt = Greater than)**\n\nCompare the first computed remapper value with the second computed remapper value.\n\nReturns `true` if the first entry is greater than the second entry.\n\nFor example, if `stock` is more than 5 here, it returns `true`.\n\n```yaml\ncondition:\n gt:\n - prop: stock\n - 5\n```\n","minItems":2,"maxItems":2,"items":{"$ref":"#/components/schemas/RemapperDefinition"}},"lt":{"type":"array","description":"**(lt = Lesser than)\n\nCompare the first computed remapper value with the second computed remapper value.\n\nReturns `true` if the first entry is lesser than the second entry.\n\nFor example, if `stock` is less than 5 here, it returns `true`.\n\n```yaml\ncondition:\n lt:\n - prop: stock\n - 5\n```\n","minItems":2,"maxItems":2,"items":{"$ref":"#/components/schemas/RemapperDefinition"}},"not":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"Compare all computed remapper values against the first.\n\nReturns `false` if all entries are equal to the first entry, otherwise `true`.\n\nIf only one remapper or none is passed, the remapper value gets computed and then inverted.\n\nIf `number` in the following example is something other than 4, the condition returns `true`.\n\n```yaml\ncondition:\n not:\n - prop: number\n - 4\n```\n"},"match":{"type":"array","description":"Check if any case results in a truthy value.\n\nReturns the value of the first case where the condition equals true, otherwise returns null.\n\nIn the following example, let's say the `Gem` is a \"Ruby\". The match remapper then returns\n`value: 75`.\n\n```yaml\nmatch:\n - case: { equals: [{ prop: Gem }, Diamond] }\n value: 100\n - case: { equals: [{ prop: Gem }, Ruby] }\n value: 75\n - case: { equals: [{ prop: Gem }, Gold] }\n value: 50\n - case: { equals: [{ prop: Gem }, Sapphire] }\n value: 25\n```\n","items":{"type":"object","additionalProperties":false,"required":["case","value"],"description":"","properties":{"case":{"$ref":"#/components/schemas/RemapperDefinition","description":"The condition to check."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"This remapper is used if the case is true"}}}},"array":{"enum":["index","length"],"description":"Get the current array.map’s index or length.\n\nReturns nothing when not in the context of `array.map’s`.\n\nFor example:\n\nInput:\n```json\n[\"a\", \"b\", \"c\"]\n```\n\nThis remapper definition maps through the input array and creates an object with the length of the\narray and the current index of the loop:\n```yaml\narray.map:\n object.from:\n length: { array: length }\n index: { array: index }\n```\n\nResult:\n```json\n[\n {\n \"index\": 0,\n \"length\": 3\n },\n {\n \"index\": 1,\n \"length\": 3\n },\n {\n \"index\": 2,\n \"length\": 3\n }\n]\n```\n"},"app":{"enum":["id","locale","url"],"description":"Gives actual information about the current app. Using this remapper you will have access to the\nfollowing information:\n\n- `id`: App ID\n- `locale`: Current locale (user selected language) of the app\n- `url`: Base URL of the app\n\nExample:\n\n```json\n{\n \"id\": 11,\n \"locale\": \"en\",\n \"url\": \"https://example-app.examplecompany.appsemble.app\"\n}\n```\n"},"context":{"type":"string","description":"Gets a property from custom context passed by blocks. This property is specific to each block. To\nunderstand what the context of a certain block does, check the block’s description.\n\nFor this example, we will take the [`table`](/blocks/@appsemble/table/0.20.39) block. As of now,\nthis block provides two options for context: `index` and `repeatedIndex`. Whenever you click on an\nitem in the table, it gives the index of that table row in the associated action.\n\nSo with the following example:\n\n```yaml\ntype: table\nversion: 0.20.39\nevents:\n listen:\n data: contextData\nparameters:\n fields:\n - label: Name\n value: { prop: name }\n onClick: clickName\n - label: Age\n value: { prop: age }\nactions:\n clickName:\n remapBefore:\n context: index\n type: log\n```\n\nClicking on the first item would log `0`, the second item `1` and so on.\n"},"history":{"type":"integer","description":"> **Note:** This remapper is explained more in depth in the [History](/docs/remapper/history) page\n\nGives the data at the history entry at the specified history index. The history at specified index\nis the data that is passed to that action.\n\n```yaml\nremapBefore:\n object.from:\n title: Most influential bands of all time\n content: ...\ntype: noop # history 0\nonSuccess:\n type: resource.query # history 1\n resource: people\n onSuccess:\n type: noop # history 2\n onSuccess:\n remapBefore:\n history: 1\n type: log # history 3\n```\n\nResult:\n\n```json\n{\n \"title\": \"Most influential bands of all time\",\n \"content\": ...\n}\n```\n "},"step":{"type":"string","description":"\n\nWhile in a loop page, this remapper allows you to get properties from the data at the current index.\n\n```yaml\nname: Survey\ntype: loop\nactions:\n onLoad:\n type: resource.query\n resource: questions\nforeach:\n blocks:\n - type: detail-viewer\n version: 0.20.39\n parameters:\n fields:\n - label: { step: title }\n```\n\nWith this example, we load an array of questions that have the `title` property. What the `step`\nremapper does in this case is show the title of the current question in the loop.\n\nThe result of this is a flow page where each page shows the question’s title.\n\n"},"page":{"enum":["data","url"],"description":"Gives actual information about the current page. This remapper gives access to the following\ninformation:\n\n- `data`: Current page data (FlowPage)\n- `url`: Full URL of the current page\n\nExample:\n\n```json\n{\n \"data\": {\n \"name\": \"Peter\"\n },\n \"url\": \"https://example-app.examplecompany.appsemble.app/en/example-page-a\"\n}\n```\n\nThe page data only works in the context of a flow page. Let’s say you have a\n[“FlowPage”](/docs/reference/app#-flow-page-definition) type with multiple subpages. Whenever you\nnavigate to the next page it adds the data from that page to the flow page’s data. The page remapper\nallows you to access this cumulative data.\n\nThe following page definition shows a page definition for a flow page where the user has to fill in\nsome user information. For each subpage the result of `page: data` is shown.\n\n\n```yaml\nname: PageDataFlow\ntype: flow\nsteps:\n # page: data = {}\n - blocks:\n - type: form\n version: 0.20.39\n parameters:\n fields:\n - name: name\n type: string\n actions:\n onSubmit:\n type: flow.next\n # page: data = { name: \"Peter\" }\n - blocks:\n - type: form\n version: 0.20.39\n parameters:\n fields:\n - name: age\n type: string\n actions:\n onSubmit:\n type: flow.next\n # page: data = { name: \"Peter\", age: \"47\" }\n - blocks:\n - type: data-loader\n version: 0.20.39\n actions:\n onLoad:\n remapBefore:\n page: data\n type: log\n```\n\nThe result of the final page’s log would then be:\n\n```json\n{\n \"name\": \"Peter\",\n \"age\": \"47\"\n}\n```\n\n"},"prop":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"array","minItems":1,"items":{"anyOf":[{"type":"string"},{"type":"integer"}]}}],"description":"Gets the chosen property from an object.\n\n```json\n{\n \"name\": \"John\",\n \"age\": 52\n}\n```\n\n```yaml\nprop: name\n```\n\nResult:\n\n```json\n\"John\"\n```\n"},"root":{"enum":[null],"description":"Gets the input data as it was initially passed to the remapper function.\n\n```yaml\ntype: resource.query\nresource: people\nquery:\n object.from:\n $filter: city eq 'Eindhoven'\nonSuccess:\n remapBefore:\n object.from:\n name: Residents of Eindhoven\n people:\n root: null\n```\n\nResult:\n\n```json\n{\n \"name\": \"Residents of Eindhoven\",\n \"people\": [\n {\n \"name\": ...,\n \"city\": \"Eindhoven\"\n },\n ...\n ]\n}\n```\n "},"static":{"description":"Create a static value\n\n```yaml\nstatic: Hello!\n```\n\nReturns the following string:\n\n```\nHello!\n```\n"},"translate":{"type":"string","description":"> **Note:** This is explained much more in depth at [Translating](/docs/03-guide/translating)\n\nThis remapper allows you to easily add translations to your app. To make this remapper work, replace\nany static text with `translate: {name}`. Then, in your app’s Translations page pick the language\nyou want to translate. You will see a list of names with input text below. Translations you manually\nput in the app using the `translate` remapper are found under “Custom messages”.\n\nAfter putting the translation in, any user that logs in with that language selected will see the\ntranslated message.\n\nExample:\n\n```yaml\ntype: detail-viewer\nversion: 0.20.39\nparameters:\n fields:\n - label: { translate: weatherTitle }\n value: { translate: weatherBody }\n```\n\n"},"user":{"enum":["sub","name","email","email_verified","picture","profile","locale"],"description":"\n> **Note:** For this remapper to work, the user that activated the remapper has to be logged in to\n> the app\n\nProvides some fields of user information taken from the OpenID user info. These fields are:\n\n- `email`: User’s **primary** email address\n- `email_verified`: Whether the user’s primary email address is verified or not (`boolean`)\n- `locale`: The user’s default language [`BCP47`](https://en.wikipedia.org/wiki/IETF_language_tag)\n language tag (ex. `en`) (Broken)\n- `name`: The user’s name\n- `picture`: Full URL to the user’s profile picture web address\n- `sub`: The user’s identifier\n\nExample:\n\n```json\n{\n \"email\": \"[email protected]\",\n \"email_verified\": true,\n \"locale\": \"en\",\n \"name\": \"Test User\",\n \"picture\": \"https://www.gravatar.com/avatar/f46b82357ce29bcd1099915946cda468?s=128&d=mp\",\n \"sub\": \"5c6270e2-ad31-414f-bcab-6752a2c4dcfd\"\n}\n```\n "},"date.add":{"type":"string","description":"Adds a specified date value to the provided date.\n\nThe value to add should be specified according to the\n[parse-duration](https://www.npmjs.com/package/parse-duration) API. If you want to add a day to a\ndate for example, the syntax would be `date.add: 1d`.\n\nFull list of supported unit types:\n- nanoseconds (ns)\n- microseconds (μs)\n- milliseconds (ms)\n- seconds (s, sec)\n- minutes (m, min)\n- hours (h, hr)\n- days (d)\n- weeks (w, wk)\n- months\n- years (y, yr)\n\nFor example:\n\nDate now:\n```json\n2023-06-30T14:50:19.601Z\n```\n\nRemapper definition:\n```yaml\n[{ date.now: null }, { date.add: 1w } , { date.format: null }]\n```\n\nResult:\n```json\n2023-07-07T14:50:19.601Z\n```\n\n"},"date.format":{"enum":[null],"description":"Format a date according to the RFC3339 format.\n\nHere is an example of a RFC3339 complicit date:\n`2002-10-02T15:00:00Z`\n\nIn an app definition, it’s best to use this when you want to display a date in a specific format.\nFor example, if your app has a form with a Datepicker field the incoming data will be formatted\nas a simple date format. If you want to format it tot he RFC3339 format, you can use this remapper.\n\nWhen you submit a form with a DateField, the internal output looks like this:\n\n```js\n2023-07-03\n```\n\nYou can then format the date so that it uses the RFC3339 format.\n\n```yaml\ndate.format: null\n```\n\nResult:\n```js\n\"2023-07-03T09:09:50.000Z\"\n```\n"},"date.now":{"enum":[null],"description":"Returns the current date as a JavaScript Date object.\n```yaml\ndate.now: null\n```\n\nResult:\n```js\n\"Mon Jul 03 2023 11:47:18 GMT+0200 (Midden-Europese zomertijd)\"\n```\n"},"date.parse":{"type":"string","description":"Convert a string to a date using a given format.\n\nFor example:\n```yaml\n- static: 02/11/2014 # The date string to parse\n- date.parse: MM/dd/yyyy # The given format to parse the date with\n # => Tue Feb 11 2014 00:00:00\n```\n\nSee [date-fns](https://date-fns.org/v2.29.3/docs/parse) for the supported formats.\n\nLeaving the format empty will try to parse the date using the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\nFor example:\n```yaml\ndate.parse:\n- static: 2014-02-11T11:30:30 # The date string to parse\n- date.parse: '' # The given format to parse the date with\n # => Tue Feb 11 2014 11:30:30\n```\n"},"from.history":{"type":"object","required":["index","props"],"description":"Creates a new object based on the specified properties in the given history index. This can be very\nuseful when you want to combine two sources of data together. It’s also cleaner than separately\nusing `object.from` together with `history`.\n\nIn the following example, you can see why this might be handy. Let’s say you get the details about a\nconcert from a source like an action or a block. You have this information and then you want to get\nsome additional data like the attendees of the concert. With `from.history` you can combine the\nolder data like the name and date, and add the new `attendees` data. The result will be an object\nwith this combined data.\n\nHistory index 1:\n\n```json\n{\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"price\": 120\n}\n```\n\nInput:\n\n```json\n[ .. ]\n```\n\n```yaml\nobject.from:\n concertDetails:\n from.history:\n index: 1\n props:\n name: { prop: name }\n date: { prop: date }\n attendees: { root: null }\n```\n\nResult:\n\n```json\n{\n \"concertDetails\": {\n \"attendees\": [ .. ],\n \"date\": \"07-07-2022\",\n \"name\": \"Rolling stones at Amsterdam Arena\"\n }\n}\n```\n","additionalProperties":false,"properties":{"index":{"type":"integer","description":"The index of the history stack item to assign.\n\n0 is the index of the first item in the history stack.\n"},"props":{"description":"Predefined mapper keys to choose what properties to apply.","additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"}}}},"assign.history":{"type":"object","required":["index","props"],"description":"Assigns properties from the specified history stack index to an existing object.\nSimilarly to the `from.history` remapper, this allows you to get a property from a place in the\nhistory and give it to a new object. The only difference here is that you are not creating an\nentirely new object, but you are taking an existing object and assigning new values to it.\n\nSo, we can take the example from `from.history` and flip it.\n\nHistory index 1:\n\n```json\n{\n \"peopleAmount\": 3000\n}\n```\n\nInput:\n\n```json\n{\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"price\": 120\n}\n```\n\n```yaml\nobject.from:\n concertDetails:\n assign.history:\n index: 1\n props:\n attendees: { prop: peopleAmount }\n```\n\nResult:\n\n```json\n{\n \"concertDetails\": {\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"price\": 120,\n \"attendees\": 3000\n }\n}\n```\n","additionalProperties":false,"properties":{"index":{"type":"integer","description":"The index of the history stack item to assign.\n\n0 is the index of the first item in the history stack.\n"},"props":{"description":"Predefined mapper keys to choose what properties to assign.","additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"}}}},"omit.history":{"type":"object","required":["index","keys"],"description":"Assigns properties from the specified history stack index to the current value and excludes the\ngiven properties.\n\nSimilarly to the other history remappers, this gives you the data from a certain point in the\nhistory stack and allows you to modify it before adding to the current value. This one, however,\nallows you to take the complete specified history data and omit certain values.\n\nThis remapper can be extremely helpful for re-using data you got before in the history stack while\nfiltering certain properties.\n\nFor example, let’s say you have the information for a concert but don’t want normal users to see\nsensitive data about it. Using `omit.history` you can take this concert data but exclude the\nsensitive parts.\n\nHistory index 1:\n\n```json\n{\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"bandPasswords\": [ .. ],\n \"bankDetailsAttendees\": [ .. ]\n}\n```\n\nInput:\n\n```json\n[ .. ]\n```\n\n```yaml\nobject.from:\n concertDetails:\n omit.history:\n index: 1\n keys:\n - bandPasswords\n - bankDetailsAttendees\n```\n\nResult:\n\n```json\n{\n \"concertDetails\": {\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"attendees\": [ .. ]\n }\n}\n```\n","additionalProperties":false,"properties":{"index":{"type":"integer","description":"The index of the history stack item to assign.\n\n0 is the index of the first item in the history stack.\n"},"keys":{"description":"Exclude properties from the history stack item, based on the given object keys.\n\nNested properties can be excluded using arrays of keys.\n\nFor example:\n```yaml\nomit.history:\n index: 0\n keys:\n - foo # Excludes the property foo\n - - bar # Excludes the property baz inside of bar\n - baz\n```\n","type":"array","items":{"minItems":1,"anyOf":[{"type":"string"},{"type":"array","minItems":2,"items":{"type":"string"}}]}}}},"object.assign":{"additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\n\nLet’s say you have an existing object that you want to add an additional value on top of. For this\nyou can use the `object.assign` remapper. The remapper takes an existing object and allows the user\nto assign their own value on top of that.\n\nInput:\n\n```json\n{\n \"title\": \"Weekly fishing 21\"\n}\n```\n\n```yaml\nobject.assign:\n author: John Doe\n```\n\nResult:\n\n```json\n{\n \"title\": \"Weekly fishing 21\",\n \"author\": \"John Doe\"\n}\n```\n\n"},"object.from":{"additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\n\nWith this remapper you can create an entirely new object based on input values and other remappers.\n`object.from` itself accepts remapper functions as its input which allows you to chain multiple\nremappers together to make complex objects.\n\nAs a base, the remapper looks like this:\n\n```yaml\nobject.from:\n username: Chris Taub\n email: [email protected]\n```\n\n```json\n{\n \"username\": \"Chris Taub\",\n \"email\": \"[email protected]\"\n}\n```\n\nMost of the time you won’t create an object just to store one value. Luckily, this is where the\nchaining of remappers comes in. You can create an object that contains an `object.from` remapper\nwhich then allows more inputs:\n\n```yaml\nobject.from:\n username: Chris Taub\n email: [email protected]\n addresses:\n object.from:\n work:\n object.from:\n city: Eindhoven\n address: Nachtegaallaan 15\n home:\n object.from:\n city: Amsterdam\n address: Amstel 1\n```\n\n```json\n{\n \"username\": \"Chris Taub\",\n \"email\": \"[email protected]\",\n \"addresses\": {\n \"work\": {\n \"city\": \"Eindhoven\",\n \"address\": \"Nachtegaallaan 15\"\n },\n \"home\": {\n \"city\": \"Amsterdam\",\n \"address\": \"Amstel 1\"\n }\n }\n}\n```\n\n"},"object.omit":{"type":"array","items":{"minItems":1,"anyOf":[{"type":"string"},{"type":"array","minItems":2,"items":{"type":"string"}}]},"description":"\n\nIn contrary to the previous remapper, what if you have an object from which you want to remove a\nvalue? Then you can use `object.omit`. The remapper can remove properties from an existing object\nbased on the given object keys. This includes nested properties.\n\nInput:\n\n```json\n{\n \"title\": \"Weekly fishing 21\",\n \"author\": \"John Doe\",\n \"content\": {\n \"introduction\": \"This is the introduction for the new weekly fishing issue\",\n \"paragraph1\": \"...\",\n \"interview\": \"...\"\n }\n}\n```\n\n```yaml\nobject.omit:\n - author\n - - content\n - interview\n```\n\nResult:\n\n```json\n{\n \"title\": \"Weekly fishing 21\",\n \"content\": {\n \"introduction\": \"This is the introduction for the new weekly fishing issue\",\n \"paragraph1\": \"...\"\n }\n}\n```\n\n"},"random.choice":{"enum":[null],"description":"Pick and return a random entry from an array. If the input is not an array, the input is returned as-is.\nFor example:\n\nIf you input the following array:\n```json\n[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]\n```\n\n```yaml\nrandom.choice: null\n```\n\nThe result could return any one of these numbers.\n\nYou can also combine different data types in this array and have it work in the same way. If mixed in\nstrings, the result could be either one of the provided numbers or one of the provided strings.\n\n```json\n[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, \"Peter\", \"Patrick\", \"Michael\", \"Harry\"]\n```\n"},"random.integer":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"integer"},"description":"Pick and return a random integer between the provided lowest and highest values.\nFor example:\n```yaml\nrandom.integer:\n - 0\n - 1000\n```\n\nReturns a random integer between 0 and 1000.\n"},"random.float":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"},"description":"Pick and return a random float value between the provided lowest and highest values.\nFor example:\n```yaml\nrandom.float:\n - 0\n - 1\n```\n\nReturns a random float value between 0 and 1.\n"},"random.string":{"type":"object","required":["choice","length"],"additionalProperties":false,"properties":{"choice":{"type":"string","minLength":1},"length":{"type":"integer","minimum":1}},"description":"Pick and return a random string from a given length using characters from a given input string defined in `choice`.\nFor example:\n```yaml\nrandom.string:\n choice: abcdefghijklmnopqrstuvwxyz0123456789\n length: 6\n```\n\nReturns a randomized string that is 6 characters long and consists of any characters in the `choice` field, like: `g8ajss9`.\n"},"string.case":{"enum":["lower","upper"],"description":"Convert a string to upper or lower case.\n```yaml\nstring.case: upper\n```\n\nResult:\n\n```json\n\"PATRICK\"\n```\n\n"},"string.format":{"type":"object","additionalProperties":false,"properties":{"messageId":{"type":"string","description":"The message id pointing to the template string to format."},"template":{"type":"string","description":"The template default string to format."},"values":{"description":"A set of remappers to convert the input to usable values.","additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"}}},"description":"Format a string using remapped input variables.\nUseful for replacing static text with generated values.\n\n```yaml\nstring.format:\n template: 'You have won €{lotteryAmount} in the lottery!!'\n values:\n lotteryAmount: { prop: lotteryPrize }\n```\n\nResult:\n\n```json\n\"You have won €5000 in the lottery!!\"\n```\n\n> **Tip:** Considering this can be inserted anywhere a remapper is accepted. You can also use this\n> to choose specific URL’s more accurately.\n\n"},"string.replace":{"type":"object","minProperties":1,"maxProperties":1,"additionalProperties":{"type":"string"},"description":"\nUses RegEx to find a value in a string and replace it with a given value.\n\n```yaml\n# Input: Eindhoven is the best city in the Netherlands\nstring.replace:\n (beszt*)\\w+: cleanest\n```\n\nResult:\n\n```json\n\"Eindhoven is the cleanest city in the Netherlands\"\n```\n"},"ics":{"type":"object","description":"Create a calendar event. This event can be downloaded as an `.ics` file and\nuploaded to your agenda using the [download](../reference/action#download) action.\n\nFor example, the following input:\n```yaml\nics:\ncoordinates\n object.from:\n latitude: 38.897700545442646\n longitude: -77.03655660152435\ndescription: \"Sprint planning meeting\"\nduration: 1d\nend: 2023-07-19\nlocation: The Oval Office.\nstart: 2023-07-18\ntitle: Important Meeting\nurl: https://google.nl\n```\n\nCreates the following ICS-formatted object:\n```\nBEGIN:VCALENDAR\nVERSION:2.0\nCALSCALE:GREGORIAN\nPRODID:http://remappers.appsemble.localhost:9999\nMETHOD:PUBLISH\nX-PUBLISHED-TTL:PT1H\nBEGIN:VEVENT\nUID:b8TsbczhfpIxPM-3lNHQz\nSUMMARY:Important Meeting\nDTSTAMP:20230703T102029Z\nDTSTART:20230717T220000Z\nDTEND:20230718T220000Z\nDESCRIPTION:Sprint planning meeting\nURL:https://google.nl\nGEO:38.897700545442646;-77.03655123710632\nLOCATION:The Oval Office.\nEND:VEVENT\nEND:VCALENDAR\n```\n","additionalProperties":false,"required":["start","title"],"properties":{"start":{"$ref":"#/components/schemas/RemapperDefinition","description":"The start of the icalendar event."},"end":{"$ref":"#/components/schemas/RemapperDefinition","description":"The end of the icalendar event."},"duration":{"$ref":"#/components/schemas/RemapperDefinition","description":"The duration of the event.","example":"1w 3d 10h 30m"},"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title of the event."},"description":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional description of the event."},"url":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional link to attach to the event."},"location":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional location description to attach to the event."},"coordinates":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional geolocation description to attach to the event.\n\n This must be an object with the properties `lat` or `latitude`, and `lon`, `lng` or `longitude`."}}},"null.strip":{"description":"Strip all null, undefined, and empty array values from an object or array.\nFor example, with the following input value:\n```json\n[0, 4, null, null, \"Peter\", 0.4234, null]\n```\n```yaml\nnull.strip: null\n```\n\nThe null values will be removed, leaving a dense array:\n```json\n[0, 4, \"Peter\", 0.4234]\n```\n\nInstead of giving it `null` as option, you can also provide a `depth` property to specify how\ndeep to recurse into the object or array to remove null values.\n\nFor example, with the following input:\n```json\n{\n 0: [0, null, \"Peter\"],\n 1: {\n \"array1\": [4, null, 0.4234, null]\n }\n}\n```\n\nYou can specify to which degree of depth you want the null values to be removed.\nWith this remapper definition:\n```yaml\nnull.strip:\n depth: 2\n```\n\nIt will only check two objects in for any null values. That means only the first array within the\nobject will be checked. The result looks like this:\n```json\n{\n 0: [0, \"Peter\"],\n 1: {\n \"array1\": [4, null, 0.4234, null]\n }\n}\n```\n","anyOf":[{"enum":[null]},{"type":"object","required":["depth"],"additionalProperties":false,"description":"Options for the null.strip remapper.","properties":{"depth":{"type":"integer","minimum":1,"description":"How deep to recurse into objects and arrays to remove null values."}}}]},"log":{"enum":["info","warn","error"],"description":"Logs in the browser's console and returns the incoming data and the remapper function's context.\n\nThe context contains relevant info about the app, like the URL and locale, but also contains the\nremapper’s history.\n\nThe options represent the level of logging that will show in the console.\n\n- `input`: The input data going into this remapper,\n- `context`:\n - `root`: The input data going into this remapper,\n - `appId`: ID of the application,\n - `url`: Absolute URL of the page where the remapper was fired,\n - `appUrl`: Base URL of the application,\n - `pageData`: Current page data of a FlowPage (See [page remapper](./data#page)),\n - `userInfo`: User's information if they are logged in (See [user remapper](./data#user)),\n - `context`:\n - `history`: Complete list of this remapper’s history (See [history remapper](./history))\n - `history`: Complete list of this remapper’s history (See [history remapper](./history))\n - `locale`: The user’s locale,\n - `stepRef`: In a loop page, gives the properties from the loop’s current data index (See [step remapper](./data#step))\n\nFor example:\n\n```json\n{\n \"input\": {\n \"name\": \"Peter\",\n \"age\": 49,\n \"birthday\": \"07-08-2023\"\n },\n \"context\": {\n \"root\": {\n \"name\": \"Peter\",\n \"age\": 49,\n \"birthday\": \"07-08-2023\"\n },\n \"appId\": 49,\n \"url\": \"http://remappers.appsemble.localhost:9999/en/other\",\n \"appUrl\": \"http://remappers.appsemble.localhost:9999\",\n \"pageData\": {\n \"triedAppsemble\": false\n },\n \"userInfo\": {\n \"email\": \"[email protected]\",\n \"email_verified\": true,\n \"name\": \"Example User 1\",\n \"picture\": \"https://www.gravatar.com/avatar/f46b82357ce29bcd1099915946cda468?s=128&d=mp\",\n \"sub\": \"0000-0000-0000-0000\",\n \"locale\": \"en\",\n \"zoneinfo\": \"Europe/Amsterdam\"\n },\n \"context\": {\n \"history\": [\n [\n 0,\n 4,\n null,\n null,\n \"Peter\",\n 0.4234,\n null\n ],\n {\n \"name\": \"Peter\",\n \"age\": 49\n },\n {\n \"name\": \"Peter\",\n \"age\": 49,\n \"birthday\": \"07-08-2023\"\n }\n ]\n },\n \"history\": [\n [\n 0,\n 4,\n null,\n null,\n \"Peter\",\n 0.4234,\n null\n ],\n {\n \"name\": \"Peter\",\n \"age\": 49\n },\n {\n \"name\": \"Peter\",\n \"age\": 49,\n \"birthday\": \"07-08-2023\"\n }\n ],\n \"locale\": \"en\",\n \"stepRef\": {\n \"current\": {\n \"answerType\": \"multiple choice\",\n \"question\": \"How much do you enjoy working here?\"\n }\n }\n }\n}\n```\n"}}},"Organization":{"type":"object","description":"An organization groups a set of users, apps, themes, and permissions together","required":["id"],"additionalProperties":false,"properties":{"id":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","minLength":1,"maxLength":30,"description":"The unique identifier for the organization."},"name":{"type":"string","description":"The display name for the organization."},"description":{"type":"string","description":"The description of the organization.","maxLength":160},"email":{"type":"string","description":"The email address of the organization."},"website":{"type":"string","description":"The website of the organization."},"iconUrl":{"type":"string","description":"The URL used to fetch the organization’s icon."}}},"PageDefinition":{"type":"object","additionalProperties":false,"description":"The list of blocks that are displayed on the page.\n\nEach page requires at least one block. Blocks are displayed in the order that they are defined in\nthe list.\n","required":["blocks","name"],"properties":{"blocks":{"type":"array","minItems":1,"description":"The blocks that make up a page.","items":{"$ref":"#/components/schemas/BlockDefinition"}},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren’t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"}}},"Rating":{"type":"object","description":"A representation of an App rating.","additionalProperties":false,"required":["rating"],"properties":{"rating":{"type":"number","minimum":1,"maximum":5,"description":"A value ranging from 1 to 5 stars rating of the App."},"description":{"type":"string","description":"An optional explanation of the given rating."},"name":{"$ref":"#/components/schemas/User/properties/name","readOnly":true,"description":"The name of the user who submitted the rating."}}},"RemapperDefinition":{"anyOf":[{"type":"boolean","description":"A boolean remapper is always returned directly."},{"enum":[null],"description":"A null remapper is always returned directly."},{"type":"number","description":"A numeric remapper is always returned directly."},{"type":"string","description":"A string remapper is always returned directly."},{"$ref":"#/components/schemas/ObjectRemapperDefinition"},{"$ref":"#/components/schemas/ArrayRemapperDefinition"}]},"RequestActionDefinition":{"type":"object","additionalProperties":false,"required":["type","url"],"properties":{"type":{"enum":["request"],"description":"Performs an HTTP request.\n\nThis can be used to call the Appsemble API or an external API in order to fetch data or send data.\nWhen sending `POST`, `PUT`, `DELETE` and `PATCH` calls the data that is currently available\nin the block gets passed through.\n\nIf the content type of the request is `text/xml` or `application/xml`, the data will be\nconverted to JSON.\n"},"url":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in the URL to send the request to.\n\nCan be a relative URL (E.g. `/api/health`) for usage with the Appsemble API, or an absolute URL\n(E.g. `https://example.com`) for usage with external sites."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"Resource":{"type":"object","additionalProperties":true,"description":"A resource can be anything defined as described in an app resource definition.","properties":{"id":{"type":"number","readOnly":true},"$clonable":{"type":"boolean"},"$expires":{"type":"string","format":"date-time"}}},"ResourceCountActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.count"],"description":"Count the number of resources a similar `resource.query` action would return."},"resource":{"type":"string","description":"The type of the resource to count."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceCreateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.create"],"description":"Create a resource."},"resource":{"type":"string","description":"The type of the resource to create."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceDefinition":{"type":"object","additionalProperties":false,"description":"A definition of how this resource works.","required":["schema"],"properties":{"expires":{"type":"string","description":"A time string representing when a resource should expire.\n\nExample: 1d 8h 30m\n","pattern":"^(\\d+(y|yr|years))?\\s*(\\d+months)?\\s*(\\d+(w|wk|weeks))?\\s*(\\d+(d|days))?\\s*(\\d+(h|hr|hours))?\\s*(\\d+(m|min|minutes))?\\s*(\\d+(s|sec|seconds))?$"},"schema":{"$ref":"#/components/schemas/JSONSchemaRoot","description":"JSON schema definitions that may be used by the app."},"references":{"type":"object","description":"References to other resources.\n\nThe key is the property that references the other resource. The value is an object describing the\nname of the resource and how it should behave.\n","minProperties":1,"additionalProperties":{"type":"object","description":"A reference to between two resource types.","additionalProperties":false,"properties":{"resource":{"type":"string"},"create":{"type":"object","additionalProperties":false,"description":"To be documented.","properties":{"trigger":{"type":"array","items":{"enum":["create","update","delete"]},"minItems":1,"uniqueItems":true}}},"update":{"type":"object","additionalProperties":false,"description":"To be documented.","properties":{"trigger":{"type":"array","items":{"enum":["create","update","delete"]},"minItems":1,"uniqueItems":true}}},"delete":{"type":"object","additionalProperties":false,"description":"To be documented.","properties":{"trigger":{"type":"array","items":{"enum":["create","update","delete"]},"minItems":1,"uniqueItems":true}}}}}},"roles":{"type":"array","description":"The default roles that are allowed to perform all actions.","items":{"type":"string"}},"url":{"type":"string","default":"/api/apps/{appId}/{resource}","description":"URL to use if not otherwise specified."},"id":{"type":"string","default":"id","description":"Name of the field used when accessing singular entities."},"history":{"description":"A definition of how versioning should happen for instances of this resource.","default":false,"oneOf":[{"type":"boolean","description":"Setting this to `true` is the same as using an object with the property `data` set to `true`."},{"$ref":"#/components/schemas/ResourceHistoryDefinition"}]},"query":{"type":"object","description":"Overrides for 'query' requests.","additionalProperties":false,"properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this action.\n\nThis will override the default roles that are assigned.\n","items":{"type":"string"}},"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"GET","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}","description":"URL to use for this type of request."}}},"get":{"type":"object","description":"Overrides for 'get' requests.","additionalProperties":false,"properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this action.\n\nThis will override the default roles that are assigned.\n","items":{"type":"string"}},"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"GET","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."}}},"count":{"type":"object","description":"Overrides for 'count' requests.","additionalProperties":false,"properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this action.\n\nThis will override the default roles that are assigned.\n","items":{"type":"string"}},"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"GET","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/$count","description":"URL to use for this type of request."}}},"create":{"type":"object","description":"Overrides for 'create' requests.","additionalProperties":false,"properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this action.\n\nThis will override the default roles that are assigned.\n","items":{"type":"string"}},"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"POST","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."},"hooks":{"$ref":"#/components/schemas/ResourceHooksDefinition"}}},"update":{"type":"object","description":"Overrides for 'update' requests.","additionalProperties":false,"properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this action.\n\nThis will override the default roles that are assigned.\n","items":{"type":"string"}},"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"PUT","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."},"hooks":{"$ref":"#/components/schemas/ResourceHooksDefinition"}}},"delete":{"type":"object","description":"Overrides for 'delete' requests.","additionalProperties":false,"properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this action.\n\nThis will override the default roles that are assigned.\n","items":{"type":"string"}},"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"DELETE","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."},"hooks":{"$ref":"#/components/schemas/ResourceHooksDefinition"}}},"views":{"$ref":"#/components/schemas/ResourceViewDefinition"}}},"ResourceDeleteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.delete"],"description":"Delete a resource."},"resource":{"type":"string","description":"The type of the resource to delete."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceGetActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.get"],"description":"Get a single resource."},"resource":{"type":"string","description":"The type of the resource to get."},"view":{"type":"string","description":"The view to use for the resource."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceHistoryDefinition":{"type":"object","additionalProperties":false,"description":"A definition of how versioning works for instances of this resource","required":["data"],"properties":{"data":{"type":"boolean","default":true,"description":"If set to `false`, edits are still tracked, but exactly what changed is lost."}}},"ResourceHooksDefinition":{"type":"object","description":"Hooks that are triggered upon calling a resource action.","additionalProperties":false,"minProperties":1,"properties":{"notification":{"$ref":"#/components/schemas/NotificationHookDefinition"}}},"ResourcePatchActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.patch"],"description":"Patch a resource."},"resource":{"type":"string","description":"The type of the resource to patch."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceQueryActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.query"],"description":"Query a list of resources."},"resource":{"type":"string","description":"The type of the resource to query."},"view":{"type":"string","description":"The view to use for the resource."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscription":{"type":"object","additionalProperties":false,"description":"This describes how a user is subscribed to a resource.","properties":{"create":{"type":"boolean","description":"If true, the user is subscribed to any create actions for the resource type"},"update":{"type":"boolean","description":"If true, the user is subscribed to any update actions for the resource type"},"delete":{"type":"boolean","description":"If true, the user is subscribed to any delete actions for the resource type"},"subscriptions":{"type":"object","description":"A mapping of resource IDs to individual resource subscriptions","additionalProperties":{"type":"object","description":"The subscription status of a user for a single resource.","additionalProperties":false,"properties":{"update":{"type":"boolean","description":"If true, the user is subscribed to update actions on this particular resource."},"delete":{"type":"boolean","description":"If true, the user will be notified when this particular resource is deleted."}}}}}},"ResourceSubscriptionStatusActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.status"],"description":"Get the status of whether or not the user is subscriped to notifications for resource modifications."},"resource":{"type":"string","description":"The type of the resource to get the subscription state for."},"action":{"enum":["create","delete","update"],"description":"The resource action type to get the subscription state for."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscriptionSubscribeActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.subscribe"],"description":"Subscribe to notifications on resource modifications."},"resource":{"type":"string","description":"The type of the resource to subscribe to."},"action":{"enum":["create","delete","update"],"description":"The resource action type to subscribe to."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscriptionToggleActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.toggle"],"description":"Toggle whether or not to receive notifications on resource modifications."},"resource":{"type":"string","description":"The type of the resource to toggle the subscription state for."},"action":{"enum":["create","delete","update"],"description":"The resource action type to toggle the subscription state for."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscriptionUnsubscribeActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.unsubscribe"],"description":"Unsubscribe from notifications on resource modifications."},"resource":{"type":"string","description":"The type of the resource to unsubscribe from."},"action":{"enum":["create","delete","update"],"description":"The resource action type to unsubscribe from."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceUpdateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.update"],"description":"Update a resource."},"resource":{"type":"string","description":"The type of the resource to update."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceViewDefinition":{"type":"object","minProperties":1,"description":"Alternative views of a resource that are modified using remappers and support different sets of roles.","additionalProperties":{"type":"object","additionalProperties":false,"description":"A custom view for a resource.","properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this view.","items":{"type":"string"}},"remap":{"$ref":"#/components/schemas/RemapperDefinition","description":"The modified view."}}}},"SSLSecret":{"type":"object","additionalProperties":false,"description":"The SSL secret of an app.","properties":{"certificate":{"type":"string","description":"The public SSL certificate chain in PEM format."},"key":{"type":"string","description":"The SSL private key in PEM format."}}},"SSOConfiguration":{"type":"object","description":"A single sign on configuration which is exposed to users.","additionalProperties":false,"properties":{"url":{"type":"string","format":"url","description":"The URL users will be redirected to in the login process."},"name":{"type":"string","description":"A user readable name for the configuration."},"icon":{"type":"string","description":"A Font Awesome icon."}}},"ScimPatchOp":{"type":"object","description":"A SCIM patch operation","required":["schemas","operations"],"additionalProperties":true,"properties":{"schemas":{"type":"array","maxItems":1,"minItems":1,"items":{"enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}},"operations":{"type":"array","description":"Patch operations to apply to the resource","items":{"anyOf":[{"type":"object","description":"A SCIM patch single replace operation","additionalProperties":false,"required":["op","path","value"],"properties":{"op":{"enum":["add","replace"]},"name":{"type":"string"},"path":{"type":"string"},"value":{}}},{"type":"object","description":"A SCIM patch bulk replace operation","additionalProperties":false,"required":["op","path"],"properties":{"op":{"enum":["remove"]},"path":{"type":"string"}}}]}}}},"ScimSecret":{"type":"object","additionalProperties":false,"description":"An app’s SCIM configuration.","properties":{"enabled":{"type":"boolean","description":"Whether or not SCIM is enabled for the app."},"token":{"type":"string","description":"The secret SCIM token"}}},"ScimUser":{"type":"object","additionalProperties":true,"description":"The definition of a user according to the SCIM documentation.","required":["emails","schemas","userName"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"userName":{"type":"string","description":"A unique identifier for the user (generally maps to the Azure AD user principal name)"},"active":{"type":"boolean"},"meta":{"type":"object","additionalProperties":false,"description":"Read-only metadata maintained by the service provider","properties":{"resourceType":{"type":"string"},"created":{"type":"string"},"lastModified":{"type":"string"},"location":{"type":"string"}}},"emails":{"type":"array","minLength":1,"items":{"type":"object","additionalProperties":false,"description":"A user's email. By default, one of these should be of type 'work' and have 'primary' set to true. Value contains actual address","required":["primary","type","value"],"properties":{"primary":{"type":"boolean"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"SecurityDefaultDefinition":{"type":"object","required":["role"],"description":"The default role to apply to members.","additionalProperties":false,"properties":{"policy":{"enum":["everyone","organization","invite"],"default":"everyone","description":"How the `default` role gets applied to users.\n\nThe following values are allowed:\n- `everyone`: Every authenticated user gets the default role.\n- `organization`: Every authenticated user gets the default role if they are in the same organization as the app.\n- `invite`: The user has to manually get a role assigned.\n\n> **Important**: When [OAuth2](../03-guide/oauth2) or [SAML2.0](../03-guide/saml) is used in the\n> app, you must set the policy to `everyone`. This will specifically allow every configured\n> authentication method on the secrets page to be used as login method. If you do not want other\n> Appsemble user accounts to be able to log in, you must `disable` the `appsemble login` options\n> (including the Appsemble OAuth2 option) in the secrets page. If this option is enabled, any\n> Appsemble user account is able to log in to the app and will receive the default role.\n"},"role":{"type":"string","description":"The default role to apply to members.\n\nThis must match with one of the roles defined within the security definition.\n"}}},"SecurityDefinition":{"type":"object","description":"This describes how the app is secured.","required":["default","roles"],"additionalProperties":false,"properties":{"default":{"$ref":"#/components/schemas/SecurityDefaultDefinition"},"roles":{"type":"object","description":"This property defines the user roles that are available within the app.","minProperties":1,"additionalProperties":{"$ref":"#/components/schemas/SecurityRoleDefinition"}},"teams":{"$ref":"#/components/schemas/TeamsDefinition","description":"Define how teams are handled by the app."}}},"SecurityRoleDefinition":{"type":"object","description":"This describes a security role.","additionalProperties":false,"properties":{"description":{"type":"string","description":"The description of the role."},"defaultPage":{"type":"string","description":"The default page to redirect users with this role to."},"inherits":{"type":"array","minItems":1,"description":"The name of the role to inherit from.\n\nNote that this role must exist and can not inherit itself via this field or the `inherits` field\nof the referenced role.\n","items":{"type":"string"}}}},"ShareActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["share"],"description":"The `share` action can be used to display a prompt that allows the user to share something with others, primarily via social media.\n\nDepending on whether the user’s browser supports a native share function it will either display a\nnative dialog for sharing links, or display a more limited fallback in a dialog.\n"},"url":{"$ref":"#/components/schemas/RemapperDefinition","description":"The url that is being shared."},"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title that should be shared."},"text":{"$ref":"#/components/schemas/RemapperDefinition","description":"The main body that should be shared."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StaticActionDefinition":{"type":"object","additionalProperties":false,"required":["type","value"],"properties":{"type":{"enum":["static"],"description":"The `static` action returns static data defined in the action definition.\n\nThis is useful for example for stubbing data.\n"},"value":{"description":"The static value to return."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageAppendActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key","value"],"properties":{"type":{"enum":["storage.append"],"description":"Append data to an existing array in storage.\n If the storage entry is a single object, it turns it into an array to append the data on.\n\nFor example:\n```yaml\ntype: storage.append\nkey: temp\nvalue: { root }\nstorage: localStorage\nremapBefore:\n object.from:\n text:\n This is a new data item\n value:\n 1\n```\n"},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"The data to write on top of the storage entry."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to store the data.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageDeleteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key"],"properties":{"type":{"enum":["storage.delete"],"description":"Delete the item that is stored at the specified key.\n\nFor example:\n```yaml\ntype: storage.delete\nkey: temp\nstorage: localStorage\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry to remove."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to remove the data from.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageReadActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key"],"properties":{"type":{"enum":["storage.read"],"description":"Read data from the app’s local storage.\n\nFor example:\n```yaml\ntype: storage.read\nkey: temp\nstorage: localStorage\n```\n\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to read the data from.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageSubtractActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key"],"properties":{"type":{"enum":["storage.subtract"],"description":"Subtract last item from a storage entry.\n\n If the entry consists of only one item, turns it into a singular object.\n\n If the entry is a single item, the entry is removed entirely.\n\nFor example:\n```yaml\ntype: storage.subtract\nkey: temp\nstorage: localStorage\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to read the data from.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageUpdateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key","value"],"properties":{"type":{"enum":["storage.update"],"description":"Update an existing item in storage, or update an item inside a stored array.\n\nFor example:\n```yaml\ntype: storage.update\nkey: temp\nitem: 1\nvalue: { root }\nstorage: localStorage\nremapBefore:\n object.from:\n text: { prop: text }\n value: { prop: value }\n newField: \"New field\"\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"item":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the item in an array to update."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"The data to update the specified item with."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to store the data.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageWriteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key","value"],"properties":{"type":{"enum":["storage.write"],"description":"Write data to the app’s local storage.\n\nFor example:\n```yaml\ntype: storage.write\nkey: temp\nvalue: { root }\nstorage: localStorage\nremapBefore:\n object.from:\n data:\n cool data\n value:\n 1\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"The data to write to the storage entry."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to store the data.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"SubPage":{"type":"object","description":"This describes what a sub page will look like in the app.","required":["blocks"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"The name of the sub page.","minLength":1,"maxLength":50},"blocks":{"type":"array","minItems":1,"description":"The blocks that make up a page.","items":{"$ref":"#/components/schemas/BlockDefinition"}}}},"TabsPageDefinition":{"type":"object","description":"This describes what a page will look like in the app.","required":["type","tabs","name"],"additionalProperties":true,"properties":{"type":{"enum":["tabs"]},"tabs":{"type":"array","minItems":1,"description":"Each of the available tabs for the tabs page.","items":{"$ref":"#/components/schemas/SubPage"}},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren’t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"}}},"TeamInviteActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["team.invite"],"description":"Get a list of all of the user’s teams."},"id":{"description":"The ID of the team to invite the user to.","$ref":"#/components/schemas/RemapperDefinition"},"email":{"description":"The email address of the user to invite.","$ref":"#/components/schemas/RemapperDefinition"},"role":{"description":"The role to invite the user as.","$ref":"#/components/schemas/RemapperDefinition","default":"member"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"TeamJoinActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["team.join"],"description":"Get a list of all of the user’s teams."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"TeamListActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["team.list"],"description":"Get a list of all of the user’s teams."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"TeamMembersActionDefinition":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"enum":["team.members"],"description":"Get a list of a team's members"},"id":{"description":"The ID of a specific team to get the members from","$ref":"#/components/schemas/RemapperDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"TeamsDefinition":{"type":"object","additionalProperties":false,"description":"This defines how teams are handled by an app.","required":["join","invite"],"properties":{"join":{"enum":["anyone","invite"],"description":"If this is set to `anyone`, any logged in user may join a team. If this is set to `invite`, only users may join who have been invited."},"create":{"type":"array","description":"A list of app roles which may create a team.\n\nBy default teams can only be created from Appsemble Studio.","items":{"type":"string"},"default":[]},"invite":{"type":"array","description":"The roles here determine which users may invite a team member.\n\nThe special roles `$team:member` and `$team:manager` mean that users who are already member of manager of the team may also invite new members.","items":{"type":"string"}}}},"Theme":{"type":"object","description":"A generic theme definition.","additionalProperties":false,"minProperties":1,"properties":{"themeColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#ffffff","description":"The generic theme color of the app.\n\nThis is used for example in the URL bar on Android.\n"},"splashColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#ffffff","description":"The background color of the PWA splash screen.\n\nThis defaults to the theme color.\n"},"primaryColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#5393ff","description":"The primary color used within the app.\n\nThis is used in various elements like the navbar.\n"},"linkColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#0440ad","description":"The color used for links."},"infoColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#a7d0ff","description":"The color used for informational messages."},"successColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#1fd25b","description":"The color used for successful actions."},"warningColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#fed719","description":"The color used for warning messages."},"dangerColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#ff2800","description":"The color used for error messages."},"tileLayer":{"type":"string","format":"uri","default":"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png","description":"The tileLayer to use for Leaflet maps."},"font":{"description":"The font to use in the app.","anyOf":[{"$ref":"#/components/schemas/CustomFontDefinition"},{"$ref":"#/components/schemas/GoogleFontDefinition"}]}}},"ThrowActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["throw"],"description":"This action throws a new exception based on the data that is passed through.\n\nThis can be used to create a custom error that ends up in the error action handler.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"User":{"type":"object","description":"An object representing a user.","additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true,"description":"The ID of the user."},"name":{"type":"string","description":"The display name of the user."},"email":{"type":"string","description":"The primary email used for communication."},"locale":{"type":"string","description":"The locale of the user."},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"],"description":"The time zone of the user."}}},"UserEmail":{"type":"object","description":"\n An email address that is linked to a user.\n\n Users may use any of their email addresses to login.\n ","required":["email"],"additionalProperties":false,"properties":{"email":{"type":"string","format":"email","description":"The email address that is registered"},"verified":{"type":"boolean","readOnly":true,"description":"Wether or not the email address has been verified by the user."}}},"UserLoginActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["user.login"],"description":"Allows the user to login using an email address and a password.\n\nDoes nothing if the user is already logged in."},"password":{"description":"The password to login with."},"email":{"description":"The email to login with."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"UserRegisterActionDefinition":{"type":"object","additionalProperties":false,"required":["email","password"],"properties":{"type":{"enum":["user.register"],"description":"Allows the user to register a new account using an email address and a password.\n\nDoes nothing if the user is already logged in."},"password":{"description":"The password to login with."},"email":{"description":"The email to login with."},"displayName":{"description":"The display name of the user."},"picture":{"description":"The image to use for the profile picture of the user."},"properties":{"description":"The custom properties for the user.\n\nEvery value will be converted to a string."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"UserUpdateActionDefinition":{"type":"object","additionalProperties":false,"required":[],"properties":{"type":{"enum":["user.update"],"description":"Allows the user to update their existing account.\n\nDoes nothing if the user isn’t logged in."},"password":{"description":"The new password."},"email":{"description":"The new email address."},"displayName":{"description":"The new display name of the user."},"picture":{"description":"The new profile picture of the user."},"properties":{"description":"The custom properties for the user.\n\nEvery value will be converted to a string."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}}},"securitySchemes":{"app":{"type":"oauth2","description":"\n OAuth2 login for apps.\n\n The authorization code flow is recommended. The password flow exists for legacy apps and will be\n removed in the future.\n ","flows":{"authorizationCode":{"authorizationUrl":"/connect/authorize","tokenUrl":"/oauth2/token","refreshUrl":"/oauth2/token","scopes":{"email":"Read the user email address.","openid":"Login the user to the requesting app using OpenID.","profile":"Read the user profile, including the display name and profile picture.","resources:manage":"Manage app resources on behalf of a user.","teams:read":"Read the teams the user is a part of.","teams:write":"Add new members to a team."}},"password":{"tokenUrl":"/oauth2/token","refreshUrl":"/oauth2/token","scopes":{"email":"Read the user email address.","openid":"Login the user to the requesting app using OpenID.","profile":"Read the user profile, including the display name and profile picture.","resources:manage":"Manage app resources on behalf of a user.","teams:read":"Read the teams the user is a part of.","teams:write":"Add new members to a team."}}}},"basic":{"type":"http","scheme":"basic","description":"Used for logging in to the web interface"},"cli":{"type":"oauth2","description":"\n OAuth2 login for client credentials.\n\n For example the Appsemble CLI uses this.\n ","flows":{"clientCredentials":{"tokenUrl":"/oauth2/token","scopes":{"apps:write":"Create and update apps","blocks:write":"Register and update blocks, and publish new block versions.","organizations:write":"Create and manage organizations.","resources:read":"Read app resources on behalf of a user.","resources:write":"Modify app resources on behalf of a user.","assets:write":"Create app assets on behalf of a user.","teams:read":"Read information about the user’s teams.","teams:write":"Read information about the user’s teams."}}}},"scim":{"type":"http","scheme":"bearer","description":"Used SCIM clients"},"studio":{"type":"http","scheme":"bearer","bearerFormat":"jwt","description":"Used for authenticating requests made using Appsemble studio interface."}}},"externalDocs":{"description":"Appsemble developer documentation","url":"https://appsemble.app/docs"},"info":{"title":"Appsemble","description":"Welcome to the Appsemble API.\n\nThe app studio can be found on\n> https://appsemble.app\n\nThe OpenAPI explorer can be found on\n> https://appsemble.app/api-explorer\n","license":{"name":"LGPL","url":"https://gitlab.com/appsemble/appsemble/blob/main/LICENSE.md"},"version":"0.21.3"},"paths":{"/api/apps/{appId}/secrets/oauth2":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["secret"],"operationId":"createAppOAuth2Secret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}},"security":[{"studio":[]}],"responses":{"201":{"description":"A list of the OAuth2 secrets for the app.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}},"get":{"tags":["secret"],"operationId":"getAppOAuth2Secrets","security":[{"studio":[]}],"responses":{"200":{"description":"A list of the OAuth2 secrets for the app.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}}}},"/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appOAuth2SecretId"}],"get":{"tags":["secret"],"operationId":"getAppOAuth2Secret","responses":{"200":{"description":"\n Get a partial app OAuth2 secret\n\n Only public facing values are output on this endpoint.\n ","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}}},"put":{"tags":["secret"],"operationId":"updateAppOAuth2Secret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated OAuth2 secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}},"delete":{"tags":["secret"],"operationId":"deleteAppOAuth2Secret","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted OAuth2 secret."}}}},"/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}/verify":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appOAuth2SecretId"}],"post":{"tags":["secret"],"operationId":"verifyAppOAuth2SecretCode","security":[{"studio":[]},{}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["code","scope","redirectUri","timezone"],"properties":{"code":{"type":"string"},"scope":{"type":"string"},"redirectUri":{"type":"string"},"zimezone":{"type":"string"}}}}}},"responses":{"200":{"description":"\n Get a partial app OAuth2 secret\n\n Only public facing values are output on this endpoint.\n ","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"}}}}}}}}},"/api/apps":{"post":{"tags":["app"],"description":"Create a new app","operationId":"createApp","parameters":[{"in":"query","name":"dryRun","description":"Validate whether an app could be created without actually creating one. Must be set to ‘true’.","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["OrganizationId","yaml"],"properties":{"domain":{"$ref":"#/components/schemas/App/properties/domain"},"path":{"$ref":"#/components/schemas/App/properties/path"},"visibility":{"$ref":"#/components/schemas/App/properties/visibility"},"template":{"$ref":"#/components/schemas/App/properties/template"},"longDescription":{"$ref":"#/components/schemas/App/properties/longDescription"},"yaml":{"type":"string","description":"The original YAML definition used to define the app."},"OrganizationId":{"$ref":"#/components/schemas/Organization/properties/id"},"icon":{"type":"string","format":"binary","description":"The app icon."},"maskableIcon":{"type":"string","format":"binary","description":"The app icon."},"iconBackground":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","description":"The background color to use for the maskable icon."},"coreStyle":{"type":"string","description":"The custom style to apply to the core app."},"sharedStyle":{"type":"string","description":"The custom style to apply to all parts of app."},"screenshots":{"type":"array","description":"Screenshots to showcase in the store","items":{"type":"string","format":"binary"}}}},"encoding":{"coreStyle":{"contentType":"text/css"},"sharedStyle":{"contentType":"text/css"},"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"},"screenshots":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"201":{"description":"The app that was created.","$ref":"#/components/responses/app"}},"security":[{"studio":[]},{"cli":["apps:write"]}]},"get":{"tags":["app"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get all existing apps.","operationId":"queryApps","responses":{"200":{"description":"The list of all apps.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}}}},"security":[{"studio":[]},{}]}},"/api/apps/{appId}":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get a single app","operationId":"getAppById","responses":{"200":{"description":"The app that matches the given id.","$ref":"#/components/responses/app"}},"security":[{"studio":[]},{}]},"patch":{"tags":["app"],"description":"Update parts of an existing app","operationId":"patchApp","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/App/properties/domain"},"path":{"$ref":"#/components/schemas/App/properties/path"},"visibility":{"$ref":"#/components/schemas/App/properties/visibility"},"template":{"$ref":"#/components/schemas/App/properties/template"},"longDescription":{"$ref":"#/components/schemas/App/properties/longDescription"},"force":{"type":"boolean","description":"Whether the locked property should be ignored."},"yaml":{"type":"string","description":"The original YAML definition used to define the app."},"icon":{"type":"string","format":"binary","description":"The app icon."},"maskableIcon":{"type":"string","format":"binary","description":"The app icon."},"iconBackground":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$"},"coreStyle":{"type":"string","description":"The custom style to apply to the core app."},"sharedStyle":{"type":"string","description":"The custom style to apply to all parts of app."},"screenshots":{"type":"array","description":"Screenshots to showcase in the store","items":{"type":"string","format":"binary"}},"showAppsembleLogin":{"type":"boolean","description":"Whether the Appsemble login method should be shown."},"showAppsembleOAuth2Login":{"type":"boolean","description":"Whether the Appsemble OAuth2 login method should be shown."},"emailName":{"type":"string","description":"The name used for emails."},"emailHost":{"type":"string","description":"The hostname of the SMTP server."},"emailPassword":{"type":"string","description":"The password to use for SMTP authentication. This gets encrypted when stored."},"emailUser":{"type":"string","description":"The username used to authenticate against the SMTP server."},"emailPort":{"type":"string","description":"The port used for the SMTP server."},"emailSecure":{"type":"boolean","description":"Whether TLS is being used."}}},"encoding":{"coreStyle":{"contentType":"text/css"},"sharedStyle":{"contentType":"text/css"},"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"description":"The updated app.","$ref":"#/components/responses/app"}},"security":[{"studio":[]},{"cli":["apps:write"]}]},"delete":{"tags":["app"],"description":"Delete an existing app","operationId":"deleteApp","responses":{"204":{"description":"The app was successfully deleted."}},"security":[{"studio":[]}]}},"/api/apps/{appId}/lock":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app"],"description":"Update the locked property an app.","operationId":"setAppLock","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["locked"],"properties":{"locked":{"$ref":"#/components/schemas/App/properties/locked","description":"Whether the app should be locked."}}}}}},"responses":{"204":{"description":"Lock status successfully changed"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/email":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get the app’s email settings.","operationId":"getAppEmailSettings","responses":{"200":{"description":"The current app email settings","content":{"application/json":{"schema":{"type":"object","properties":{"emailName":{"type":"string","description":"The name used for emails."},"emailHost":{"type":"string","description":"The hostname of the SMTP server."},"emailPassword":{"type":"boolean","description":"Whether a password is set."},"emailUser":{"type":"string","description":"The username used to authenticate against the SMTP server."},"emailPort":{"type":"string","description":"The port used for the SMTP server."},"emailSecure":{"type":"boolean","description":"Whether TLS is being used."}}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/icon":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get the current app icon.","operationId":"getAppIcon","responses":{"200":{"description":"The icon of the app that matches the given id.","content":{"image/png":{},"image/jpeg":{},"image/tiff":{},"image/webp":{}}}}},"delete":{"tags":["app"],"description":"Delete the current app icon.","operationId":"deleteAppIcon","responses":{"204":{"description":"The icon has been successfully removed"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/maskableIcon":{"parameters":[{"$ref":"#/components/parameters/appId"}],"delete":{"tags":["app"],"description":"Delete the current app’s maskable icon.","operationId":"deleteAppMaskableIcon","responses":{"204":{"description":"The icon has been successfully removed"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/subscriptions":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"parameters":[{"$ref":"#/components/parameters/endpoint"}],"description":"Fetch all subscription settings of an app.","operationId":"getSubscription","responses":{"200":{"description":"The subscription settings.","$ref":"#/components/responses/subscriptions"}}},"post":{"tags":["app"],"description":"Subscribe to an app’s push notifications","operationId":"addSubscription","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"A serialized PushSubscription object","required":["endpoint","keys"],"properties":{"endpoint":{"type":"string"},"keys":{"type":"object","required":["p256dh","auth"],"properties":{"p256dh":{"type":"string"},"auth":{"type":"string"}}}}}}}},"responses":{"204":{"description":"The subscription has successfully been registered."}},"security":[{"app":["openid"]},{}]},"patch":{"tags":["app"],"description":"Subscribe to an app’s push notifications. If value isn’t set it will toggle between subscribing and unsubscribing.","operationId":"updateSubscription","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["endpoint","resource","action"],"properties":{"endpoint":{"type":"string","format":"uri"},"resource":{"type":"string"},"action":{"type":"string","enum":["create","update","delete"]},"value":{"type":"boolean"},"resourceId":{"type":"number"}}}}}},"responses":{"204":{"description":"The subscription has successfully been updated."}},"security":[{"app":["openid"]},{}]}},"/api/apps/{appId}/members":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Fetch all members of an app.","operationId":"getAppMembers","responses":{"200":{"description":"The list of app members.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Member"}}}}}},"security":[{"studio":[]},{"app":["openid"]}]}},"/api/apps/{appId}/members/{memberId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"memberId","in":"path","description":"The ID of the member on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"get":{"tags":["app"],"description":"Get an app member.","operationId":"getAppMember","responses":{"200":{"description":"The resulting app member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"studio":[]},{"app":["openid"]}]},"post":{"tags":["app"],"description":"Assign an app role to a member.","operationId":"setAppMember","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["role"],"properties":{"role":{"type":"string","description":"The role to assign."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Any additional properties that are allowed to be set for members."}}}}}},"responses":{"200":{"description":"The resulting app member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"studio":[]}]},"delete":{"tags":["app"],"description":"Delete an app member.","operationId":"deleteAppMember","responses":{"204":{"description":"The app member was deleted successfully."}},"security":[{"studio":[]}]}},"/api/apps/{appId}/members/{memberId}/picture":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"memberId","in":"path","description":"The ID of the member on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"get":{"tags":["app"],"description":"Get an app member’s profile picture.\n\nThis will return a 404 if the user has not uploaded one.","operationId":"getAppMemberPicture","responses":{"200":{"description":"The profile picture of the app member.","content":{"image/png":{},"image/jpeg":{},"image/tiff":{},"image/webp":{}}}}}},"/api/apps/{appId}/ratings":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Fetch all ratings of an app.","operationId":"getAppRatings","responses":{"200":{"description":"The list of apps ratings.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}}}}},"post":{"tags":["app"],"description":"Submit an app rating.","operationId":"submitAppRating","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["rating"],"properties":{"rating":{"$ref":"#/components/schemas/Rating/properties/rating"},"description":{"$ref":"#/components/schemas/Rating/properties/description"}}}}}},"responses":{"200":{"description":"The submitted app rating.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset/properties/id"}}}}},"security":[{"studio":[]}]}},"/api/apps/{appId}/broadcast":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app"],"description":"Broadcast a push notification to every subscriber of the app.","operationId":"broadcast","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The data to include in the notification","required":["body"],"properties":{"title":{"description":"The title of the notification. This defaults to the name of the app if not otherwise specified.","type":"string"},"body":{"description":"The content of the notification","type":"string"}}}}}},"responses":{"204":{"description":"The notification has been successfully broadcasted."}},"security":[{"studio":[]}]}},"/api/apps/{appId}/snapshots":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get a list of snapshots made of the app.","operationId":"getAppSnapshots","responses":{"200":{"description":"The available snapshots","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"The ID of the snapshot."},"$created":{"type":"string","format":"date-time","description":"The creation date of the snapshot."},"$author":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/User/properties/id"},"name":{"$ref":"#/components/schemas/User/properties/name"}}}}}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/snapshots/{snapshotId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"snapshotId","in":"path","description":"The ID of the snapshot","required":true,"schema":{"type":"number","description":"The ID of the snapshot."}}],"get":{"tags":["app"],"description":"Get a single snapshot made of the app.","operationId":"getAppSnapshot","responses":{"200":{"description":"The snapshot","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the snapshot."},"yaml":{"type":"string","description":"The app definition."},"$created":{"type":"string","format":"date-time","description":"The creation date of the snapshot."},"$author":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/User/properties/id"},"name":{"$ref":"#/components/schemas/User/properties/name"}}}}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/screenshots":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app"],"description":"Add one or multiple screenshots of an app.","operationId":"createAppScreenshot","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"screenshots":{"type":"array","description":"Screenshots to showcase in the store","minItems":1,"items":{"type":"string","format":"binary"}}}},"encoding":{"screenshots":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"201":{"description":"The screenshots have been successfully created.","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","description":"The ID of the newly created screenshot."}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/screenshots/{screenshotId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/screenshotId"}],"get":{"tags":["app"],"description":"Get a screenshot of an app.","operationId":"getAppScreenshot","responses":{"200":{"description":"The app screenshot"}}},"delete":{"tags":["app"],"description":"Delete an existing screenshot.","operationId":"deleteAppScreenshot","responses":{"200":{"description":"The screenshot has been successfully deleted."}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/style/core":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get the core style for this app.","operationId":"getAppCoreStyle","responses":{"200":{"description":"The core stylesheet associated with this app.","content":{"text/css":{}}}}}},"/api/apps/{appId}/style/shared":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get the shared style for this app.","operationId":"getAppSharedStyle","responses":{"200":{"description":"The shared stylesheet associated with this app.","content":{"text/css":{}}}}}},"/api/apps/{appId}/style/block/@{organizationId}/{blockId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"}],"get":{"tags":["app"],"description":"Get the app style for a block.","operationId":"getAppBlockStyle","responses":{"200":{"description":"The stylesheet associated with this block for this app.","content":{"text/css":{}}}}},"post":{"tags":["app"],"description":"Upload a block stylesheet for this app.","operationId":"setAppBlockStyle","requestBody":{"description":"The new app block stylesheet.","content":{"application/json":{"schema":{"type":"object","required":["style"],"properties":{"style":{"type":"string"},"force":{"type":"boolean","writeOnly":true,"description":"If this is true, the app lock is ignored."}}}}}},"responses":{"204":{"description":"The block style has been updated successfully."}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/teams":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get a list of app teams.","operationId":"getTeams","responses":{"200":{"description":"The list of all teams.","content":{"application/json":{"schema":{"type":"array","items":{"description":"An app team","type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"role":{"type":"string","description":"The role of the user requesting the list of teams","enum":["member","manager"]}}}}}}}},"security":[{"studio":[]},{"app":["teams:read"]}]},"post":{"tags":["app"],"description":"Create a new team.","operationId":"createTeam","requestBody":{"description":"The team to create.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"annotations":{"type":"object","additionalProperties":{"type":"string"}}}}}}},"responses":{"201":{"description":"The created team","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"role":{"type":"string","description":"The role of the user who created the team","enum":["member","manager"]}}}}}}},"security":[{"app":["teams:write"]},{"studio":[]},{"cli":["teams:write"]}]}},"/api/apps/{appId}/teams/{teamId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"teamId","in":"path","description":"The ID of the team","required":true,"schema":{"type":"number","readOnly":true}}],"get":{"tags":["app"],"description":"Fetch an existing team.","operationId":"getTeam","responses":{"200":{"description":"The requested team","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"role":{"type":"string","description":"The role of the user who requested the team","enum":["member","manager"]}}}}}}},"security":[{"studio":[]}]},"patch":{"tags":["app"],"description":"Update an existing team.","operationId":"patchTeam","requestBody":{"description":"The team to update.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"annotations":{"type":"object","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"The updated team","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"role":{"type":"string","description":"The role of the user who updated the team","enum":["member","manager"]}}}}}}},"security":[{"studio":[]},{"cli":["teams:write"]}]},"delete":{"tags":["app"],"description":"Delete an existing team.","operationId":"deleteTeam","responses":{"204":{"description":"The team has successfully been deleted."}},"security":[{"studio":[]},{"cli":["teams:write"]}]}},"/api/apps/{appId}/teams/{teamId}/members":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"teamId","in":"path","description":"The ID of the team","required":true,"schema":{"type":"number","readOnly":true}}],"get":{"tags":["app"],"description":"Fetch the members of a team and their roles within the team.","operationId":"getTeamMembers","responses":{"200":{"description":"The list of all members.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Member"}}}}}},"security":[{"studio":[]},{"app":["teams:read"]}]},"post":{"tags":["app"],"description":"Add an app member member to a team.","operationId":"addTeamMember","requestBody":{"description":"The team to update.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/User/properties/id"}}}}}},"responses":{"201":{"description":"The added member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"studio":[]},{"app":["teams:write"]},{"cli":["teams:write"]}]}},"/api/apps/{appId}/teams/{teamId}/members/{memberId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"teamId","in":"path","description":"The ID of the team","required":true,"schema":{"type":"number","readOnly":true}},{"name":"memberId","in":"path","description":"The ID of the team member","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"get":{"tags":["app"],"description":"Get a certain team member from a team","operationId":"getTeamMember","responses":{"200":{"description":"The specified team member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}}},"put":{"tags":["app"],"description":"Update the role of a team member.","operationId":"updateTeamMember","requestBody":{"description":"The team to update.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["member","manager"]}}}}}},"responses":{"200":{"description":"The updated member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"studio":[]},{"cli":["teams:write"]}]},"delete":{"tags":["app"],"description":"Remove a member from a team.","operationId":"removeTeamMember","responses":{"204":{"description":"The team member has been removed successfully."}},"security":[{"studio":[]},{"cli":["teams:write"]}]}},"/api/apps/{appId}/teams/{teamId}/invite":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"teamId","in":"path","description":"The ID of the team","required":true,"schema":{"type":"number","readOnly":true}}],"post":{"tags":["app"],"description":"Invite a new user to a team.","operationId":"inviteTeamMember","requestBody":{"description":"The team invite to create.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"The email address of the user to invite."},"role":{"type":"string","enum":["member","manager"],"description":"The role to invite the user as.","default":"member"}}}}}},"responses":{"200":{"description":"The updated member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"app":["teams:write"]}]}},"/api/apps/{appId}/team/invite":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get details of a team invite.","operationId":"getTeamInvite","parameters":[{"name":"code","in":"query","description":"The ID code of the team invite","required":true,"schema":{"type":"string","readOnly":true}}],"responses":{"200":{"description":"The team invite","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"app":["teams:read"]}]},"post":{"tags":["app"],"operationId":"acceptTeamInvite","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"}}}}}},"responses":{"200":{"description":"The created member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"app":["teams:read"]}]}},"/api/apps/{appId}/secrets/saml":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["secret"],"operationId":"createAppSamlSecret","requestBody":{"content":{"application/json":{"schema":{}}}},"security":[{"studio":[]}],"responses":{"201":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{}}}}}},"get":{"tags":["secret"],"operationId":"getAppSamlSecrets","security":[{"studio":[]}],"responses":{"200":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/apps/{appId}/secrets/saml/{appSamlSecretId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"put":{"tags":["secret"],"operationId":"updateAppSamlSecret","requestBody":{"content":{"application/json":{"schema":{}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated SAML secret.","content":{"application/json":{"schema":{}}}}}},"delete":{"tags":["secret"],"operationId":"deleteAppSamlSecret","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted SAML secret."}}}},"/api/apps/{appId}/secrets/scim":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["secret"],"operationId":"getAppScimSecret","description":"Get app SCIM secret configuration","security":[{"studio":[]}],"responses":{"200":{"description":"The app SCIM configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSecret"}}}}}},"patch":{"tags":["secret"],"operationId":"updateAppScimSecret","description":"Update app SCIM secret configuration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSecret"}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The app SCIM configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSecret"}}}}}}},"/api/apps/{appId}/scim/Schemas":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"getSCIMSchemas","responses":{"200":{"description":"The SCIM Schema","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}}},"/api/apps/{appId}/scim/Schemas/{schemaId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"schemaId","in":"path","schema":{"type":"string"}}],"get":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"getSCIMSchema","responses":{"200":{"description":"The SCIM Schema","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}}},"/api/apps/{appId}/scim/ResourceTypes":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"getSCIMResourceTypes","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{}}}}}}},"/api/apps/{appId}/scim/ResourceTypes/{resourceTypeId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"resourceTypeId","in":"path","schema":{"type":"string"}}],"get":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"getSCIMResourceType","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{}}}}}}},"/api/apps/{appId}/scim/ServiceProviderConfig":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"getSCIMServiceProviderConfig","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{}}}}}}},"/api/apps/{appId}/scim/Users":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"createSCIMUser","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}},"application/scim+json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"201":{"description":"Integrated SCIM user schema","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}},"get":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"getSCIMUsers","parameters":[{"name":"count","in":"query","schema":{"type":"number"}},{"name":"startIndex","in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}}},"/api/apps/{appId}/scim/Users/{userId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"userId","in":"path","description":"The ID of the member to perform the operation on","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"get":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"getSCIMUser","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}},"delete":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"deleteSCIMUser","responses":{"204":{"description":"SCIM user"}}},"put":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"updateSCIMUser","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}},"application/scim+json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"SCIM user"}}},"patch":{"tags":["scim"],"security":[{"scim":[]}],"operationId":"patchSCIMUser","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}},"application/scim+json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"SCIM user"}}}},"/api/messages":{"parameters":[{"name":"context","in":"query","schema":{"type":"string","enum":["studio","app"]}}],"get":{"tags":["language"],"description":"Get a list of all languages with messages.","operationId":"getAppsembleLanguages","responses":{"200":{"description":"The list of supported languages","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/messages/{language}":{"parameters":[{"$ref":"#/components/parameters/language"}],"get":{"tags":["language"],"description":"Get the Appsemble messages for this language.","operationId":"getStudioMessages","responses":{"200":{"description":"The app messages for the selected language.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMessages"}}}}}}},"/api/apps/{appId}/secrets/ssl":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app"],"description":"Get the SSL certificate of an app","operationId":"getSSLSecret","responses":{"200":{"description":"The SSL secret of the app.","$ref":"#/components/schemas/SSLSecret"}},"security":[{"studio":[]}]},"put":{"tags":["app"],"description":"Update the app’s SSL secret","operationId":"updateSSLSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSLSecret"}}}},"responses":{"200":{"description":"The updated SSL secret.","$ref":"#/components/schemas/SSLSecret"}},"security":[{"studio":[]}]}},"/api/apps/{appId}/quotas/email":{"get":{"tags":["app"],"operationId":"getAppEmailQuota","parameters":[{"$ref":"#/components/parameters/appId"}],"security":[{"studio":[]},{}],"responses":{"200":{"description":"Email quota for an app","content":{"application/json":{"schema":{"type":"object","properties":{"used":{"type":"number","description":"Number of emails sent today"},"limit":{"type":"number","description":"Maximum number of emails that can be sent today"},"reset":{"type":"string","format":"date-time","description":"Date and time when the quota resets"}}}}}}}}},"/api/apps/{appId}/assets":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["asset"],"description":"Get all of the app’s assets.","operationId":"getAssets","parameters":[{"$ref":"#/components/parameters/$top"}],"responses":{"200":{"description":"The assets associated with the app.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}}},"security":[{"studio":[]},{}]},"post":{"tags":["asset"],"description":"Upload a new asset.","operationId":"createAsset","requestBody":{"description":"The asset to upload.","content":{"multipart/form-data":{"schema":{"type":"object","description":"The request body for creating an asset.","additionalProperties":false,"required":["file"],"properties":{"file":{"type":"string","format":"binary","writeOnly":true,"description":"The binary data of the asset. This may include a filename."},"name":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The given name of the asset. Assets may be referenced by their name or ID in the API."}}}}}},"responses":{"201":{"description":"The asset that was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}}},"security":[{"studio":[]},{},{"cli":["assets:write"]}]},"delete":{"tags":["asset"],"description":"Delete multiple app assets.","operationId":"deleteAssets","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"An array of asset IDs to remove.","items":{"$ref":"#/components/schemas/Asset/properties/id"}}}}},"responses":{"204":{"description":"The app assets have been deleted successfully."}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]}},"/api/apps/{appId}/assets/\\$count":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["asset"],"description":"Get the number of assets in the app.","operationId":"countAssets","responses":{"200":{"description":"The number of assets in the app.","content":{"application/json":{"schema":{"type":"number"}}}}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]}},"/api/apps/{appId}/assets/{assetId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/assetId"}],"get":{"tags":["asset"],"description":"Get a single asset","operationId":"getAssetById","responses":{"200":{"description":"The asset that matches the given id."}}},"delete":{"tags":["asset"],"description":"Remove an existing asset","operationId":"deleteAsset","responses":{"204":{"description":"The asset was successfully deleted."}},"security":[{"studio":[]},{"app":["resources:manage"]}]}},"/api/blocks":{"post":{"tags":["block version"],"description":"Publish a block.","operationId":"publishBlock","requestBody":{"description":"The new block version to publish.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/BlockVersion"}}}},"responses":{"201":{"$ref":"#/components/responses/blockVersion"}},"security":[{"cli":["blocks:write"]}]},"get":{"tags":["block"],"description":"Get all block’s latest definitions.","operationId":"queryBlocks","responses":{"200":{"description":"The list of all latest block versions.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockVersion"}}}}}},"security":[{"studio":[]},{}]}},"/api/blocks/@{organizationId}/{blockId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"}],"get":{"tags":["block"],"description":"Get a single block","operationId":"getBlock","responses":{"200":{"description":"The latest version of the block that matches the given id.","$ref":"#/components/responses/blockVersion"}}}},"/api/blocks/@{organizationId}/{blockId}/versions":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"}],"get":{"tags":["block version"],"description":"Retrieves all available versions of a block.","operationId":"getBlockVersions","responses":{"200":{"description":"A list of versions of a block.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockVersion"}}}}}}}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"}],"get":{"tags":["block"],"description":"Retrieve a single block version.","operationId":"getBlockVersion","responses":{"200":{"$ref":"#/components/responses/blockVersion"}}}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/asset":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"},{"name":"filename","in":"query","description":"The file name of the block asset to download","schema":{"type":"string"}}],"get":{"tags":["block"],"description":"Download a single block asset","operationId":"getBlockAsset","responses":{"200":{"description":"The asset that has been requested."}}}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/messages/{language}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"},{"in":"path","name":"language","schema":{"type":"string"},"description":"The language to get messages for.","required":true}],"get":{"tags":["block"],"description":"Get internationalized messages for a block.","operationId":"getBlockMessages","responses":{"200":{"description":"A key/value mapping of block messages.","content":{"application/json":{"schema":{"type":"object","description":"A key/value mapping of block messages.","additionalProperties":{"type":"string","description":"A translated block message."}}}}}}}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/icon":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"}],"get":{"tags":["block"],"description":"Get the icon of a block version.","operationId":"getBlockIcon","responses":{"200":{"description":"The icon that represents the block."}}}},"/api/email":{"post":{"tags":["user"],"description":"Register a new account using an email address and a password.","operationId":"registerEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"password":{"type":"string","minLength":8},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"]}}}}}},"responses":{"201":{"description":"The account that was created."}}}},"/api/email/verify":{"post":{"tags":["user"],"description":"Verify the email address of a registered user.","operationId":"verifyEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string"}}}}}},"responses":{"200":{"description":"The account was successfully verified."}}}},"/api/email/resend":{"post":{"tags":["user"],"description":"Resend the verification code for a registered email.","operationId":"resendEmailVerification","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The verification email was sent if an account was found in the database."}},"security":[{"studio":[]}]}},"/api/email/reset/request":{"post":{"tags":["user"],"description":"Request a reset token for resetting passwords.","operationId":"requestResetPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The request has been received and an email was sent if it exists."}}}},"/api/email/reset":{"post":{"tags":["user"],"description":"Reset a password using a password reset token.","operationId":"resetPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password","token"],"properties":{"password":{"type":"string","minLength":8},"token":{"type":"string"}}}}}},"responses":{"204":{"description":"The password has been reset."}}}},"/api/health":{"get":{"tags":["health"],"description":"Check whether or not the API is healthy","operationId":"checkHealth","responses":{"200":{"description":"An indication the server is healthy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}}}},"/api/ssl":{"get":{"tags":["health"],"description":"Check the SSL certificate status for the given domain names.","operationId":"getSSLStatus","parameters":[{"in":"query","name":"domains","required":true,"schema":{"type":"array","items":{"type":"string","format":"hostname"}}}],"responses":{"200":{"description":"A mapping of domain name to their SSL status","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"enum":["error","missing","pending","ready","unknown"]}}}}}}}},"/api/timezones":{"get":{"tags":["health"],"description":"Get a list of timezones supported by the API","operationId":"getTimezones","responses":{"200":{"description":"A list of timezones supported by the API","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/invites/{token}":{"parameters":[{"name":"token","in":"path","description":"The token of the invite.","required":true,"schema":{"type":"string"}}],"get":{"tags":["organization"],"description":"Fetch information about an invite.","operationId":"getInvitation","responses":{"200":{"description":"An invite response","$ref":"#/components/responses/invite"}}}},"/api/oauth2/client-credentials":{"post":{"description":"Register new OAuth2 client credentials for the authenticated user.","tags":["oauth2"],"operationId":"registerOAuth2ClientCredentials","requestBody":{"description":"The OAuth2 client credentials","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2ClientCredentials"}}}},"responses":{"201":{"description":"The newly created client credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2ClientCredentials"}}}}},"security":[{"studio":[]}]},"get":{"description":"Get a list of client credentials for the authenticated user","tags":["oauth2"],"operationId":"listOAuth2ClientCredentials","responses":{"200":{"description":"A list of client credentials entities.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuth2ClientCredentials"}}}}}},"security":[{"studio":[]}]}},"/api/oauth2/client-credentials/{clientId}":{"parameters":[{"name":"clientId","in":"path","description":"The client id of the OAuth2 client credentials on which to perform an operation","required":true,"schema":{"type":"string"}}],"delete":{"description":"Revoke the client credentials","tags":["oauth2"],"operationId":"deleteOAuth2ClientCredentials","responses":{"204":{"description":"The client credentials have been revoked successfully."}},"security":[{"studio":[]}]}},"/api/oauth2/connect/register":{"post":{"operationId":"registerOAuth2Connection","description":"asd","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["authorizationUrl","code"],"properties":{"authorizationUrl":{"type":"string"},"code":{"type":"string"}}}}}},"responses":{"200":{"description":""}}}},"/api/oauth2/connect/pending":{"post":{"description":"Create an account using an OAuth2 authorization.","tags":["oauth2"],"operationId":"connectPendingOAuth2Profile","requestBody":{"description":"The OAuth2 client credentials","required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["code","authorizationUrl","timezone"],"properties":{"code":{"type":"string"},"authorizationUrl":{"type":"string"},"timezone":{"type":"string"}}}}}},"responses":{"200":{"description":"An access token response.","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[{"studio":[]},{}]}},"/api/oauth2/connected":{"get":{"description":"Get a list of the user’s connected OAuth2 accounts.","tags":["oauth2"],"operationId":"getConnectedAccounts","responses":{"200":{"description":"An access token response.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"authorizationUrl":{"type":"string"}}}}}}}},"security":[{"studio":[]}]},"delete":{"description":"Unlink a linked account from the logged in user.","tags":["oauth2"],"operationId":"unlinkConnectedAccount","parameters":[{"in":"query","name":"authorizationUrl","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The account was unlinked successfully."}},"security":[{"studio":[]}]}},"/api/connect/userinfo":{"get":{"tags":["openid","user"],"description":"\n Get the user information formatted as OpenID user info.\n\n See https://connect2id.com/products/server/docs/api/userinfo\n ","operationId":"getUserInfo","security":[{"studio":[]},{"app":["openid"]}],"responses":{"200":{"description":"OpenID compatible user information","content":{"application/json":{"schema":{"type":"object","properties":{"sub":{"type":"string","description":"The subject (end-user) identifier. "},"name":{"type":"string","description":"The full name of the end-user"},"picture":{"type":"string","format":"url","description":"The URL of the profile page for the end-user."},"email":{"type":"string","format":"email","description":"The end-user’s preferred email address."},"email_verified":{"type":"boolean","description":"True if the end-user’s email address has been verified, else false."}}}}}}}}},"/api/oauth2/consent/verify":{"post":{"description":"Verify if the user has previously agreed to the requested OAuth2 consent.","tags":["oauth2"],"operationId":"verifyOAuth2Consent","requestBody":{"$ref":"#/components/requestBodies/oauth2Consent"},"responses":{"200":{"$ref":"#/components/responses/oauth2AuthorizationCode"}},"security":[{"studio":[]}]}},"/api/oauth2/consent/agree":{"post":{"description":"Create a new OAuth2 consent.","tags":["oauth2"],"operationId":"agreeOAuth2Consent","requestBody":{"$ref":"#/components/requestBodies/oauth2Consent"},"responses":{"201":{"$ref":"#/components/responses/oauth2AuthorizationCode"}},"security":[{"studio":[]}]}},"/api/organizations":{"get":{"tags":["organization"],"description":"Fetch the list of organizations.","operationId":"getOrganizations","responses":{"200":{"description":"The list of of organizations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}}}}}},"post":{"tags":["organization"],"description":"Create a new organization.","operationId":"createOrganization","requestBody":{"description":"The organization to create","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Organization/properties/id"},"name":{"$ref":"#/components/schemas/Organization/properties/name"},"description":{"$ref":"#/components/schemas/Organization/properties/description"},"email":{"$ref":"#/components/schemas/Organization/properties/email"},"website":{"$ref":"#/components/schemas/Organization/properties/website"},"icon":{"type":"string","format":"binary","description":"The organization icon."}}},"encoding":{"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"201":{"$ref":"#/components/responses/organization"}},"security":[{"studio":[]},{"cli":["organizations:write"]}]}},"/api/organizations/{organizationId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"description":"Get a single organization.","operationId":"getOrganization","responses":{"200":{"$ref":"#/components/responses/organization"}}},"patch":{"tags":["organization"],"description":"Update an organization","operationId":"patchOrganization","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Organization/properties/name"},"description":{"$ref":"#/components/schemas/Organization/properties/description"},"email":{"$ref":"#/components/schemas/Organization/properties/email"},"website":{"$ref":"#/components/schemas/Organization/properties/website"},"icon":{"type":"string","format":"binary","description":"The organization icon."}}},"encoding":{"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"$ref":"#/components/responses/organization"}},"security":[{"studio":[]},{"cli":["organizations:write"]}]}},"/api/organizations/{organizationId}/icon":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"description":"Get the organization icon.","operationId":"getOrganizationIcon","responses":{"200":{"description":"The icon that represents the organization."}}}},"/api/organizations/{organizationId}/members":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"description":"Get a list of organization members.","operationId":"getMembers","responses":{"200":{"description":"The list of all members.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Member"}}}}}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/invites/resend":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"post":{"tags":["organization"],"description":"Request to resend an invitation.","operationId":"resendInvitation","requestBody":{"description":"The email of the person to resend the invitation to.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}}}}},"responses":{"204":{"description":"The invite has been sent."}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/join":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"post":{"tags":["organization"],"description":"Respond to a given invitation.","operationId":"respondInvitation","requestBody":{"description":"The response of the invitation.\n\n If response is true, user will join the organization. If response is false, the user declines the invite and the invite is removed.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["response","token"],"properties":{"response":{"type":"boolean"},"token":{"type":"string"}}}}}},"responses":{"204":{"description":"The response has been processed."}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/invites":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"description":"Get a list of invited organization members.","operationId":"getInvites","responses":{"200":{"description":"The list of all invites.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["Member","Translator","APIReader","APIUser","AppEditor","Maintainer","Owner"]}}}}}}}},"security":[{"studio":[]}]},"post":{"tags":["organization"],"description":"Invite a new member to the organization that matches the given id.","operationId":"inviteMembers","requestBody":{"description":"The member to invite.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["email","role"],"properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["Member","Translator","APIReader","APIUser","AppEditor","Maintainer","Owner"]}}}}}}},"responses":{"201":{"description":"The newly invited member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"studio":[]}]},"delete":{"tags":["organization"],"description":"Revoke a member invitation.","operationId":"removeInvite","requestBody":{"description":"The email address to revoke the invite of.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The invitation has been successfully revoked."}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/members/{memberId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"name":"memberId","in":"path","description":"The ID of the member to remove","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"delete":{"tags":["organization"],"description":"Remove a member from the organization that matches the given id, or leave the organization if the member id matches the user’s member id","operationId":"removeMember","responses":{"204":{"description":"The member has been successfully removed."}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/members/{memberId}/role":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"name":"memberId","in":"path","description":"The ID of the member","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"put":{"tags":["organization"],"description":"Set the role of the member within the organization.","operationId":"setRole","requestBody":{"description":"The role to set.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["Member","Translator","APIReader","APIUser","AppEditor","Maintainer","Owner"]}}}}}},"responses":{"200":{"description":"The member’s role has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/apps":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get a list of an organization’s apps. Private apps are excluded unless the user is in the organization.","operationId":"getOrganizationApps","responses":{"200":{"description":"The list of this organization’s apps.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}}}},"security":[{"studio":[]},{}]}},"/api/organizations/{organizationId}/blocks":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"description":"Get a list of an organization’s blocks.","operationId":"getOrganizationBlocks","responses":{"200":{"description":"The list of this organization’s blocks.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockVersion"}}}}}},"security":[{"studio":[]},{}]}},"/api/apps/{appId}/action/{path}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"in":"path","name":"path","description":"The path to the action to execute.","required":true,"schema":{"type":"string"}}],"get":{"tags":["proxy"],"description":"Proxy a GET request action","operationId":"proxyGet","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"parameters":[{"in":"query","name":"data","description":"The data that was passed to the action","required":true,"schema":{"type":"string"}}]},"delete":{"tags":["proxy"],"description":"Proxy a DELETE request action","operationId":"proxyDelete","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"parameters":[{"in":"query","name":"data","description":"The data that was passed to the action","required":true,"schema":{"type":"string"}}]},"patch":{"tags":["proxy"],"description":"Proxy a PATCH request action","operationId":"proxyPatch","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"requestBody":{"description":"The data that was passed to the action","required":true,"content":{"application/json":{}}}},"post":{"tags":["proxy"],"description":"Proxy a POST request action","operationId":"proxyPost","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"requestBody":{"description":"The data that was passed to the action","required":true,"content":{"application/json":{}}}},"put":{"tags":["proxy"],"description":"Proxy a PUT request action","operationId":"proxyPut","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"requestBody":{"description":"The data that was passed to the action","required":true,"content":{"application/json":{}}}}},"/api/apps/{appId}/resources/{resourceType}/{resourceId}/history":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/resourceId"}],"get":{"tags":["resource"],"description":"Get the known history of a resource","operationId":"getResourceHistory","responses":{"200":{"description":"The resource that matches the given id.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/responses/resource"}}}}}},"security":[{"studio":[]}]}},"/api/apps/{appId}/resources/{resourceType}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"}],"get":{"tags":["resource"],"description":"Get all resources of this app.","operationId":"queryResources","parameters":[{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/$filter"},{"$ref":"#/components/parameters/$orderby"},{"$ref":"#/components/parameters/$select"},{"$ref":"#/components/parameters/$top"},{"$ref":"#/components/parameters/$team"}],"responses":{"200":{"description":"The list of all this app’s resources of this type.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}},"text/csv":{"schema":{"type":"string"}}}}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]},"post":{"tags":["resource"],"description":"Create a new resource for this app.","operationId":"createResource","requestBody":{"required":true,"description":"The resource to create","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Resource"},{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}]}},"multipart/form-data":{"schema":{"type":"object","required":["resource"],"description":"A `multipart/form-data` representation of a resource.","additionalProperties":false,"properties":{"resource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"assets":{"type":"array","description":"A list of assets that should be linked to the resource.","items":{"type":"string","format":"binary"}}}}},"text/csv":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}}},"responses":{"201":{"description":"The resource that was created.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"put":{"tags":["resource"],"description":"Update existing app resources.","operationId":"updateResources","requestBody":{"required":true,"description":"The resources to update","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}},"multipart/form-data":{"schema":{"type":"object","required":["resource"],"description":"A `multipart/form-data` representation of a resource.","additionalProperties":false,"properties":{"resource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"assets":{"type":"array","description":"A list of assets that should be linked to the resources.","items":{"type":"string","format":"binary"}}}}},"text/csv":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}}},"responses":{"200":{"description":"The updated resources.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"delete":{"tags":["resource"],"description":"Delete multiple app resources.","operationId":"deleteResources","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"An array of resource IDs to remove.","items":{"$ref":"#/components/schemas/Resource/properties/id"}}}}},"responses":{"204":{"description":"The app resources have been deleted successfully."}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]}},"/api/apps/{appId}/resources/{resourceType}/\\$count":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"}],"get":{"tags":["resource"],"description":"Get a count of all resources of this app.","operationId":"countResources","parameters":[{"$ref":"#/components/parameters/$filter"},{"$ref":"#/components/parameters/$team"}],"responses":{"200":{"description":"The count of all this app’s resources of this type.","content":{"application/json":{"schema":{"type":"number"}}}}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]}},"/api/apps/{appId}/resources/{resourceType}/subscriptions":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/endpoint"}],"get":{"tags":["resource"],"description":"Get the current subscription status of this resource.","operationId":"getResourceTypeSubscription","responses":{"200":{"description":"The subscription status for this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceSubscription"}}}}},"security":[{"studio":[]},{"app":["openid"]},{}]}},"/api/apps/{appId}/resources/{resourceType}/{resourceId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/resourceId"},{"$ref":"#/components/parameters/view"}],"get":{"tags":["resource"],"description":"Get a single app resource.","operationId":"getResourceById","responses":{"200":{"description":"The resource that matches the given id.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]},"put":{"tags":["resource"],"description":"Update an existing app resource.","operationId":"updateResource","requestBody":{"required":true,"$ref":"#/components/requestBodies/resource"},"responses":{"200":{"description":"The updated resource.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"patch":{"tags":["resource"],"description":"Patch an existing app resource.","operationId":"patchResource","requestBody":{"required":true,"$ref":"#/components/requestBodies/resource"},"responses":{"200":{"description":"The patched resource.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"delete":{"tags":["resource"],"description":"Delete an existing app resource.","operationId":"deleteResource","responses":{"204":{"description":"The app resource has been deleted successfully.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]}},"/api/apps/{appId}/resources/{resourceType}/{resourceId}/subscriptions":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/resourceId"},{"$ref":"#/components/parameters/endpoint"}],"get":{"tags":["resource"],"description":"Get the subscription status of a resource.","operationId":"getResourceSubscription","responses":{"200":{"description":"The subscription status of the resource that matches the given id.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"update":{"type":"boolean"},"delete":{"type":"boolean"}}}}}}}}},"/api/apps/{appId}/saml/{appSamlSecretId}/authn":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"post":{"tags":["secret"],"operationId":"createAuthnRequest","security":[{"studio":[]},{}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"redirectUri":{"type":"string"},"scope":{"type":"string"},"state":{"type":"string"},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"]}}}}}},"responses":{"201":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{}}}}}}},"/api/apps/{appId}/saml/{appSamlSecretId}/acs":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"post":{"tags":["secret"],"operationId":"assertConsumerService","security":[{"studio":[]},{}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"RelayState":{"type":"string"},"SAMLResponse":{"type":"string"}}}}}},"responses":{"302":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{}}}}}}},"/api/apps/{appId}/saml/{appSamlSecretId}/metadata.xml":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"get":{"tags":["secret"],"operationId":"getEntityId","responses":{"200":{"description":"Get the SAML entity ID metadata","content":{"application/xml":{"schema":{}}}}}}},"/api/saml/continue":{"post":{"tags":["saml"],"operationId":"continueSamlLogin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Continue SAML login in case of an email conflict","content":{"application/jso":{"schema":{"type":"object","additionalProperties":false,"properties":{"redirect":{"type":"string"}}}}}}},"security":[{"studio":[]},{}]}},"/api/templates":{"get":{"tags":["template"],"description":"Fetch a list of all available templates.","operationId":"getAppTemplates","responses":{"200":{"description":"The list of all available templates.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"template":{"type":"string","description":"The name of the template."},"description":{"type":"string","description":"The description of the template."},"resources":{"type":"boolean","description":"Whether this template supports pre-made resources"}}}}}}}},"security":[{"studio":[]}]},"post":{"tags":["template"],"description":"Register a new app using a template.","operationId":"createTemplateApp","requestBody":{"description":"The template to use for app creation.","content":{"application/json":{"schema":{"type":"object","required":["templateId","organizationId"],"properties":{"templateId":{"type":"number","description":"The ID of the template."},"name":{"$ref":"#/components/schemas/AppDefinition/properties/name"},"description":{"$ref":"#/components/schemas/AppDefinition/properties/description"},"organizationId":{"$ref":"#/components/schemas/Organization/properties/id"},"resources":{"type":"boolean","description":"Include example resources."},"visibility":{"$ref":"#/components/schemas/App/properties/visibility"}}}}}},"responses":{"201":{"$ref":"#/components/responses/app"}},"security":[{"studio":[]}]}},"/api/apps/{appId}/messages":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"merge","in":"query","schema":{"type":"boolean"}}],"get":{"tags":["language"],"description":"Get a list of all languages with messages.","operationId":"getLanguages","responses":{"200":{"description":"The list of supported languages","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}},"post":{"tags":["language"],"description":"Upload messages for the given language.","operationId":"createMessages","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMessages"}}}},"responses":{"201":{"description":"The translation was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMessages"}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/messages/{language}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/language"},{"in":"query","name":"merge","description":"Whether the language’s messages should be merged with its base language.","schema":{"type":"string"}},{"in":"query","name":"override","description":"Whether the app’s language overrides should be included and merged.","schema":{"type":"string","default":"true"}}],"get":{"tags":["language"],"description":"Get the app’s messages for this language.","operationId":"getMessages","responses":{"200":{"description":"The app messages for the selected language.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMessages"}}}}}},"delete":{"tags":["language"],"description":"Delete the app’s messages for this language.","operationId":"deleteMessages","responses":{"204":{"description":"The messages have successfully been deleted."}},"security":[{"studio":[]}]}},"/api/apps/{appId}/secrets/service":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["secret"],"operationId":"addAppServiceSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}},"security":[{"studio":[]}],"responses":{"201":{"description":"The created app service secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}}}},"get":{"tags":["secret"],"operationId":"getAppServiceSecrets","security":[{"studio":[]}],"responses":{"200":{"description":"The list of app service secrets.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppServiceSecret"}}}}}}}},"/api/apps/{appId}/secrets/service/{appServiceId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appServiceId"}],"put":{"tags":["secret"],"operationId":"updateAppServiceSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated app service secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}}}},"delete":{"tags":["secret"],"operationId":"deleteAppServiceSecret","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted app service secret."}}}},"/api/login":{"post":{"tags":["user"],"description":"Login using the Appsemble studio.","operationId":"emailLogin","responses":{"200":{"description":"Logged in successfully."}},"security":[{"basic":[]}]}},"/api/user/apps":{"get":{"tags":["app"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get all apps that are editable by the user.","operationId":"queryMyApps","responses":{"200":{"description":"The list of all editable apps.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}}}},"security":[{"studio":[]}]}},"/api/refresh":{"post":{"tags":["user"],"description":"Refresh an access token using the Appsemble studio","operationId":"refreshToken","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string","description":"The refresh token to use for refreshing the session."}}}}}},"responses":{"200":{"description":"The token has been refreshed successfully."}}}},"/api/user":{"get":{"tags":["user"],"description":"Fetch the logged in user's profile.","operationId":"getUser","responses":{"200":{"description":"The user's profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"studio":[]}]},"put":{"tags":["user"],"description":"Update the logged in user's profile.","operationId":"updateUser","requestBody":{"required":true,"$ref":"#/components/requestBodies/user"},"responses":{"200":{"description":"The user's profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"studio":[]}]}},"/api/user/organizations":{"get":{"tags":["template"],"description":"Fetch the logged in user's organizations.","operationId":"getUserOrganizations","responses":{"200":{"description":"The organizations the logged in user is a member of.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Organization/properties/id"},"name":{"$ref":"#/components/schemas/Organization/properties/name"},"role":{"$ref":"#/components/schemas/Member/properties/role"}}}}}}}},"security":[{"studio":[]}]}},"/api/user/email":{"get":{"tags":["user"],"description":"List email addresses registered to logged in user's account.","operationId":"listEmails","responses":{"200":{"description":"The email address has been added successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserEmail"}}}}}},"security":[{"studio":[]}]},"post":{"tags":["user"],"description":"Register a new email to logged in user's account.","operationId":"addEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEmail"}}}},"responses":{"201":{"description":"The email address has been added successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEmail"}}}}},"security":[{"studio":[]}]},"delete":{"tags":["user"],"description":"Remove an existing email to logged in user's account.","operationId":"removeEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEmail"}}}},"responses":{"204":{"description":"The email address has been removed successfully."}},"security":[{"studio":[]}]}},"/api/user/apps/accounts":{"get":{"description":"Get the accounts that have been linked to an app and the user","tags":["user"],"operationId":"getAppAccounts","security":[{"studio":[]}],"responses":{"200":{"description":"A list of linked accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppAccount"}}}}}}}},"/api/user/apps/{appId}/account":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"description":"Get a single account that has been linked to an app and the current user","tags":["user"],"operationId":"getAppAccount","security":[{"studio":[]}],"responses":{"200":{"description":"A list of linked accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAccount"}}}}}},"post":{"tags":["appMember"],"description":"Register a new app account using an email address and a password.","operationId":"registerMemberEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["email","password","timezone"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"password":{"type":"string","minLength":8},"picture":{"type":"string","format":"binary","description":"The account’s profile picture."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The member’s custom properties."},"timezone":{"type":"string"}}}}}},"responses":{"201":{"description":"The account that was created."}}},"patch":{"description":"Update user data for a specific app","tags":["user"],"operationId":"patchAppAccount","security":[{"studio":[]},{"app":[]}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"},"picture":{"type":"string","format":"binary","description":"The member’s profile picture."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The member’s custom properties."},"locale":{"type":"string","description":"The preferred locale of the user."}}},"encoding":{"picture":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"description":"A linked app account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAccount"}}}}}}},"/api/user/apps/{appId}/account/verify":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["appMember"],"description":"Verify the email address of a registered user.","operationId":"verifyMemberEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string"}}}}}},"responses":{"200":{"description":"The account was successfully verified."}}}},"/api/user/apps/{appId}/account/resend":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["appMember"],"description":"Resend the verification code for a registered email.","operationId":"resendMemberEmailVerification","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The verification email was sent if an account was found in the database."}},"security":[{"studio":[]},{"app":["email"]}]}},"/api/user/apps/{appId}/account/reset/request":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["appMember"],"description":"Request a reset token for resetting passwords.","operationId":"requestMemberResetPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The request has been received and an email was sent if it exists."}}}},"/api/user/apps/{appId}/account/reset":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["appMember"],"description":"Reset a password using a password reset token.","operationId":"resetMemberPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password","token"],"properties":{"password":{"type":"string","minLength":8},"token":{"type":"string"}}}}}},"responses":{"204":{"description":"The password has been reset."}}}}},"tags":[{"name":"app","description":"Operations related to the App definition"},{"name":"asset","description":"Operations related to Assets"},{"name":"auth","description":"Operations related to the Authentication"},{"name":"language","description":"Operations related to App translations"},{"name":"organization","description":"Operations related to organizations"},{"name":"app","description":"Operations related to the Resources definition"},{"name":"user","description":"Operations related to a user."}]}

libman.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "anyOf": [ { "$ref": "#/definitions/specifiedProvider" }, { "$ref": "#/definitions/defaultProvider" } ] }, { "anyOf": [ { "$ref": "#/definitions/specifiedDestination" }, { "$ref": "#/definitions/defaultDestination" } ] } ], "definitions": { "libraryEntry": { "required": ["library"], "properties": { "files": { "description": "The file names of the individual files to copy to the project.", "type": "array", "default": null, "items": { "type": "string", "minLength": 1 } }, "library": { "description": "The unique identifier of the library.", "type": "string", "minLength": 1 }, "destination": { "description": "The relative folder path from this config file to the location where the files should be copied to.", "type": "string", "pattern": "^[^\\\\]+$" }, "provider": { "description": "The unique identifier of the provider", "type": "string", "minLength": 1 } } }, "specifiedProvider": { "properties": { "libraries": { "items": { "required": ["provider"] } } }, "not": { "required": ["defaultProvider"] } }, "defaultProvider": { "properties": { "defaultProvider": { "description": "The unique identifier of the provider to use as default.", "type": "string", "minLength": 1 } } }, "specifiedDestination": { "properties": { "libraries": { "items": { "required": ["destination"] } } }, "not": { "required": ["defaultDestination"] } }, "defaultDestination": { "properties": { "defaultDestination": { "description": "The default destination to place library files.", "type": "string", "minLength": 1 } } } }, "id": "https://json.schemastore.org/libman.json", "properties": { "libraries": { "description": "A list of library references.", "type": "array", "items": { "$ref": "#/definitions/libraryEntry" } }, "version": { "description": "The syntax version of this config file. Can only be 1.0", "enum": ["1.0"], "default": "1.0" } }, "required": ["libraries"], "title": "JSON schema for client-side library config files", "type": "object" }

typo3.json

{ "$id": "https://json.schemastore.org/typo3.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "definitions": { "enhancerRoute": { "type": "object", "properties": { "routePath": { "type": "string" }, "_controller": { "type": "string", "pattern": "^([a-zA-Z0-9]{1,30})::([a-zA-Z0-9]{1,30})$" }, "_arguments": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": ["routePath", "_controller"], "additionalProperties": false }, "baseVariants": { "type": "object", "properties": { "base": { "type": "string" }, "condition": { "type": "string" } }, "required": ["base", "condition"], "additionalProperties": false }, "redirects": { "type": "object", "properties": { "autoUpdateSlugs": { "description": "Automatically update slugs of all sub pages. Default: true", "type": "boolean" }, "autoCreateRedirects": { "description": "Automatically create redirects for pages with a new slug (works only in LIVE workspace). Default: true", "type": "boolean" }, "redirectTTL": { "description": "Time To Live in days for redirect records to be created - `0` disables TTL, no expiration. Default: 0", "type": "integer" }, "httpStatusCode": { "description": "HTTP status code for the redirect, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections#Temporary_redirections. Default: 307", "type": "integer", "anyOf": [ { "type": "integer", "enum": [300, 301, 302, 303, 304, 305, 306, 307, 308] } ] } }, "additionalProperties": false }, "errorHandling": { "type": "object", "properties": { "errorCode": { "description": "Make sure to have at least 0 (not defined otherwise) configured in order to serve helpful error messages to your visitors.", "anyOf": [ { "type": "integer", "default": 404, "enum": [0, 404, 403, 500, 503] }, { "type": "integer" } ] }, "errorHandler": { "description": "How to handle Errors", "type": "string", "default": "Page", "enum": ["Page", "Fluid", "PHP"] } }, "allOf": [ { "if": { "properties": { "errorHandler": { "const": "PHP" } } }, "then": { "additionalProperties": false, "properties": { "errorCode": { "type": "integer" }, "errorHandler": { "type": "string" }, "errorPhpClassFQCN": { "description": "Fully qualified class name to a class that implements the PageErrorHandlerInterface.", "type": "string" } }, "required": ["errorCode", "errorHandler", "errorPhpClassFQCN"] } }, { "if": { "properties": { "errorHandler": { "const": "Fluid" } } }, "then": { "additionalProperties": false, "properties": { "errorCode": { "type": "integer" }, "errorHandler": { "type": "string" }, "errorFluidTemplate": { "description": "Path to the fluid template file given by absolute, relative path (from site root) or by referring the template file inside an extension with \"EXT:\" prefix.", "type": "string" }, "errorFluidTemplatesRootPath": { "type": "string" }, "errorFluidLayoutsRootPath": { "type": "string" }, "errorFluidPartialsRootPath": { "type": "string" } }, "required": ["errorCode", "errorHandler", "errorFluidTemplate"] } }, { "if": { "properties": { "errorHandler": { "const": "Page" } } }, "then": { "properties": { "errorCode": { "type": "integer" }, "errorHandler": { "type": "string" }, "errorContentSource": { "description": "Show Content from Page", "examples": ["t3://page?uid=123"], "type": "string" } }, "required": ["errorCode", "errorHandler", "errorContentSource"] } } ] }, "staticRoutes": { "type": "object", "properties": { "route": { "description": "Static Route Name", "type": "string" }, "type": { "description": "Route Type", "type": "string", "enum": ["uri", "staticText"] } }, "if": { "properties": { "type": { "const": "uri" } } }, "then": { "properties": { "source": { "description": "Page, File or URL", "type": "string" } }, "required": ["source"] }, "else": { "properties": { "content": { "description": "Static Text", "type": "string" } }, "required": ["content"] }, "required": ["route", "type"], "additionalProperties": false }, "localeMap": { "type": "object", "minItems": 1, "properties": { "locale": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "language": { "type": "object", "properties": { "title": { "description": "Title", "type": "string" }, "enabled": { "description": "Visible in Frontend", "type": "boolean" }, "languageId": { "description": "ID of the related sys_language record", "type": "integer", "examples": [1] }, "base": { "description": "Use a full qualified domain \"https://www.mydomain.fr/\" or \"/fr/\". Use \"/\" to keep the main URL for the default language. Add language specific suffixes to use those, or configure complete URLs for independent domains.", "type": "string", "default": "/" }, "baseVariants": { "type": "array", "items": { "$ref": "#/definitions/baseVariants" } }, "typo3Language": { "description": "Select the language to be used from translation files. Keep default if no translation files are available. Deprecated with TYPO3 12.3", "anyOf": [ { "type": "string", "default": "default", "enum": [ "default", "af", "ar", "bs", "bg", "ca", "ch", "cs", "da", "de", "el", "eo", "es", "et", "eu", "fa", "fi", "fo", "fr", "fr_CA", "gl", "he", "hi", "hr", "hu", "is", "it", "ja", "ka", "kl", "km", "ko", "lt", "lv", "mi", "mk", "ms", "nl", "no", "pl", "pt", "pt_BR", "ro", "ru", "rw", "sk", "sl", "sq", "sr", "sv", "th", "tr", "uk", "vi", "zh" ] }, { "type": "string" } ] }, "locale": { "description": "Used for localized date and currency formats. E.g. \"de_DE\" or \"en_US.UTF-8\".", "type": "string" }, "iso-639-1": { "description": "ISO 639-1 code of the Language", "type": "string", "enum": [ "ab", "aa", "af", "ak", "sq", "am", "ar", "an", "hy", "as", "av", "ae", "ay", "az", "bm", "ba", "eu", "be", "bn", "bh", "bi", "bs", "br", "bg", "my", "ca", "ch", "ce", "ny", "zh", "cv", "kw", "co", "cr", "hr", "cs", "da", "dv", "nl", "dz", "en", "eo", "et", "ee", "fo", "fj", "fi", "fr", "ff", "gl", "ka", "de", "el", "gn", "gu", "ht", "ha", "he", "hz", "hi", "ho", "hu", "ia", "id", "ie", "ga", "ig", "ik", "io", "is", "it", "iu", "ja", "jv", "kl", "kn", "kr", "ks", "kk", "km", "ki", "rw", "ky", "kv", "kg", "ko", "ku", "kj", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "gv", "mk", "mg", "ms", "ml", "mt", "mi", "mr", "mh", "mn", "na", "nv", "nd", "ne", "ng", "nb", "nn", "no", "ii", "nr", "oc", "oj", "cu", "om", "or", "os", "pa", "pi", "fa", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "sa", "sc", "sd", "se", "sm", "sg", "sr", "gd", "sn", "si", "sk", "sl", "so", "st", "es", "su", "sw", "ss", "sv", "ta", "te", "tg", "th", "ti", "bo", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "cy", "wo", "fy", "xh", "yi", "yo", "za", "zu" ] }, "navigationTitle": { "description": "Used within language-related menus", "type": "string" }, "hreflang": { "description": "Used within for \"lang\" and \"hreflang\" attributes", "type": "string" }, "direction": { "description": "Language direction for \"dir\" attribute", "type": "string", "enum": ["", "ltr", "rtl"] }, "flag": { "type": "string", "enum": [ "global", "ad", "ae", "af", "ag", "ai", "al", "am", "an", "ao", "aq", "ar", "as", "at", "au", "aw", "ax", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bi", "bj", "bl", "bm", "bn", "bo", "bq", "br", "bs", "bt", "bv", "bw", "by", "bz", "ca", "catalonia", "cc", "cd", "cf", "cg", "ch", "ci", "ck", "cl", "cm", "cn", "co", "cr", "cs", "cu", "cv", "cw", "cx", "cy", "cz", "de", "dj", "dk", "dm", "do", "dz", "ec", "ee", "eg", "eh", "en-us-gb", "gb-eng", "er", "es", "et", "eu", "fi", "fj", "fk", "fm", "fo", "fr", "ga", "gb", "gd", "ge", "gf", "gg", "gh", "gi", "gl", "gm", "gn", "gp", "gq", "gr", "gs", "gt", "gu", "gw", "gy", "hk", "hm", "hn", "hr", "ht", "hu", "id", "ie", "il", "im", "in", "io", "iq", "ir", "is", "it", "jm", "jo", "jp", "ke", "kg", "kh", "ki", "kl", "km", "kn", "kp", "kr", "kw", "ky", "kz", "la", "lb", "lc", "li", "lk", "lr", "ls", "lt", "lu", "lv", "ly", "ma", "mc", "md", "me", "mf", "mg", "mh", "mi", "mk", "ml", "mm", "mn", "mo", "mp", "mq", "mr", "ms", "mt", "mu", "mv", "mw", "mx", "my", "mz", "na", "nc", "ne", "nf", "ng", "ni", "gb-nir", "nl", "no", "np", "nr", "nu", "nz", "om", "pa", "pe", "pf", "pg", "ph", "pk", "pl", "pm", "pn", "pr", "ps", "pt", "pw", "py", "qa", "qc", "re", "ro", "rs", "ru", "rw", "sa", "sb", "sc", "gb-sct", "sd", "se", "sg", "sh", "si", "sj", "sk", "sl", "sm", "sn", "so", "sr", "ss", "st", "sv", "sx", "sy", "sz", "tc", "td", "tf", "tg", "th", "tj", "tk", "tl", "tm", "tn", "to", "tr", "tt", "tv", "tw", "tz", "ua", "ug", "um", "us", "uy", "uz", "va", "vc", "ve", "vg", "vi", "vn", "vu", "gb-wls", "wf", "ws", "ye", "yt", "za", "zm", "zw" ] }, "websiteTitle": { "description": "With this language based Website title, you can override the Website title for this language", "type": "string" }, "fallbackType": { "description": "Fallback Type", "type": "string", "enum": ["strict", "fallback", "free"], "default": "strict" }, "fallbacks": { "description": "Fallback to other Language(s) - order is important! Comma separated list", "type": "string" } }, "required": ["title", "enabled", "languageId", "base", "locale"], "additionalProperties": true } }, "properties": { "base": { "description": "Base URL. This is the URL under which this site is available", "type": "string" }, "rootPageId": { "description": "ID of the page where this site begins", "type": "integer" }, "languages": { "type": "array", "items": { "$ref": "#/definitions/language" } }, "baseVariants": { "type": "array", "items": { "$ref": "#/definitions/baseVariants" } }, "errorHandling": { "type": "array", "items": { "$ref": "#/definitions/errorHandling" } }, "routes": { "type": "array", "items": { "$ref": "#/definitions/staticRoutes" } }, "websiteTitle": { "type": "string", "description": "Default website title" }, "routeEnhancers": { "description": "routeEnhancers transform arguments into nice urls. Docs can be found at https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/Routing/Index.html", "type": "object", "additionalProperties": { "type": "object", "description": "Each enhancer must have a type", "required": ["type"], "properties": { "type": { "type": "string", "anyOf": [ { "type": "string", "enum": ["Simple", "Plugin", "Extbase", "PageType"] }, { "type": "string" } ] }, "default": { "type": "string" }, "routePath": { "type": "string" }, "limitToPages": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "requirements": { "type": "object", "additionalProperties": { "type": "string" } }, "_arguments": { "type": "object", "additionalProperties": { "type": "string" } }, "aspects": { "type": "object", "additionalProperties": { "type": "object", "required": ["type"], "properties": { "type": { "title": "Type of aspect", "type": "string", "anyOf": [ { "type": "string", "enum": [ "LocaleModifier", "PersistedAliasMapper", "PersistedPatternMapper", "StaticRangeMapper", "StaticValueMapper" ] }, { "type": "string" } ] } }, "allOf": [ { "if": { "properties": { "type": { "const": "PersistedAliasMapper" } } }, "then": { "additionalProperties": false, "properties": { "type": { "type": "string" }, "tableName": { "type": "string" }, "routeFieldName": { "type": "string" }, "routeValuePrefix": { "type": "string", "examples": ["", "/"], "maxLength": 1 } }, "required": ["type", "routeFieldName", "tableName"] } }, { "if": { "properties": { "type": { "const": "PersistedPatternMapper" } } }, "then": { "additionalProperties": false, "properties": { "type": { "type": "string" }, "tableName": { "type": "string" }, "routeFieldName": { "type": "string" }, "routeValuePrefix": { "type": "string", "examples": ["", "/"], "maxLength": 1 } }, "required": ["type", "routeFieldName", "tableName"] } }, { "if": { "properties": { "type": { "const": "LocaleModifier" } } }, "then": { "additionalProperties": false, "properties": { "type": { "type": "string" }, "default": { "type": "string" }, "localeMap": { "type": "array", "items": { "$ref": "#/definitions/localeMap" } } }, "required": ["type", "default", "localeMap"] } }, { "if": { "properties": { "type": { "const": "StaticRangeMapper" } } }, "then": { "additionalProperties": false, "properties": { "type": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["type", "start", "end"] } }, { "if": { "properties": { "type": { "const": "StaticValueMapper" } } }, "then": { "additionalProperties": false, "properties": { "type": { "type": "string" }, "map": { "type": "object" } }, "required": ["type", "map"] } } ] } } }, "allOf": [ { "if": { "properties": { "type": { "const": "Simple" } } }, "then": { "required": ["type", "routePath", "_arguments"] } }, { "if": { "properties": { "type": { "const": "Plugin" } } }, "then": { "properties": { "namespace": { "$comment": "plugin namespace", "type": "string" } }, "required": ["type", "namespace", "requirements"] } }, { "if": { "properties": { "type": { "const": "Extbase" } } }, "then": { "properties": { "defaults": { "type": "object" }, "routes": { "type": "array", "items": { "$ref": "#/definitions/enhancerRoute" } }, "extension": { "$comment": "extbase", "type": "string", "pattern": "^([A-Z]{1})([a-zA-Z0-9]{2,30})$" }, "plugin": { "$comment": "extbase", "type": "string" }, "defaultController": { "$comment": "extbase", "type": "string", "pattern": "^([a-zA-Z0-9]{1,30})::([a-zA-Z0-9]{1,30})$" } }, "required": ["type", "extension", "plugin", "defaultController"] } } ] } }, "settings": { "type": "object", "properties": { "redirects": { "$ref": "#/definitions/redirects" } }, "additionalProperties": true }, "sitePackage": { "type": "string", "description": "Extension key for site setup (used by EXT:bolt)" }, "solr_core_read": { "type": "string", "description": "EXT:solr default core for read" }, "solr_enabled_read": { "type": "boolean", "description": "EXT:solr enable default solr read" }, "solr_host_read": { "type": "string", "description": "EXT:solr default host for read" }, "solr_password_read": { "type": "string", "description": "EXT:solr password for read" }, "solr_username_read": { "type": "string", "description": "EXT:solr username for read" }, "solr_port_read": { "type": "string", "description": "EXT:solr port for read" }, "solr_scheme_read": { "type": "string", "description": "EXT:solr scheme for read", "anyOf": [ { "type": "string", "enum": ["http", "https", "%env(SOLR_SCHEME)%"] } ] }, "solr_use_write_connection": { "type": "boolean", "description": "EXT:solr use write connection" } }, "required": ["base", "rootPageId", "languages"], "type": "object" }

schema-store-talismanrc.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://github.com/thoughtworks/talisman/talismanrc", "title": "schema for .talismanrc", "type": "object", "additionalProperties": false, "fileMatch": [ ".talismanrc" ], "properties": { "fileignoreconfig": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string", "description": "Fully qualified filename" }, "checksum": { "type": "string", "description": "This field should always have the value specified by Talisman message" }, "ignore_detectors": { "type": "array", "description": "Disable specific detectors for a particular file", "items": { "type": "string", "enum": ["filecontent", "filename", "filesize"] } }, "allowed_patterns": { "type": "array", "description": "Keywords to ignore to reduce the number of false positives", "items": { "type": "string" } } }, "required": ["filename"] } }, "scopeconfig": { "type": "array", "description": "Talisman is configured to ignore certain files based on the specified scopes", "items": { "type": "object", "properties": { "scope": { "type": "string" } }, "required": ["scope"] } }, "allowed_patterns": { "type": "array", "description": "Keywords to ignore to reduce the number of false positives", "items": { "type": "string" } }, "custom_patterns": { "type": "array", "description": "You can specify custom regex patterns to look for in the current repository", "items": { "type": "string" } }, "custom_severities": { "type": "array", "description": "Custom detectors severities", "items": { "type": "object", "properties": { "detector": { "type": "string" }, "severity": { "type": "string", "enum": ["low", "medium", "high"] } }, "required": ["detector", "severity"] } }, "threshold": { "type": "string", "description": "Default minimal threshold", "enum": ["low", "medium", "high"] }, "version": { "type": "string", "description": ".talismanrc version" } }, "required": [] }

values.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/socialgouv/kontinuous/v1/docs/values.schema.json", "title": "schema for .kontinuous/values.yaml", "type": "object", "additionalProperties": { "type": "object", "description": "Kontinuous component", "allOf": [ { "if": { "required": ["~chart"] }, "then": { "description": "Common to all charts", "$ref": "#/definitions/chart" } }, { "if": { "required": ["~chart"], "properties": { "~chart": { "const": "app" } } }, "then": { "$ref": "https://raw.githubusercontent.com/socialgouv/kontinuous/v1/plugins/contrib/charts/app/kontinuous.values.schema.json#" } }, { "if": { "required": ["~chart"], "properties": { "~chart": { "const": "jobs" } } }, "then": { "$ref": "https://raw.githubusercontent.com/socialgouv/kontinuous/v1/plugins/contrib/charts/jobs/kontinuous.values.schema.json#" } } ] }, "properties": { "global": { "description": "Global variables", "type": "object", "additionalProperties": true, "properties": { "repositoryName": { "description": "Application name, default to GIT repository name", "type": "string" }, "namespace": { "description": "Default namespace", "type": "string" }, "registry": { "description": "Default docker registry URL, it is recommended tu use .kontinuous/config.yaml file to setup registry instead of using values", "type": "string", "examples": ["harbor.somewhere.io"] }, "rancherProjectId": { "description": "Rancher project ID to put on the", "type": "string", "examples": ["1234:5678"] }, "imageProject": { "description": "Default docker project name. ex registry/[imageProject]/image:tag", "type": "string", "default": "", "examples": ["project-x"] }, "imageRepository": { "description": "Default docker image repository name. ex registry/project/[imageRepository]image:tag", "type": "string", "default": "", "examples": ["application-x"] }, "imageTag": { "description": "Default docker image repository name. ex registry/project/[imageRepository]image:tag", "type": "string", "default": "", "examples": ["v2.3.1"] }, "ttl": { "description": "Dev environments janitor namespaces time-to-live. see https://codeberg.org/hjacobs/kube-janitor", "type": "string", "default": "7d", "examples": ["7d"] }, "replicas": { "description": "Default number of deployment replicas", "type": "number", "default": 1, "examples": [3] }, "host": { "description": "Default host name", "type": "string", "default": "", "examples": ["app.somewhere.io"] }, "pgDatabase": { "description": "Default PG database name, defaults to `application-branch`", "type": "string", "default": "", "examples": ["db-demo"] }, "pgSecretName": { "description": "Default PG secret name, defaults to `pg-user-branch`", "type": "string", "default": "", "examples": ["pg-demo"] }, "pgUser": { "description": "Default PG user name, defaults to `user-branch`", "type": "string", "default": "", "examples": ["user-demo"] }, "registrySecretRefName": { "description": "Secret name that hold the docker registry to push images to", "type": "string", "default": "", "examples": ["user-demo"] } } }, "project": { "type": "object", "additionalProperties": true }, "jobs": { "$ref": "https://raw.githubusercontent.com/socialgouv/kontinuous/v1/plugins/contrib/charts/jobs/kontinuous.values.schema.json#" } }, "required": [], "definitions": { "chart": { "type": "object", "properties": { "~chart": { "description": "Kontinuous Chart for this component. see https://github.com/SocialGouv/kontinuous/tree/master/plugins/contrib/charts", "type": "string", "examples": ["app", "maildev", "hasura", "metabase"] }, "~needs": { "description": "Job or deployment dependencies", "type": "array", "items": { "type": "string" }, "examples": ["[build-app]"] } }, "required": ["~chart"] } } }

buildinfo-schema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "build-info", "description": "build-info", "type": "object", "properties": { "properties": { "type": "object", "description": "Environment variables and properties collected from the CI server", "patternProperties": { "^.+$": { "type": "string" } } }, "version": { "description": "Build info schema version", "type": "string" }, "name": { "description": "Build name", "type": "string" }, "number": { "description": "Build number", "type": "string" }, "type": { "description": "Build type", "type": "string" }, "buildAgent": { "description": "Build tool information", "type": "object", "properties": { "name": { "description": "Build tool type", "type": "string" }, "version": { "description": "Build tool version", "type": "string" } } }, "agent": { "description": "CI server information", "type": "object", "properties": { "name": { "description": "CI server type", "type": "string" }, "version": { "description": "CI server version", "type": "string" } } }, "started": { "description": "Build start time", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}(Z|[+-]\\d{4})$" }, "durationMillis": { "description": "Build duration in milliseconds", "type": "integer" }, "principal": { "description": "", "type": "string" }, "url": { "description": "CI server URL", "type": "string" }, "vcs": { "description": "List of VCS used for the build", "type": "array", "items": { "url": { "description": "VCS URL", "type": "string" }, "branch": { "description": "Branch", "type": "string" }, "revision": { "description": "Last commit hash", "type": "string" }, "message": { "description": "Last commit message", "type": "string" } } } }, "modules": { "description": "Build-info modules", "type": "array", "items": { "type": "object", "properties": { "properties": { "description": "Module properties", "type": "object", "patternProperties": { "^.+$": { "type": "string" } } }, "id": { "description": "Module ID", "type": "string" }, "type": { "description": "Module type", "type": "string" }, "artifacts": { "description": "List of module artifacts", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha256": { "type": "string" }, "sha1": { "type": "string" }, "md5": { "type": "string" } } } }, "dependencies": { "description": "List of module dependencies", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "sha256": { "type": "string" }, "sha1": { "type": "string" }, "md5": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "requestedBy": { "description": "List of ancestor dependencies, which caused this dependency to be imported into the build", "type": "array", "items": { "description": "List of ancestor dependencies, which caused this dependency to be imported into the build. The first item in the list is the direct ancestor", "type": "array", "items": { "description": "Dependency ID", "type": "string" } } } } } } } } }, "issues": { "description": "List of issues related to the build", "type": "object", "properties": { "tracker": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } }, "required": ["name", "version"], "additionalProperties": false }, "aggregateBuildIssues": { "description": "Whether issues have appeared in previous builds", "type": "boolean" }, "aggregationBuildStatus": { "type": "string" }, "affectedIssues": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "url": { "type": "string" }, "summary": { "type": "string" }, "aggregated": { "description": "Whether this specific issue already appeared in previous builds", "type": "boolean" } } } } } } }

noodl.schema.json

{ "$id": "https://json.schemastore.org/noodl.schema.json", "$ref": "#/definitions/RootConfig", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "Action": { "additionalProperties": {}, "properties": { "actionType": { "$ref": "#/definitions/ActionType" }, "contentType": { "$ref": "#/definitions/ContentType" }, "dataKey": { "$ref": "#/definitions/DataKeyString" }, "dataObject": { "$ref": "#/definitions/DataObject" }, "dismissOnTouchOutside": { "description": "Signals that a popup should close when a user clicks outside of it. This is used for closing modals/popups", "type": "boolean" }, "emit": { "$ref": "#/definitions/Emit" }, "funcName": { "description": "A name/identifier for a function. This is used mainly for builtIn actions, where applications implement their own behavior and binds it to some object in the noodl", "examples": [ "redraw", "goto", "saveSignature" ], "title": "Function name", "type": "string" }, "goto": { "$ref": "#/definitions/Goto" }, "object": { "anyOf": [ { "type": "string" }, { "type": "object" }, { "type": "array" } ], "title": "Eval object's object" }, "popUpView": { "description": "A binding between a popUp or popUpDismiss component to a popUp action.", "title": "A popUp component's identifier by popup behavior", "type": "string" }, "reload": { "description": "When set to true, this signals that a page should run its \"init\" operation upon visiting from the user. If it is false, a page will not run it, which can be used to persist values when navigating pages", "title": "Skip or run \"init\"", "type": "boolean" }, "timer": { "description": "A timer is useful for situations such as chat rooms where users will have a time limit before being getting out", "title": "Timer", "type": "string" }, "timerTag": { "title": "Timer tag", "type": "string" }, "viewTag": { "$ref": "#/definitions/ViewTag" }, "wait": { "description": "Used to prevent further actions from happening. For example, a popUp action with \"wait: true\" will open a pop up in the page and will not run actions that are next in the call stack. This can be used to restrict access to pages when authenticating", "examples": [ true, "5000" ], "oneOf": [ { "type": "boolean" }, { "type": "number" } ], "title": "Wait" } }, "type": "object" }, "ActionChain": { "description": "A chain of actions in sequential order", "items": { "$ref": "#/definitions/UserEvent" }, "title": "Action chain", "type": "array" }, "ActionType": { "description": "An identifier/name for an action", "examples": [ "openCamera", "openPhotoLibrary", "openDocumentManager", "pageJump", "popUpDismiss", "refresh", "register", "removeSignature", "saveObject", "saveSignature", "updateObject", "popUp", "builtIn", "evalObject" ], "title": "Action type", "type": "string" }, "AwaitReference": { "description": "A reference that returns its result after the value at the referenced path is received", "pattern": "^[=.]*[a-zA-Z0-9]+.*@$", "title": "Await reference", "type": "string" }, "Boolean": { "description": "A boolean value is either one of \"true\", true, \"false\", or false", "enum": [ "true", "false", true, false ], "title": "Boolean" }, "Border": { "description": "Border styles", "oneOf": [ { "type": "string" }, { "additionalProperties": true, "properties": { "color": { "$ref": "#/definitions/Color" }, "line": { "examples": [ "dashed", "solid" ], "type": "string" }, "style": { "$ref": "#/definitions/BorderStylePreset" }, "width": { "$ref": "#/definitions/NoodlUnit" } }, "type": "object" } ], "title": "Border" }, "BorderPreset1": { "description": "Removes border including the radius", "enum": [ "1", 1 ], "oneOf": [ { "type": "string" }, { "type": "number" } ], "title": "Border style preset #1" }, "BorderPreset2": { "description": "Removes border from all sides (including radius) except the bottom. This will create an underline effect", "enum": [ 2, "2" ], "oneOf": [ { "type": "string" }, { "type": "number" } ], "title": "Border style preset #2" }, "BorderPreset3": { "description": "Applies a solid border to all sides", "enum": [ "3", 3 ], "oneOf": [ { "type": "string" }, { "type": "number" } ], "title": "Border style preset #3" }, "BorderPreset4": { "description": "Sets the border to be a dashed border", "enum": [ "4", 4 ], "oneOf": [ { "type": "string" }, { "type": "number" } ], "title": "Border style preset #4" }, "BorderPreset5": { "description": "Removes border from all sides", "enum": [ "5", 5 ], "oneOf": [ { "type": "string" }, { "type": "number" } ], "title": "Border style preset #5" }, "BorderPreset6": { "description": "Sets the border to be a solid border. This will also remove border radius from all sides", "enum": [ "6", 6 ], "oneOf": [ { "type": "string" }, { "type": "number" } ], "title": "Border style preset #1" }, "BorderStylePreset": { "description": "A set of border presets, each applying a different style", "oneOf": [ { "$ref": "#/definitions/BorderPreset1" }, { "$ref": "#/definitions/BorderPreset2" }, { "$ref": "#/definitions/BorderPreset3" }, { "$ref": "#/definitions/BorderPreset4" }, { "$ref": "#/definitions/BorderPreset5" }, { "$ref": "#/definitions/BorderPreset6" } ], "title": "Border style preset" }, "BuiltInEval": { "description": "Objects that become built in functions when parsed/serialized", "patternProperties": { "^=.builtIn.[a-zA-Z0-9]+$": { "additionalProperties": true, "properties": { "dataIn": { "$ref": "#/definitions/DataIn" }, "dataOut": { "$ref": "#/definitions/DataOut" } }, "type": "object" } }, "title": "Built in eval object", "type": "object" }, "Color": { "examples": [ "\"0x000000\"" ], "pattern": "^(0x)[a-zA-Z0-9]+$", "title": "Color", "type": "string" }, "Component": { "additionalProperties": true, "description": "Components are the building blocks that construct to user interfaces", "properties": { "audioStream": { "type": "boolean" }, "borderRadius": { "$ref": "#/definitions/NoodlUnit" }, "children": { "items": { "oneOf": [ { "$ref": "#/definitions/Component" }, { "$ref": "#/definitions/Reference" } ] }, "type": "array" }, "contentType": { "$ref": "#/definitions/ContentType" }, "dataKey": { "$ref": "#/definitions/DataKey" }, "ecosObj": { "examples": [ "..document.ecosObj" ], "type": "string" }, "global": { "$ref": "#/definitions/Boolean", "examples": [ "true" ] }, "image": { "type": "string" }, "imgPath": { "type": "string" }, "isEdit": { "$ref": "#/definitions/Boolean" }, "isEditable": { "anyOf": [ { "$ref": "#/definitions/Boolean" }, { "type": "string" } ] }, "itemObject": { "description": "This is a common value used for iteratorVar", "title": "itemObject", "type": "string" }, "iteratorVar": { "examples": [ "itemObject" ], "title": "Iterator variable", "type": "string" }, "listObject": { "anyOf": [ { "$ref": "#/definitions/Empty" }, { "$ref": "#/definitions/Reference", "examples": [ "..listData.contactList.docs" ] }, { "type": "array" } ], "title": "List data" }, "onBlur": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onChange": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onClick": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onEvent": { "examples": [ "onNewEcosDoc" ], "type": "string" }, "onFocus": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onHover": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onInput": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onMouseEnter": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onMouseLeave": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onMouseOut": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "onMouseOver": { "oneOf": [ { "$ref": "#/definitions/ActionChain" }, { "$ref": "#/definitions/UserEvent" } ] }, "options": { "examples": [ "..formData.options" ], "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "overflow": { "examples": [ "hidden" ], "type": "string" }, "path": { "$ref": "#/definitions/Path" }, "placeholder": { "oneOf": [ { "examples": [ "..myPlaceholder" ], "type": "string" }, { "$ref": "#/definitions/If" }, { "properties": { "emit": { "$ref": "#/definitions/Emit" } }, "type": "object" } ] }, "popUpView": { "type": "string" }, "postMessage": { "type": "array" }, "poster": { "description": "A cover image used on video components. When a video has not been interacted with by a user, a cover image is displayed. This value can be used for the cover image", "examples": [ "poster.png" ], "title": "Cover image", "type": "string" }, "required": { "oneOf": [ { "examples": [ "true", "false" ], "type": "string" }, { "type": "boolean" } ] }, "resource": { "examples": [ "https://google.com/someImage.jpeg" ], "type": "string" }, "style": { "$ref": "#/definitions/Style" }, "text": { "$ref": "#/definitions/Text" }, "text=func": { "description": "A function to transform a component's text. A component must have the 'text' property.", "examples": [ "=.builtIn.system.configUrl" ], "title": "Text transformer", "type": "string" }, "textAlign": { "$ref": "#/definitions/TextAlign" }, "textBoard": { "$ref": "#/definitions/TextBoard" }, "type": { "$ref": "#/definitions/ComponentType" }, "videoFormat": { "examples": [ "mp4" ], "type": "string" }, "videoStream": { "type": "boolean" }, "viewTag": { "$ref": "#/definitions/ViewTag" }, "zIndex": { "examples": [ "\"1000\"" ], "type": "number" } }, "title": "Component", "type": "object" }, "ComponentType": { "examples": [ "button", "canvas", "chart", "chatList", "ecosDoc", "divider", "footer", "header", "image", "label", "list", "listItem", "map", "page", "plugin", "pluginHead", "pluginBodyTop", "pluginBodyTail", "popUp", "register", "scrollView", "textField", "textView", "video", "view" ], "title": "Component type", "type": "string" }, "ConfigVersionObjectByDevice": { "additionalProperties": false, "properties": { "cadlVersion": { "properties": { "stable": { "examples": [ "0.56d" ], "type": "string" }, "test": { "examples": [ "0.56d" ], "type": "string" } }, "type": "object" } }, "title": "Root config version object", "type": "object" }, "ContentType": { "description": "Determines the content type of the component. For example, a textField component may be a date textField if it has contentType: date, or a password textField with contentType: password, etc", "examples": [ "countryCode", "email", "date", "file", "formattedDate", "formattedDuration", "hidden", "listObject", "messageHidden", "number", "password", "passwordHidden", "phone", "phoneNumber", "tel", "text", "timer", "videoSubStream" ], "title": "Content type", "type": "string" }, "DataIn": { "$ref": "#/definitions/Value", "description": "Argument(s) to the surrounding built in function", "title": "Data in" }, "DataKey": { "anyOf": [ { "$ref": "#/definitions/DataKeyString" }, { "$ref": "#/definitions/DataKeyObject" } ], "description": "A value/pointer to a a property of an object", "title": "Data key" }, "DataKeyObject": { "description": "Data key in the emit object", "patternProperties": { "^[a-zA-Z0-9]+$": { "examples": [ "{var:\"\"}" ], "type": "object" } }, "title": "Data key", "type": "object" }, "DataKeyString": { "description": "The path to a data object or value. It might provide a different behavior depending on where it is placed. For example, a dataKey set on a textField component will bind its value to the path in the dataKey, enabling it to mutate the value while updating textField's value", "examples": [ "formData.password", "SignIn.formData.password" ], "title": "Data key", "type": "string" }, "DataObject": { "description": "An object that contains data. It is most commonly used in actions such as updateObject as a way to update its data values", "title": "Data object", "type": "string" }, "DataOut": { "$ref": "#/definitions/Value", "description": "Return value(s) to the surrounding built in function", "title": "Data out" }, "Emit": { "additionalProperties": false, "description": "An emit is a special type of action that usually contains a dataKey paired with a list of actions that are called in order. Some emits can contain just a list of actions. When paired with a dataKey it is usually mutating the value at the path in the dataKey", "properties": { "actions": { "items": { "anyOf": [ { "$ref": "#/definitions/Action" }, { "$ref": "#/definitions/BuiltInEval" } ] }, "title": "Emit actions", "type": "array" }, "dataKey": { "oneOf": [ { "type": "string" }, { "type": "object" } ], "title": "Emit action data key string or data key object" } }, "required": [ "actions" ], "title": "Emit", "type": "object" }, "Empty": { "const": "", "description": "Empty value (empty string)", "title": "Empty", "type": "string" }, "Goto": { "anyOf": [ { "examples": [ "SignIn" ], "type": "string" }, { "$ref": "#/definitions/GotoObject", "type": "object" }, { "$ref": "#/definitions/GotoPageComponentUrl", "type": "string" } ], "description": "The destination the user should navigate to", "not": { "type": "number" }, "title": "Goto" }, "GotoObject": { "properties": { "destination": { "examples": [ "SignIn" ], "type": "string" } }, "title": "Goto (object)", "type": "object" }, "GotoPage": { "examples": [ "SignIn", "SignOut" ], "title": "Goto (string)", "type": "string" }, "GotoPageComponentUrl": { "examples": [ "Dashboard@SignIn#someViewTag" ], "pattern": "[a-zA-Z0-9]+@[a-zA-Z0-9]+#[a-zA-Z0-9]+", "title": "Goto url", "type": "string" }, "If": { "description": "If objects contain an array with three items used for conditional checks. The first item is used as a test for truthiness which can be in the form of any data type such as a string, number, boolean, object, etc. Either the second or third item is returned depending on the result of the truthiness test", "properties": { "if": { "items": { "$ref": "#/definitions/Value" }, "maxItems": 3, "minItems": 3, "type": "array" } }, "title": "A condition evaluation", "type": "object" }, "Init": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/definitions/If" }, { "type": "string" }, { "$ref": "#/definitions/Goto" }, { "const": [ "" ], "title": "Page init", "type": "string" } ] }, "type": "array" }, { "$ref": "#/definitions/MixedActionChain" } ], "description": "One or more action(s) which will occur when entering a page", "title": "Init" }, "LocalEvalReference": { "description": "Mutates the value at the referenced path after receiving its result", "pattern": "^=[.][.][a-zA-Z0-9]+.*$", "title": "Local eval reference", "type": "string" }, "LocalReference": { "description": "A reference whose scope is within the page object, making them invisible to the objects outside of its scope", "pattern": "^[.][.][a-zA-Z0-9]+.*$", "title": "Local reference", "type": "string" }, "MixedActionChain": { "description": "An ActionChain but also includes the BuiltInEval objects =.builtIn.* as well as await/eval references", "items": { "anyOf": [ { "$ref": "#/definitions/ActionChain" }, { "items": { "$ref": "#/definitions/BuiltInEval" }, "type": "array" }, { "patternProperties": { "(=.[a-zA_Z0-9])*@$": { "$ref": "#/definitions/Value" } }, "type": "object" } ] }, "title": "ActionChain + Init", "type": "array" }, "NoodlUnit": { "description": "A measurement adaptive to the size of the viewport", "examples": [ "\"0\"", "\"0.1\"", "\"1\"" ], "title": "Noodl unit (ex: \"0.1\", \"0.25\", etc)", "type": "string" }, "Page": { "additionalProperties": {}, "description": "A page object", "properties": { "check": { "$ref": "#/definitions/Init" }, "components": { "items": { "$ref": "#/definitions/Component" }, "title": "Page components", "type": "array" }, "init": { "oneOf": [ { "$ref": "#/definitions/Init" }, { "const": "" } ] }, "module": { "$ref": "#/definitions/PageModule" }, "pageNumber": { "$ref": "#/definitions/PageNumber" }, "save": { "$ref": "#/definitions/Init" }, "title": { "description": "Titles can be used to represent the page", "examples": [ "My Title" ], "title": "Page title", "type": "string" }, "update": { "$ref": "#/definitions/Init" }, "viewPort": { "description": "Determines the initial scroll position for the user", "examples": [ "top", "center", "bottom" ], "type": "string" } }, "title": "Page", "type": "object" }, "PageActions": { "items": { "anyOf": [ { "$ref": "#/definitions/If" }, { "properties": { "emit": { "$ref": "#/definitions/Emit" } }, "type": "object" }, { "type": "object" }, { "$ref": "#/definitions/BuiltInEval" } ], "type": "array" }, "title": "Page actions", "type": "array" }, "PageModule": { "examples": [ "admin", "business" ], "title": "Page module", "type": "string" }, "PageNumber": { "description": "A page number may help distinguish between pages with similar names", "examples": [ "\"219\"" ], "title": "Page number", "type": "string" }, "Path": { "description": "A path can be in the form of a string, an if object, or an emit object", "oneOf": [ { "anyOf": [ { "examples": [ "logo.png", "SignIn" ], "type": "string" }, { "$ref": "#/definitions/GotoPageComponentUrl" } ] }, { "anyOf": [ { "$ref": "#/definitions/BuiltInEval" }, { "$ref": "#/definitions/If" }, { "properties": { "emit": { "$ref": "#/definitions/Emit" } }, "type": "object" } ] } ], "title": "Destination pointing to a separate page or url" }, "Reference": { "description": "Placeholder values that obtain their real values at a later time", "oneOf": [ { "$ref": "#/definitions/LocalReference" }, { "$ref": "#/definitions/RootReference" }, { "$ref": "#/definitions/LocalEvalReference" }, { "$ref": "#/definitions/RootEvalReference" }, { "$ref": "#/definitions/AwaitReference" } ], "title": "Reference", "type": "string" }, "Root": { "additionalProperties": true, "description": "The root/base object. It is global to all descendants", "properties": { "BaseCSS": { "properties": { "Style": { "$ref": "#/definitions/Style" } }, "title": "Base CSS styles", "type": "object" }, "BaseDataModel": { "additionalProperties": { "anyOf": [ { "type": "object" } ] }, "properties": { "Config": { "$ref": "#/definitions/RootConfig" }, "Global": { "type": "object" } }, "title": "Base data models", "type": "object" }, "BasePage": { "title": "Base page components", "type": "object" }, "Config": { "$ref": "#/definitions/RootConfig", "title": "Alias of RootConfig" }, "Global": { "description": "This can be accessed and mutated by any object at any time", "title": "Global object", "type": "object" } }, "title": "Root object", "type": "object" }, "RootConfig": { "additionalProperties": true, "properties": { "android": { "$ref": "#/definitions/ConfigVersionObjectByDevice", "type": "object" }, "apiCheck": { "type": "object" }, "apiHost": { "type": "string" }, "apiPort": { "examples": [ "443" ], "type": "string" }, "appApiHost": { "type": "string" }, "cadlBaseUrl": { "type": "string" }, "cadlMain": { "examples": [ "cadlEndpoint.yml" ], "type": "string" }, "cadlVersion": { "type": "object" }, "connectiontimeout": { "examples": [ "5" ], "type": "string" }, "debug": { "oneOf": [ { "examples": [ "console_log_api" ], "type": "string" }, { "type": "object" } ] }, "elasticClient": { "type": "object" }, "ios": { "$ref": "#/definitions/ConfigVersionObjectByDevice", "type": "object" }, "isGetPosition": { "$ref": "#/definitions/Boolean" }, "keywords": { "items": { "type": "string" }, "type": "array" }, "loadingLevel": { "examples": [ "1" ], "type": "number" }, "log": { "type": "string" }, "myBaseUrl": { "type": "string" }, "searchLink": { "type": "object" }, "syncHost": { "type": "string" }, "timestamp": { "examples": [ 5272021 ], "type": "number" }, "viewWidthHeightRatio": { "properties": { "max": { "examples": [ 0.56 ], "type": "number" }, "min": { "examples": [ 0.7 ], "type": "number" } }, "type": "object" }, "web": { "$ref": "#/definitions/ConfigVersionObjectByDevice" }, "webApiHost": { "type": "string" } }, "title": "Root/base config", "type": "object" }, "RootEvalReference": { "description": "Mutates the value at the root referenced path after receiving its result", "pattern": "^=[.][a-zA-Z0-9]+.*$", "title": "Root eval reference", "type": "string" }, "RootReference": { "description": "A reference whose scope is at the global level", "pattern": "^[.][a-zA-Z0-9]+.*$", "title": "Root reference", "type": "string" }, "SelectOptions": { "description": "Options for a select component. These are the items that appear in the drop down menu when interacting with a select component", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "title": "Select options", "type": "array" }, "Style": { "additionalProperties": true, "properties": { "align": { "description": "The alignment in a block. If align is horizontal, siblings will align horizontally, vice versa. This is functionally equivalent to the \"axis\" keyword", "examples": [ "centerX", "centerY" ], "title": "Alignment", "type": "string" }, "axis": { "description": "The axis in a block. If axis is horizontal, siblings will align horizontally, vice versa. This was previously used in list/listItem components", "examples": [ "horizontal", "vertical" ], "title": "Axis", "type": "string" }, "backgroundColor": { "examples": [ "\"0x030303\"" ], "title": "Background color", "type": "string" }, "border": { "$ref": "#/definitions/Border" }, "borderBottom": { "title": "Bottom border", "type": "string" }, "borderColor": { "examples": [ "\"0x000000\"" ], "title": "Border color", "type": "string" }, "borderRadius": { "$ref": "#/definitions/NoodlUnit", "title": "Border radius" }, "borderWidth": { "$ref": "#/definitions/NoodlUnit", "title": "Border width" }, "boxShadow": { "description": "Applies a box shadow style effect", "title": "Box shadow", "type": "string" }, "boxSizing": { "examples": [ "border-box", "content-box" ], "title": "Box sizing", "type": "string" }, "color": { "examples": [ "\"0x000000\"" ], "title": "Color", "type": "string" }, "fontFamily": { "examples": [ "Arial", "Courier New", "Verdana", "Times New Roman", "Consolas", "Helvetica" ], "title": "Font family", "type": "string" }, "fontSize": { "$ref": "#/definitions/NoodlUnit", "title": "Font size" }, "fontStyle": { "title": "Font style", "type": "string" }, "fontWeight": { "oneOf": [ { "description": "Applies a thickness style effect", "examples": [ 100, 200, 400, 500, 700, 900, "bold" ], "type": "number" }, { "type": "string" } ], "title": "Font weight" }, "height": { "$ref": "#/definitions/NoodlUnit", "title": "Component Height" }, "isEditable": { "$ref": "#/definitions/Boolean" }, "isHidden": { "$ref": "#/definitions/Boolean", "description": "Used for hiding/showing components" }, "justifyContent": { "examples": [ "flex-start", "center", "flex-end", "space-around" ], "title": "Justify content", "type": "string" }, "left": { "$ref": "#/definitions/NoodlUnit", "description": "Left position. The greater the value, the further away from the left position", "title": "Component left position" }, "letterSpacing": { "description": "Spacing between each letter", "title": "Letter spacing", "type": "string" }, "lineHeight": { "description": "Spacing between each line", "title": "Line height", "type": "string" }, "margin": { "$ref": "#/definitions/NoodlUnit", "title": "Margin" }, "marginTop": { "$ref": "#/definitions/NoodlUnit", "title": "Margin top" }, "opacity": { "description": "Applies a transparenct style effect. The lower the opacity, the more the transparent effect is applied", "examples": [ "0.5" ], "title": "Opacity", "type": "number" }, "overflow": { "description": "If hidden, any styles flowing outside of a component's bounds will be invisible", "examples": [ "hidden" ], "title": "Overflow", "type": "string" }, "paddingBottom": { "$ref": "#/definitions/NoodlUnit", "title": "Padding bottom" }, "paddingLeft": { "$ref": "#/definitions/NoodlUnit", "title": "Padding left" }, "position": { "examples": [ "relative", "absolute", "fixed", "static" ], "title": "Position", "type": "string" }, "required": { "type": "string" }, "shadow": { "description": "Applies a box shadow effect", "oneOf": [ { "examples": [ "true", "false" ], "type": "string" }, { "type": "boolean" } ], "title": "Shadow" }, "textAlign": { "$ref": "#/definitions/TextAlign" }, "textColor": { "$ref": "#/definitions/Color" }, "textIndent": { "type": "string" }, "top": { "$ref": "#/definitions/NoodlUnit", "description": "Top position. The greater the value, the further away from the top position", "title": "Component top position" }, "width": { "$ref": "#/definitions/NoodlUnit", "title": "Component width" }, "zIndex": { "description": "Applies a level of precedence/importance to a component. The higher the zIndex the higher level the component will be placed. For example, if a child 3 levels down applies a higher zIndex than the parent, then the child will appear to be on top in the page", "examples": [ "\"1000\"" ], "title": "zIndex", "type": "string" } }, "title": "Component style object", "type": "object" }, "Text": { "description": "Used to display text in the user interface. Most commonly used in label components", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/If" } ], "title": "Text" }, "TextAlign": { "oneOf": [ { "$ref": "#/definitions/TextAlignEnum" }, { "$ref": "#/definitions/TextAlignObject" } ], "title": "Text alignment" }, "TextAlignEnum": { "examples": [ "left", "center", "centerX", "right" ], "title": "Enum for the string textAlign type", "type": "string" }, "TextAlignObject": { "additionalProperties": true, "properties": { "x": { "examples": [ "left", "center", "centerX", "right" ], "type": "string" }, "y": { "examples": [ "center" ], "type": "string" } }, "title": "Text align object", "type": "object" }, "TextBoard": { "description": "A component that contains children of text that are positioned inline (side by side)", "items": { "properties": { "color": { "type": "string" }, "text": { "$ref": "#/definitions/Text" } }, "type": "object" }, "title": "Textboard components", "type": "array" }, "UserEvent": { "anyOf": [ { "$ref": "#/definitions/Action", "type": "object" }, { "$ref": "#/definitions/Reference" } ], "description": "An event in the form of an ActionChain that triggers from user interactions, like onClick and onFocus", "title": "User event" }, "Value": { "description": "A valid value in accordance to the noodl specification", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/NoodlUnit" }, { "type": "number" }, { "type": "object" }, { "type": "array" }, { "$ref": "#/definitions/Reference" }, { "type": "null" }, { "$ref": "#/definitions/If" }, { "properties": { "emit": { "$ref": "#/definitions/Emit" } }, "type": "object" } ], "title": "Noodl value" }, "ViewTag": { "description": "An identifier which is used to bind a component and an action together. Actions can define a viewTag that invokes certain behavior towards a component. The component must also contain the same viewTag key/value. If multiple components have the same viewTag, then the action will effect multiple components", "title": "View tag", "type": "string" } }, "patternProperties": { "^[a-zA-Z0-9]*$": { "anyOf": [ { "$ref": "#/definitions/Page" } ], "type": "object" } }, "title": "Noodl Schema", "type": "object" }

zcodeformat-schema-0.0.1.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "IBM zCodeFormatSettings", "description": "JSON schema for zcodeformat.yaml or zcodeformat.json code formatter preferences files. Version 0.0.1 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022. All Rights Reserved.", "type": "object", "properties": { "additionalProperties": false, "cobol": { "$ref": "#/definitions/cobol" }, "copybook": { "$ref": "#/definitions/copybook" } }, "definitions": { "copybookCapitalizationOptions": { "enum": ["upper", "lower"] }, "cobolCapitalizationOptions": { "enum": ["none", "upper", "lower", "mixed"] }, "cobol": { "additionalProperties": false, "type": "object", "properties": { "dataDivision": { "additionalProperties": false, "type": "object", "properties": { "enableIndentation": { "type": "boolean", "description": "Enable indentation of record descriptions\nIf false, startOfAreaA and indentLength are not allowed", "default": true }, "indentation": { "type": "object", "description": "Indentation objects based on enableIndentation", "$ref": "#/definitions/dataDivIndent" }, "alignPictureClauses": { "type": "boolean", "description": "Align PICTURE Clauses", "default": true }, "alignValueClauses": { "type": "boolean", "description": "Align VALUE Clauses", "default": true } }, "anyOf": [ { "properties": { "enableIndentation": { "const": false }, "indentation": { "type": "object", "additionalProperties": false } } }, { "properties": { "enableIndentation": { "const": true }, "indentation": { "$ref": "#/definitions/dataDivIndent" } } } ] }, "procedureDivision": { "additionalProperties": false, "type": "object", "properties": { "enableIndentation": { "type": "boolean", "description": "Enable indentation of procedure divisions", "default": true }, "indentation": { "type": "object", "description": "Indentation objects based on enableIndentation", "$ref": "#/definitions/procDivIndent" } }, "anyOf": [ { "properties": { "enableIndentation": { "const": false }, "indentation": { "type": "object", "additionalProperties": false } } }, { "properties": { "enableIndentation": { "const": true }, "indentation": { "$ref": "#/definitions/procDivIndent" } } } ] }, "reservedWordCase": { "type": "string", "description": "Reserved words", "default": "upper", "$ref": "#/definitions/cobolCapitalizationOptions" }, "userDefinedWordCase": { "type": "string", "description": "User-defined words", "default": "upper", "$ref": "#/definitions/cobolCapitalizationOptions" }, "commentCase": { "type": "string", "description": "Comment", "default": "none", "$ref": "#/definitions/cobolCapitalizationOptions" }, "functionCase": { "type": "string", "description": "Function", "default": "upper", "$ref": "#/definitions/cobolCapitalizationOptions" }, "dateFormatCase": { "type": "string", "description": "Date format", "default": "upper", "$ref": "#/definitions/cobolCapitalizationOptions" }, "compilerDirectiveCase": { "type": "string", "description": "Compiler directive", "default": "upper", "$ref": "#/definitions/cobolCapitalizationOptions" }, "endOfAreaB": { "type": "integer", "description": "End of Area B\n\nIf -1, will use Margin R as the end of Area B", "default": -1, "oneOf": [ { "minimum": -1, "maximum": -1 }, { "minimum": 50, "maximum": 100 } ] }, "lineWrappingStyle": { "type": "string", "description": "If indentation moves code beyond Area B", "default": "wrapToNextLine", "enum": ["wrapToNextLine", "noIndent", "indentToAreaB", "indentPastAreaB"] } } }, "copybook": { "additionalProperties": false, "type": "object", "properties": { "codeCase": { "type": "string", "description": "Format copybook code in uppercase", "default": "upper", "$ref": "#/definitions/copybookCapitalizationOptions" }, "commentCase": { "type": "string", "description": "Format copybook comments in uppercase", "default": "upper", "$ref": "#/definitions/copybookCapitalizationOptions" } } }, "dataDivIndent": { "type": "object", "additionalProperties": false, "properties": { "startOfAreaA": { "type": "integer", "description": "Start of Area A\nCannot be used if enableIndentation is false", "default": 8, "minimum": 8, "maximum": 11 }, "indentLength": { "type": "integer", "description": "Indent Length\nCannot be used if enableIndentation is false", "default": 3, "minimum": 0, "maximum": 10 } } }, "procDivIndent": { "type": "object", "additionalProperties": false, "properties": { "startOfAreaA": { "type": "integer", "description": "Start of Area A\nCannot be used if enableIndentation is false", "default": 8, "minimum": 8, "maximum": 11 }, "startOfAreaB": { "type": "integer", "description": "Start of Area B\nCannot be used if enableIndentation is false", "default": 12, "minimum": 12, "maximum": 16 }, "indentMultipleLineStatements": { "type": "integer", "description": "Multiple line statement indent length\nCannot be used if enableIndentation is false\nuse -1 to disable", "default": 3, "minimum": 0, "maximum": 10 }, "alignLists": { "type": "boolean", "description": "Align lists\nCannot be used if enableIndentation is false", "default": true }, "indentForAllBlocks": { "type": "integer", "description": "Fixed indent length to use for all blocks\nCannot be used if enableIndentation is false\nCannot be used with other individual block indent values", "default": 3, "minimum": 0, "maximum": 10 }, "blocks": { "type": "object", "description": "Individual block indent values", "$ref": "#/definitions/blockIndent" } }, "anyOf": [ { "properties": { "indentForAllBlocks": { "type": "number" }, "blocks": { "type": "object", "additionalProperties": false } } }, { "properties": { "indentForAllBlocks": false, "blocks": { "$ref": "#/definitions/blockIndent" } } } ] }, "blockIndent": { "type": "object", "additionalProperties": false, "properties": { "indentAtEndBlock": { "type": "integer", "description": "Indent length of AT END block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 3, "minimum": 0, "maximum": 10 }, "indentAtEndOfPageBlock": { "type": "integer", "description": "Indent length of AT END OF PAGE block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 3, "minimum": 0, "maximum": 10 }, "indentExecBlock": { "type": "integer", "description": "Indent length of EXEC block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 5, "minimum": 0, "maximum": 10 }, "indentEndExecPhrase": { "type": "boolean", "description": "Indent END-EXEC phrase\nCannot be used if enableIndentation is false\nEND-EXEC phrase will be indented with Exec Block", "default": true }, "indentIfBlock": { "type": "integer", "description": "Indent length of IF block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 3, "minimum": 0, "maximum": 10 }, "indentInvalidKeyBlock": { "type": "integer", "description": "Indent length of INVALID KEY block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 8, "minimum": 0, "maximum": 10 }, "indentNotAtEndBlock": { "type": "integer", "description": "Indent length of NOT AT END block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 4, "minimum": 0, "maximum": 10 }, "indentNotAtEndOfPageBlock": { "type": "integer", "description": "Indent length of NOT AT END OF PAGE block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 4, "minimum": 0, "maximum": 10 }, "indentNotInvalidKeyBlock": { "type": "integer", "description": "Indent length of INVALID KEY\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 4, "minimum": 0, "maximum": 10 }, "indentNotOnExceptionBlock": { "type": "integer", "description": "Indent length of NOT ON EXCEPTION block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 4, "minimum": 0, "maximum": 10 }, "indentNotOnOverflowBlock": { "type": "integer", "description": "Indent length of NOT ON OVERFLOW block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 4, "minimum": 0, "maximum": 10 }, "indentNotOnSizeErrorBlock": { "type": "integer", "description": "Indent length of NOT ON SIZE ERROR block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 4, "minimum": 0, "maximum": 10 }, "indentOnExceptionBlock": { "type": "integer", "description": "Indent length of ON EXCEPTION block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 3, "minimum": 0, "maximum": 10 }, "indentOnOverflowBlock": { "type": "integer", "description": "Indent length of ON OVERFLOW block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 3, "minimum": 0, "maximum": 10 }, "indentOnSizeErrorBlock": { "type": "integer", "description": "Indent length of ON SIZE ERROR block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 3, "minimum": 0, "maximum": 10 }, "indentPerformBlock": { "type": "integer", "description": "Indent length of PERFORM block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 8, "minimum": 0, "maximum": 10 }, "indentWhenBlock": { "type": "integer", "description": "Indent length of WHEN block\nCannot be used if enableIndentation is false\nCannot be used if indentForAllBlocks is used", "default": 5, "minimum": 0, "maximum": 10 } } } } }

camel-yaml-dsl.json

{ "$schema" : "http://json-schema.org/draft-04/schema#", "type" : "array", "items" : { "maxProperties" : 1, "definitions" : { "org.apache.camel.model.ProcessorDefinition" : { "type" : "object", "maxProperties" : 1, "properties" : { "aggregate" : { "$ref" : "#/items/definitions/org.apache.camel.model.AggregateDefinition" }, "bean" : { "$ref" : "#/items/definitions/org.apache.camel.model.BeanDefinition" }, "do-catch" : { "$ref" : "#/items/definitions/org.apache.camel.model.CatchDefinition" }, "doCatch" : { "$ref" : "#/items/definitions/org.apache.camel.model.CatchDefinition" }, "choice" : { "$ref" : "#/items/definitions/org.apache.camel.model.ChoiceDefinition" }, "circuit-breaker" : { "$ref" : "#/items/definitions/org.apache.camel.model.CircuitBreakerDefinition" }, "circuitBreaker" : { "$ref" : "#/items/definitions/org.apache.camel.model.CircuitBreakerDefinition" }, "claim-check" : { "$ref" : "#/items/definitions/org.apache.camel.model.ClaimCheckDefinition" }, "claimCheck" : { "$ref" : "#/items/definitions/org.apache.camel.model.ClaimCheckDefinition" }, "convert-body-to" : { "$ref" : "#/items/definitions/org.apache.camel.model.ConvertBodyDefinition" }, "convertBodyTo" : { "$ref" : "#/items/definitions/org.apache.camel.model.ConvertBodyDefinition" }, "delay" : { "$ref" : "#/items/definitions/org.apache.camel.model.DelayDefinition" }, "dynamic-router" : { "$ref" : "#/items/definitions/org.apache.camel.model.DynamicRouterDefinition" }, "dynamicRouter" : { "$ref" : "#/items/definitions/org.apache.camel.model.DynamicRouterDefinition" }, "enrich" : { "$ref" : "#/items/definitions/org.apache.camel.model.EnrichDefinition" }, "filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.FilterDefinition" }, "do-finally" : { "$ref" : "#/items/definitions/org.apache.camel.model.FinallyDefinition" }, "doFinally" : { "$ref" : "#/items/definitions/org.apache.camel.model.FinallyDefinition" }, "idempotent-consumer" : { "$ref" : "#/items/definitions/org.apache.camel.model.IdempotentConsumerDefinition" }, "idempotentConsumer" : { "$ref" : "#/items/definitions/org.apache.camel.model.IdempotentConsumerDefinition" }, "intercept" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptDefinition" }, "intercept-from" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptFromDefinition" }, "interceptFrom" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptFromDefinition" }, "intercept-send-to-endpoint" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptSendToEndpointDefinition" }, "interceptSendToEndpoint" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptSendToEndpointDefinition" }, "kamelet" : { "$ref" : "#/items/definitions/org.apache.camel.model.KameletDefinition" }, "load-balance" : { "$ref" : "#/items/definitions/org.apache.camel.model.LoadBalanceDefinition" }, "loadBalance" : { "$ref" : "#/items/definitions/org.apache.camel.model.LoadBalanceDefinition" }, "log" : { "$ref" : "#/items/definitions/org.apache.camel.model.LogDefinition" }, "loop" : { "$ref" : "#/items/definitions/org.apache.camel.model.LoopDefinition" }, "marshal" : { "$ref" : "#/items/definitions/org.apache.camel.model.MarshalDefinition" }, "multicast" : { "$ref" : "#/items/definitions/org.apache.camel.model.MulticastDefinition" }, "on-completion" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnCompletionDefinition" }, "onCompletion" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnCompletionDefinition" }, "on-fallback" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnFallbackDefinition" }, "onFallback" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnFallbackDefinition" }, "otherwise" : { "$ref" : "#/items/definitions/org.apache.camel.model.OtherwiseDefinition" }, "pausable" : { "$ref" : "#/items/definitions/org.apache.camel.model.PausableDefinition" }, "pipeline" : { "$ref" : "#/items/definitions/org.apache.camel.model.PipelineDefinition" }, "policy" : { "$ref" : "#/items/definitions/org.apache.camel.model.PolicyDefinition" }, "poll-enrich" : { "$ref" : "#/items/definitions/org.apache.camel.model.PollEnrichDefinition" }, "pollEnrich" : { "$ref" : "#/items/definitions/org.apache.camel.model.PollEnrichDefinition" }, "process" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessDefinition" }, "recipient-list" : { "$ref" : "#/items/definitions/org.apache.camel.model.RecipientListDefinition" }, "recipientList" : { "$ref" : "#/items/definitions/org.apache.camel.model.RecipientListDefinition" }, "remove-header" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemoveHeaderDefinition" }, "removeHeader" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemoveHeaderDefinition" }, "remove-headers" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemoveHeadersDefinition" }, "removeHeaders" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemoveHeadersDefinition" }, "remove-properties" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemovePropertiesDefinition" }, "removeProperties" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemovePropertiesDefinition" }, "remove-property" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemovePropertyDefinition" }, "removeProperty" : { "$ref" : "#/items/definitions/org.apache.camel.model.RemovePropertyDefinition" }, "resequence" : { "$ref" : "#/items/definitions/org.apache.camel.model.ResequenceDefinition" }, "resumable" : { "$ref" : "#/items/definitions/org.apache.camel.model.ResumableDefinition" }, "rollback" : { "$ref" : "#/items/definitions/org.apache.camel.model.RollbackDefinition" }, "routing-slip" : { "$ref" : "#/items/definitions/org.apache.camel.model.RoutingSlipDefinition" }, "routingSlip" : { "$ref" : "#/items/definitions/org.apache.camel.model.RoutingSlipDefinition" }, "saga" : { "$ref" : "#/items/definitions/org.apache.camel.model.SagaDefinition" }, "sample" : { "$ref" : "#/items/definitions/org.apache.camel.model.SamplingDefinition" }, "script" : { "$ref" : "#/items/definitions/org.apache.camel.model.ScriptDefinition" }, "set-body" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetBodyDefinition" }, "setBody" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetBodyDefinition" }, "set-exchange-pattern" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetExchangePatternDefinition" }, "setExchangePattern" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetExchangePatternDefinition" }, "set-header" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetHeaderDefinition" }, "setHeader" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetHeaderDefinition" }, "set-property" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetPropertyDefinition" }, "setProperty" : { "$ref" : "#/items/definitions/org.apache.camel.model.SetPropertyDefinition" }, "sort" : { "$ref" : "#/items/definitions/org.apache.camel.model.SortDefinition" }, "split" : { "$ref" : "#/items/definitions/org.apache.camel.model.SplitDefinition" }, "step" : { "$ref" : "#/items/definitions/org.apache.camel.model.StepDefinition" }, "stop" : { "$ref" : "#/items/definitions/org.apache.camel.model.StopDefinition" }, "threads" : { "$ref" : "#/items/definitions/org.apache.camel.model.ThreadsDefinition" }, "throttle" : { "$ref" : "#/items/definitions/org.apache.camel.model.ThrottleDefinition" }, "throw-exception" : { "$ref" : "#/items/definitions/org.apache.camel.model.ThrowExceptionDefinition" }, "throwException" : { "$ref" : "#/items/definitions/org.apache.camel.model.ThrowExceptionDefinition" }, "to" : { "$ref" : "#/items/definitions/org.apache.camel.model.ToDefinition" }, "to-d" : { "$ref" : "#/items/definitions/org.apache.camel.model.ToDynamicDefinition" }, "toD" : { "$ref" : "#/items/definitions/org.apache.camel.model.ToDynamicDefinition" }, "transacted" : { "$ref" : "#/items/definitions/org.apache.camel.model.TransactedDefinition" }, "transform" : { "$ref" : "#/items/definitions/org.apache.camel.model.TransformDefinition" }, "do-try" : { "$ref" : "#/items/definitions/org.apache.camel.model.TryDefinition" }, "doTry" : { "$ref" : "#/items/definitions/org.apache.camel.model.TryDefinition" }, "unmarshal" : { "$ref" : "#/items/definitions/org.apache.camel.model.UnmarshalDefinition" }, "validate" : { "$ref" : "#/items/definitions/org.apache.camel.model.ValidateDefinition" }, "when" : { "$ref" : "#/items/definitions/org.apache.camel.model.WhenDefinition" }, "when-skip-send-to-endpoint" : { "$ref" : "#/items/definitions/org.apache.camel.model.WhenSkipSendToEndpointDefinition" }, "whenSkipSendToEndpoint" : { "$ref" : "#/items/definitions/org.apache.camel.model.WhenSkipSendToEndpointDefinition" }, "wire-tap" : { "$ref" : "#/items/definitions/org.apache.camel.model.WireTapDefinition" }, "wireTap" : { "$ref" : "#/items/definitions/org.apache.camel.model.WireTapDefinition" }, "service-call" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ServiceCallDefinition" }, "serviceCall" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ServiceCallDefinition" } } }, "org.apache.camel.dsl.yaml.deserializers.BeansDeserializer" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.app.RegistryBeanDefinition" } }, "org.apache.camel.dsl.yaml.deserializers.ErrorHandlerBuilderDeserializer" : { "type" : "object", "properties" : { "dead-letter-channel" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.DeadLetterChannelDefinition" }, "default-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.DefaultErrorHandlerDefinition" }, "jta-transaction-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.JtaTransactionErrorHandlerDefinition" }, "no-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.NoErrorHandlerDefinition" }, "ref-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.RefErrorHandlerDefinition" }, "spring-transaction-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.SpringTransactionErrorHandlerDefinition" } } }, "org.apache.camel.dsl.yaml.deserializers.OutputAwareFromDefinition" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "parameters" : { "type" : "object" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "uri" : { "type" : "string" } }, "required" : [ "steps", "uri" ] }, "org.apache.camel.dsl.yaml.deserializers.RouteFromDefinitionDeserializer" : { "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.dsl.yaml.deserializers.OutputAwareFromDefinition" } ], "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "parameters" : { "type" : "object" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "uri" : { "type" : "string" } }, "required" : [ "steps", "uri" ] }, "org.apache.camel.model.AggregateDefinition" : { "title" : "Aggregate", "description" : "Aggregates many messages into a single message", "type" : "object", "properties" : { "aggregate-controller" : { "type" : "string", "title" : "Aggregate Controller", "description" : "To use a org.apache.camel.processor.aggregate.AggregateController to allow external sources to control this aggregator." }, "aggregation-repository" : { "type" : "string", "title" : "Aggregation Repository", "description" : "The AggregationRepository to use. Sets the custom aggregate repository to use. Will by default use org.apache.camel.processor.aggregate.MemoryAggregationRepository" }, "aggregation-strategy" : { "type" : "string", "title" : "Aggregation Strategy", "description" : "The AggregationStrategy to use. For example to lookup a bean with the name foo, the value is simply just #bean:foo. Configuring an AggregationStrategy is required, and is used to merge the incoming Exchange with the existing already merged exchanges. At first call the oldExchange parameter is null. On subsequent invocations the oldExchange contains the merged exchanges and newExchange is of course the new incoming Exchange." }, "aggregation-strategy-method-allow-null" : { "type" : "boolean", "title" : "Aggregation Strategy Method Allow Null", "description" : "If this option is false then the aggregate method is not used for the very first aggregation. If this option is true then null values is used as the oldExchange (at the very first aggregation), when using beans as the AggregationStrategy." }, "aggregation-strategy-method-name" : { "type" : "string", "title" : "Aggregation Strategy Method Name", "description" : "This option can be used to explicit declare the method name to use, when using beans as the AggregationStrategy." }, "close-correlation-key-on-completion" : { "type" : "number", "title" : "Close Correlation Key On Completion", "description" : "Closes a correlation key when its complete. Any late received exchanges which has a correlation key that has been closed, it will be defined and a ClosedCorrelationKeyException is thrown." }, "complete-all-on-stop" : { "type" : "boolean", "title" : "Complete All On Stop", "description" : "Indicates to wait to complete all current and partial (pending) aggregated exchanges when the context is stopped. This also means that we will wait for all pending exchanges which are stored in the aggregation repository to complete so the repository is empty before we can stop. You may want to enable this when using the memory based aggregation repository that is memory based only, and do not store data on disk. When this option is enabled, then the aggregator is waiting to complete all those exchanges before its stopped, when stopping CamelContext or the route using it." }, "completion-from-batch-consumer" : { "type" : "boolean", "title" : "Completion From Batch Consumer", "description" : "Enables the batch completion mode where we aggregate from a org.apache.camel.BatchConsumer and aggregate the total number of exchanges the org.apache.camel.BatchConsumer has reported as total by checking the exchange property org.apache.camel.Exchange#BATCH_COMPLETE when its complete. This option cannot be used together with discardOnAggregationFailure." }, "completion-interval" : { "type" : "string", "title" : "Completion Interval", "description" : "A repeating period in millis by which the aggregator will complete all current aggregated exchanges. Camel has a background task which is triggered every period. You cannot use this option together with completionTimeout, only one of them can be used." }, "completion-on-new-correlation-group" : { "type" : "boolean", "title" : "Completion On New Correlation Group", "description" : "Enables completion on all previous groups when a new incoming correlation group. This can for example be used to complete groups with same correlation keys when they are in consecutive order. Notice when this is enabled then only 1 correlation group can be in progress as when a new correlation group starts, then the previous groups is forced completed." }, "completion-predicate" : { "title" : "Completion Predicate", "description" : "A Predicate to indicate when an aggregated exchange is complete. If this is not specified and the AggregationStrategy object implements Predicate, the aggregationStrategy object will be used as the completionPredicate.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "completion-size" : { "type" : "number", "title" : "Completion Size", "description" : "Number of messages aggregated before the aggregation is complete. This option can be set as either a fixed value or using an Expression which allows you to evaluate a size dynamically - will use Integer as result. If both are set Camel will fallback to use the fixed value if the Expression result was null or 0." }, "completion-size-expression" : { "title" : "Completion Size Expression", "description" : "Number of messages aggregated before the aggregation is complete. This option can be set as either a fixed value or using an Expression which allows you to evaluate a size dynamically - will use Integer as result. If both are set Camel will fallback to use the fixed value if the Expression result was null or 0.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "completion-timeout" : { "type" : "string", "title" : "Completion Timeout", "description" : "Time in millis that an aggregated exchange should be inactive before its complete (timeout). This option can be set as either a fixed value or using an Expression which allows you to evaluate a timeout dynamically - will use Long as result. If both are set Camel will fallback to use the fixed value if the Expression result was null or 0. You cannot use this option together with completionInterval, only one of the two can be used. By default the timeout checker runs every second, you can use the completionTimeoutCheckerInterval option to configure how frequently to run the checker. The timeout is an approximation and there is no guarantee that the a timeout is triggered exactly after the timeout value. It is not recommended to use very low timeout values or checker intervals." }, "completion-timeout-checker-interval" : { "type" : "string", "title" : "Completion Timeout Checker Interval", "description" : "Interval in millis that is used by the background task that checks for timeouts ( org.apache.camel.TimeoutMap ). By default the timeout checker runs every second. The timeout is an approximation and there is no guarantee that the a timeout is triggered exactly after the timeout value. It is not recommended to use very low timeout values or checker intervals.", "default" : "1000" }, "completion-timeout-expression" : { "title" : "Completion Timeout Expression", "description" : "Time in millis that an aggregated exchange should be inactive before its complete (timeout). This option can be set as either a fixed value or using an Expression which allows you to evaluate a timeout dynamically - will use Long as result. If both are set Camel will fallback to use the fixed value if the Expression result was null or 0. You cannot use this option together with completionInterval, only one of the two can be used. By default the timeout checker runs every second, you can use the completionTimeoutCheckerInterval option to configure how frequently to run the checker. The timeout is an approximation and there is no guarantee that the a timeout is triggered exactly after the timeout value. It is not recommended to use very low timeout values or checker intervals.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "correlation-expression" : { "title" : "Correlation Expression", "description" : "The expression used to calculate the correlation key to use for aggregation. The Exchange which has the same correlation key is aggregated together. If the correlation key could not be evaluated an Exception is thrown. You can disable this by using the ignoreBadCorrelationKeys option.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "discard-on-aggregation-failure" : { "type" : "boolean", "title" : "Discard On Aggregation Failure", "description" : "Discards the aggregated message when aggregation failed (an exception was thrown from AggregationStrategy . This means the partly aggregated message is dropped and not sent out of the aggregator. This option cannot be used together with completionFromBatchConsumer." }, "discard-on-completion-timeout" : { "type" : "boolean", "title" : "Discard On Completion Timeout", "description" : "Discards the aggregated message on completion timeout. This means on timeout the aggregated message is dropped and not sent out of the aggregator." }, "eager-check-completion" : { "type" : "boolean", "title" : "Eager Check Completion", "description" : "Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "If using parallelProcessing you can specify a custom thread pool to be used. In fact also if you are not using parallelProcessing this custom thread pool is used to send out aggregated exchanges as well." }, "force-completion-on-stop" : { "type" : "boolean", "title" : "Force Completion On Stop", "description" : "Indicates to complete all current aggregated exchanges when the context is stopped" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-correlation-keys" : { "type" : "boolean", "title" : "Ignore Invalid Correlation Keys", "description" : "If a correlation key cannot be successfully evaluated it will be ignored by logging a DEBUG and then just ignore the incoming Exchange." }, "inherit-error-handler" : { "type" : "boolean" }, "optimistic-lock-retry-policy" : { "title" : "Optimistic Lock Retry Policy", "description" : "Allows to configure retry settings when using optimistic locking.", "$ref" : "#/items/definitions/org.apache.camel.model.OptimisticLockRetryPolicyDefinition" }, "optimistic-locking" : { "type" : "boolean", "title" : "Optimistic Locking", "description" : "Turns on using optimistic locking, which requires the aggregationRepository being used, is supporting this by implementing org.apache.camel.spi.OptimisticLockingAggregationRepository ." }, "parallel-processing" : { "type" : "boolean", "title" : "Parallel Processing", "description" : "When aggregated are completed they are being send out of the aggregator. This option indicates whether or not Camel should use a thread pool with multiple threads for concurrency. If no custom thread pool has been specified then Camel creates a default pool with 10 concurrent threads." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "timeout-checker-executor-service" : { "type" : "string", "title" : "Timeout Checker Executor Service", "description" : "If using either of the completionTimeout, completionTimeoutExpression, or completionInterval options a background thread is created to check for the completion for every aggregator. Set this option to provide a custom thread pool to be used rather than creating a new thread for every aggregator." } }, "required" : [ "aggregation-strategy" ] }, "org.apache.camel.model.BeanDefinition" : { "title" : "Bean", "description" : "Calls a Java bean", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "bean-type" : { "type" : "string", "title" : "Bean Type", "description" : "Sets the class name (fully qualified) of the bean to use" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "method" : { "type" : "string", "title" : "Method", "description" : "Sets the method name on the bean to use" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Sets a reference to an exiting bean to use, which is looked up from the registry" }, "scope" : { "type" : "string", "title" : "Scope", "description" : "Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. So when using prototype scope then this depends on the bean registry implementation.", "default" : "Singleton", "enum" : [ "Singleton", "Request", "Prototype" ] } } } ] }, "org.apache.camel.model.CatchDefinition" : { "title" : "Do Catch", "description" : "Catches exceptions as part of a try, catch, finally block", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "exception" : { "type" : "array", "title" : "Exception", "description" : "The exception(s) to catch.", "items" : { "type" : "string" } }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "on-when" : { "title" : "On When", "description" : "Sets an additional predicate that should be true before the onCatch is triggered. To be used for fine grained controlling whether a thrown exception should be intercepted by this exception type or not.", "$ref" : "#/items/definitions/org.apache.camel.model.WhenDefinition" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.ChoiceDefinition" : { "title" : "Choice", "description" : "Route messages based on a series of predicates", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "otherwise" : { "title" : "Otherwise", "description" : "Sets the otherwise node", "$ref" : "#/items/definitions/org.apache.camel.model.OtherwiseDefinition" }, "precondition" : { "type" : "boolean", "title" : "Precondition", "description" : "Indicates whether this Choice EIP is in precondition mode or not. If so its branches (when/otherwise) are evaluated during startup to keep at runtime only the branch that matched." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "when" : { "type" : "array", "title" : "When", "description" : "Sets the when nodes", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.WhenDefinition" } } } }, "org.apache.camel.model.CircuitBreakerDefinition" : { "title" : "Circuit Breaker", "description" : "Route messages in a fault tolerance way using Circuit Breaker", "type" : "object", "properties" : { "configuration" : { "type" : "string", "title" : "Configuration", "description" : "Refers to a circuit breaker configuration (such as resillience4j, or microprofile-fault-tolerance) to use for configuring the circuit breaker EIP." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "fault-tolerance-configuration" : { "title" : "Fault Tolerance Configuration", "description" : "Configures the circuit breaker to use MicroProfile Fault Tolerance with the given configuration.", "$ref" : "#/items/definitions/org.apache.camel.model.FaultToleranceConfigurationDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "on-fallback" : { "title" : "On Fallback", "description" : "The fallback route path to execute that does not go over the network. This should be a static or cached result that can immediately be returned upon failure. If the fallback requires network connection then use onFallbackViaNetwork() .", "$ref" : "#/items/definitions/org.apache.camel.model.OnFallbackDefinition" }, "resilience4j-configuration" : { "title" : "Resilience4j Configuration", "description" : "Configures the circuit breaker to use Resilience4j with the given configuration.", "$ref" : "#/items/definitions/org.apache.camel.model.Resilience4jConfigurationDefinition" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.ClaimCheckDefinition" : { "title" : "Claim Check", "description" : "The Claim Check EIP allows you to replace message content with a claim check (a unique key), which can be used to retrieve the message content at a later time.", "type" : "object", "properties" : { "aggregation-strategy" : { "type" : "string", "title" : "Aggregation Strategy", "description" : "To use a custom AggregationStrategy instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time." }, "aggregation-strategy-method-name" : { "type" : "string", "title" : "Aggregation Strategy Method Name", "description" : "This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "filter" : { "type" : "string", "title" : "Filter", "description" : "Specify a filter to control what data gets merged data back from the claim check repository. The following syntax is supported: body - to aggregate the message body attachments - to aggregate all the message attachments headers - to aggregate all the message headers header:pattern - to aggregate all the message headers that matches the pattern. The following pattern rules are applied in this order: exact match, returns true wildcard match (pattern ends with a and the name starts with the pattern), returns true regular expression match, returns true otherwise returns false You can specify multiple rules separated by comma. For example, the following includes the message body and all headers starting with foo: body,header:foo. The syntax supports the following prefixes which can be used to specify include,exclude, or remove - to include (which is the default mode) - - to exclude (exclude takes precedence over include) -- - to remove (remove takes precedence) For example to exclude a header name foo, and remove all headers starting with bar, -header:foo,--headers:bar Note you cannot have both include and exclude header:pattern at the same time." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "key" : { "type" : "string", "title" : "Key", "description" : "To use a specific key for claim check id (for dynamic keys use simple language syntax as the key)." }, "operation" : { "type" : "string", "title" : "Operation", "description" : "The claim check operation to use. The following operations are supported: Get - Gets (does not remove) the claim check by the given key. GetAndRemove - Gets and removes the claim check by the given key. Set - Sets a new (will override if key already exists) claim check with the given key. Push - Sets a new claim check on the stack (does not use key). Pop - Gets the latest claim check from the stack (does not use key).", "enum" : [ "Get", "GetAndRemove", "Set", "Push", "Pop" ] } } }, "org.apache.camel.model.ContextScanDefinition" : { "title" : "Context Scan", "description" : "Scans for Java org.apache.camel.builder.RouteBuilder instances in the context org.apache.camel.spi.Registry .", "type" : "object", "properties" : { "excludes" : { "type" : "array", "title" : "Excludes", "description" : "Exclude finding route builder from these java package names.", "items" : { "type" : "string" } }, "include-non-singletons" : { "type" : "boolean", "title" : "Include Non Singletons", "description" : "Whether to include non-singleton beans (prototypes) By default only singleton beans is included in the context scan" }, "includes" : { "type" : "array", "title" : "Includes", "description" : "Include finding route builder from these java package names.", "items" : { "type" : "string" } } } }, "org.apache.camel.model.ConvertBodyDefinition" : { "title" : "Convert Body To", "description" : "Converts the message body to another type", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "charset" : { "type" : "string", "title" : "Charset", "description" : "To use a specific charset when converting" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "mandatory" : { "type" : "boolean", "title" : "Mandatory", "description" : "When mandatory then the conversion must return a value (cannot be null), if this is not possible then NoTypeConversionAvailableException is thrown. Setting this to false could mean conversion is not possible and the value is null." }, "type" : { "type" : "string", "title" : "Type", "description" : "The java type to convert to" } } } ], "required" : [ "type" ] }, "org.apache.camel.model.DataFormatDefinition" : { "type" : "object", "properties" : { "id" : { "type" : "string" } } }, "org.apache.camel.model.DelayDefinition" : { "title" : "Delay", "description" : "Delays processing for a specified length of time", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "async-delayed" : { "type" : "boolean", "title" : "Async Delayed", "description" : "Enables asynchronous delay which means the thread will not block while delaying." }, "caller-runs-when-rejected" : { "type" : "boolean", "title" : "Caller Runs When Rejected", "description" : "Whether or not the caller should run the task when it was rejected by the thread pool. Is by default true" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "To use a custom Thread Pool if asyncDelay has been enabled." }, "expression" : { "title" : "Expression", "description" : "Expression to define how long time to wait (in millis)", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" } } }, "org.apache.camel.model.DynamicRouterDefinition" : { "title" : "Dynamic Router", "description" : "Route messages based on dynamic rules", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "cache-size" : { "type" : "number", "title" : "Cache Size", "description" : "Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this dynamic router, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to call that returns the endpoint(s) to route to in the dynamic routing. Important: The expression will be called in a while loop fashion, until the expression returns null which means the dynamic router is finished.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-endpoints" : { "type" : "boolean", "title" : "Ignore Invalid Endpoints", "description" : "Ignore the invalidate endpoint exception when try to create a producer with that endpoint" }, "inherit-error-handler" : { "type" : "boolean" }, "uri-delimiter" : { "type" : "string", "title" : "Uri Delimiter", "description" : "Sets the uri delimiter to use", "default" : "," } } }, "org.apache.camel.model.EnrichDefinition" : { "title" : "Enrich", "description" : "Enriches a message with data from a secondary resource", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "aggregate-on-exception" : { "type" : "boolean", "title" : "Aggregate On Exception", "description" : "If this option is false then the aggregate method is not used if there was an exception thrown while trying to retrieve the data to enrich from the resource. Setting this option to true allows end users to control what to do if there was an exception in the aggregate method. For example to suppress the exception or set a custom message body etc." }, "aggregation-strategy" : { "type" : "string", "title" : "Aggregation Strategy", "description" : "Sets the AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message. By default Camel will use the reply from the external service as outgoing message." }, "aggregation-strategy-method-allow-null" : { "type" : "string", "title" : "Aggregation Strategy Method Allow Null", "description" : "If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy." }, "aggregation-strategy-method-name" : { "type" : "string", "title" : "Aggregation Strategy Method Name", "description" : "This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy." }, "allow-optimised-components" : { "type" : "boolean", "title" : "Allow Optimised Components", "description" : "Whether to allow components to optimise enricher if they are org.apache.camel.spi.SendDynamicAware ." }, "cache-size" : { "type" : "number", "title" : "Cache Size", "description" : "Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producer when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression that computes the endpoint uri to use as the resource endpoint to enrich from", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-endpoint" : { "type" : "boolean", "title" : "Ignore Invalid Endpoint", "description" : "Ignore the invalidate endpoint exception when try to create a producer with that endpoint" }, "inherit-error-handler" : { "type" : "boolean" }, "share-unit-of-work" : { "type" : "boolean", "title" : "Share Unit Of Work", "description" : "Shares the org.apache.camel.spi.UnitOfWork with the parent and the resource exchange. Enrich will by default not share unit of work between the parent exchange and the resource exchange. This means the resource exchange has its own individual unit of work." } } }, "org.apache.camel.model.ErrorHandlerDefinition" : { "title" : "Error Handler", "description" : "Camel error handling.", "type" : "object", "properties" : { "dead-letter-channel" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.DeadLetterChannelDefinition" }, "default-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.DefaultErrorHandlerDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "jta-transaction-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.JtaTransactionErrorHandlerDefinition" }, "no-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.NoErrorHandlerDefinition" }, "spring-transaction-error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.errorhandler.SpringTransactionErrorHandlerDefinition" } } }, "org.apache.camel.model.ExpressionSubElementDefinition" : { "type" : "object", "properties" : { "constant" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ConstantExpression" }, "csimple" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.CSimpleExpression" }, "datasonnet" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.DatasonnetExpression" }, "exchange-property" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExchangePropertyExpression" }, "exchangeProperty" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExchangePropertyExpression" }, "groovy" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.GroovyExpression" }, "header" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.HeaderExpression" }, "hl7terser" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.Hl7TerserExpression" }, "joor" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JoorExpression" }, "jq" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JqExpression" }, "js" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JavaScriptExpression" }, "jsonpath" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JsonPathExpression" }, "language" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.LanguageExpression" }, "method" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.MethodCallExpression" }, "mvel" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.MvelExpression" }, "ognl" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.OgnlExpression" }, "python" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.PythonExpression" }, "ref" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.RefExpression" }, "simple" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.SimpleExpression" }, "spel" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.SpELExpression" }, "tokenize" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.TokenizerExpression" }, "xpath" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.XPathExpression" }, "xquery" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.XQueryExpression" }, "xtokenize" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.XMLTokenizerExpression" } } }, "org.apache.camel.model.FaultToleranceConfigurationDefinition" : { "title" : "Fault Tolerance Configuration", "description" : "MicroProfile Fault Tolerance Circuit Breaker EIP configuration", "type" : "object", "properties" : { "bulkhead-enabled" : { "type" : "boolean", "title" : "Bulkhead Enabled", "description" : "Whether bulkhead is enabled or not on the circuit breaker. Default is false." }, "bulkhead-executor-service" : { "type" : "string", "title" : "Bulkhead Executor Service", "description" : "References to a custom thread pool to use when bulkhead is enabled." }, "bulkhead-max-concurrent-calls" : { "type" : "number", "title" : "Bulkhead Max Concurrent Calls", "description" : "Configures the max amount of concurrent calls the bulkhead will support.", "default" : "10" }, "bulkhead-waiting-task-queue" : { "type" : "number", "title" : "Bulkhead Waiting Task Queue", "description" : "Configures the task queue size for holding waiting tasks to be processed by the bulkhead.", "default" : "10" }, "circuit-breaker" : { "type" : "string", "title" : "Circuit Breaker", "description" : "Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use." }, "delay" : { "type" : "string", "title" : "Delay", "description" : "Control how long the circuit breaker stays open. The default is 5 seconds.", "default" : "5000" }, "failure-ratio" : { "type" : "number", "title" : "Failure Ratio", "description" : "Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage.", "default" : "50" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "request-volume-threshold" : { "type" : "number", "title" : "Request Volume Threshold", "description" : "Controls the size of the rolling window used when the circuit breaker is closed", "default" : "20" }, "success-threshold" : { "type" : "number", "title" : "Success Threshold", "description" : "Controls the number of trial calls which are allowed when the circuit breaker is half-open", "default" : "1" }, "timeout-duration" : { "type" : "string", "title" : "Timeout Duration", "description" : "Configures the thread execution timeout. Default value is 1 second.", "default" : "1000" }, "timeout-enabled" : { "type" : "boolean", "title" : "Timeout Enabled", "description" : "Whether timeout is enabled or not on the circuit breaker. Default is false." }, "timeout-pool-size" : { "type" : "number", "title" : "Timeout Pool Size", "description" : "Configures the pool size of the thread pool when timeout is enabled. Default value is 10.", "default" : "10" }, "timeout-scheduled-executor-service" : { "type" : "string", "title" : "Timeout Scheduled Executor Service", "description" : "References to a custom thread pool to use when timeout is enabled" } } }, "org.apache.camel.model.FilterDefinition" : { "title" : "Filter", "description" : "Filter out messages based using a predicate", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to determine if the message should be filtered or not. If the expression returns an empty value or false then the message is filtered (dropped), otherwise the message is continued being routed.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "status-property-name" : { "type" : "string", "title" : "Status Property Name", "description" : "Name of exchange property to use for storing the status of the filtering. Setting this allows to know if the filter predicate evaluated as true or false." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.FinallyDefinition" : { "title" : "Do Finally", "description" : "Path traversed when a try, catch, finally block exits", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.FromDefinition" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "parameters" : { "type" : "object" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "uri" : { "type" : "string" } }, "required" : [ "steps", "uri" ] }, "org.apache.camel.model.GlobalOptionDefinition" : { "title" : "Global Option", "description" : "Models a string key/value pair for configuring some global options on a Camel context such as max debug log length.", "type" : "object", "properties" : { "key" : { "type" : "string", "title" : "Key", "description" : "Global option key" }, "value" : { "type" : "string", "title" : "Value", "description" : "Global option value" } }, "required" : [ "key", "value" ] }, "org.apache.camel.model.GlobalOptionsDefinition" : { "title" : "Global Options", "description" : "Models a series of string key/value pairs for configuring some global options on a Camel context such as max debug log length.", "type" : "object", "properties" : { "global-option" : { "type" : "array", "title" : "Global Option", "description" : "A series of global options as key value pairs", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.GlobalOptionDefinition" } } } }, "org.apache.camel.model.IdempotentConsumerDefinition" : { "title" : "Idempotent Consumer", "description" : "Filters out duplicate messages", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "completion-eager" : { "type" : "boolean", "title" : "Completion Eager", "description" : "Sets whether to complete the idempotent consumer eager or when the exchange is done. If this option is true to complete eager, then the idempotent consumer will trigger its completion when the exchange reached the end of the block of the idempotent consumer pattern. So if the exchange is continued routed after the block ends, then whatever happens there does not affect the state. If this option is false (default) to not complete eager, then the idempotent consumer will complete when the exchange is done being routed. So if the exchange is continued routed after the block ends, then whatever happens there also affect the state. For example if the exchange failed due to an exception, then the state of the idempotent consumer will be a rollback." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "eager" : { "type" : "boolean", "title" : "Eager", "description" : "Sets whether to eagerly add the key to the idempotent repository or wait until the exchange is complete. Eager is default enabled." }, "expression" : { "title" : "Expression", "description" : "Expression used to calculate the correlation key to use for duplicate check. The Exchange which has the same correlation key is regarded as a duplicate and will be rejected.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "idempotent-repository" : { "type" : "string", "title" : "Idempotent Repository", "description" : "Sets the reference name of the message id repository" }, "inherit-error-handler" : { "type" : "boolean" }, "remove-on-failure" : { "type" : "boolean", "title" : "Remove On Failure", "description" : "Sets whether to remove or keep the key on failure. The default behavior is to remove the key on failure." }, "skip-duplicate" : { "type" : "boolean", "title" : "Skip Duplicate", "description" : "Sets whether to skip duplicates or not. The default behavior is to skip duplicates. A duplicate message would have the Exchange property org.apache.camel.Exchange#DUPLICATE_MESSAGE set to a Boolean#TRUE value. A none duplicate message will not have this property set." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } }, "required" : [ "idempotent-repository" ] }, "org.apache.camel.model.InputTypeDefinition" : { "title" : "Input Type", "description" : "Set the expected data type of the input message. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists. If validate attribute is true then camel applies Validator as well. Type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example {code java:java.lang.String} , {code json:ABCOrder} . It's also possible to specify only scheme part, so that it works like a wildcard. If only 'xml' is specified, all the XML message matches. It's handy to add only one transformer/validator for all the transformation from/to XML.", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "urn" : { "type" : "string", "title" : "Urn", "description" : "The input type URN." }, "validate" : { "type" : "boolean", "title" : "Validate", "description" : "Whether if validation is required for this input type." } }, "required" : [ "urn" ] }, "org.apache.camel.model.InterceptDefinition" : { "title" : "Intercept", "description" : "Intercepts a message at each step in the route", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.InterceptFromDefinition" : { "title" : "Intercept From", "description" : "Intercepts incoming messages", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "uri" : { "type" : "string", "title" : "Uri", "description" : "Intercept incoming messages from the uri or uri pattern. If this option is not configured, then all incoming messages is intercepted." } } } ] }, "org.apache.camel.model.InterceptSendToEndpointDefinition" : { "title" : "Intercept Send To Endpoint", "description" : "Intercepts messages being sent to an endpoint", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "after-uri" : { "type" : "string", "title" : "After Uri", "description" : "After sending to the endpoint then send the message to this uri which allows to process its result." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "skip-send-to-original-endpoint" : { "type" : "string", "title" : "Skip Send To Original Endpoint", "description" : "If set to true then the message is not sent to the original endpoint. By default (false) the message is both intercepted and then sent to the original endpoint." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "uri" : { "type" : "string", "title" : "Uri", "description" : "Intercept sending to the uri or uri pattern." } } } ], "required" : [ "uri" ] }, "org.apache.camel.model.KameletDefinition" : { "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "inherit-error-handler" : { "type" : "boolean" }, "name" : { "type" : "string" }, "parameters" : { "type" : "object" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } } ], "required" : [ "name" ] }, "org.apache.camel.model.LoadBalanceDefinition" : { "title" : "Load Balance", "description" : "Balances message processing among a number of nodes", "type" : "object", "properties" : { "custom-load-balancer" : { "$ref" : "#/items/definitions/org.apache.camel.model.loadbalancer.CustomLoadBalancerDefinition" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "failover" : { "$ref" : "#/items/definitions/org.apache.camel.model.loadbalancer.FailoverLoadBalancerDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean", "title" : "Inherit Error Handler", "description" : "Sets whether or not to inherit the configured error handler. The default value is true. You can use this to disable using the inherited error handler for a given DSL such as a load balancer where you want to use a custom error handler strategy." }, "random" : { "$ref" : "#/items/definitions/org.apache.camel.model.loadbalancer.RandomLoadBalancerDefinition" }, "round-robin" : { "$ref" : "#/items/definitions/org.apache.camel.model.loadbalancer.RoundRobinLoadBalancerDefinition" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "sticky" : { "$ref" : "#/items/definitions/org.apache.camel.model.loadbalancer.StickyLoadBalancerDefinition" }, "topic" : { "$ref" : "#/items/definitions/org.apache.camel.model.loadbalancer.TopicLoadBalancerDefinition" }, "weighted" : { "$ref" : "#/items/definitions/org.apache.camel.model.loadbalancer.WeightedLoadBalancerDefinition" } } }, "org.apache.camel.model.LogDefinition" : { "title" : "Log", "description" : "Logs the defined message to the logger", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "log-name" : { "type" : "string", "title" : "Log Name", "description" : "Sets the name of the logger" }, "logger" : { "type" : "string", "title" : "Logger", "description" : "To refer to a custom logger instance to lookup from the registry." }, "logging-level" : { "type" : "string", "title" : "Logging Level", "description" : "Sets the logging level. The default value is INFO", "default" : "INFO", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "marker" : { "type" : "string", "title" : "Marker", "description" : "To use slf4j marker" }, "message" : { "type" : "string", "title" : "Message", "description" : "Sets the log message (uses simple language)" } } } ], "required" : [ "message" ] }, "org.apache.camel.model.LoopDefinition" : { "title" : "Loop", "description" : "Processes a message multiple times", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "break-on-shutdown" : { "type" : "boolean", "title" : "Break On Shutdown", "description" : "If the breakOnShutdown attribute is true, then the loop will not iterate until it reaches the end when Camel is shut down." }, "copy" : { "type" : "boolean", "title" : "Copy", "description" : "If the copy attribute is true, a copy of the input Exchange is used for each iteration. That means each iteration will start from a copy of the same message. By default loop will loop the same exchange all over, so each iteration may have different message content." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "do-while" : { "type" : "boolean", "title" : "Do While", "description" : "Enables the while loop that loops until the predicate evaluates to false or null." }, "expression" : { "title" : "Expression", "description" : "Expression to define how many times we should loop. Notice the expression is only evaluated once, and should return a number as how many times to loop. A value of zero or negative means no looping. The loop is like a for-loop fashion, if you want a while loop, then the dynamic router may be a better choice.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.MarshalDefinition" : { "title" : "Marshal", "description" : "Marshals data into a specified format for transmission over a transport or component", "type" : "object", "properties" : { "asn1" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ASN1DataFormat" }, "avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.AvroDataFormat" }, "barcode" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BarcodeDataFormat" }, "base64" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.Base64DataFormat" }, "bindy" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BindyDataFormat" }, "cbor" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CBORDataFormat" }, "crypto" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CryptoDataFormat" }, "csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CsvDataFormat" }, "custom" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CustomDataFormat" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "fhir-json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirJsonDataFormat" }, "fhir-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirXmlDataFormat" }, "flatpack" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FlatpackDataFormat" }, "grok" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GrokDataFormat" }, "gzip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GzipDeflaterDataFormat" }, "hl7" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.HL7DataFormat" }, "ical" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.IcalDataFormat" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "jackson-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JacksonXMLDataFormat" }, "jaxb" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JaxbDataFormat" }, "json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonDataFormat" }, "json-api" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonApiDataFormat" }, "lzf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.LZFDataFormat" }, "mime-multipart" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.MimeMultipartDataFormat" }, "parquet-avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ParquetAvroDataFormat" }, "pgp" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.PGPDataFormat" }, "protobuf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ProtobufDataFormat" }, "rss" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.RssDataFormat" }, "soap" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SoapDataFormat" }, "swift-mt" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMtDataFormat" }, "swift-mx" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMxDataFormat" }, "syslog" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SyslogDataFormat" }, "tar-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TarFileDataFormat" }, "thrift" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ThriftDataFormat" }, "tidy-markup" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TidyMarkupDataFormat" }, "univocity-csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityCsvDataFormat" }, "univocity-fixed" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityFixedDataFormat" }, "univocity-tsv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityTsvDataFormat" }, "xml-security" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.XMLSecurityDataFormat" }, "yaml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.YAMLDataFormat" }, "zip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipDeflaterDataFormat" }, "zip-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipFileDataFormat" } } }, "org.apache.camel.model.MulticastDefinition" : { "title" : "Multicast", "description" : "Routes the same message to multiple paths either sequentially or in parallel.", "type" : "object", "properties" : { "aggregation-strategy" : { "type" : "string", "title" : "Aggregation Strategy", "description" : "Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy" }, "aggregation-strategy-method-allow-null" : { "type" : "boolean", "title" : "Aggregation Strategy Method Allow Null", "description" : "If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy" }, "aggregation-strategy-method-name" : { "type" : "string", "title" : "Aggregation Strategy Method Name", "description" : "This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "Refers to a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "on-prepare" : { "type" : "string", "title" : "On Prepare", "description" : "Uses the Processor when preparing the org.apache.camel.Exchange to be send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send." }, "parallel-aggregate" : { "type" : "boolean", "title" : "Parallel Aggregate", "description" : "If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default this is false meaning that Camel synchronizes the call to the aggregate method. Though in some use-cases this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe." }, "parallel-processing" : { "type" : "boolean", "title" : "Parallel Processing", "description" : "If enabled then sending messages to the multicasts occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the multicasts which happens concurrently. When parallel processing is enabled, then the Camel routing engin will continue processing using last used thread from the parallel thread pool. However, if you want to use the original thread that called the multicast, then make sure to enable the synchronous option as well." }, "share-unit-of-work" : { "type" : "boolean", "title" : "Share Unit Of Work", "description" : "Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Multicast will by default not share unit of work between the parent exchange and each multicasted exchange. This means each sub exchange has its own individual unit of work." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "stop-on-exception" : { "type" : "boolean", "title" : "Stop On Exception", "description" : "Will now stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the multicast will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine. The default behavior is to not stop but continue processing till the end" }, "streaming" : { "type" : "boolean", "title" : "Streaming", "description" : "If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as defined by the multicast." }, "synchronous" : { "type" : "boolean", "title" : "Synchronous", "description" : "Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the multicast is complete, even if parallel processing is enabled." }, "timeout" : { "type" : "string", "title" : "Timeout", "description" : "Sets a total timeout specified in millis, when using parallel processing. If the Multicast hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Multicast breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.", "default" : "0" } } }, "org.apache.camel.model.OnCompletionDefinition" : { "title" : "On Completion", "description" : "Route to be executed when normal route processing completes", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "To use a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "mode" : { "type" : "string", "title" : "Mode", "description" : "Sets the on completion mode. The default value is AfterConsumer", "default" : "AfterConsumer", "enum" : [ "AfterConsumer", "BeforeConsumer" ] }, "on-complete-only" : { "type" : "boolean", "title" : "On Complete Only", "description" : "Will only synchronize when the org.apache.camel.Exchange completed successfully (no errors)." }, "on-failure-only" : { "type" : "boolean", "title" : "On Failure Only", "description" : "Will only synchronize when the org.apache.camel.Exchange ended with failure (exception or FAULT message)." }, "on-when" : { "title" : "On When", "description" : "Sets an additional predicate that should be true before the onCompletion is triggered. To be used for fine grained controlling whether a completion callback should be invoked or not", "$ref" : "#/items/definitions/org.apache.camel.model.WhenDefinition" }, "parallel-processing" : { "type" : "boolean", "title" : "Parallel Processing", "description" : "If enabled then the on completion process will run asynchronously by a separate thread from a thread pool. By default this is false, meaning the on completion process will run synchronously using the same caller thread as from the route." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "use-original-message" : { "type" : "boolean", "title" : "Use Original Message", "description" : "Will use the original input message body when an org.apache.camel.Exchange for this on completion. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." } } }, "org.apache.camel.model.OnExceptionDefinition" : { "title" : "On Exception", "description" : "Route to be executed when an exception is thrown", "type" : "object", "properties" : { "continued" : { "title" : "Continued", "description" : "Sets whether the exchange should handle and continue routing from the point of failure. If this option is enabled then its considered handled as well.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "exception" : { "type" : "array", "title" : "Exception", "description" : "A set of exceptions to react upon.", "items" : { "type" : "string" } }, "handled" : { "title" : "Handled", "description" : "Sets whether the exchange should be marked as handled or not.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "on-exception-occurred-ref" : { "type" : "string", "title" : "On Exception Occurred Ref", "description" : "Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened. Important: Any exception thrown from this processor will be ignored." }, "on-redelivery-ref" : { "type" : "string", "title" : "On Redelivery Ref", "description" : "Sets a reference to a processor that should be processed before a redelivery attempt. Can be used to change the org.apache.camel.Exchange before its being redelivered." }, "on-when" : { "title" : "On When", "description" : "Sets an additional predicate that should be true before the onException is triggered. To be used for fine grained controlling whether a thrown exception should be intercepted by this exception type or not.", "$ref" : "#/items/definitions/org.apache.camel.model.WhenDefinition" }, "redelivery-policy" : { "title" : "Redelivery Policy", "description" : "Used for configuring redelivery options", "$ref" : "#/items/definitions/org.apache.camel.model.RedeliveryPolicyDefinition" }, "redelivery-policy-ref" : { "type" : "string", "title" : "Redelivery Policy Ref", "description" : "Sets a reference to a redelivery policy to lookup in the org.apache.camel.spi.Registry to be used." }, "retry-while" : { "title" : "Retry While", "description" : "Sets the retry while predicate. Will continue retrying until predicate returns false.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "use-original-body" : { "type" : "boolean", "title" : "Use Original Body", "description" : "Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." }, "use-original-message" : { "type" : "boolean", "title" : "Use Original Message", "description" : "Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." } } }, "org.apache.camel.model.OnFallbackDefinition" : { "title" : "On Fallback", "description" : "Route to be executed when Circuit Breaker EIP executes fallback", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "fallback-via-network" : { "type" : "boolean", "title" : "Fallback Via Network", "description" : "Whether the fallback goes over the network. If the fallback will go over the network it is another possible point of failure. It is important to execute the fallback command on a separate thread-pool, otherwise if the main command were to become latent and fill the thread-pool this would prevent the fallback from running if the two commands share the same pool." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.OptimisticLockRetryPolicyDefinition" : { "title" : "Optimistic Lock Retry Policy", "description" : "To configure optimistic locking", "type" : "object", "properties" : { "exponential-back-off" : { "type" : "boolean", "title" : "Exponential Back Off", "description" : "Enable exponential backoff" }, "maximum-retries" : { "type" : "number", "title" : "Maximum Retries", "description" : "Sets the maximum number of retries" }, "maximum-retry-delay" : { "type" : "string", "title" : "Maximum Retry Delay", "description" : "Sets the upper value of retry in millis between retries, when using exponential or random backoff", "default" : "1000" }, "random-back-off" : { "type" : "boolean", "title" : "Random Back Off", "description" : "Enables random backoff" }, "retry-delay" : { "type" : "string", "title" : "Retry Delay", "description" : "Sets the delay in millis between retries", "default" : "50" } } }, "org.apache.camel.model.OtherwiseDefinition" : { "title" : "Otherwise", "description" : "Route to be executed when all other choices evaluate to false", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.OutputDefinition" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.OutputTypeDefinition" : { "title" : "Output Type", "description" : "Set the expected data type of the output message. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists. If validate attribute is true then camel applies Validator as well. Type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example {code java:java.lang.String} , {code json:ABCOrder} . It's also possible to specify only scheme part, so that it works like a wildcard. If only 'xml' is specified, all the XML message matches. It's handy to add only one transformer/validator for all the XML-Java transformation.", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "urn" : { "type" : "string", "title" : "Urn", "description" : "Set output type URN." }, "validate" : { "type" : "boolean", "title" : "Validate", "description" : "Whether if validation is required for this output type." } }, "required" : [ "urn" ] }, "org.apache.camel.model.PackageScanDefinition" : { "title" : "Package Scan", "description" : "Scans for Java org.apache.camel.builder.RouteBuilder classes in java packages", "type" : "object", "properties" : { "excludes" : { "type" : "array", "title" : "Excludes", "description" : "Exclude finding route builder from these java package names.", "items" : { "type" : "string" } }, "includes" : { "type" : "array", "title" : "Includes", "description" : "Include finding route builder from these java package names.", "items" : { "type" : "string" } }, "package" : { "type" : "array", "title" : "Package", "description" : "Sets the java package names to use for scanning for route builder classes", "items" : { "type" : "string" } } } }, "org.apache.camel.model.PausableDefinition" : { "title" : "Pausable", "description" : "Pausable EIP to support resuming processing from last known offset.", "type" : "object", "properties" : { "consumer-listener" : { "type" : "string", "title" : "Consumer Listener", "description" : "Sets the consumer listener to use" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "until-check" : { "type" : "string", "title" : "Until Check", "description" : "References to a java.util.function.Predicate to use for until checks. The predicate is responsible for evaluating whether the processing can resume or not. Such predicate should return true if the consumption can resume, or false otherwise. The exact point of when the predicate is called is dependent on the component, and it may be called on either one of the available events. Implementations should not assume the predicate to be called at any specific point." } }, "required" : [ "consumer-listener", "until-check" ] }, "org.apache.camel.model.PipelineDefinition" : { "title" : "Pipeline", "description" : "Routes the message to a sequence of processors.", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.PolicyDefinition" : { "title" : "Policy", "description" : "Defines a policy the route will use", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Sets a reference to use for lookup the policy in the registry." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } }, "required" : [ "ref" ] }, "org.apache.camel.model.PollEnrichDefinition" : { "title" : "Poll Enrich", "description" : "Enriches messages with data polled from a secondary resource", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "aggregate-on-exception" : { "type" : "boolean", "title" : "Aggregate On Exception", "description" : "If this option is false then the aggregate method is not used if there was an exception thrown while trying to retrieve the data to enrich from the resource. Setting this option to true allows end users to control what to do if there was an exception in the aggregate method. For example to suppress the exception or set a custom message body etc." }, "aggregation-strategy" : { "type" : "string", "title" : "Aggregation Strategy", "description" : "Sets the AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message. By default Camel will use the reply from the external service as outgoing message." }, "aggregation-strategy-method-allow-null" : { "type" : "string", "title" : "Aggregation Strategy Method Allow Null", "description" : "If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy." }, "aggregation-strategy-method-name" : { "type" : "string", "title" : "Aggregation Strategy Method Name", "description" : "This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy." }, "cache-size" : { "type" : "number", "title" : "Cache Size", "description" : "Sets the maximum size used by the org.apache.camel.spi.ConsumerCache which is used to cache and reuse consumers when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression that computes the endpoint uri to use as the resource endpoint to enrich from", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-endpoint" : { "type" : "boolean", "title" : "Ignore Invalid Endpoint", "description" : "Ignore the invalidate endpoint exception when try to create a producer with that endpoint" }, "inherit-error-handler" : { "type" : "boolean" }, "timeout" : { "type" : "string", "title" : "Timeout", "description" : "Timeout in millis when polling from the external service. The timeout has influence about the poll enrich behavior. It basically operations in three different modes: negative value - Waits until a message is available and then returns it. Warning that this method could block indefinitely if no messages are available. 0 - Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet. positive value - Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns null if timed out The default value is -1 and therefore the method could block indefinitely, and therefore its recommended to use a timeout value", "default" : "-1" } } }, "org.apache.camel.model.ProcessDefinition" : { "title" : "Process", "description" : "Calls a Camel processor", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to the Processor to lookup in the registry to use. Can also be used for creating new beans by their class name by prefixing with #class, eg #class:com.foo.MyClassType. And it is also possible to refer to singleton beans by their type in the registry by prefixing with #type: syntax, eg #type:com.foo.MyClassType" } }, "required" : [ "ref" ] }, "org.apache.camel.model.PropertyDefinition" : { "title" : "Property", "description" : "A key value pair where the value is a literal value", "type" : "object", "properties" : { "key" : { "type" : "string", "title" : "Key", "description" : "Property key" }, "value" : { "type" : "string", "title" : "Value", "description" : "Property value" } }, "required" : [ "key", "value" ] }, "org.apache.camel.model.PropertyExpressionDefinition" : { "title" : "Property Expression", "description" : "A key value pair where the value is an expression.", "type" : "object", "properties" : { "expression" : { "title" : "Expression", "description" : "Property values as an expression", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "key" : { "type" : "string", "title" : "Key", "description" : "Property key" } }, "required" : [ "key" ] }, "org.apache.camel.model.RecipientListDefinition" : { "title" : "Recipient List", "description" : "Route messages to a number of dynamically specified recipients", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "aggregation-strategy" : { "type" : "string", "title" : "Aggregation Strategy", "description" : "Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy" }, "aggregation-strategy-method-allow-null" : { "type" : "boolean", "title" : "Aggregation Strategy Method Allow Null", "description" : "If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy" }, "aggregation-strategy-method-name" : { "type" : "string", "title" : "Aggregation Strategy Method Name", "description" : "This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy." }, "cache-size" : { "type" : "number", "title" : "Cache Size", "description" : "Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers." }, "delimiter" : { "type" : "string", "title" : "Delimiter", "description" : "Delimiter used if the Expression returned multiple endpoints. Can be turned off using the value false. The default value is ,", "default" : "," }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "To use a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well." }, "expression" : { "title" : "Expression", "description" : "Expression that returns which endpoints (url) to send the message to (the recipients). If the expression return an empty value then the message is not sent to any recipients.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-endpoints" : { "type" : "boolean", "title" : "Ignore Invalid Endpoints", "description" : "Ignore the invalidate endpoint exception when try to create a producer with that endpoint" }, "inherit-error-handler" : { "type" : "boolean" }, "on-prepare" : { "type" : "string", "title" : "On Prepare", "description" : "Uses the Processor when preparing the org.apache.camel.Exchange to be used send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send." }, "parallel-aggregate" : { "type" : "boolean", "title" : "Parallel Aggregate", "description" : "If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default this is false meaning that Camel synchronizes the call to the aggregate method. Though in some use-cases this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe." }, "parallel-processing" : { "type" : "boolean", "title" : "Parallel Processing", "description" : "If enabled then sending messages to the recipients occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the recipients which happens concurrently. When parallel processing is enabled, then the Camel routing engin will continue processing using last used thread from the parallel thread pool. However, if you want to use the original thread that called the recipient list, then make sure to enable the synchronous option as well." }, "share-unit-of-work" : { "type" : "boolean", "title" : "Share Unit Of Work", "description" : "Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Recipient List will by default not share unit of work between the parent exchange and each recipient exchange. This means each sub exchange has its own individual unit of work." }, "stop-on-exception" : { "type" : "boolean", "title" : "Stop On Exception", "description" : "Will now stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the recipient list will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine. The default behavior is to not stop but continue processing till the end" }, "streaming" : { "type" : "boolean", "title" : "Streaming", "description" : "If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as defined by the recipient list." }, "synchronous" : { "type" : "boolean", "title" : "Synchronous", "description" : "Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the recipient list is complete, even if parallel processing is enabled." }, "timeout" : { "type" : "string", "title" : "Timeout", "description" : "Sets a total timeout specified in millis, when using parallel processing. If the Recipient List hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Recipient List breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.", "default" : "0" } } }, "org.apache.camel.model.RedeliveryPolicyDefinition" : { "title" : "Redelivery Policy", "description" : "To configure re-delivery for error handling", "type" : "object", "properties" : { "allow-redelivery-while-stopping" : { "type" : "boolean", "title" : "Allow Redelivery While Stopping", "description" : "Controls whether to allow redelivery while stopping/shutting down a route that uses error handling." }, "async-delayed-redelivery" : { "type" : "boolean", "title" : "Async Delayed Redelivery", "description" : "Allow asynchronous delayed redelivery. The route, in particular the consumer's component, must support the Asynchronous Routing Engine (e.g. seda)." }, "back-off-multiplier" : { "type" : "number", "title" : "Back Off Multiplier", "description" : "Sets the back off multiplier", "default" : "2.0" }, "collision-avoidance-factor" : { "type" : "number", "title" : "Collision Avoidance Factor", "description" : "Sets the collision avoidance factor", "default" : "0.15" }, "delay-pattern" : { "type" : "string", "title" : "Delay Pattern", "description" : "Sets the delay pattern with delay intervals." }, "disable-redelivery" : { "type" : "boolean", "title" : "Disable Redelivery", "description" : "Disables redelivery (same as setting maximum redeliveries to 0)" }, "exchange-formatter-ref" : { "type" : "string", "title" : "Exchange Formatter Ref", "description" : "Sets the reference of the instance of org.apache.camel.spi.ExchangeFormatter to generate the log message from exchange." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "log-continued" : { "type" : "boolean", "title" : "Log Continued", "description" : "Sets whether continued exceptions should be logged or not. Can be used to include or reduce verbose." }, "log-exhausted" : { "type" : "boolean", "title" : "Log Exhausted", "description" : "Sets whether exhausted exceptions should be logged or not. Can be used to include or reduce verbose." }, "log-exhausted-message-body" : { "type" : "boolean", "title" : "Log Exhausted Message Body", "description" : "Sets whether exhausted message body should be logged including message history or not (supports property placeholders). Can be used to include or reduce verbose. Requires logExhaustedMessageHistory to be enabled." }, "log-exhausted-message-history" : { "type" : "boolean", "title" : "Log Exhausted Message History", "description" : "Sets whether exhausted exceptions should be logged including message history or not (supports property placeholders). Can be used to include or reduce verbose." }, "log-handled" : { "type" : "boolean", "title" : "Log Handled", "description" : "Sets whether handled exceptions should be logged or not. Can be used to include or reduce verbose." }, "log-new-exception" : { "type" : "boolean", "title" : "Log New Exception", "description" : "Sets whether new exceptions should be logged or not. Can be used to include or reduce verbose. A new exception is an exception that was thrown while handling a previous exception." }, "log-retry-attempted" : { "type" : "boolean", "title" : "Log Retry Attempted", "description" : "Sets whether retry attempts should be logged or not. Can be used to include or reduce verbose." }, "log-retry-stack-trace" : { "type" : "boolean", "title" : "Log Retry Stack Trace", "description" : "Sets whether stack traces should be logged when an retry attempt failed. Can be used to include or reduce verbose." }, "log-stack-trace" : { "type" : "boolean", "title" : "Log Stack Trace", "description" : "Sets whether stack traces should be logged. Can be used to include or reduce verbose." }, "maximum-redeliveries" : { "type" : "number", "title" : "Maximum Redeliveries", "description" : "Sets the maximum redeliveries x = redeliver at most x times 0 = no redeliveries -1 = redeliver forever" }, "maximum-redelivery-delay" : { "type" : "string", "title" : "Maximum Redelivery Delay", "description" : "Sets the maximum delay between redelivery", "default" : "60000" }, "redelivery-delay" : { "type" : "string", "title" : "Redelivery Delay", "description" : "Sets the initial redelivery delay", "default" : "1000" }, "retries-exhausted-log-level" : { "type" : "string", "title" : "Retries Exhausted Log Level", "description" : "Sets the logging level to use when retries have been exhausted", "default" : "ERROR" }, "retry-attempted-log-interval" : { "type" : "number", "title" : "Retry Attempted Log Interval", "description" : "Sets the interval to use for logging retry attempts", "default" : "1" }, "retry-attempted-log-level" : { "type" : "string", "title" : "Retry Attempted Log Level", "description" : "Sets the logging level to use for logging retry attempts", "default" : "DEBUG" }, "use-collision-avoidance" : { "type" : "boolean", "title" : "Use Collision Avoidance", "description" : "Turn on collision avoidance." }, "use-exponential-back-off" : { "type" : "boolean", "title" : "Use Exponential Back Off", "description" : "Turn on exponential backk off" } } }, "org.apache.camel.model.RemoveHeaderDefinition" : { "title" : "Remove Header", "description" : "Removes a named header from the message", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "name" : { "type" : "string", "title" : "Name", "description" : "Name of header to remove" } } } ], "required" : [ "name" ] }, "org.apache.camel.model.RemoveHeadersDefinition" : { "title" : "Remove Headers", "description" : "Removes message headers whose name matches a specified pattern", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "exclude-pattern" : { "type" : "string", "title" : "Exclude Pattern", "description" : "Name or patter of headers to not remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive)." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Name or pattern of headers to remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive)." } } } ], "required" : [ "pattern" ] }, "org.apache.camel.model.RemovePropertiesDefinition" : { "title" : "Remove Properties", "description" : "Removes message exchange properties whose name matches a specified pattern", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "exclude-pattern" : { "type" : "string", "title" : "Exclude Pattern", "description" : "Name or pattern of properties to not remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive)." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Name or pattern of properties to remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive)." } } } ], "required" : [ "pattern" ] }, "org.apache.camel.model.RemovePropertyDefinition" : { "title" : "Remove Property", "description" : "Removes a named property from the message exchange", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "name" : { "type" : "string", "title" : "Name", "description" : "Name of property to remove." } } } ], "required" : [ "name" ] }, "org.apache.camel.model.ResequenceDefinition" : { "title" : "Resequence", "description" : "Resequences (re-order) messages based on an expression", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "batch-config" : { "$ref" : "#/items/definitions/org.apache.camel.model.config.BatchResequencerConfig" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to use for re-ordering the messages, such as a header with a sequence number", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "stream-config" : { "$ref" : "#/items/definitions/org.apache.camel.model.config.StreamResequencerConfig" } } }, "org.apache.camel.model.Resilience4jConfigurationDefinition" : { "title" : "Resilience4j Configuration", "description" : "Resilience4j Circuit Breaker EIP configuration", "type" : "object", "properties" : { "automatic-transition-from-open-to-half-open-enabled" : { "type" : "boolean", "title" : "Automatic Transition From Open To Half Open Enabled", "description" : "Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed." }, "bulkhead-enabled" : { "type" : "boolean", "title" : "Bulkhead Enabled", "description" : "Whether bulkhead is enabled or not on the circuit breaker. Default is false." }, "bulkhead-max-concurrent-calls" : { "type" : "number", "title" : "Bulkhead Max Concurrent Calls", "description" : "Configures the max amount of concurrent calls the bulkhead will support.", "default" : "25" }, "bulkhead-max-wait-duration" : { "type" : "number", "title" : "Bulkhead Max Wait Duration", "description" : "Configures a maximum amount of time which the calling thread will wait to enter the bulkhead. If bulkhead has space available, entry is guaranteed and immediate. If bulkhead is full, calling threads will contest for space, if it becomes available. maxWaitDuration can be set to 0. Note: for threads running on an event-loop or equivalent (rx computation pool, etc), setting maxWaitDuration to 0 is highly recommended. Blocking an event-loop thread will most likely have a negative effect on application throughput.", "default" : "0" }, "circuit-breaker" : { "type" : "string", "title" : "Circuit Breaker", "description" : "Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use." }, "config" : { "type" : "string", "title" : "Config", "description" : "Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry." }, "failure-rate-threshold" : { "type" : "number", "title" : "Failure Rate Threshold", "description" : "Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage.", "default" : "50" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "minimum-number-of-calls" : { "type" : "number", "title" : "Minimum Number Of Calls", "description" : "Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate. For example, if minimumNumberOfCalls is 10, then at least 10 calls must be recorded, before the failure rate can be calculated. If only 9 calls have been recorded the CircuitBreaker will not transition to open even if all 9 calls have failed. Default minimumNumberOfCalls is 100", "default" : "100" }, "permitted-number-of-calls-in-half-open-state" : { "type" : "number", "title" : "Permitted Number Of Calls In Half Open State", "description" : "Configures the number of permitted calls when the CircuitBreaker is half open. The size must be greater than 0. Default size is 10.", "default" : "10" }, "sliding-window-size" : { "type" : "number", "title" : "Sliding Window Size", "description" : "Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. slidingWindowSize configures the size of the sliding window. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. The slidingWindowSize must be greater than 0. The minimumNumberOfCalls must be greater than 0. If the slidingWindowType is COUNT_BASED, the minimumNumberOfCalls cannot be greater than slidingWindowSize . If the slidingWindowType is TIME_BASED, you can pick whatever you want. Default slidingWindowSize is 100.", "default" : "100" }, "sliding-window-type" : { "type" : "string", "title" : "Sliding Window Type", "description" : "Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. Default slidingWindowType is COUNT_BASED.", "default" : "COUNT_BASED", "enum" : [ "TIME_BASED", "COUNT_BASED" ] }, "slow-call-duration-threshold" : { "type" : "number", "title" : "Slow Call Duration Threshold", "description" : "Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage. Default value is 60 seconds.", "default" : "60" }, "slow-call-rate-threshold" : { "type" : "number", "title" : "Slow Call Rate Threshold", "description" : "Configures a threshold in percentage. The CircuitBreaker considers a call as slow when the call duration is greater than slowCallDurationThreshold Duration. When the percentage of slow calls is equal or greater the threshold, the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 100 percentage which means that all recorded calls must be slower than slowCallDurationThreshold.", "default" : "100" }, "throw-exception-when-half-open-or-open-state" : { "type" : "boolean", "title" : "Throw Exception When Half Open Or Open State", "description" : "Whether to throw io.github.resilience4j.circuitbreaker.CallNotPermittedException when the call is rejected due circuit breaker is half open or open." }, "timeout-cancel-running-future" : { "type" : "boolean", "title" : "Timeout Cancel Running Future", "description" : "Configures whether cancel is called on the running future. Defaults to true." }, "timeout-duration" : { "type" : "number", "title" : "Timeout Duration", "description" : "Configures the thread execution timeout. Default value is 1 second.", "default" : "1000" }, "timeout-enabled" : { "type" : "boolean", "title" : "Timeout Enabled", "description" : "Whether timeout is enabled or not on the circuit breaker. Default is false." }, "timeout-executor-service" : { "type" : "string", "title" : "Timeout Executor Service", "description" : "References to a custom thread pool to use when timeout is enabled (uses ForkJoinPool#commonPool() by default)" }, "wait-duration-in-open-state" : { "type" : "number", "title" : "Wait Duration In Open State", "description" : "Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open. Default value is 60 seconds.", "default" : "60" }, "writable-stack-trace-enabled" : { "type" : "boolean", "title" : "Writable Stack Trace Enabled", "description" : "Enables writable stack traces. When set to false, Exception.getStackTrace returns a zero length array. This may be used to reduce log spam when the circuit breaker is open as the cause of the exceptions is already known (the circuit breaker is short-circuiting calls)." } } }, "org.apache.camel.model.RestContextRefDefinition" : { "title" : "Rest Context Ref", "description" : "To refer to an XML file with rest services defined using the rest-dsl", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to the rest-dsl" } } } ], "required" : [ "ref" ] }, "org.apache.camel.model.ResumableDefinition" : { "title" : "Resumable", "description" : "Resume EIP to support resuming processing from last known offset.", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "intermittent" : { "type" : "boolean", "title" : "Intermittent", "description" : "Sets whether the offsets will be intermittently present or whether they must be present in every exchange" }, "logging-level" : { "type" : "string", "title" : "Logging Level", "default" : "ERROR", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "resume-strategy" : { "type" : "string", "title" : "Resume Strategy", "description" : "Sets the resume strategy to use" } }, "required" : [ "resume-strategy" ] }, "org.apache.camel.model.RollbackDefinition" : { "title" : "Rollback", "description" : "Forces a rollback by stopping routing the message", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "mark-rollback-only" : { "type" : "boolean", "title" : "Mark Rollback Only", "description" : "Mark the transaction for rollback only (cannot be overruled to commit)" }, "mark-rollback-only-last" : { "type" : "boolean", "title" : "Mark Rollback Only Last", "description" : "Mark only last sub transaction for rollback only. When using sub transactions (if the transaction manager support this)" }, "message" : { "type" : "string", "title" : "Message", "description" : "Message to use in rollback exception" } } } ] }, "org.apache.camel.model.RouteBuilderDefinition" : { "title" : "Route Builder", "description" : "To refer to a Java org.apache.camel.builder.RouteBuilder instance to use.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to the route builder instance" } } } ], "required" : [ "ref" ] }, "org.apache.camel.model.RouteConfigurationContextRefDefinition" : { "title" : "Route Configuration Context Ref", "description" : "To refer to an XML file with route configuration defined using the xml-dsl", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to the route templates in the xml dsl" } } } ], "required" : [ "ref" ] }, "org.apache.camel.model.RouteConfigurationDefinition" : { "type" : "object", "properties" : { "error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.model.ErrorHandlerDefinition" }, "id" : { "type" : "string" }, "intercept" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptDefinition" } }, "intercept-from" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptFromDefinition" } }, "intercept-send-to-endpoint" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.InterceptSendToEndpointDefinition" } }, "on-completion" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnCompletionDefinition" } }, "on-exception" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnExceptionDefinition" } }, "precondition" : { "type" : "string" } } }, "org.apache.camel.model.RouteContextRefDefinition" : { "title" : "Route Context Ref", "description" : "To refer to an XML file with routes defined using the xml-dsl", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to the routes in the xml dsl" } } } ], "required" : [ "ref" ] }, "org.apache.camel.model.RouteDefinition" : { "type" : "object", "properties" : { "auto-startup" : { "type" : "boolean" }, "description" : { "type" : "string" }, "from" : { "$ref" : "#/items/definitions/org.apache.camel.model.FromDefinition" }, "group" : { "type" : "string" }, "id" : { "type" : "string" }, "input-type" : { "$ref" : "#/items/definitions/org.apache.camel.model.InputTypeDefinition" }, "log-mask" : { "type" : "boolean" }, "message-history" : { "type" : "boolean" }, "node-prefix-id" : { "type" : "string" }, "output-type" : { "$ref" : "#/items/definitions/org.apache.camel.model.OutputTypeDefinition" }, "precondition" : { "type" : "string" }, "route-configuration-id" : { "type" : "string" }, "route-policy" : { "type" : "string" }, "startup-order" : { "type" : "number" }, "stream-caching" : { "type" : "boolean" }, "trace" : { "type" : "boolean" } }, "required" : [ "from" ] }, "org.apache.camel.model.RouteTemplateBeanDefinition" : { "type" : "object", "properties" : { "bean-type" : { "type" : "string" }, "name" : { "type" : "string" }, "properties" : { "type" : "object" }, "property" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "script" : { "type" : "string" }, "type" : { "type" : "string" } }, "required" : [ "name", "type" ] }, "org.apache.camel.model.RouteTemplateDefinition" : { "type" : "object", "properties" : { "beans" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteTemplateBeanDefinition" } }, "description" : { "type" : "string" }, "from" : { "$ref" : "#/items/definitions/org.apache.camel.model.FromDefinition" }, "id" : { "type" : "string" }, "parameters" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteTemplateParameterDefinition" } }, "route" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteDefinition" } }, "required" : [ "id" ] }, "org.apache.camel.model.RouteTemplateParameterDefinition" : { "title" : "Template Parameter", "description" : "A route template parameter", "type" : "object", "properties" : { "default-value" : { "type" : "string", "title" : "Default Value", "description" : "Default value of the parameter. If a default value is provided then the parameter is implied not to be required." }, "description" : { "type" : "string", "title" : "Description", "description" : "Description of the parameter" }, "name" : { "type" : "string", "title" : "Name", "description" : "The name of the parameter" }, "required" : { "type" : "boolean", "title" : "Required", "description" : "Whether the parameter is required or not. A parameter is required unless this option is set to false or a default value has been configured." } }, "required" : [ "name" ] }, "org.apache.camel.model.RoutingSlipDefinition" : { "title" : "Routing Slip", "description" : "Routes a message through a series of steps that are pre-determined (the slip)", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "cache-size" : { "type" : "number", "title" : "Cache Size", "description" : "Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this routing slip, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to define the routing slip, which defines which endpoints to route the message in a pipeline style. Notice the expression is evaluated once, if you want a more dynamic style, then the dynamic router eip is a better choice.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-endpoints" : { "type" : "boolean", "title" : "Ignore Invalid Endpoints", "description" : "Ignore the invalidate endpoint exception when try to create a producer with that endpoint" }, "inherit-error-handler" : { "type" : "boolean" }, "uri-delimiter" : { "type" : "string", "title" : "Uri Delimiter", "description" : "Sets the uri delimiter to use", "default" : "," } } } ], "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ] }, "org.apache.camel.model.SagaActionUriDefinition" : { "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "inherit-error-handler" : { "type" : "boolean" }, "parameters" : { "type" : "object" }, "uri" : { "type" : "string" } } } ], "required" : [ "uri" ] }, "org.apache.camel.model.SagaDefinition" : { "title" : "Saga", "description" : "Enables Sagas on the route", "type" : "object", "properties" : { "compensation" : { "title" : "Compensation", "description" : "The compensation endpoint URI that must be called to compensate all changes done in the route. The route corresponding to the compensation URI must perform compensation and complete without error. If errors occur during compensation, the saga service may call again the compensation URI to retry.", "$ref" : "#/items/definitions/org.apache.camel.model.SagaActionUriDefinition" }, "completion" : { "title" : "Completion", "description" : "The completion endpoint URI that will be called when the Saga is completed successfully. The route corresponding to the completion URI must perform completion tasks and terminate without error. If errors occur during completion, the saga service may call again the completion URI to retry.", "$ref" : "#/items/definitions/org.apache.camel.model.SagaActionUriDefinition" }, "completion-mode" : { "type" : "string", "title" : "Completion Mode", "description" : "Determine how the saga should be considered complete. When set to AUTO, the saga is completed when the exchange that initiates the saga is processed successfully, or compensated when it completes exceptionally. When set to MANUAL, the user must complete or compensate the saga using the saga:complete or saga:compensate endpoints.", "default" : "AUTO", "enum" : [ "AUTO", "MANUAL" ] }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "option" : { "type" : "array", "title" : "Option", "description" : "Allows to save properties of the current exchange in order to re-use them in a compensation/completion callback route. Options are usually helpful e.g. to store and retrieve identifiers of objects that should be deleted in compensating actions. Option values will be transformed into input headers of the compensation/completion exchange.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyExpressionDefinition" } }, "propagation" : { "type" : "string", "title" : "Propagation", "description" : "Set the Saga propagation mode (REQUIRED, REQUIRES_NEW, MANDATORY, SUPPORTS, NOT_SUPPORTED, NEVER).", "default" : "REQUIRED", "enum" : [ "REQUIRED", "REQUIRES_NEW", "MANDATORY", "SUPPORTS", "NOT_SUPPORTED", "NEVER" ] }, "saga-service" : { "type" : "string", "title" : "Saga Service", "description" : "Refers to the id to lookup in the registry for the specific CamelSagaService to use." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "timeout" : { "type" : "string", "title" : "Timeout", "description" : "Set the maximum amount of time for the Saga. After the timeout is expired, the saga will be compensated automatically (unless a different decision has been taken in the meantime)." } } }, "org.apache.camel.model.SamplingDefinition" : { "title" : "Sample", "description" : "Extract a sample of the messages passing through a route", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "message-frequency" : { "type" : "number", "title" : "Message Frequency", "description" : "Sets the sample message count which only a single Exchange will pass through after this many received." }, "sample-period" : { "type" : "string", "title" : "Sample Period", "description" : "Sets the sample period during which only a single Exchange will pass through.", "default" : "1000" } } } ] }, "org.apache.camel.model.ScriptDefinition" : { "title" : "Script", "description" : "Executes a script from a language which does not change the message body.", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to return the transformed message body (the new message body to use)", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" } } }, "org.apache.camel.model.SetBodyDefinition" : { "title" : "Set Body", "description" : "Sets the contents of the message body", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression that returns the new body to use", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" } } }, "org.apache.camel.model.SetExchangePatternDefinition" : { "title" : "Set Exchange Pattern", "description" : "Sets the exchange pattern on the message exchange", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Sets the new exchange pattern of the Exchange to be used from this point forward", "enum" : [ "InOnly", "InOut" ] } } } ] }, "org.apache.camel.model.SetHeaderDefinition" : { "title" : "Set Header", "description" : "Sets the value of a message header", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to return the value of the header", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "name" : { "type" : "string", "title" : "Name", "description" : "Name of message header to set a new value The simple language can be used to define a dynamic evaluated header name to be used. Otherwise a constant name will be used." } }, "required" : [ "name" ] }, "org.apache.camel.model.SetPropertyDefinition" : { "title" : "Set Property", "description" : "Sets a named property on the message exchange", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to return the value of the message exchange property", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "name" : { "type" : "string", "title" : "Name", "description" : "Name of exchange property to set a new value. The simple language can be used to define a dynamic evaluated exchange property name to be used. Otherwise a constant name will be used." } }, "required" : [ "name" ] }, "org.apache.camel.model.SortDefinition" : { "title" : "Sort", "description" : "Sorts the contents of the message", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "comparator" : { "type" : "string", "title" : "Comparator", "description" : "Sets the comparator to use for sorting" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Optional expression to sort by something else than the message body", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" } } }, "org.apache.camel.model.SplitDefinition" : { "title" : "Split", "description" : "Splits a single message into many sub-messages.", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "aggregation-strategy" : { "type" : "string", "title" : "Aggregation Strategy", "description" : "Sets a reference to the AggregationStrategy to be used to assemble the replies from the split messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy" }, "aggregation-strategy-method-allow-null" : { "type" : "boolean", "title" : "Aggregation Strategy Method Allow Null", "description" : "If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy" }, "aggregation-strategy-method-name" : { "type" : "string", "title" : "Aggregation Strategy Method Name", "description" : "This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy." }, "delimiter" : { "type" : "string", "title" : "Delimiter", "description" : "Delimiter used in splitting messages. Can be turned off using the value false. The default value is ,", "default" : "," }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "To use a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatically implied, and you do not have to enable that option as well." }, "expression" : { "title" : "Expression", "description" : "Expression of how to split the message body, such as as-is, using a tokenizer, or using a xpath.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "on-prepare" : { "type" : "string", "title" : "On Prepare", "description" : "Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent." }, "parallel-aggregate" : { "type" : "boolean", "title" : "Parallel Aggregate", "description" : "If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default this is false meaning that Camel synchronizes the call to the aggregate method. Though in some use-cases this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe." }, "parallel-processing" : { "type" : "boolean", "title" : "Parallel Processing", "description" : "If enabled then processing each split messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. It's only processing the sub messages from the splitter which happens concurrently. When parallel processing is enabled, then the Camel routing engin will continue processing using last used thread from the parallel thread pool. However, if you want to use the original thread that called the splitter, then make sure to enable the synchronous option as well." }, "share-unit-of-work" : { "type" : "boolean", "title" : "Share Unit Of Work", "description" : "Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Splitter will by default not share unit of work between the parent exchange and each split exchange. This means each split exchange has its own individual unit of work." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } }, "stop-on-exception" : { "type" : "boolean", "title" : "Stop On Exception", "description" : "Will now stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the splitter will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine. The default behavior is to not stop but continue processing till the end" }, "streaming" : { "type" : "boolean", "title" : "Streaming", "description" : "When in streaming mode, then the splitter splits the original message on-demand, and each split message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the org.apache.camel.Exchange#SPLIT_SIZE is empty. In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the split messages in memory and therefore requires more memory. The total size is provided in the org.apache.camel.Exchange#SPLIT_SIZE header. The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, e.g. in the order they come back. If disabled, Camel will process replies in the same order as the messages was split." }, "synchronous" : { "type" : "boolean", "title" : "Synchronous", "description" : "Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the split is complete, even if parallel processing is enabled." }, "timeout" : { "type" : "string", "title" : "Timeout", "description" : "Sets a total timeout specified in millis, when using parallel processing. If the Splitter hasn't been able to split and process all the sub messages within the given timeframe, then the timeout triggers and the Splitter breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.", "default" : "0" } } }, "org.apache.camel.model.StepDefinition" : { "title" : "Step", "description" : "Routes the message to a sequence of processors which is grouped together as one logical name", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.StopDefinition" : { "title" : "Stop", "description" : "Stops the processing of the current message", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" } } }, "org.apache.camel.model.TemplatedRouteBeanDefinition" : { "type" : "object", "properties" : { "bean-type" : { "type" : "string" }, "name" : { "type" : "string" }, "properties" : { "type" : "object" }, "property" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "script" : { "type" : "string" }, "type" : { "type" : "string" } }, "required" : [ "name", "type" ] }, "org.apache.camel.model.TemplatedRouteDefinition" : { "type" : "object", "properties" : { "beans" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.TemplatedRouteBeanDefinition" } }, "parameters" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.TemplatedRouteParameterDefinition" } }, "prefix-id" : { "type" : "string" }, "route-id" : { "type" : "string" }, "route-template-ref" : { "type" : "string" } }, "required" : [ "route-template-ref" ] }, "org.apache.camel.model.TemplatedRouteParameterDefinition" : { "title" : "Templated Route Parameter", "description" : "An input parameter of a route template.", "type" : "object", "properties" : { "name" : { "type" : "string", "title" : "Name", "description" : "The name of the parameter" }, "value" : { "type" : "string", "title" : "Value", "description" : "The value of the parameter." } }, "required" : [ "name", "value" ] }, "org.apache.camel.model.ThreadPoolProfileDefinition" : { "title" : "Thread Pool Profile", "description" : "To configure thread pools", "type" : "object", "properties" : { "allow-core-thread-time-out" : { "type" : "boolean", "title" : "Allow Core Thread Time Out", "description" : "Whether idle core threads is allowed to timeout and therefore can shrink the pool size below the core pool size Is by default true" }, "default-profile" : { "type" : "boolean", "title" : "Default Profile", "description" : "Whether this profile is the default thread pool profile" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "keep-alive-time" : { "type" : "number", "title" : "Keep Alive Time", "description" : "Sets the keep alive time for idle threads in the pool" }, "max-pool-size" : { "type" : "number", "title" : "Max Pool Size", "description" : "Sets the maximum pool size" }, "max-queue-size" : { "type" : "number", "title" : "Max Queue Size", "description" : "Sets the maximum number of tasks in the work queue. Use -1 or Integer.MAX_VALUE for an unbounded queue" }, "pool-size" : { "type" : "number", "title" : "Pool Size", "description" : "Sets the core pool size" }, "rejected-policy" : { "type" : "string", "title" : "Rejected Policy", "description" : "Sets the handler for tasks which cannot be executed by the thread pool.", "enum" : [ "Abort", "CallerRuns" ] }, "time-unit" : { "type" : "string", "title" : "Time Unit", "description" : "Sets the time unit to use for keep alive time By default SECONDS is used.", "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "org.apache.camel.model.ThreadsDefinition" : { "title" : "Threads", "description" : "Specifies that all steps after this node are processed asynchronously", "type" : "object", "properties" : { "allow-core-thread-time-out" : { "type" : "boolean", "title" : "Allow Core Thread Time Out", "description" : "Whether idle core threads are allowed to timeout and therefore can shrink the pool size below the core pool size Is by default false" }, "caller-runs-when-rejected" : { "type" : "string", "title" : "Caller Runs When Rejected", "description" : "Whether or not to use as caller runs as fallback when a task is rejected being added to the thread pool (when its full). This is only used as fallback if no rejectedPolicy has been configured, or the thread pool has no configured rejection handler. Is by default true", "default" : "true" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "To use a custom thread pool" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "keep-alive-time" : { "type" : "number", "title" : "Keep Alive Time", "description" : "Sets the keep alive time for idle threads" }, "max-pool-size" : { "type" : "number", "title" : "Max Pool Size", "description" : "Sets the maximum pool size" }, "max-queue-size" : { "type" : "number", "title" : "Max Queue Size", "description" : "Sets the maximum number of tasks in the work queue. Use -1 or Integer.MAX_VALUE for an unbounded queue" }, "pool-size" : { "type" : "number", "title" : "Pool Size", "description" : "Sets the core pool size" }, "rejected-policy" : { "type" : "string", "title" : "Rejected Policy", "description" : "Sets the handler for tasks which cannot be executed by the thread pool.", "enum" : [ "Abort", "CallerRuns" ] }, "thread-name" : { "type" : "string", "title" : "Thread Name", "description" : "Sets the thread name to use.", "default" : "Threads" }, "time-unit" : { "type" : "string", "title" : "Time Unit", "description" : "Sets the keep alive time unit. By default SECONDS is used.", "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "org.apache.camel.model.ThrottleDefinition" : { "title" : "Throttle", "description" : "Controls the rate at which messages are passed to the next node in the route", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "async-delayed" : { "type" : "boolean", "title" : "Async Delayed", "description" : "Enables asynchronous delay which means the thread will not block while delaying." }, "caller-runs-when-rejected" : { "type" : "boolean", "title" : "Caller Runs When Rejected", "description" : "Whether or not the caller should run the task when it was rejected by the thread pool. Is by default true" }, "correlation-expression" : { "title" : "Correlation Expression", "description" : "The expression used to calculate the correlation key to use for throttle grouping. The Exchange which has the same correlation key is throttled together.", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "To use a custom thread pool (ScheduledExecutorService) by the throttler." }, "expression" : { "title" : "Expression", "description" : "Expression to configure the maximum number of messages to throttle per request", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "reject-execution" : { "type" : "boolean", "title" : "Reject Execution", "description" : "Whether or not throttler throws the ThrottlerRejectedExecutionException when the exchange exceeds the request limit Is by default false" }, "time-period-millis" : { "type" : "string", "title" : "Time Period Millis", "description" : "Sets the time period during which the maximum request count is valid for", "default" : "1000" } } }, "org.apache.camel.model.ThrowExceptionDefinition" : { "title" : "Throw Exception", "description" : "Throws an exception", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "exception-type" : { "type" : "string", "title" : "Exception Type", "description" : "The class of the exception to create using the message." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "message" : { "type" : "string", "title" : "Message", "description" : "To create a new exception instance and use the given message as caused message (supports simple language)" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to the exception instance to lookup from the registry to throw" } } }, "org.apache.camel.model.ToDefinition" : { "title" : "To", "description" : "Sends the message to a static endpoint", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "parameters" : { "type" : "object" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Sets the optional ExchangePattern used to invoke this endpoint", "enum" : [ "InOnly", "InOut" ] }, "uri" : { "type" : "string", "title" : "Uri", "description" : "Sets the uri of the endpoint to send to." } } } ], "required" : [ "uri" ] }, "org.apache.camel.model.ToDynamicDefinition" : { "title" : "To D", "description" : "Sends the message to a dynamic endpoint", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "allow-optimised-components" : { "type" : "boolean", "title" : "Allow Optimised Components", "description" : "Whether to allow components to optimise toD if they are org.apache.camel.spi.SendDynamicAware ." }, "auto-start-components" : { "type" : "boolean", "title" : "Auto Start Components", "description" : "Whether to auto startup components when toD is starting up." }, "cache-size" : { "type" : "number", "title" : "Cache Size", "description" : "Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-endpoint" : { "type" : "boolean", "title" : "Ignore Invalid Endpoint", "description" : "Whether to ignore invalid endpoint URIs and skip sending the message." }, "inherit-error-handler" : { "type" : "boolean" }, "parameters" : { "type" : "object" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Sets the optional ExchangePattern used to invoke this endpoint", "enum" : [ "InOnly", "InOut" ] }, "uri" : { "type" : "string", "title" : "Uri", "description" : "The uri of the endpoint to send to. The uri can be dynamic computed using the org.apache.camel.language.simple.SimpleLanguage expression." } } } ], "required" : [ "uri" ] }, "org.apache.camel.model.TransactedDefinition" : { "title" : "Transacted", "description" : "Enables transaction on the route", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Sets a reference to use for lookup the policy in the registry." }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.TransformDefinition" : { "title" : "Transform", "description" : "Transforms the message body based on an expression", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to return the transformed message body (the new message body to use)", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "from-type" : { "type" : "string", "title" : "From Type", "description" : "From type used in data type transformation." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "to-type" : { "type" : "string", "title" : "To Type", "description" : "To type used as a target data type in the transformation." } } }, "org.apache.camel.model.TryDefinition" : { "title" : "Do Try", "description" : "Marks the beginning of a try, catch, finally block", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "do-catch" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.CatchDefinition" } }, "do-finally" : { "$ref" : "#/items/definitions/org.apache.camel.model.FinallyDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.UnmarshalDefinition" : { "title" : "Unmarshal", "description" : "Converts the message data received from the wire into a format that Apache Camel processors can consume", "type" : "object", "properties" : { "allow-null-body" : { "type" : "boolean", "title" : "Allow Null Body", "description" : "Indicates whether null is allowed as value of a body to unmarshall." }, "asn1" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ASN1DataFormat" }, "avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.AvroDataFormat" }, "barcode" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BarcodeDataFormat" }, "base64" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.Base64DataFormat" }, "bindy" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BindyDataFormat" }, "cbor" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CBORDataFormat" }, "crypto" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CryptoDataFormat" }, "csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CsvDataFormat" }, "custom" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CustomDataFormat" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "fhir-json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirJsonDataFormat" }, "fhir-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirXmlDataFormat" }, "flatpack" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FlatpackDataFormat" }, "grok" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GrokDataFormat" }, "gzip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GzipDeflaterDataFormat" }, "hl7" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.HL7DataFormat" }, "ical" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.IcalDataFormat" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "jackson-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JacksonXMLDataFormat" }, "jaxb" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JaxbDataFormat" }, "json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonDataFormat" }, "json-api" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonApiDataFormat" }, "lzf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.LZFDataFormat" }, "mime-multipart" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.MimeMultipartDataFormat" }, "parquet-avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ParquetAvroDataFormat" }, "pgp" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.PGPDataFormat" }, "protobuf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ProtobufDataFormat" }, "rss" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.RssDataFormat" }, "soap" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SoapDataFormat" }, "swift-mt" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMtDataFormat" }, "swift-mx" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMxDataFormat" }, "syslog" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SyslogDataFormat" }, "tar-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TarFileDataFormat" }, "thrift" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ThriftDataFormat" }, "tidy-markup" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TidyMarkupDataFormat" }, "univocity-csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityCsvDataFormat" }, "univocity-fixed" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityFixedDataFormat" }, "univocity-tsv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityTsvDataFormat" }, "xml-security" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.XMLSecurityDataFormat" }, "yaml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.YAMLDataFormat" }, "zip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipDeflaterDataFormat" }, "zip-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipFileDataFormat" } } }, "org.apache.camel.model.ValidateDefinition" : { "title" : "Validate", "description" : "Validates a message based on an expression", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression to use for validation as a predicate. The expression should return either true or false. If returning false the message is invalid and an exception is thrown.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "predicate-exception-factory" : { "type" : "string", "title" : "Predicate Exception Factory", "description" : "The bean id of custom PredicateExceptionFactory to use for creating the exception when the validation fails. By default, Camel will throw PredicateValidationException. By using a custom factory you can control which exception to throw instead." } } }, "org.apache.camel.model.ValueDefinition" : { "title" : "Value", "description" : "A single value", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "value" : { "type" : "string", "title" : "Value", "description" : "Property value" } } } ] }, "org.apache.camel.model.WhenDefinition" : { "title" : "When", "description" : "Triggers a route when the expression evaluates to true", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression used as the predicate to evaluate whether this when should trigger and route the message or not.", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.WhenSkipSendToEndpointDefinition" : { "title" : "When Skip Send To Endpoint", "description" : "Predicate to determine if the message should be sent or not to the endpoint, when using interceptSentToEndpoint.", "type" : "object", "anyOf" : [ { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" } ], "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "expression" : { "title" : "Expression", "description" : "Expression used as the predicate to evaluate whether the message should be sent or not to the endpoint", "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ProcessorDefinition" } } } }, "org.apache.camel.model.WireTapDefinition" : { "title" : "Wire Tap", "description" : "Routes a copy of a message (or creates a new message) to a secondary destination while continue routing the original message.", "type" : "object", "properties" : { "allow-optimised-components" : { "type" : "boolean", "title" : "Allow Optimised Components", "description" : "Whether to allow components to optimise toD if they are org.apache.camel.spi.SendDynamicAware ." }, "auto-start-components" : { "type" : "boolean", "title" : "Auto Start Components", "description" : "Whether to auto startup components when toD is starting up." }, "cache-size" : { "type" : "number", "title" : "Cache Size", "description" : "Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers." }, "copy" : { "type" : "boolean", "title" : "Copy", "description" : "Uses a copy of the original exchange" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "dynamic-uri" : { "type" : "boolean", "title" : "Dynamic Uri", "description" : "Whether the uri is dynamic or static. If the uri is dynamic then the simple language is used to evaluate a dynamic uri to use as the wire-tap destination, for each incoming message. This works similar to how the toD EIP pattern works. If static then the uri is used as-is as the wire-tap destination." }, "executor-service" : { "type" : "string", "title" : "Executor Service", "description" : "Uses a custom thread pool" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "ignore-invalid-endpoint" : { "type" : "boolean", "title" : "Ignore Invalid Endpoint", "description" : "Whether to ignore invalid endpoint URIs and skip sending the message." }, "inherit-error-handler" : { "type" : "boolean" }, "on-prepare" : { "type" : "string", "title" : "On Prepare", "description" : "Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent." }, "parameters" : { "type" : "object" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Sets the optional ExchangePattern used to invoke this endpoint", "enum" : [ "InOnly", "InOut" ] }, "uri" : { "type" : "string", "title" : "Uri", "description" : "The uri of the endpoint to send to. The uri can be dynamic computed using the org.apache.camel.language.simple.SimpleLanguage expression." } }, "required" : [ "uri" ] }, "org.apache.camel.model.app.ApplicationDefinition" : { "title" : "Camel", "description" : "If beans reminds Spring application too much, we can use camel.", "type" : "object", "properties" : { "bean" : { "type" : "array", "title" : "Bean", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.app.RegistryBeanDefinition" } }, "component-scan" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.app.ComponentScanDefinition" } }, "rest" : { "type" : "array", "title" : "Rest", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestDefinition" } }, "rest-configuration" : { "type" : "array", "title" : "Rest Configuration", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestConfigurationDefinition" } }, "route" : { "type" : "array", "title" : "Route", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteDefinition" } }, "route-configuration" : { "type" : "array", "title" : "Route Configuration", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteConfigurationDefinition" } }, "route-template" : { "type" : "array", "title" : "Route Template", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteTemplateDefinition" } }, "templated-route" : { "type" : "array", "title" : "Templated Route", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.TemplatedRouteDefinition" } } } }, "org.apache.camel.model.app.BeanPropertiesDefinition" : { "type" : "object", "properties" : { "property" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.app.BeanPropertyDefinition" } } } }, "org.apache.camel.model.app.BeanPropertyDefinition" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "properties" : { "$ref" : "#/items/definitions/org.apache.camel.model.app.BeanPropertiesDefinition" }, "value" : { "type" : "string" } } }, "org.apache.camel.model.app.BeansDefinition" : { "title" : "Beans", "description" : "A grouping POJO (and related XML root element) that's historically associated with entire application (or its distinguished fragment). This class is not meant to be used with Camel Java DSL, but it's needed to generate XML Schema and MX parser methods.", "type" : "object", "properties" : { "bean" : { "type" : "array", "title" : "Bean", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.app.RegistryBeanDefinition" } }, "component-scan" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.app.ComponentScanDefinition" } }, "rest" : { "type" : "array", "title" : "Rest", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestDefinition" } }, "rest-configuration" : { "type" : "array", "title" : "Rest Configuration", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestConfigurationDefinition" } }, "route" : { "type" : "array", "title" : "Route", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteDefinition" } }, "route-configuration" : { "type" : "array", "title" : "Route Configuration", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteConfigurationDefinition" } }, "route-template" : { "type" : "array", "title" : "Route Template", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteTemplateDefinition" } }, "templated-route" : { "type" : "array", "title" : "Templated Route", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.TemplatedRouteDefinition" } } } }, "org.apache.camel.model.app.ComponentScanDefinition" : { "type" : "object", "properties" : { "base-package" : { "type" : "string" } } }, "org.apache.camel.model.app.RegistryBeanDefinition" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "properties" : { "type" : "object" }, "type" : { "type" : "string" } } }, "org.apache.camel.model.cloud.BlacklistServiceCallServiceFilterConfiguration" : { "title" : "Blacklist Service Filter", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "servers" : { "type" : "array", "title" : "Servers", "description" : "Sets the server blacklist. Each entry can be a list of servers separated by comma in the format: servicehost:port,servicehost2:port,servicehost3:port", "items" : { "type" : "string" } } } }, "org.apache.camel.model.cloud.CachingServiceCallServiceDiscoveryConfiguration" : { "title" : "Caching Service Discovery", "deprecated" : true, "type" : "object", "properties" : { "combined-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CombinedServiceCallServiceDiscoveryConfiguration" }, "consul-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ConsulServiceCallServiceDiscoveryConfiguration" }, "dns-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.DnsServiceCallServiceDiscoveryConfiguration" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "kubernetes-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.KubernetesServiceCallServiceDiscoveryConfiguration" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "static-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.StaticServiceCallServiceDiscoveryConfiguration" }, "timeout" : { "type" : "number", "title" : "Timeout", "description" : "Set the time the services will be retained.", "default" : "60" }, "units" : { "type" : "string", "title" : "Units", "description" : "Set the time unit for the timeout.", "default" : "SECONDS", "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "org.apache.camel.model.cloud.CombinedServiceCallServiceDiscoveryConfiguration" : { "title" : "Combined Service Discovery", "deprecated" : true, "type" : "object", "properties" : { "caching-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CachingServiceCallServiceDiscoveryConfiguration" }, "consul-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ConsulServiceCallServiceDiscoveryConfiguration" }, "dns-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.DnsServiceCallServiceDiscoveryConfiguration" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "kubernetes-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.KubernetesServiceCallServiceDiscoveryConfiguration" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "static-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.StaticServiceCallServiceDiscoveryConfiguration" } } }, "org.apache.camel.model.cloud.CombinedServiceCallServiceFilterConfiguration" : { "title" : "Combined Service Filter", "deprecated" : true, "type" : "object", "properties" : { "blacklist-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.BlacklistServiceCallServiceFilterConfiguration" }, "custom-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CustomServiceCallServiceFilterConfiguration" }, "healthy-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.HealthyServiceCallServiceFilterConfiguration" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "pass-through-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.PassThroughServiceCallServiceFilterConfiguration" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.ConsulServiceCallServiceDiscoveryConfiguration" : { "title" : "Consul Service Discovery", "deprecated" : true, "type" : "object", "properties" : { "acl-token" : { "type" : "string", "title" : "Acl Token", "description" : "Sets the ACL token to be used with Consul" }, "block-seconds" : { "type" : "number", "title" : "Block Seconds", "description" : "The seconds to wait for a watch event, default 10 seconds", "default" : "10" }, "connect-timeout-millis" : { "type" : "number", "title" : "Connect Timeout Millis", "description" : "Connect timeout for OkHttpClient" }, "datacenter" : { "type" : "string", "title" : "Datacenter", "description" : "The data center" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "password" : { "type" : "string", "title" : "Password", "description" : "Sets the password to be used for basic authentication" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "read-timeout-millis" : { "type" : "number", "title" : "Read Timeout Millis", "description" : "Read timeout for OkHttpClient" }, "url" : { "type" : "string", "title" : "Url", "description" : "The Consul agent URL" }, "user-name" : { "type" : "string", "title" : "User Name", "description" : "Sets the username to be used for basic authentication" }, "write-timeout-millis" : { "type" : "number", "title" : "Write Timeout Millis", "description" : "Write timeout for OkHttpClient" } } }, "org.apache.camel.model.cloud.CustomServiceCallServiceFilterConfiguration" : { "title" : "Custom Service Filter", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference of a ServiceFilter" } } }, "org.apache.camel.model.cloud.DefaultServiceCallServiceLoadBalancerConfiguration" : { "title" : "Default Load Balancer", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.DnsServiceCallServiceDiscoveryConfiguration" : { "title" : "Dns Service Discovery", "deprecated" : true, "type" : "object", "properties" : { "domain" : { "type" : "string", "title" : "Domain", "description" : "The domain name;" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "proto" : { "type" : "string", "title" : "Proto", "description" : "The transport protocol of the desired service.", "default" : "_tcp" } } }, "org.apache.camel.model.cloud.HealthyServiceCallServiceFilterConfiguration" : { "title" : "Healthy Service Filter", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.KubernetesServiceCallServiceDiscoveryConfiguration" : { "title" : "Kubernetes Service Discovery", "deprecated" : true, "type" : "object", "properties" : { "api-version" : { "type" : "string", "title" : "Api Version", "description" : "Sets the API version when using client lookup" }, "ca-cert-data" : { "type" : "string", "title" : "Ca Cert Data", "description" : "Sets the Certificate Authority data when using client lookup" }, "ca-cert-file" : { "type" : "string", "title" : "Ca Cert File", "description" : "Sets the Certificate Authority data that are loaded from the file when using client lookup" }, "client-cert-data" : { "type" : "string", "title" : "Client Cert Data", "description" : "Sets the Client Certificate data when using client lookup" }, "client-cert-file" : { "type" : "string", "title" : "Client Cert File", "description" : "Sets the Client Certificate data that are loaded from the file when using client lookup" }, "client-key-algo" : { "type" : "string", "title" : "Client Key Algo", "description" : "Sets the Client Keystore algorithm, such as RSA when using client lookup" }, "client-key-data" : { "type" : "string", "title" : "Client Key Data", "description" : "Sets the Client Keystore data when using client lookup" }, "client-key-file" : { "type" : "string", "title" : "Client Key File", "description" : "Sets the Client Keystore data that are loaded from the file when using client lookup" }, "client-key-passphrase" : { "type" : "string", "title" : "Client Key Passphrase", "description" : "Sets the Client Keystore passphrase when using client lookup" }, "dns-domain" : { "type" : "string", "title" : "Dns Domain", "description" : "Sets the DNS domain to use for DNS lookup." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "lookup" : { "type" : "string", "title" : "Lookup", "description" : "How to perform service lookup. Possible values: client, dns, environment. When using client, then the client queries the kubernetes master to obtain a list of active pods that provides the service, and then random (or round robin) select a pod. When using dns the service name is resolved as name.namespace.svc.dnsDomain. When using dnssrv the service name is resolved with SRV query for _._...svc... When using environment then environment variables are used to lookup the service. By default environment is used.", "default" : "environment", "enum" : [ "environment", "dns", "client" ] }, "master-url" : { "type" : "string", "title" : "Master Url", "description" : "Sets the URL to the master when using client lookup" }, "namespace" : { "type" : "string", "title" : "Namespace", "description" : "Sets the namespace to use. Will by default use namespace from the ENV variable KUBERNETES_MASTER." }, "oauth-token" : { "type" : "string", "title" : "Oauth Token", "description" : "Sets the OAUTH token for authentication (instead of username/password) when using client lookup" }, "password" : { "type" : "string", "title" : "Password", "description" : "Sets the password for authentication when using client lookup" }, "port-name" : { "type" : "string", "title" : "Port Name", "description" : "Sets the Port Name to use for DNS/DNSSRV lookup." }, "port-protocol" : { "type" : "string", "title" : "Port Protocol", "description" : "Sets the Port Protocol to use for DNS/DNSSRV lookup." }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "trust-certs" : { "type" : "boolean", "title" : "Trust Certs", "description" : "Sets whether to turn on trust certificate check when using client lookup" }, "username" : { "type" : "string", "title" : "Username", "description" : "Sets the username for authentication when using client lookup" } } }, "org.apache.camel.model.cloud.PassThroughServiceCallServiceFilterConfiguration" : { "title" : "Pass Through Service Filter", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.ServiceCallConfigurationDefinition" : { "title" : "Service Call Configuration", "description" : "Remote service call configuration", "deprecated" : true, "type" : "object", "properties" : { "blacklist-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.BlacklistServiceCallServiceFilterConfiguration" }, "caching-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CachingServiceCallServiceDiscoveryConfiguration" }, "combined-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CombinedServiceCallServiceDiscoveryConfiguration" }, "combined-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CombinedServiceCallServiceFilterConfiguration" }, "component" : { "type" : "string", "title" : "Component", "description" : "The component to use.", "default" : "http" }, "consul-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ConsulServiceCallServiceDiscoveryConfiguration" }, "custom-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CustomServiceCallServiceFilterConfiguration" }, "default-load-balancer" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.DefaultServiceCallServiceLoadBalancerConfiguration" }, "dns-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.DnsServiceCallServiceDiscoveryConfiguration" }, "expression" : { "title" : "Expression", "description" : "Configures the Expression using the given configuration.", "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ServiceCallExpressionConfiguration" }, "expression-ref" : { "type" : "string", "title" : "Expression Ref", "description" : "Set a reference to a custom Expression to use." }, "healthy-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.HealthyServiceCallServiceFilterConfiguration" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "kubernetes-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.KubernetesServiceCallServiceDiscoveryConfiguration" }, "load-balancer-ref" : { "type" : "string", "title" : "Load Balancer Ref", "description" : "Sets a reference to a custom ServiceLoadBalancer to use." }, "pass-through-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.PassThroughServiceCallServiceFilterConfiguration" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Sets the optional ExchangePattern used to invoke this endpoint", "enum" : [ "InOnly", "InOut" ] }, "service-chooser-ref" : { "type" : "string", "title" : "Service Chooser Ref", "description" : "Sets a reference to a custom ServiceChooser to use." }, "service-discovery-ref" : { "type" : "string", "title" : "Service Discovery Ref", "description" : "Sets a reference to a custom ServiceDiscovery to use." }, "service-filter-ref" : { "type" : "string", "title" : "Service Filter Ref", "description" : "Sets a reference to a custom ServiceFilter to use." }, "static-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.StaticServiceCallServiceDiscoveryConfiguration" }, "uri" : { "type" : "string", "title" : "Uri", "description" : "The uri of the endpoint to send to. The uri can be dynamic computed using the simple language expression." }, "zookeeper-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ZooKeeperServiceCallServiceDiscoveryConfiguration" } } }, "org.apache.camel.model.cloud.ServiceCallDefinition" : { "title" : "Service Call", "description" : "To call remote services", "deprecated" : true, "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "blacklist-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.BlacklistServiceCallServiceFilterConfiguration" }, "caching-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CachingServiceCallServiceDiscoveryConfiguration" }, "combined-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CombinedServiceCallServiceDiscoveryConfiguration" }, "combined-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CombinedServiceCallServiceFilterConfiguration" }, "component" : { "type" : "string", "title" : "Component", "description" : "The component to use.", "default" : "http" }, "configuration-ref" : { "type" : "string", "title" : "Configuration Ref", "description" : "Refers to a ServiceCall configuration to use" }, "consul-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ConsulServiceCallServiceDiscoveryConfiguration" }, "custom-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.CustomServiceCallServiceFilterConfiguration" }, "default-load-balancer" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.DefaultServiceCallServiceLoadBalancerConfiguration" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime." }, "dns-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.DnsServiceCallServiceDiscoveryConfiguration" }, "expression" : { "title" : "Expression", "description" : "Configures the Expression using the given configuration.", "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ServiceCallExpressionConfiguration" }, "expression-ref" : { "type" : "string", "title" : "Expression Ref", "description" : "Set a reference to a custom Expression to use." }, "healthy-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.HealthyServiceCallServiceFilterConfiguration" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "inherit-error-handler" : { "type" : "boolean" }, "kubernetes-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.KubernetesServiceCallServiceDiscoveryConfiguration" }, "load-balancer-ref" : { "type" : "string", "title" : "Load Balancer Ref", "description" : "Sets a reference to a custom ServiceLoadBalancer to use." }, "name" : { "type" : "string", "title" : "Name", "description" : "Sets the name of the service to use" }, "pass-through-service-filter" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.PassThroughServiceCallServiceFilterConfiguration" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "Sets the optional ExchangePattern used to invoke this endpoint", "enum" : [ "InOnly", "InOut" ] }, "service-chooser-ref" : { "type" : "string", "title" : "Service Chooser Ref", "description" : "Sets a reference to a custom ServiceChooser to use." }, "service-discovery-ref" : { "type" : "string", "title" : "Service Discovery Ref", "description" : "Sets a reference to a custom ServiceDiscovery to use." }, "service-filter-ref" : { "type" : "string", "title" : "Service Filter Ref", "description" : "Sets a reference to a custom ServiceFilter to use." }, "static-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.StaticServiceCallServiceDiscoveryConfiguration" }, "uri" : { "type" : "string", "title" : "Uri", "description" : "The uri of the endpoint to send to. The uri can be dynamic computed using the org.apache.camel.language.simple.SimpleLanguage expression." }, "zookeeper-service-discovery" : { "$ref" : "#/items/definitions/org.apache.camel.model.cloud.ZooKeeperServiceCallServiceDiscoveryConfiguration" } } } ], "required" : [ "name" ] }, "org.apache.camel.model.cloud.ServiceCallExpressionConfiguration" : { "title" : "Service Expression", "deprecated" : true, "type" : "object", "properties" : { "expression-type" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "host-header" : { "type" : "string", "title" : "Host Header", "description" : "The header that holds the service host information, default ServiceCallConstants.SERVICE_HOST", "default" : "CamelServiceCallServiceHost" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "port-header" : { "type" : "string", "title" : "Port Header", "description" : "The header that holds the service port information, default ServiceCallConstants.SERVICE_PORT", "default" : "CamelServiceCallServicePort" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.ServiceCallServiceChooserConfiguration" : { "title" : "Service Chooser Configuration", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.ServiceCallServiceDiscoveryConfiguration" : { "title" : "Service Discovery Configuration", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.ServiceCallServiceFilterConfiguration" : { "title" : "Service Filter Configuration", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.ServiceCallServiceLoadBalancerConfiguration" : { "title" : "Load Balancer Configuration", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } } } }, "org.apache.camel.model.cloud.StaticServiceCallServiceDiscoveryConfiguration" : { "title" : "Static Service Discovery", "deprecated" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "servers" : { "type" : "array", "title" : "Servers", "description" : "Sets the server list. Each entry can be a list of servers separated by comma in the format: servicehost:port,servicehost2:port,servicehost3:port", "items" : { "type" : "string" } } } }, "org.apache.camel.model.cloud.ZooKeeperServiceCallServiceDiscoveryConfiguration" : { "title" : "Zookeeper Service Discovery", "deprecated" : true, "type" : "object", "properties" : { "base-path" : { "type" : "string", "title" : "Base Path", "description" : "Set the base path to store in ZK" }, "connection-timeout" : { "type" : "string", "title" : "Connection Timeout", "description" : "Connection timeout." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "namespace" : { "type" : "string", "title" : "Namespace", "description" : "As ZooKeeper is a shared space, users of a given cluster should stay within a pre-defined namespace. If a namespace is set here, all paths will get pre-pended with the namespace" }, "nodes" : { "type" : "string", "title" : "Nodes", "description" : "A comma separate list of servers to connect to in the form host:port" }, "properties" : { "type" : "array", "title" : "Properties", "description" : "Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "reconnect-base-sleep-time" : { "type" : "string", "title" : "Reconnect Base Sleep Time", "description" : "Initial amount of time to wait between retries." }, "reconnect-max-retries" : { "type" : "string", "title" : "Reconnect Max Retries", "description" : "Max number of times to retry" }, "reconnect-max-sleep-time" : { "type" : "string", "title" : "Reconnect Max Sleep Time", "description" : "Max time in ms to sleep on each retry" }, "session-timeout" : { "type" : "string", "title" : "Session Timeout", "description" : "Session timeout." } }, "required" : [ "base-path", "nodes" ] }, "org.apache.camel.model.config.BatchResequencerConfig" : { "title" : "Batch-config", "description" : "Configures batch-processing resequence eip.", "type" : "object", "properties" : { "allow-duplicates" : { "type" : "boolean", "title" : "Allow Duplicates", "description" : "Whether to allow duplicates." }, "batch-size" : { "type" : "number", "title" : "Batch Size", "description" : "Sets the size of the batch to be re-ordered. The default size is 100.", "default" : "100" }, "batch-timeout" : { "type" : "string", "title" : "Batch Timeout", "description" : "Sets the timeout for collecting elements to be re-ordered. The default timeout is 1000 msec.", "default" : "1000" }, "ignore-invalid-exchanges" : { "type" : "boolean", "title" : "Ignore Invalid Exchanges", "description" : "Whether to ignore invalid exchanges" }, "reverse" : { "type" : "boolean", "title" : "Reverse", "description" : "Whether to reverse the ordering." } } }, "org.apache.camel.model.config.StreamResequencerConfig" : { "title" : "Stream-config", "description" : "Configures stream-processing resequence eip.", "type" : "object", "properties" : { "capacity" : { "type" : "number", "title" : "Capacity", "description" : "Sets the capacity of the resequencer inbound queue.", "default" : "1000" }, "comparator" : { "type" : "string", "title" : "Comparator", "description" : "To use a custom comparator as a org.apache.camel.processor.resequencer.ExpressionResultComparator type." }, "delivery-attempt-interval" : { "type" : "string", "title" : "Delivery Attempt Interval", "description" : "Sets the interval in milliseconds the stream resequencer will at most wait while waiting for condition of being able to deliver.", "default" : "1000" }, "ignore-invalid-exchanges" : { "type" : "boolean", "title" : "Ignore Invalid Exchanges", "description" : "Whether to ignore invalid exchanges" }, "reject-old" : { "type" : "boolean", "title" : "Reject Old", "description" : "If true, throws an exception when messages older than the last delivered message are processed" }, "timeout" : { "type" : "string", "title" : "Timeout", "description" : "Sets minimum time (milliseconds) to wait for missing elements (messages).", "default" : "1000" } } }, "org.apache.camel.model.dataformat.ASN1DataFormat" : { "title" : "ASN.1 File", "description" : "Encode and decode data structures using Abstract Syntax Notation One (ASN.1).", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class to use when unmarshalling." }, "using-iterator" : { "type" : "boolean", "title" : "Using Iterator", "description" : "If the asn1 file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode." } } } ] }, "org.apache.camel.model.dataformat.AvroDataFormat" : { "title" : "Avro", "description" : "Serialize and deserialize messages using Apache Avro binary data format.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "allow-jms-type" : { "type" : "boolean", "title" : "Allow Jms Type", "description" : "Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to." }, "allow-unmarshall-type" : { "type" : "boolean", "title" : "Allow Unmarshall Type", "description" : "If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used." }, "auto-discover-object-mapper" : { "type" : "boolean", "title" : "Auto Discover Object Mapper", "description" : "If set to true then Jackson will lookup for an objectMapper into the registry" }, "auto-discover-schema-resolver" : { "type" : "boolean", "title" : "Auto Discover Schema Resolver", "description" : "When not disabled, the SchemaResolver will be looked up into the registry" }, "collection-type" : { "type" : "string", "title" : "Collection Type", "description" : "Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default." }, "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "disable-features" : { "type" : "string", "title" : "Disable Features", "description" : "Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "enable-features" : { "type" : "string", "title" : "Enable Features", "description" : "Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "include" : { "type" : "string", "title" : "Include", "description" : "If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL" }, "instance-class-name" : { "type" : "string", "title" : "Instance Class Name", "description" : "Class name to use for marshal and unmarshalling" }, "json-view" : { "type" : "string", "title" : "Json View", "description" : "When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations" }, "library" : { "type" : "string", "title" : "Library", "description" : "Which Avro library to use.", "default" : "ApacheAvro", "enum" : [ "ApacheAvro", "Jackson" ] }, "module-class-names" : { "type" : "string", "title" : "Module Class Names", "description" : "To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma." }, "module-refs" : { "type" : "string", "title" : "Module Refs", "description" : "To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma." }, "object-mapper" : { "type" : "string", "title" : "Object Mapper", "description" : "Lookup and use the existing ObjectMapper with the given id when using Jackson." }, "schema-resolver" : { "type" : "string", "title" : "Schema Resolver", "description" : "Optional schema resolver used to lookup schemas for the data in transit." }, "timezone" : { "type" : "string", "title" : "Timezone", "description" : "If set then Jackson will use the Timezone when marshalling/unmarshalling." }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class name of the java type to use when unmarshalling" }, "use-default-object-mapper" : { "type" : "boolean", "title" : "Use Default Object Mapper", "description" : "Whether to lookup and use default Jackson ObjectMapper from the registry." }, "use-list" : { "type" : "boolean", "title" : "Use List", "description" : "To unmarshal to a List of Map or a List of Pojo." } } } ] }, "org.apache.camel.model.dataformat.BarcodeDataFormat" : { "title" : "Barcode", "description" : "Transform strings to various 1D/2D barcode bitmap formats and back.", "type" : "object", "properties" : { "barcode-format" : { "type" : "string", "title" : "Barcode Format", "description" : "Barcode format such as QR-Code" }, "height" : { "type" : "number", "title" : "Height", "description" : "Height of the barcode" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "image-type" : { "type" : "string", "title" : "Image Type", "description" : "Image type of the barcode such as png" }, "width" : { "type" : "number", "title" : "Width", "description" : "Width of the barcode" } } }, "org.apache.camel.model.dataformat.Base64DataFormat" : { "title" : "Base64", "description" : "Encode and decode data using Base64.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "line-length" : { "type" : "number", "title" : "Line Length", "description" : "To specific a maximum line length for the encoded data. By default 76 is used.", "default" : "76" }, "line-separator" : { "type" : "string", "title" : "Line Separator", "description" : "The line separators to use. Uses new line characters (CRLF) by default." }, "url-safe" : { "type" : "boolean", "title" : "Url Safe", "description" : "Instead of emitting '' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode operations. Decoding seamlessly handles both modes. Is by default false." } } }, "org.apache.camel.model.dataformat.BindyDataFormat" : { "title" : "Bindy", "description" : "Marshal and unmarshal Java beans from and to flat payloads (such as CSV, delimited, fixed length formats, or FIX messages).", "type" : "object", "properties" : { "allow-empty-stream" : { "type" : "boolean", "title" : "Allow Empty Stream", "description" : "Whether to allow empty streams in the unmarshal process. If true, no exception will be thrown when a body without records is provided." }, "class-type" : { "type" : "string", "title" : "Class Type", "description" : "Name of model class to use." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "locale" : { "type" : "string", "title" : "Locale", "description" : "To configure a default locale to use, such as us for united states. To use the JVM platform default locale then use the name default" }, "type" : { "type" : "string", "title" : "Type", "description" : "Whether to use Csv, Fixed, or KeyValue.", "enum" : [ "Csv", "Fixed", "KeyValue" ] }, "unwrap-single-instance" : { "type" : "boolean", "title" : "Unwrap Single Instance", "description" : "When unmarshalling should a single instance be unwrapped and returned instead of wrapped in a java.util.List." } } }, "org.apache.camel.model.dataformat.CBORDataFormat" : { "title" : "CBOR", "description" : "Unmarshal a CBOR payload to POJO and back.", "type" : "object", "properties" : { "allow-jms-type" : { "type" : "boolean", "title" : "Allow Jms Type", "description" : "Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to." }, "allow-unmarshall-type" : { "type" : "boolean", "title" : "Allow Unmarshall Type", "description" : "If enabled then Jackson CBOR is allowed to attempt to use the CamelCBORUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used." }, "collection-type" : { "type" : "string", "title" : "Collection Type", "description" : "Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default." }, "disable-features" : { "type" : "string", "title" : "Disable Features", "description" : "Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "enable-features" : { "type" : "string", "title" : "Enable Features", "description" : "Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "object-mapper" : { "type" : "string", "title" : "Object Mapper", "description" : "Lookup and use the existing CBOR ObjectMapper with the given id when using Jackson." }, "pretty-print" : { "type" : "boolean", "title" : "Pretty Print", "description" : "To enable pretty printing output nicely formatted. Is by default false." }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class name of the java type to use when unmarshalling" }, "use-default-object-mapper" : { "type" : "boolean", "title" : "Use Default Object Mapper", "description" : "Whether to lookup and use default Jackson CBOR ObjectMapper from the registry." }, "use-list" : { "type" : "boolean", "title" : "Use List", "description" : "To unmarshal to a List of Map or a List of Pojo." } } }, "org.apache.camel.model.dataformat.CryptoDataFormat" : { "title" : "Crypto (Java Cryptographic Extension)", "description" : "Encrypt and decrypt messages using Java Cryptography Extension (JCE).", "type" : "object", "properties" : { "algorithm" : { "type" : "string", "title" : "Algorithm", "description" : "The JCE algorithm name indicating the cryptographic algorithm that will be used." }, "algorithm-parameter-ref" : { "type" : "string", "title" : "Algorithm Parameter Ref", "description" : "A JCE AlgorithmParameterSpec used to initialize the Cipher. Will lookup the type using the given name as a java.security.spec.AlgorithmParameterSpec type." }, "buffer-size" : { "type" : "number", "title" : "Buffer Size", "description" : "The size of the buffer used in the signature process.", "default" : "4096" }, "crypto-provider" : { "type" : "string", "title" : "Crypto Provider", "description" : "The name of the JCE Security Provider that should be used." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "init-vector-ref" : { "type" : "string", "title" : "Init Vector Ref", "description" : "Refers to a byte array containing the Initialization Vector that will be used to initialize the Cipher." }, "inline" : { "type" : "boolean", "title" : "Inline", "description" : "Flag indicating that the configured IV should be inlined into the encrypted data stream. Is by default false." }, "key-ref" : { "type" : "string", "title" : "Key Ref", "description" : "Refers to the secret key to lookup from the register to use." }, "mac-algorithm" : { "type" : "string", "title" : "Mac Algorithm", "description" : "The JCE algorithm name indicating the Message Authentication algorithm.", "default" : "HmacSHA1" }, "should-append-hmac" : { "type" : "boolean" } } }, "org.apache.camel.model.dataformat.CsvDataFormat" : { "title" : "CSV", "description" : "Handle CSV (Comma Separated Values) payloads.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "allow-missing-column-names" : { "type" : "boolean", "title" : "Allow Missing Column Names", "description" : "Whether to allow missing column names." }, "capture-header-record" : { "type" : "boolean", "title" : "Capture Header Record", "description" : "Whether the unmarshalling should capture the header record and store it in the message header" }, "comment-marker" : { "type" : "string", "title" : "Comment Marker", "description" : "Sets the comment marker of the reference format." }, "comment-marker-disabled" : { "type" : "boolean", "title" : "Comment Marker Disabled", "description" : "Disables the comment marker of the reference format." }, "delimiter" : { "type" : "string", "title" : "Delimiter", "description" : "Sets the delimiter to use. The default value is , (comma)" }, "escape" : { "type" : "string", "title" : "Escape", "description" : "Sets the escape character to use" }, "escape-disabled" : { "type" : "boolean", "title" : "Escape Disabled", "description" : "Use for disabling using escape character" }, "format-name" : { "type" : "string", "title" : "Format Name", "description" : "The name of the format to use, the default value is CSVFormat.DEFAULT", "default" : "DEFAULT", "enum" : [ "DEFAULT", "EXCEL", "INFORMIX_UNLOAD", "INFORMIX_UNLOAD_CSV", "MYSQL", "RFC4180" ] }, "format-ref" : { "type" : "string", "title" : "Format Ref", "description" : "The reference format to use, it will be updated with the other format options, the default value is CSVFormat.DEFAULT" }, "header" : { "type" : "array", "title" : "Header", "description" : "To configure the CSV headers", "items" : { "type" : "string" } }, "header-disabled" : { "type" : "boolean", "title" : "Header Disabled", "description" : "Use for disabling headers" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ignore-empty-lines" : { "type" : "boolean", "title" : "Ignore Empty Lines", "description" : "Whether to ignore empty lines." }, "ignore-header-case" : { "type" : "boolean", "title" : "Ignore Header Case", "description" : "Sets whether or not to ignore case when accessing header names." }, "ignore-surrounding-spaces" : { "type" : "boolean", "title" : "Ignore Surrounding Spaces", "description" : "Whether to ignore surrounding spaces" }, "lazy-load" : { "type" : "boolean", "title" : "Lazy Load", "description" : "Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one." }, "marshaller-factory-ref" : { "type" : "string", "title" : "Marshaller Factory Ref", "description" : "Sets the implementation of the CsvMarshallerFactory interface which is able to customize marshalling/unmarshalling behavior by extending CsvMarshaller or creating it from scratch." }, "null-string" : { "type" : "string", "title" : "Null String", "description" : "Sets the null string" }, "null-string-disabled" : { "type" : "boolean", "title" : "Null String Disabled", "description" : "Used to disable null strings" }, "quote" : { "type" : "string", "title" : "Quote", "description" : "Sets the quote which by default is" }, "quote-disabled" : { "type" : "boolean", "title" : "Quote Disabled", "description" : "Used to disable quotes" }, "quote-mode" : { "type" : "string", "title" : "Quote Mode", "description" : "Sets the quote mode", "enum" : [ "ALL", "ALL_NON_NULL", "MINIMAL", "NON_NUMERIC", "NONE" ] }, "record-converter-ref" : { "type" : "string", "title" : "Record Converter Ref", "description" : "Refers to a custom CsvRecordConverter to lookup from the registry to use." }, "record-separator" : { "type" : "string", "title" : "Record Separator", "description" : "Sets the record separator (aka new line) which by default is new line characters (CRLF)" }, "record-separator-disabled" : { "type" : "string", "title" : "Record Separator Disabled", "description" : "Used for disabling record separator" }, "skip-header-record" : { "type" : "boolean", "title" : "Skip Header Record", "description" : "Whether to skip the header record in the output" }, "trailing-delimiter" : { "type" : "boolean", "title" : "Trailing Delimiter", "description" : "Sets whether or not to add a trailing delimiter." }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Sets whether or not to trim leading and trailing blanks." }, "use-maps" : { "type" : "boolean", "title" : "Use Maps", "description" : "Whether the unmarshalling should produce maps (HashMap)for the lines values instead of lists. It requires to have header (either defined or collected)." }, "use-ordered-maps" : { "type" : "boolean", "title" : "Use Ordered Maps", "description" : "Whether the unmarshalling should produce ordered maps (LinkedHashMap) for the lines values instead of lists. It requires to have header (either defined or collected)." } } } ] }, "org.apache.camel.model.dataformat.CustomDataFormat" : { "title" : "Custom", "description" : "Delegate to a custom org.apache.camel.spi.DataFormat implementation via Camel registry.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to the custom org.apache.camel.spi.DataFormat to lookup from the Camel registry." } } } ], "required" : [ "ref" ] }, "org.apache.camel.model.dataformat.DataFormatsDefinition" : { "title" : "Data formats", "description" : "Configure data formats.", "type" : "object", "properties" : { "asn1" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ASN1DataFormat" }, "avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.AvroDataFormat" }, "barcode" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BarcodeDataFormat" }, "base64" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.Base64DataFormat" }, "bindy" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BindyDataFormat" }, "cbor" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CBORDataFormat" }, "crypto" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CryptoDataFormat" }, "csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CsvDataFormat" }, "custom" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CustomDataFormat" }, "fhir-json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirJsonDataFormat" }, "fhir-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirXmlDataFormat" }, "flatpack" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FlatpackDataFormat" }, "grok" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GrokDataFormat" }, "gzip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GzipDeflaterDataFormat" }, "hl7" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.HL7DataFormat" }, "ical" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.IcalDataFormat" }, "jackson-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JacksonXMLDataFormat" }, "jaxb" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JaxbDataFormat" }, "json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonDataFormat" }, "json-api" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonApiDataFormat" }, "lzf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.LZFDataFormat" }, "mime-multipart" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.MimeMultipartDataFormat" }, "parquet-avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ParquetAvroDataFormat" }, "pgp" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.PGPDataFormat" }, "protobuf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ProtobufDataFormat" }, "rss" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.RssDataFormat" }, "soap" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SoapDataFormat" }, "swift-mt" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMtDataFormat" }, "swift-mx" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMxDataFormat" }, "syslog" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SyslogDataFormat" }, "tar-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TarFileDataFormat" }, "thrift" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ThriftDataFormat" }, "tidy-markup" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TidyMarkupDataFormat" }, "univocity-csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityCsvDataFormat" }, "univocity-fixed" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityFixedDataFormat" }, "univocity-tsv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityTsvDataFormat" }, "xml-security" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.XMLSecurityDataFormat" }, "yaml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.YAMLDataFormat" }, "zip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipDeflaterDataFormat" }, "zip-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipFileDataFormat" } } }, "org.apache.camel.model.dataformat.FhirJsonDataFormat" : { "title" : "FHIR JSon", "description" : "Marshall and unmarshall FHIR objects to/from JSON.", "type" : "object", "properties" : { "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "dont-encode-elements" : { "type" : "string", "title" : "Dont Encode Elements", "description" : "If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Don't encode patient and all its children Patient.name - Don't encode the patient's name Patient.name.family - Don't encode the patient's family name .text - Don't encode the text element on any resource (only the very first position may contain a wildcard) DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3 mode." }, "dont-strip-versions-from-references-at-paths" : { "type" : "string", "title" : "Dont Strip Versions From References At Paths", "description" : "If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process. Multiple elements can be separated by comma when using String parameter. This method provides a finer-grained level of control than setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(String) has been set to true (which is the default)" }, "encode-elements" : { "type" : "string", "title" : "Encode Elements", "description" : "If provided, specifies the elements which should be encoded, to the exclusion of all others. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Encode patient and all its children Patient.name - Encode only the patient's name Patient.name.family - Encode only the patient's family name .text - Encode the text element on any resource (only the very first position may contain a wildcard) .(mandatory) - This is a special case which causes any mandatory fields (min 0) to be encoded" }, "encode-elements-applies-to-child-resources-only" : { "type" : "boolean", "title" : "Encode Elements Applies To Child Resources Only", "description" : "If set to true (default is false), the values supplied to setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)" }, "fhir-context" : { "type" : "string", "title" : "Fhir Context", "description" : "To use a custom fhir context. Reference to object of type ca.uhn.fhir.context.FhirContext" }, "fhir-version" : { "type" : "string", "title" : "Fhir Version", "description" : "The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4,R5", "default" : "R4", "enum" : [ "DSTU2", "DSTU2_HL7ORG", "DSTU2_1", "DSTU3", "R4", "R5" ] }, "force-resource-id" : { "type" : "string", "title" : "Force Resource Id", "description" : "When encoding, force this resource ID to be encoded as the resource ID. Reference to object of type org.hl7.fhir.instance.model.api.IIdType" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "omit-resource-id" : { "type" : "boolean", "title" : "Omit Resource Id", "description" : "If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID." }, "override-resource-id-with-bundle-entry-full-url" : { "type" : "boolean", "title" : "Override Resource Id With Bundle Entry Full Url", "description" : "If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id)." }, "parser-error-handler" : { "type" : "string", "title" : "Parser Error Handler", "description" : "Registers an error handler which will be invoked when any parse errors are found. Reference to object of type ca.uhn.fhir.parser.IParserErrorHandler" }, "parser-options" : { "type" : "string", "title" : "Parser Options", "description" : "Sets the parser options object which will be used to supply default options to newly created parsers. Reference to object of type ca.uhn.fhir.context.ParserOptions." }, "prefer-types" : { "type" : "string", "title" : "Prefer Types", "description" : "If set (FQN class names), when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority). For example, if a custom type which declares to implement the Patient resource is passed in here, and the parser is parsing a Bundle containing a Patient resource, the parser will use the given custom type. Multiple class names can be separated by comma." }, "pretty-print" : { "type" : "boolean", "title" : "Pretty Print", "description" : "Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible." }, "server-base-url" : { "type" : "string", "title" : "Server Base Url", "description" : "Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base." }, "strip-versions-from-references" : { "type" : "boolean", "title" : "Strip Versions From References", "description" : "If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false. This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use setDontStripVersionsFromReferencesAtPaths(List)" }, "summary-mode" : { "type" : "boolean", "title" : "Summary Mode", "description" : "If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included." }, "suppress-narratives" : { "type" : "boolean", "title" : "Suppress Narratives", "description" : "If set to true (default is false), narratives will not be included in the encoded values." } } }, "org.apache.camel.model.dataformat.FhirXmlDataFormat" : { "title" : "FHIR XML", "description" : "Marshall and unmarshall FHIR objects to/from XML.", "type" : "object", "properties" : { "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "dont-encode-elements" : { "type" : "string", "title" : "Dont Encode Elements", "description" : "If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Don't encode patient and all its children Patient.name - Don't encode the patient's name Patient.name.family - Don't encode the patient's family name .text - Don't encode the text element on any resource (only the very first position may contain a wildcard) DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3 mode." }, "dont-strip-versions-from-references-at-paths" : { "type" : "string", "title" : "Dont Strip Versions From References At Paths", "description" : "If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process. Multiple elements can be separated by comma when using String parameter. This method provides a finer-grained level of control than setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(String) has been set to true (which is the default)" }, "encode-elements" : { "type" : "string", "title" : "Encode Elements", "description" : "If provided, specifies the elements which should be encoded, to the exclusion of all others. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Encode patient and all its children Patient.name - Encode only the patient's name Patient.name.family - Encode only the patient's family name .text - Encode the text element on any resource (only the very first position may contain a wildcard) .(mandatory) - This is a special case which causes any mandatory fields (min 0) to be encoded" }, "encode-elements-applies-to-child-resources-only" : { "type" : "boolean", "title" : "Encode Elements Applies To Child Resources Only", "description" : "If set to true (default is false), the values supplied to setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)" }, "fhir-context" : { "type" : "string", "title" : "Fhir Context", "description" : "To use a custom fhir context. Reference to object of type ca.uhn.fhir.context.FhirContext" }, "fhir-version" : { "type" : "string", "title" : "Fhir Version", "description" : "The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4,R5", "default" : "R4", "enum" : [ "DSTU2", "DSTU2_HL7ORG", "DSTU2_1", "DSTU3", "R4", "R5" ] }, "force-resource-id" : { "type" : "string", "title" : "Force Resource Id", "description" : "When encoding, force this resource ID to be encoded as the resource ID. Reference to object of type org.hl7.fhir.instance.model.api.IIdType" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "omit-resource-id" : { "type" : "boolean", "title" : "Omit Resource Id", "description" : "If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID." }, "override-resource-id-with-bundle-entry-full-url" : { "type" : "boolean", "title" : "Override Resource Id With Bundle Entry Full Url", "description" : "If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id)." }, "parser-error-handler" : { "type" : "string", "title" : "Parser Error Handler", "description" : "Registers an error handler which will be invoked when any parse errors are found. Reference to object of type ca.uhn.fhir.parser.IParserErrorHandler" }, "parser-options" : { "type" : "string", "title" : "Parser Options", "description" : "Sets the parser options object which will be used to supply default options to newly created parsers. Reference to object of type ca.uhn.fhir.context.ParserOptions." }, "prefer-types" : { "type" : "string", "title" : "Prefer Types", "description" : "If set (FQN class names), when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority). For example, if a custom type which declares to implement the Patient resource is passed in here, and the parser is parsing a Bundle containing a Patient resource, the parser will use the given custom type. Multiple class names can be separated by comma." }, "pretty-print" : { "type" : "boolean", "title" : "Pretty Print", "description" : "Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible." }, "server-base-url" : { "type" : "string", "title" : "Server Base Url", "description" : "Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base." }, "strip-versions-from-references" : { "type" : "boolean", "title" : "Strip Versions From References", "description" : "If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false. This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use setDontStripVersionsFromReferencesAtPaths(List)" }, "summary-mode" : { "type" : "boolean", "title" : "Summary Mode", "description" : "If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included." }, "suppress-narratives" : { "type" : "boolean", "title" : "Suppress Narratives", "description" : "If set to true (default is false), narratives will not be included in the encoded values." } } }, "org.apache.camel.model.dataformat.FlatpackDataFormat" : { "title" : "Flatpack", "description" : "Marshal and unmarshal Java lists and maps to/from flat files (such as CSV, delimited, or fixed length formats) using Flatpack library.", "type" : "object", "properties" : { "allow-short-lines" : { "type" : "boolean", "title" : "Allow Short Lines", "description" : "Allows for lines to be shorter than expected and ignores the extra characters" }, "definition" : { "type" : "string", "title" : "Definition", "description" : "The flatpack pzmap configuration file. Can be omitted in simpler situations, but its preferred to use the pzmap." }, "delimiter" : { "type" : "string", "title" : "Delimiter", "description" : "The delimiter char (could be ; , or similar)", "default" : "," }, "fixed" : { "type" : "boolean", "title" : "Fixed", "description" : "Delimited or fixed. Is by default false = delimited" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ignore-extra-columns" : { "type" : "boolean", "title" : "Ignore Extra Columns", "description" : "Allows for lines to be longer than expected and ignores the extra characters." }, "ignore-first-record" : { "type" : "boolean", "title" : "Ignore First Record", "description" : "Whether the first line is ignored for delimited files (for the column headers). Is by default true." }, "parser-factory-ref" : { "type" : "string", "title" : "Parser Factory Ref", "description" : "References to a custom parser factory to lookup in the registry" }, "text-qualifier" : { "type" : "string", "title" : "Text Qualifier", "description" : "If the text is qualified with a character. Uses quote character by default." } } }, "org.apache.camel.model.dataformat.GrokDataFormat" : { "title" : "Grok", "description" : "Unmarshal unstructured data to objects using Logstash based Grok patterns.", "type" : "object", "properties" : { "allow-multiple-matches-per-line" : { "type" : "boolean", "title" : "Allow Multiple Matches Per Line", "description" : "If false, every line of input is matched for pattern only once. Otherwise the line can be scanned multiple times when non-terminal pattern is used." }, "flattened" : { "type" : "boolean", "title" : "Flattened", "description" : "Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "named-only" : { "type" : "boolean", "title" : "Named Only", "description" : "Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})" }, "pattern" : { "type" : "string", "title" : "Pattern", "description" : "The grok pattern to match lines of input" } }, "required" : [ "pattern" ] }, "org.apache.camel.model.dataformat.GzipDeflaterDataFormat" : { "title" : "GZip Deflater", "description" : "Compress and decompress messages using java.util.zip.GZIPStream.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.dataformat.HL7DataFormat" : { "title" : "HL7", "description" : "Marshal and unmarshal HL7 (Health Care) model objects using the HL7 MLLP codec.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "validate" : { "type" : "boolean", "title" : "Validate", "description" : "Whether to validate the HL7 message Is by default true." } } }, "org.apache.camel.model.dataformat.IcalDataFormat" : { "title" : "iCal", "description" : "Marshal and unmarshal iCal (.ics) documents to/from model objects.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "validating" : { "type" : "boolean", "title" : "Validating", "description" : "Whether to validate." } } }, "org.apache.camel.model.dataformat.JacksonXMLDataFormat" : { "title" : "Jackson XML", "description" : "Unmarshal an XML payloads to POJOs and back using XMLMapper extension of Jackson.", "type" : "object", "properties" : { "allow-jms-type" : { "type" : "boolean", "title" : "Allow Jms Type", "description" : "Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to." }, "allow-unmarshall-type" : { "type" : "boolean", "title" : "Allow Unmarshall Type", "description" : "If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used." }, "collection-type" : { "type" : "string", "title" : "Collection Type", "description" : "Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default." }, "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "disable-features" : { "type" : "string", "title" : "Disable Features", "description" : "Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "enable-features" : { "type" : "string", "title" : "Enable Features", "description" : "Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "enable-jaxb-annotation-module" : { "type" : "boolean", "title" : "Enable Jaxb Annotation Module", "description" : "Whether to enable the JAXB annotations module when using jackson. When enabled then JAXB annotations can be used by Jackson." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "include" : { "type" : "string", "title" : "Include", "description" : "If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL" }, "json-view" : { "type" : "string", "title" : "Json View", "description" : "When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations" }, "module-class-names" : { "type" : "string", "title" : "Module Class Names", "description" : "To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma." }, "module-refs" : { "type" : "string", "title" : "Module Refs", "description" : "To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma." }, "pretty-print" : { "type" : "boolean", "title" : "Pretty Print", "description" : "To enable pretty printing output nicely formatted. Is by default false." }, "timezone" : { "type" : "string", "title" : "Timezone", "description" : "If set then Jackson will use the Timezone when marshalling/unmarshalling." }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class name of the java type to use when unmarshalling" }, "use-list" : { "type" : "boolean", "title" : "Use List", "description" : "To unmarshal to a List of Map or a List of Pojo." }, "xml-mapper" : { "type" : "string", "title" : "Xml Mapper", "description" : "Lookup and use the existing XmlMapper with the given id." } } }, "org.apache.camel.model.dataformat.JaxbDataFormat" : { "title" : "JAXB", "description" : "Unmarshal XML payloads to POJOs and back using JAXB2 XML marshalling standard.", "type" : "object", "properties" : { "access-external-schema-protocols" : { "type" : "string", "title" : "Access External Schema Protocols", "description" : "Only in use if schema validation has been enabled. Restrict access to the protocols specified for external reference set by the schemaLocation attribute, Import and Include element. Examples of protocols are file, http, jar:file. false or none to deny all access to external references; a specific protocol, such as file, to give permission to only the protocol; the keyword all to grant permission to all protocols.", "default" : "false" }, "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "context-path" : { "type" : "string", "title" : "Context Path", "description" : "Package name where your JAXB classes are located." }, "context-path-is-class-name" : { "type" : "boolean", "title" : "Context Path Is Class Name", "description" : "This can be set to true to mark that the contextPath is referring to a classname and not a package name." }, "encoding" : { "type" : "string", "title" : "Encoding", "description" : "To overrule and use a specific encoding" }, "filter-non-xml-chars" : { "type" : "boolean", "title" : "Filter Non Xml Chars", "description" : "To ignore non xml characheters and replace them with an empty space." }, "fragment" : { "type" : "boolean", "title" : "Fragment", "description" : "To turn on marshalling XML fragment trees. By default JAXB looks for XmlRootElement annotation on given class to operate on whole XML tree. This is useful but not always - sometimes generated code does not have XmlRootElement annotation, sometimes you need unmarshall only part of tree. In that case you can use partial unmarshalling. To enable this behaviours you need set property partClass. Camel will pass this class to JAXB's unmarshaler." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ignore-jaxb-element" : { "type" : "boolean" }, "jaxb-provider-properties" : { "type" : "string", "title" : "Jaxb Provider Properties", "description" : "Refers to a custom java.util.Map to lookup in the registry containing custom JAXB provider properties to be used with the JAXB marshaller." }, "must-be-jaxb-element" : { "type" : "boolean" }, "namespace-prefix-ref" : { "type" : "string", "title" : "Namespace Prefix Ref", "description" : "When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To control this mapping, Camel allows you to refer to a map which contains the desired mapping." }, "no-namespace-schema-location" : { "type" : "string", "title" : "No Namespace Schema Location", "description" : "To define the location of the namespaceless schema" }, "object-factory" : { "type" : "boolean", "title" : "Object Factory", "description" : "Whether to allow using ObjectFactory classes to create the POJO classes during marshalling. This only applies to POJO classes that has not been annotated with JAXB and providing jaxb.index descriptor files." }, "part-class" : { "type" : "string", "title" : "Part Class", "description" : "Name of class used for fragment parsing. See more details at the fragment option." }, "part-namespace" : { "type" : "string", "title" : "Part Namespace", "description" : "XML namespace to use for fragment parsing. See more details at the fragment option." }, "pretty-print" : { "type" : "boolean", "title" : "Pretty Print", "description" : "To enable pretty printing output nicely formatted. Is by default false." }, "schema" : { "type" : "string", "title" : "Schema", "description" : "To validate against an existing schema. Your can use the prefix classpath:, file: or http: to specify how the resource should be resolved. You can separate multiple schema files by using the ',' character." }, "schema-location" : { "type" : "string", "title" : "Schema Location", "description" : "To define the location of the schema" }, "schema-severity-level" : { "type" : "string", "title" : "Schema Severity Level", "description" : "Sets the schema severity level to use when validating against a schema. This level determines the minimum severity error that triggers JAXB to stop continue parsing. The default value of 0 (warning) means that any error (warning, error or fatal error) will trigger JAXB to stop. There are the following three levels: 0=warning, 1=error, 2=fatal error.", "default" : "0", "enum" : [ "0", "1", "2" ] }, "xml-stream-writer-wrapper" : { "type" : "string", "title" : "Xml Stream Writer Wrapper", "description" : "To use a custom xml stream writer." } }, "required" : [ "context-path" ] }, "org.apache.camel.model.dataformat.JsonApiDataFormat" : { "title" : "JSonApi", "description" : "Marshal and unmarshal JSON:API resources using JSONAPI-Converter library.", "type" : "object", "properties" : { "data-format-types" : { "type" : "string", "title" : "Data Format Types", "description" : "The classes to take into account for the marshalling. Multiple classes can be separated by comma." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "main-format-type" : { "type" : "string", "title" : "Main Format Type", "description" : "The class to take into account while unmarshalling." } } }, "org.apache.camel.model.dataformat.JsonDataFormat" : { "title" : "JSon", "description" : "Marshal POJOs to JSON and back.", "type" : "object", "properties" : { "allow-jms-type" : { "type" : "boolean", "title" : "Allow Jms Type", "description" : "Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to." }, "allow-unmarshall-type" : { "type" : "boolean", "title" : "Allow Unmarshall Type", "description" : "If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used." }, "auto-discover-object-mapper" : { "type" : "boolean", "title" : "Auto Discover Object Mapper", "description" : "If set to true then Jackson will look for an objectMapper to use from the registry" }, "auto-discover-schema-resolver" : { "type" : "boolean", "title" : "Auto Discover Schema Resolver", "description" : "When not disabled, the SchemaResolver will be looked up into the registry" }, "collection-type" : { "type" : "string", "title" : "Collection Type", "description" : "Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows using different collection types than java.util.Collection based as default." }, "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "date-format-pattern" : { "type" : "string", "title" : "Date Format Pattern", "description" : "To configure the date format while marshall or unmarshall Date fields in JSON using Gson" }, "disable-features" : { "type" : "string", "title" : "Disable Features", "description" : "Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "enable-features" : { "type" : "string", "title" : "Enable Features", "description" : "Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "include" : { "type" : "string", "title" : "Include", "description" : "If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL" }, "json-view" : { "type" : "string", "title" : "Json View", "description" : "When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations" }, "library" : { "type" : "string", "title" : "Library", "description" : "Which json library to use.", "default" : "Jackson", "enum" : [ "Fastjson", "Gson", "Jackson", "Johnzon", "Jsonb" ] }, "module-class-names" : { "type" : "string", "title" : "Module Class Names", "description" : "To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma." }, "module-refs" : { "type" : "string", "title" : "Module Refs", "description" : "To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma." }, "naming-strategy" : { "type" : "string", "title" : "Naming Strategy", "description" : "If set then Jackson will use the the defined Property Naming Strategy.Possible values are: LOWER_CAMEL_CASE, LOWER_DOT_CASE, LOWER_CASE, KEBAB_CASE, SNAKE_CASE and UPPER_CAMEL_CASE" }, "object-mapper" : { "type" : "string", "title" : "Object Mapper", "description" : "Lookup and use the existing ObjectMapper with the given id when using Jackson." }, "pretty-print" : { "type" : "boolean", "title" : "Pretty Print", "description" : "To enable pretty printing output nicely formatted. Is by default false." }, "schema-resolver" : { "type" : "string", "title" : "Schema Resolver", "description" : "Optional schema resolver used to lookup schemas for the data in transit." }, "timezone" : { "type" : "string", "title" : "Timezone", "description" : "If set then Jackson will use the Timezone when marshalling/unmarshalling. This option will have no effect on the others Json DataFormat, like gson and fastjson." }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class name of the java type to use when unmarshalling" }, "use-default-object-mapper" : { "type" : "boolean", "title" : "Use Default Object Mapper", "description" : "Whether to lookup and use default Jackson ObjectMapper from the registry." }, "use-list" : { "type" : "boolean", "title" : "Use List", "description" : "To unmarshal to a List of Map or a List of Pojo." } } }, "org.apache.camel.model.dataformat.LZFDataFormat" : { "title" : "LZF Deflate Compression", "description" : "Compress and decompress streams using LZF deflate algorithm.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "using-parallel-compression" : { "type" : "boolean", "title" : "Using Parallel Compression", "description" : "Enable encoding (compress) using multiple processing cores." } } }, "org.apache.camel.model.dataformat.MimeMultipartDataFormat" : { "title" : "MIME Multipart", "description" : "Marshal Camel messages with attachments into MIME-Multipart messages and back.", "type" : "object", "properties" : { "binary-content" : { "type" : "boolean", "title" : "Binary Content", "description" : "Defines whether the content of binary parts in the MIME multipart is binary (true) or Base-64 encoded (false) Default is false." }, "headers-inline" : { "type" : "boolean", "title" : "Headers Inline", "description" : "Defines whether the MIME-Multipart headers are part of the message body (true) or are set as Camel headers (false). Default is false." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "include-headers" : { "type" : "string", "title" : "Include Headers", "description" : "A regex that defines which Camel headers are also included as MIME headers into the MIME multipart. This will only work if headersInline is set to true. Default is to include no headers" }, "multipart-sub-type" : { "type" : "string", "title" : "Multipart Sub Type", "description" : "Specify the subtype of the MIME Multipart. Default is mixed.", "default" : "mixed" }, "multipart-without-attachment" : { "type" : "boolean", "title" : "Multipart Without Attachment", "description" : "Defines whether a message without attachment is also marshaled into a MIME Multipart (with only one body part). Default is false." } } }, "org.apache.camel.model.dataformat.PGPDataFormat" : { "title" : "PGP", "description" : "Encrypt and decrypt messages using Java Cryptographic Extension (JCE) and PGP.", "type" : "object", "properties" : { "algorithm" : { "type" : "number", "title" : "Algorithm", "description" : "Symmetric key encryption algorithm; possible values are defined in org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags; for example 2 (= TRIPLE DES), 3 (= CAST5), 4 (= BLOWFISH), 6 (= DES), 7 (= AES_128). Only relevant for encrypting." }, "armored" : { "type" : "boolean", "title" : "Armored", "description" : "This option will cause PGP to base64 encode the encrypted text, making it available for copy/paste, etc." }, "compression-algorithm" : { "type" : "number", "title" : "Compression Algorithm", "description" : "Compression algorithm; possible values are defined in org.bouncycastle.bcpg.CompressionAlgorithmTags; for example 0 (= UNCOMPRESSED), 1 (= ZIP), 2 (= ZLIB), 3 (= BZIP2). Only relevant for encrypting." }, "hash-algorithm" : { "type" : "number", "title" : "Hash Algorithm", "description" : "Signature hash algorithm; possible values are defined in org.bouncycastle.bcpg.HashAlgorithmTags; for example 2 (= SHA1), 8 (= SHA256), 9 (= SHA384), 10 (= SHA512), 11 (=SHA224). Only relevant for signing." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "integrity" : { "type" : "boolean", "title" : "Integrity", "description" : "Adds an integrity check/sign into the encryption file. The default value is true." }, "key-file-name" : { "type" : "string", "title" : "Key File Name", "description" : "Filename of the keyring; must be accessible as a classpath resource (but you can specify a location in the file system by using the file: prefix)." }, "key-userid" : { "type" : "string", "title" : "Key Userid", "description" : "The user ID of the key in the PGP keyring used during encryption. Can also be only a part of a user ID. For example, if the user ID is Test User then you can use the part Test User or to address the user ID." }, "password" : { "type" : "string", "title" : "Password", "description" : "Password used when opening the private key (not used for encryption)." }, "provider" : { "type" : "string", "title" : "Provider", "description" : "Java Cryptography Extension (JCE) provider, default is Bouncy Castle (BC). Alternatively you can use, for example, the IAIK JCE provider; in this case the provider must be registered beforehand and the Bouncy Castle provider must not be registered beforehand. The Sun JCE provider does not work." }, "signature-key-file-name" : { "type" : "string", "title" : "Signature Key File Name", "description" : "Filename of the keyring to use for signing (during encryption) or for signature verification (during decryption); must be accessible as a classpath resource (but you can specify a location in the file system by using the file: prefix)." }, "signature-key-ring" : { "type" : "string", "title" : "Signature Key Ring", "description" : "Keyring used for signing/verifying as byte array. You can not set the signatureKeyFileName and signatureKeyRing at the same time." }, "signature-key-userid" : { "type" : "string", "title" : "Signature Key Userid", "description" : "User ID of the key in the PGP keyring used for signing (during encryption) or signature verification (during decryption). During the signature verification process the specified User ID restricts the public keys from the public keyring which can be used for the verification. If no User ID is specified for the signature verficiation then any public key in the public keyring can be used for the verification. Can also be only a part of a user ID. For example, if the user ID is Test User then you can use the part Test User or to address the User ID." }, "signature-password" : { "type" : "string", "title" : "Signature Password", "description" : "Password used when opening the private key used for signing (during encryption)." }, "signature-verification-option" : { "type" : "string", "title" : "Signature Verification Option", "description" : "Controls the behavior for verifying the signature during unmarshaling. There are 4 values possible: optional: The PGP message may or may not contain signatures; if it does contain signatures, then a signature verification is executed. required: The PGP message must contain at least one signature; if this is not the case an exception (PGPException) is thrown. A signature verification is executed. ignore: Contained signatures in the PGP message are ignored; no signature verification is executed. no_signature_allowed: The PGP message must not contain a signature; otherwise an exception (PGPException) is thrown." } } }, "org.apache.camel.model.dataformat.ParquetAvroDataFormat" : { "title" : "Parquet File", "description" : "Parquet Avro serialization and de-serialization.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "compression-codec-name" : { "type" : "string", "title" : "Compression Codec Name", "description" : "Compression codec to use when marshalling.", "default" : "GZIP" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class to use when (un)marshalling. If omitted, parquet files are converted into Avro's GenericRecords for unmarshalling and input objects are assumed as GenericRecords for marshalling." } } } ] }, "org.apache.camel.model.dataformat.ProtobufDataFormat" : { "title" : "Protobuf", "description" : "Serialize and deserialize Java objects using Google's Protocol buffers.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "allow-jms-type" : { "type" : "boolean", "title" : "Allow Jms Type", "description" : "Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to." }, "allow-unmarshall-type" : { "type" : "boolean", "title" : "Allow Unmarshall Type", "description" : "If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used." }, "auto-discover-object-mapper" : { "type" : "boolean", "title" : "Auto Discover Object Mapper", "description" : "If set to true then Jackson will lookup for an objectMapper into the registry" }, "auto-discover-schema-resolver" : { "type" : "boolean", "title" : "Auto Discover Schema Resolver", "description" : "When not disabled, the SchemaResolver will be looked up into the registry" }, "collection-type" : { "type" : "string", "title" : "Collection Type", "description" : "Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default." }, "content-type-format" : { "type" : "string", "title" : "Content Type Format", "description" : "Defines a content type format in which protobuf message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native protobuf or json fields representation. The default value is native.", "default" : "native", "enum" : [ "native", "json" ] }, "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "disable-features" : { "type" : "string", "title" : "Disable Features", "description" : "Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "enable-features" : { "type" : "string", "title" : "Enable Features", "description" : "Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "include" : { "type" : "string", "title" : "Include", "description" : "If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL" }, "instance-class" : { "type" : "string", "title" : "Instance Class", "description" : "Name of class to use when unmarshalling" }, "json-view" : { "type" : "string", "title" : "Json View", "description" : "When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations" }, "library" : { "type" : "string", "title" : "Library", "description" : "Which Protobuf library to use.", "default" : "GoogleProtobuf", "enum" : [ "GoogleProtobuf", "Jackson" ] }, "module-class-names" : { "type" : "string", "title" : "Module Class Names", "description" : "To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma." }, "module-refs" : { "type" : "string", "title" : "Module Refs", "description" : "To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma." }, "object-mapper" : { "type" : "string", "title" : "Object Mapper", "description" : "Lookup and use the existing ObjectMapper with the given id when using Jackson." }, "schema-resolver" : { "type" : "string", "title" : "Schema Resolver", "description" : "Optional schema resolver used to lookup schemas for the data in transit." }, "timezone" : { "type" : "string", "title" : "Timezone", "description" : "If set then Jackson will use the Timezone when marshalling/unmarshalling." }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class name of the java type to use when unmarshalling" }, "use-default-object-mapper" : { "type" : "boolean", "title" : "Use Default Object Mapper", "description" : "Whether to lookup and use default Jackson ObjectMapper from the registry." }, "use-list" : { "type" : "boolean", "title" : "Use List", "description" : "To unmarshal to a List of Map or a List of Pojo." } } } ] }, "org.apache.camel.model.dataformat.RssDataFormat" : { "title" : "RSS", "description" : "Transform from ROME SyndFeed Java Objects to XML and vice-versa.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.dataformat.SoapDataFormat" : { "title" : "SOAP", "description" : "Marshal Java objects to SOAP messages and back.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "context-path" : { "type" : "string", "title" : "Context Path", "description" : "Package name where your JAXB classes are located." }, "element-name-strategy-ref" : { "type" : "string", "title" : "Element Name Strategy Ref", "description" : "Refers to an element strategy to lookup from the registry. An element name strategy is used for two purposes. The first is to find a xml element name for a given object and soap action when marshaling the object into a SOAP message. The second is to find an Exception class for a given soap fault name. The following three element strategy class name is provided out of the box. QNameStrategy - Uses a fixed qName that is configured on instantiation. Exception lookup is not supported TypeNameStrategy - Uses the name and namespace from the XMLType annotation of the given type. If no namespace is set then package-info is used. Exception lookup is not supported ServiceInterfaceStrategy - Uses information from a webservice interface to determine the type name and to find the exception class for a SOAP fault All three classes is located in the package name org.apache.camel.dataformat.soap.name If you have generated the web service stub code with cxf-codegen or a similar tool then you probably will want to use the ServiceInterfaceStrategy. In the case you have no annotated service interface you should use QNameStrategy or TypeNameStrategy." }, "encoding" : { "type" : "string", "title" : "Encoding", "description" : "To overrule and use a specific encoding" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "namespace-prefix-ref" : { "type" : "string", "title" : "Namespace Prefix Ref", "description" : "When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To control this mapping, Camel allows you to refer to a map which contains the desired mapping." }, "schema" : { "type" : "string", "title" : "Schema", "description" : "To validate against an existing schema. Your can use the prefix classpath:, file: or http: to specify how the resource should be resolved. You can separate multiple schema files by using the ',' character." }, "version" : { "type" : "string", "title" : "Version", "description" : "SOAP version should either be 1.1 or 1.2. Is by default 1.1", "default" : "1.1", "enum" : [ "1.1", "1.2" ] } } } ], "required" : [ "context-path" ] }, "org.apache.camel.model.dataformat.SwiftMtDataFormat" : { "title" : "SWIFT MT", "description" : "Encode and decode SWIFT MT messages.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "write-in-json" : { "type" : "boolean", "title" : "Write In Json", "description" : "The flag indicating that messages must be marshalled in a JSON format." } } } ] }, "org.apache.camel.model.dataformat.SwiftMxDataFormat" : { "title" : "SWIFT MX", "description" : "Encode and decode SWIFT MX messages.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "read-config-ref" : { "type" : "string", "title" : "Read Config Ref", "description" : "Refers to a specific configuration to use when unmarshalling an input stream to lookup from the registry." }, "read-message-id" : { "type" : "string", "title" : "Read Message Id", "description" : "The type of MX message to produce when unmarshalling an input stream. If not set, it will be automatically detected from the namespace used." }, "write-config-ref" : { "type" : "string", "title" : "Write Config Ref", "description" : "Refers to a specific configuration to use when marshalling a message to lookup from the registry." }, "write-in-json" : { "type" : "boolean", "title" : "Write In Json", "description" : "The flag indicating that messages must be marshalled in a JSON format." } } }, "org.apache.camel.model.dataformat.SyslogDataFormat" : { "title" : "Syslog", "description" : "Marshall SyslogMessages to RFC3164 and RFC5424 messages and back.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.dataformat.TarFileDataFormat" : { "title" : "Tar File", "description" : "Archive files into tarballs or extract files from tarballs.", "type" : "object", "properties" : { "allow-empty-directory" : { "type" : "boolean", "title" : "Allow Empty Directory", "description" : "If the tar file has more than one entry, setting this option to true, allows to get the iterator even if the directory is empty" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "max-decompressed-size" : { "type" : "number", "title" : "Max Decompressed Size", "description" : "Set the maximum decompressed size of a tar file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size.", "default" : "1073741824" }, "preserve-path-elements" : { "type" : "boolean", "title" : "Preserve Path Elements", "description" : "If the file name contains path elements, setting this option to true, allows the path to be maintained in the tar file." }, "using-iterator" : { "type" : "boolean", "title" : "Using Iterator", "description" : "If the tar file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode." } } }, "org.apache.camel.model.dataformat.ThriftDataFormat" : { "title" : "Thrift", "description" : "Serialize and deserialize messages using Apache Thrift binary data format.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "content-type-format" : { "type" : "string", "title" : "Content Type Format", "description" : "Defines a content type format in which thrift message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native binary thrift, json or simple json fields representation. The default value is binary.", "default" : "binary", "enum" : [ "binary", "json", "sjson" ] }, "content-type-header" : { "type" : "boolean", "title" : "Content Type Header", "description" : "Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "instance-class" : { "type" : "string", "title" : "Instance Class", "description" : "Name of class to use when unmarshalling" } } } ] }, "org.apache.camel.model.dataformat.TidyMarkupDataFormat" : { "title" : "TidyMarkup", "description" : "Parse (potentially invalid) HTML into valid HTML or DOM.", "type" : "object", "properties" : { "data-object-type" : { "type" : "string", "title" : "Data Object Type", "description" : "What data type to unmarshal as, can either be org.w3c.dom.Node or java.lang.String. Is by default org.w3c.dom.Node", "default" : "org.w3c.dom.Node", "enum" : [ "org.w3c.dom.Node", "java.lang.String" ] }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "omit-xml-declaration" : { "type" : "boolean", "title" : "Omit Xml Declaration", "description" : "When returning a String, do we omit the XML declaration in the top." } } }, "org.apache.camel.model.dataformat.UniVocityCsvDataFormat" : { "title" : "uniVocity CSV", "description" : "Marshal and unmarshal Java objects from and to CSV (Comma Separated Values) using UniVocity Parsers.", "type" : "object", "properties" : { "as-map" : { "type" : "boolean", "title" : "As Map", "description" : "Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false" }, "comment" : { "type" : "string", "title" : "Comment", "description" : "The comment symbol. The default value is #", "default" : "#" }, "delimiter" : { "type" : "string", "title" : "Delimiter", "description" : "The delimiter of values", "default" : "," }, "empty-value" : { "type" : "string", "title" : "Empty Value", "description" : "The String representation of an empty value" }, "header-extraction-enabled" : { "type" : "boolean", "title" : "Header Extraction Enabled", "description" : "Whether or not the header must be read in the first line of the test document The default value is false" }, "headers-disabled" : { "type" : "boolean", "title" : "Headers Disabled", "description" : "Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ignore-leading-whitespaces" : { "type" : "boolean", "title" : "Ignore Leading Whitespaces", "description" : "Whether or not the leading white spaces must be ignored. The default value is true" }, "ignore-trailing-whitespaces" : { "type" : "boolean", "title" : "Ignore Trailing Whitespaces", "description" : "Whether or not the trailing white spaces must be ignored. The default value is true" }, "lazy-load" : { "type" : "boolean", "title" : "Lazy Load", "description" : "Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false" }, "line-separator" : { "type" : "string", "title" : "Line Separator", "description" : "The line separator of the files The default value is to use the JVM platform line separator" }, "normalized-line-separator" : { "type" : "string", "title" : "Normalized Line Separator", "description" : "The normalized line separator of the files The default value is a new line character.", "default" : "\\n" }, "null-value" : { "type" : "string", "title" : "Null Value", "description" : "The string representation of a null value. The default value is null" }, "number-of-records-to-read" : { "type" : "number", "title" : "Number Of Records To Read", "description" : "The maximum number of record to read." }, "quote" : { "type" : "string", "title" : "Quote", "description" : "The quote symbol.", "default" : "\"" }, "quote-all-fields" : { "type" : "boolean", "title" : "Quote All Fields", "description" : "Whether or not all values must be quoted when writing them." }, "quote-escape" : { "type" : "string", "title" : "Quote Escape", "description" : "The quote escape symbol", "default" : "\"" }, "skip-empty-lines" : { "type" : "boolean", "title" : "Skip Empty Lines", "description" : "Whether or not the empty lines must be ignored. The default value is true" }, "univocity-header" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityHeader" } } } }, "org.apache.camel.model.dataformat.UniVocityFixedDataFormat" : { "title" : "uniVocity Fixed Length", "description" : "Marshal and unmarshal Java objects from and to fixed length records using UniVocity Parsers.", "type" : "object", "properties" : { "as-map" : { "type" : "boolean", "title" : "As Map", "description" : "Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false" }, "comment" : { "type" : "string", "title" : "Comment", "description" : "The comment symbol. The default value is #", "default" : "#" }, "empty-value" : { "type" : "string", "title" : "Empty Value", "description" : "The String representation of an empty value" }, "header-extraction-enabled" : { "type" : "boolean", "title" : "Header Extraction Enabled", "description" : "Whether or not the header must be read in the first line of the test document The default value is false" }, "headers-disabled" : { "type" : "boolean", "title" : "Headers Disabled", "description" : "Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ignore-leading-whitespaces" : { "type" : "boolean", "title" : "Ignore Leading Whitespaces", "description" : "Whether or not the leading white spaces must be ignored. The default value is true" }, "ignore-trailing-whitespaces" : { "type" : "boolean", "title" : "Ignore Trailing Whitespaces", "description" : "Whether or not the trailing white spaces must be ignored. The default value is true" }, "lazy-load" : { "type" : "boolean", "title" : "Lazy Load", "description" : "Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false" }, "line-separator" : { "type" : "string", "title" : "Line Separator", "description" : "The line separator of the files The default value is to use the JVM platform line separator" }, "normalized-line-separator" : { "type" : "string", "title" : "Normalized Line Separator", "description" : "The normalized line separator of the files The default value is a new line character.", "default" : "\\n" }, "null-value" : { "type" : "string", "title" : "Null Value", "description" : "The string representation of a null value. The default value is null" }, "number-of-records-to-read" : { "type" : "number", "title" : "Number Of Records To Read", "description" : "The maximum number of record to read." }, "padding" : { "type" : "string", "title" : "Padding", "description" : "The padding character. The default value is a space" }, "record-ends-on-newline" : { "type" : "boolean", "title" : "Record Ends On Newline", "description" : "Whether or not the record ends on new line. The default value is false" }, "skip-empty-lines" : { "type" : "boolean", "title" : "Skip Empty Lines", "description" : "Whether or not the empty lines must be ignored. The default value is true" }, "skip-trailing-chars-until-newline" : { "type" : "boolean", "title" : "Skip Trailing Chars Until Newline", "description" : "Whether or not the trailing characters until new line must be ignored. The default value is false" }, "univocity-header" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityHeader" } } } }, "org.apache.camel.model.dataformat.UniVocityHeader" : { "title" : "uniVocity Header", "description" : "To configure headers for UniVocity data formats.", "type" : "object", "properties" : { "length" : { "type" : "string", "title" : "Length", "description" : "Header length" }, "name" : { "type" : "string", "title" : "Name", "description" : "Header name" } } }, "org.apache.camel.model.dataformat.UniVocityTsvDataFormat" : { "title" : "uniVocity TSV", "description" : "Marshal and unmarshal Java objects from and to TSV (Tab-Separated Values) records using UniVocity Parsers.", "type" : "object", "properties" : { "as-map" : { "type" : "boolean", "title" : "As Map", "description" : "Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false" }, "comment" : { "type" : "string", "title" : "Comment", "description" : "The comment symbol. The default value is #", "default" : "#" }, "empty-value" : { "type" : "string", "title" : "Empty Value", "description" : "The String representation of an empty value" }, "escape-char" : { "type" : "string", "title" : "Escape Char", "description" : "The escape character.", "default" : "\\" }, "header-extraction-enabled" : { "type" : "boolean", "title" : "Header Extraction Enabled", "description" : "Whether or not the header must be read in the first line of the test document The default value is false" }, "headers-disabled" : { "type" : "boolean", "title" : "Headers Disabled", "description" : "Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ignore-leading-whitespaces" : { "type" : "boolean", "title" : "Ignore Leading Whitespaces", "description" : "Whether or not the leading white spaces must be ignored. The default value is true" }, "ignore-trailing-whitespaces" : { "type" : "boolean", "title" : "Ignore Trailing Whitespaces", "description" : "Whether or not the trailing white spaces must be ignored. The default value is true" }, "lazy-load" : { "type" : "boolean", "title" : "Lazy Load", "description" : "Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false" }, "line-separator" : { "type" : "string", "title" : "Line Separator", "description" : "The line separator of the files The default value is to use the JVM platform line separator" }, "normalized-line-separator" : { "type" : "string", "title" : "Normalized Line Separator", "description" : "The normalized line separator of the files The default value is a new line character.", "default" : "\\n" }, "null-value" : { "type" : "string", "title" : "Null Value", "description" : "The string representation of a null value. The default value is null" }, "number-of-records-to-read" : { "type" : "number", "title" : "Number Of Records To Read", "description" : "The maximum number of record to read." }, "skip-empty-lines" : { "type" : "boolean", "title" : "Skip Empty Lines", "description" : "Whether or not the empty lines must be ignored. The default value is true" }, "univocity-header" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityHeader" } } } }, "org.apache.camel.model.dataformat.XMLSecurityDataFormat" : { "title" : "XML Security", "description" : "Encrypt and decrypt XML payloads using Apache Santuario.", "type" : "object", "properties" : { "add-key-value-for-encrypted-key" : { "type" : "boolean", "title" : "Add Key Value For Encrypted Key", "description" : "Whether to add the public key used to encrypt the session key as a KeyValue in the EncryptedKey structure or not." }, "digest-algorithm" : { "type" : "string", "title" : "Digest Algorithm", "description" : "The digest algorithm to use with the RSA OAEP algorithm. The available choices are: XMLCipher.SHA1 XMLCipher.SHA256 XMLCipher.SHA512 The default value is XMLCipher.SHA1", "default" : "SHA1", "enum" : [ "SHA1", "SHA256", "SHA512" ] }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "key-cipher-algorithm" : { "type" : "string", "title" : "Key Cipher Algorithm", "description" : "The cipher algorithm to be used for encryption/decryption of the asymmetric key. The available choices are: XMLCipher.RSA_v1dot5 XMLCipher.RSA_OAEP XMLCipher.RSA_OAEP_11 The default value is XMLCipher.RSA_OAEP", "default" : "RSA_OAEP", "enum" : [ "RSA_v1dot5", "RSA_OAEP", "RSA_OAEP_11" ] }, "key-or-trust-store-parameters-ref" : { "type" : "string", "title" : "Key Or Trust Store Parameters Ref", "description" : "Refers to a KeyStore instance to lookup in the registry, which is used for configuration options for creating and loading a KeyStore instance that represents the sender's trustStore or recipient's keyStore." }, "key-password" : { "type" : "string", "title" : "Key Password", "description" : "The password to be used for retrieving the private key from the KeyStore. This key is used for asymmetric decryption." }, "mgf-algorithm" : { "type" : "string", "title" : "Mgf Algorithm", "description" : "The MGF Algorithm to use with the RSA OAEP algorithm. The available choices are: EncryptionConstants.MGF1_SHA1 EncryptionConstants.MGF1_SHA256 EncryptionConstants.MGF1_SHA512 The default value is EncryptionConstants.MGF1_SHA1", "default" : "MGF1_SHA1", "enum" : [ "MGF1_SHA1", "MGF1_SHA256", "MGF1_SHA512" ] }, "pass-phrase" : { "type" : "string", "title" : "Pass Phrase", "description" : "A String used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a Only another 24 Byte key" }, "pass-phrase-byte" : { "type" : "string", "title" : "Pass Phrase Byte", "description" : "A byte used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a Only another 24 Byte key", "format" : "binary" }, "recipient-key-alias" : { "type" : "string", "title" : "Recipient Key Alias", "description" : "The key alias to be used when retrieving the recipient's public or private key from a KeyStore when performing asymmetric key encryption or decryption." }, "secure-tag" : { "type" : "string", "title" : "Secure Tag", "description" : "The XPath reference to the XML Element selected for encryption/decryption. If no tag is specified, the entire payload is encrypted/decrypted." }, "secure-tag-contents" : { "type" : "boolean", "title" : "Secure Tag Contents", "description" : "A boolean value to specify whether the XML Element is to be encrypted or the contents of the XML Element. false = Element Level. true = Element Content Level." }, "xml-cipher-algorithm" : { "type" : "string", "title" : "Xml Cipher Algorithm", "description" : "The cipher algorithm to be used for encryption/decryption of the XML message content. The available choices are: XMLCipher.TRIPLEDES XMLCipher.AES_128 XMLCipher.AES_128_GCM XMLCipher.AES_192 XMLCipher.AES_192_GCM XMLCipher.AES_256 XMLCipher.AES_256_GCM XMLCipher.SEED_128 XMLCipher.CAMELLIA_128 XMLCipher.CAMELLIA_192 XMLCipher.CAMELLIA_256 The default value is XMLCipher.AES_256_GCM", "default" : "AES-256-GCM", "enum" : [ "TRIPLEDES", "AES_128", "AES_128_GCM", "AES_192", "AES_192_GCM", "AES_256", "AES_256_GCM", "SEED_128", "CAMELLIA_128", "CAMELLIA_192", "CAMELLIA_256" ] } } }, "org.apache.camel.model.dataformat.YAMLDataFormat" : { "title" : "YAML", "description" : "Marshal and unmarshal Java objects to and from YAML.", "type" : "object", "properties" : { "allow-any-type" : { "type" : "boolean", "title" : "Allow Any Type", "description" : "Allow any class to be un-marshaled" }, "allow-recursive-keys" : { "type" : "boolean", "title" : "Allow Recursive Keys", "description" : "Set whether recursive keys are allowed." }, "constructor" : { "type" : "string", "title" : "Constructor", "description" : "BaseConstructor to construct incoming documents." }, "dumper-options" : { "type" : "string", "title" : "Dumper Options", "description" : "DumperOptions to configure outgoing objects." }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "library" : { "type" : "string", "title" : "Library", "description" : "Which yaml library to use. By default it is SnakeYAML", "default" : "SnakeYAML", "enum" : [ "SnakeYAML" ] }, "max-aliases-for-collections" : { "type" : "number", "title" : "Max Aliases For Collections", "description" : "Set the maximum amount of aliases allowed for collections.", "default" : "50" }, "pretty-flow" : { "type" : "boolean", "title" : "Pretty Flow", "description" : "Force the emitter to produce a pretty YAML document when using the flow style." }, "representer" : { "type" : "string", "title" : "Representer", "description" : "Representer to emit outgoing objects." }, "resolver" : { "type" : "string", "title" : "Resolver", "description" : "Resolver to detect implicit type" }, "type-filter" : { "type" : "array", "title" : "Type Filter", "description" : "Set the types SnakeYAML is allowed to un-marshall", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.YAMLTypeFilterDefinition" } }, "unmarshal-type" : { "type" : "string", "title" : "Unmarshal Type", "description" : "Class name of the java type to use when unmarshalling" }, "use-application-context-class-loader" : { "type" : "boolean", "title" : "Use Application Context Class Loader", "description" : "Use ApplicationContextClassLoader as custom ClassLoader" } } }, "org.apache.camel.model.dataformat.YAMLTypeFilterDefinition" : { "title" : "YAML Type Filter", "type" : "object", "properties" : { "type" : { "type" : "string", "title" : "Type", "description" : "Whether to filter by class type or regular expression" }, "value" : { "type" : "string", "title" : "Value", "description" : "Value of type such as class name or regular expression" } } }, "org.apache.camel.model.dataformat.ZipDeflaterDataFormat" : { "title" : "Zip Deflater", "description" : "Compress and decompress streams using java.util.zip.Deflater and java.util.zip.Inflater.", "type" : "object", "properties" : { "compression-level" : { "type" : "string", "title" : "Compression Level", "description" : "To specify a specific compression between 0-9. -1 is default compression, 0 is no compression, and 9 is the best compression.", "default" : "-1", "enum" : [ "-1", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9" ] }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.dataformat.ZipFileDataFormat" : { "title" : "Zip File", "description" : "Compression and decompress streams using java.util.zip.ZipStream.", "type" : "object", "properties" : { "allow-empty-directory" : { "type" : "boolean", "title" : "Allow Empty Directory", "description" : "If the zip file has more than one entry, setting this option to true, allows to get the iterator even if the directory is empty" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "max-decompressed-size" : { "type" : "number", "title" : "Max Decompressed Size", "description" : "Set the maximum decompressed size of a zip file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size.", "default" : "1073741824" }, "preserve-path-elements" : { "type" : "boolean", "title" : "Preserve Path Elements", "description" : "If the file name contains path elements, setting this option to true, allows the path to be maintained in the zip file." }, "using-iterator" : { "type" : "boolean", "title" : "Using Iterator", "description" : "If the zip file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode." } } }, "org.apache.camel.model.errorhandler.DeadLetterChannelDefinition" : { "title" : "Dead Letter Channel", "description" : "Error handler with dead letter queue.", "type" : "object", "properties" : { "dead-letter-handle-new-exception" : { "type" : "boolean", "title" : "Dead Letter Handle New Exception", "description" : "Whether the dead letter channel should handle (and ignore) any new exception that may been thrown during sending the message to the dead letter endpoint. The default value is true which means any such kind of exception is handled and ignored. Set this to false to let the exception be propagated back on the org.apache.camel.Exchange . This can be used in situations where you use transactions, and want to use Camel's dead letter channel to deal with exceptions during routing, but if the dead letter channel itself fails because of a new exception being thrown, then by setting this to false the new exceptions is propagated back and set on the org.apache.camel.Exchange , which allows the transaction to detect the exception, and rollback." }, "dead-letter-uri" : { "type" : "string", "title" : "Dead Letter Uri", "description" : "The dead letter endpoint uri for the Dead Letter error handler." }, "executor-service-ref" : { "type" : "string", "title" : "Executor Service Ref", "description" : "Sets a reference to a thread pool to be used by the error handler" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "level" : { "type" : "string", "title" : "Level", "description" : "Logging level to use when using the logging error handler type.", "default" : "ERROR", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "log-name" : { "type" : "string", "title" : "Log Name", "description" : "Name of the logger to use for the logging error handler" }, "logger-ref" : { "type" : "string", "title" : "Logger Ref", "description" : "References to a logger to use as logger for the error handler" }, "on-exception-occurred-ref" : { "type" : "string", "title" : "On Exception Occurred Ref", "description" : "Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened. Important: Any exception thrown from this processor will be ignored." }, "on-prepare-failure-ref" : { "type" : "string", "title" : "On Prepare Failure Ref", "description" : "Sets a reference to a processor to prepare the org.apache.camel.Exchange before handled by the failure processor / dead letter channel. This allows for example to enrich the message before sending to a dead letter queue." }, "on-redelivery-ref" : { "type" : "string", "title" : "On Redelivery Ref", "description" : "Sets a reference to a processor that should be processed before a redelivery attempt. Can be used to change the org.apache.camel.Exchange before its being redelivered." }, "redelivery-policy" : { "title" : "Redelivery Policy", "description" : "Sets the redelivery settings", "$ref" : "#/items/definitions/org.apache.camel.model.RedeliveryPolicyDefinition" }, "redelivery-policy-ref" : { "type" : "string", "title" : "Redelivery Policy Ref", "description" : "Sets a reference to a RedeliveryPolicy to be used for redelivery settings." }, "retry-while-ref" : { "type" : "string", "title" : "Retry While Ref", "description" : "Sets a retry while predicate. Will continue retrying until the predicate evaluates to false." }, "use-original-body" : { "type" : "boolean", "title" : "Use Original Body", "description" : "Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." }, "use-original-message" : { "type" : "boolean", "title" : "Use Original Message", "description" : "Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." } }, "required" : [ "dead-letter-uri" ] }, "org.apache.camel.model.errorhandler.DefaultErrorHandlerDefinition" : { "title" : "Default Error Handler", "description" : "The default error handler.", "type" : "object", "properties" : { "executor-service-ref" : { "type" : "string", "title" : "Executor Service Ref", "description" : "Sets a reference to a thread pool to be used by the error handler" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "level" : { "type" : "string", "title" : "Level", "description" : "Logging level to use when using the logging error handler type.", "default" : "ERROR", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "log-name" : { "type" : "string", "title" : "Log Name", "description" : "Name of the logger to use for the logging error handler" }, "logger-ref" : { "type" : "string", "title" : "Logger Ref", "description" : "References to a logger to use as logger for the error handler" }, "on-exception-occurred-ref" : { "type" : "string", "title" : "On Exception Occurred Ref", "description" : "Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened. Important: Any exception thrown from this processor will be ignored." }, "on-prepare-failure-ref" : { "type" : "string", "title" : "On Prepare Failure Ref", "description" : "Sets a reference to a processor to prepare the org.apache.camel.Exchange before handled by the failure processor / dead letter channel. This allows for example to enrich the message before sending to a dead letter queue." }, "on-redelivery-ref" : { "type" : "string", "title" : "On Redelivery Ref", "description" : "Sets a reference to a processor that should be processed before a redelivery attempt. Can be used to change the org.apache.camel.Exchange before its being redelivered." }, "redelivery-policy" : { "title" : "Redelivery Policy", "description" : "Sets the redelivery settings", "$ref" : "#/items/definitions/org.apache.camel.model.RedeliveryPolicyDefinition" }, "redelivery-policy-ref" : { "type" : "string", "title" : "Redelivery Policy Ref", "description" : "Sets a reference to a RedeliveryPolicy to be used for redelivery settings." }, "retry-while-ref" : { "type" : "string", "title" : "Retry While Ref", "description" : "Sets a retry while predicate. Will continue retrying until the predicate evaluates to false." }, "use-original-body" : { "type" : "boolean", "title" : "Use Original Body", "description" : "Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." }, "use-original-message" : { "type" : "boolean", "title" : "Use Original Message", "description" : "Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." } } }, "org.apache.camel.model.errorhandler.JtaTransactionErrorHandlerDefinition" : { "title" : "Jta Transaction Error Handler", "description" : "JTA based transactional error handler (requires camel-jta).", "type" : "object", "properties" : { "executor-service-ref" : { "type" : "string", "title" : "Executor Service Ref", "description" : "Sets a reference to a thread pool to be used by the error handler" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "level" : { "type" : "string", "title" : "Level", "description" : "Logging level to use when using the logging error handler type.", "default" : "ERROR", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "log-name" : { "type" : "string", "title" : "Log Name", "description" : "Name of the logger to use for the logging error handler" }, "logger-ref" : { "type" : "string", "title" : "Logger Ref", "description" : "References to a logger to use as logger for the error handler" }, "on-exception-occurred-ref" : { "type" : "string", "title" : "On Exception Occurred Ref", "description" : "Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened. Important: Any exception thrown from this processor will be ignored." }, "on-prepare-failure-ref" : { "type" : "string", "title" : "On Prepare Failure Ref", "description" : "Sets a reference to a processor to prepare the org.apache.camel.Exchange before handled by the failure processor / dead letter channel. This allows for example to enrich the message before sending to a dead letter queue." }, "on-redelivery-ref" : { "type" : "string", "title" : "On Redelivery Ref", "description" : "Sets a reference to a processor that should be processed before a redelivery attempt. Can be used to change the org.apache.camel.Exchange before its being redelivered." }, "redelivery-policy" : { "title" : "Redelivery Policy", "description" : "Sets the redelivery settings", "$ref" : "#/items/definitions/org.apache.camel.model.RedeliveryPolicyDefinition" }, "redelivery-policy-ref" : { "type" : "string", "title" : "Redelivery Policy Ref", "description" : "Sets a reference to a RedeliveryPolicy to be used for redelivery settings." }, "retry-while-ref" : { "type" : "string", "title" : "Retry While Ref", "description" : "Sets a retry while predicate. Will continue retrying until the predicate evaluates to false." }, "rollback-logging-level" : { "type" : "string", "title" : "Rollback Logging Level", "description" : "Sets the logging level to use for logging transactional rollback. This option is default WARN.", "default" : "WARN", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "transacted-policy-ref" : { "type" : "string", "title" : "Transacted Policy Ref", "description" : "The transacted policy to use that is configured for either Spring or JTA based transactions. If no policy has been configured then Camel will attempt to auto-discover." }, "use-original-body" : { "type" : "boolean", "title" : "Use Original Body", "description" : "Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." }, "use-original-message" : { "type" : "boolean", "title" : "Use Original Message", "description" : "Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." } } }, "org.apache.camel.model.errorhandler.NoErrorHandlerDefinition" : { "title" : "No Error Handler", "description" : "To not use an error handler.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.errorhandler.RefErrorHandlerDefinition" : { "title" : "Ref Error Handler", "description" : "References to an existing or custom error handler.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "References to an existing or custom error handler." } } } ], "required" : [ "ref" ] }, "org.apache.camel.model.errorhandler.SpringTransactionErrorHandlerDefinition" : { "title" : "Spring Transaction Error Handler", "description" : "Spring based transactional error handler (requires camel-spring).", "type" : "object", "properties" : { "executor-service-ref" : { "type" : "string", "title" : "Executor Service Ref", "description" : "Sets a reference to a thread pool to be used by the error handler" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "level" : { "type" : "string", "title" : "Level", "description" : "Logging level to use when using the logging error handler type.", "default" : "ERROR", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "log-name" : { "type" : "string", "title" : "Log Name", "description" : "Name of the logger to use for the logging error handler" }, "logger-ref" : { "type" : "string", "title" : "Logger Ref", "description" : "References to a logger to use as logger for the error handler" }, "on-exception-occurred-ref" : { "type" : "string", "title" : "On Exception Occurred Ref", "description" : "Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened. Important: Any exception thrown from this processor will be ignored." }, "on-prepare-failure-ref" : { "type" : "string", "title" : "On Prepare Failure Ref", "description" : "Sets a reference to a processor to prepare the org.apache.camel.Exchange before handled by the failure processor / dead letter channel. This allows for example to enrich the message before sending to a dead letter queue." }, "on-redelivery-ref" : { "type" : "string", "title" : "On Redelivery Ref", "description" : "Sets a reference to a processor that should be processed before a redelivery attempt. Can be used to change the org.apache.camel.Exchange before its being redelivered." }, "redelivery-policy" : { "title" : "Redelivery Policy", "description" : "Sets the redelivery settings", "$ref" : "#/items/definitions/org.apache.camel.model.RedeliveryPolicyDefinition" }, "redelivery-policy-ref" : { "type" : "string", "title" : "Redelivery Policy Ref", "description" : "Sets a reference to a RedeliveryPolicy to be used for redelivery settings." }, "retry-while-ref" : { "type" : "string", "title" : "Retry While Ref", "description" : "Sets a retry while predicate. Will continue retrying until the predicate evaluates to false." }, "rollback-logging-level" : { "type" : "string", "title" : "Rollback Logging Level", "description" : "Sets the logging level to use for logging transactional rollback. This option is default WARN.", "default" : "WARN", "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ] }, "transacted-policy-ref" : { "type" : "string", "title" : "Transacted Policy Ref", "description" : "The transacted policy to use that is configured for either Spring or JTA based transactions. If no policy has been configured then Camel will attempt to auto-discover." }, "use-original-body" : { "type" : "boolean", "title" : "Use Original Body", "description" : "Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." }, "use-original-message" : { "type" : "boolean", "title" : "Use Original Message", "description" : "Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off." } } }, "org.apache.camel.model.language.CSimpleExpression" : { "title" : "CSimple", "description" : "Evaluate a compiled simple expression.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.ConstantExpression" : { "title" : "Constant", "description" : "A fixed value set only once during the route startup.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.DatasonnetExpression" : { "title" : "DataSonnet", "description" : "To use DataSonnet scripts for message transformations.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "body-media-type" : { "type" : "string", "title" : "Body Media Type", "description" : "The String representation of the message's body MediaType" }, "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "output-media-type" : { "type" : "string", "title" : "Output Media Type", "description" : "The String representation of the MediaType to output" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.ExchangePropertyExpression" : { "title" : "ExchangeProperty", "description" : "Gets a property from the Exchange.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.ExpressionDefinition" : { "type" : "object", "properties" : { "constant" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ConstantExpression" }, "csimple" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.CSimpleExpression" }, "datasonnet" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.DatasonnetExpression" }, "exchange-property" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExchangePropertyExpression" }, "exchangeProperty" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExchangePropertyExpression" }, "groovy" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.GroovyExpression" }, "header" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.HeaderExpression" }, "hl7terser" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.Hl7TerserExpression" }, "joor" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JoorExpression" }, "jq" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JqExpression" }, "js" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JavaScriptExpression" }, "jsonpath" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.JsonPathExpression" }, "language" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.LanguageExpression" }, "method" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.MethodCallExpression" }, "mvel" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.MvelExpression" }, "ognl" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.OgnlExpression" }, "python" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.PythonExpression" }, "ref" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.RefExpression" }, "simple" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.SimpleExpression" }, "spel" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.SpELExpression" }, "tokenize" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.TokenizerExpression" }, "xpath" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.XPathExpression" }, "xquery" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.XQueryExpression" }, "xtokenize" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.XMLTokenizerExpression" } } }, "org.apache.camel.model.language.GroovyExpression" : { "title" : "Groovy", "description" : "Evaluates a Groovy script.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.HeaderExpression" : { "title" : "Header", "description" : "Gets a header from the Exchange.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.Hl7TerserExpression" : { "title" : "HL7 Terser", "description" : "Get the value of a HL7 message field specified by terse location specification syntax.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "header-name" : { "type" : "string", "title" : "Header Name", "description" : "Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "property-name" : { "type" : "string", "title" : "Property Name", "description" : "Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set." }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.JavaScriptExpression" : { "title" : "JavaScript", "description" : "Evaluates a JavaScript expression.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.JoorExpression" : { "title" : "jOOR", "description" : "Evaluates a jOOR (Java compiled once at runtime) expression.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "pre-compile" : { "type" : "boolean", "title" : "Pre Compile", "description" : "Whether the expression should be pre compiled once during initialization phase. If this is turned off, then the expression is reloaded and compiled on each evaluation." }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "single-quotes" : { "type" : "boolean", "title" : "Single Quotes", "description" : "Whether single quotes can be used as replacement for double quotes. This is convenient when you need to work with strings inside strings." }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.JqExpression" : { "title" : "JQ", "description" : "Evaluates a JQ expression against a JSON message body.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "header-name" : { "type" : "string", "title" : "Header Name", "description" : "Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "property-name" : { "type" : "string", "title" : "Property Name", "description" : "Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set." }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.JsonPathExpression" : { "title" : "JSONPath", "description" : "Evaluates a JSONPath expression against a JSON message body.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "allow-easy-predicate" : { "type" : "boolean", "title" : "Allow Easy Predicate", "description" : "Whether to allow using the easy predicate parser to pre-parse predicates." }, "allow-simple" : { "type" : "boolean", "title" : "Allow Simple", "description" : "Whether to allow in inlined Simple exceptions in the JSONPath expression" }, "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "header-name" : { "type" : "string", "title" : "Header Name", "description" : "Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "option" : { "type" : "string", "title" : "Option", "description" : "To configure additional options on JSONPath. Multiple values can be separated by comma.", "enum" : [ "DEFAULT_PATH_LEAF_TO_NULL", "ALWAYS_RETURN_LIST", "AS_PATH_LIST", "SUPPRESS_EXCEPTIONS", "REQUIRE_PROPERTIES" ] }, "property-name" : { "type" : "string", "title" : "Property Name", "description" : "Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set." }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "suppress-exceptions" : { "type" : "boolean", "title" : "Suppress Exceptions", "description" : "Whether to suppress exceptions such as PathNotFoundException." }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" }, "unpack-array" : { "type" : "boolean", "title" : "Unpack Array", "description" : "Whether to unpack a single element json-array into an object." }, "write-as-string" : { "type" : "boolean", "title" : "Write As String", "description" : "Whether to write the output of each row/element as a JSON String value instead of a Map/POJO value." } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.LanguageExpression" : { "title" : "Language", "description" : "Evaluates a custom language.", "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "language" : { "type" : "string", "title" : "Language", "description" : "The name of the language to use" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } }, "required" : [ "expression", "language" ] }, "org.apache.camel.model.language.MethodCallExpression" : { "title" : "Bean Method", "description" : "Calls a Java bean method.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "bean-type" : { "type" : "string", "title" : "Bean Type", "description" : "Class name (fully qualified) of the bean to use Will lookup in registry and if there is a single instance of the same type, then the existing bean is used, otherwise a new bean is created (requires a default no-arg constructor)." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "method" : { "type" : "string", "title" : "Method", "description" : "Name of method to call" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Reference to an existing bean (bean id) to lookup in the registry" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "scope" : { "type" : "string", "title" : "Scope", "description" : "Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. So when using prototype scope then this depends on the bean registry implementation.", "default" : "Singleton", "enum" : [ "Singleton", "Request", "Prototype" ] }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ] }, "org.apache.camel.model.language.MvelExpression" : { "title" : "MVEL", "description" : "Evaluates a MVEL template.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.OgnlExpression" : { "title" : "OGNL", "description" : "Evaluates an OGNL expression (Apache Commons OGNL).", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.PythonExpression" : { "title" : "Python", "description" : "Evaluates a Python expression.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.RefExpression" : { "title" : "Ref", "description" : "Uses an existing expression from the registry.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.SimpleExpression" : { "title" : "Simple", "description" : "Evaluates a Camel simple expression.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.SpELExpression" : { "title" : "SpEL", "description" : "Evaluates a Spring expression (SpEL).", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.TokenizerExpression" : { "title" : "Tokenize", "description" : "Tokenize text payloads using delimiter patterns.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "end-token" : { "type" : "string", "title" : "End Token", "description" : "The end token to use as tokenizer if using start/end token pairs. You can use simple language as the token to support dynamic tokens." }, "group" : { "type" : "string", "title" : "Group", "description" : "To group N parts together, for example to split big files into chunks of 1000 lines. You can use simple language as the group to support dynamic group sizes." }, "group-delimiter" : { "type" : "string", "title" : "Group Delimiter", "description" : "Sets the delimiter to use when grouping. If this has not been set then token will be used as the delimiter." }, "header-name" : { "type" : "string", "title" : "Header Name", "description" : "Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "include-tokens" : { "type" : "boolean", "title" : "Include Tokens", "description" : "Whether to include the tokens in the parts when using pairs. When including tokens then the endToken property must also be configured (to use pair mode). The default value is false" }, "inherit-namespace-tag-name" : { "type" : "string", "title" : "Inherit Namespace Tag Name", "description" : "To inherit namespaces from a root/parent tag name when using XML You can use simple language as the tag name to support dynamic names." }, "property-name" : { "type" : "string", "title" : "Property Name", "description" : "Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set." }, "regex" : { "type" : "boolean", "title" : "Regex", "description" : "If the token is a regular expression pattern. The default value is false" }, "skip-first" : { "type" : "boolean", "title" : "Skip First", "description" : "To skip the very first element" }, "token" : { "type" : "string", "title" : "Token", "description" : "The (start) token to use as tokenizer, for example you can use the new line token. You can use simple language as the token to support dynamic tokens." }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" }, "xml" : { "type" : "boolean", "title" : "Xml", "description" : "Whether the input is XML messages. This option must be set to true if working with XML payloads." } } } ], "required" : [ "token" ] }, "org.apache.camel.model.language.XMLTokenizerExpression" : { "title" : "XML Tokenize", "description" : "Tokenize XML payloads.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "group" : { "type" : "number", "title" : "Group", "description" : "To group N parts together" }, "header-name" : { "type" : "string", "title" : "Header Name", "description" : "Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "mode" : { "type" : "string", "title" : "Mode", "description" : "The extraction mode. The available extraction modes are: i - injecting the contextual namespace bindings into the extracted token (default) w - wrapping the extracted token in its ancestor context u - unwrapping the extracted token to its child content t - extracting the text content of the specified element", "default" : "i", "enum" : [ "i", "w", "u", "t" ] }, "namespace" : { "type" : "array", "title" : "Namespace", "description" : "Injects the XML Namespaces of prefix - uri mappings", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "property-name" : { "type" : "string", "title" : "Property Name", "description" : "Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set." }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.XPathExpression" : { "title" : "XPath", "description" : "Evaluates an XPath expression against an XML payload.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "document-type" : { "type" : "string", "title" : "Document Type", "description" : "Name of class for document type The default value is org.w3c.dom.Document" }, "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "factory-ref" : { "type" : "string", "title" : "Factory Ref", "description" : "References to a custom XPathFactory to lookup in the registry" }, "header-name" : { "type" : "string", "title" : "Header Name", "description" : "Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "log-namespaces" : { "type" : "boolean", "title" : "Log Namespaces", "description" : "Whether to log namespaces which can assist during troubleshooting" }, "namespace" : { "type" : "array", "title" : "Namespace", "description" : "Injects the XML Namespaces of prefix - uri mappings", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "object-model" : { "type" : "string", "title" : "Object Model", "description" : "The XPath object model to use" }, "pre-compile" : { "type" : "boolean", "title" : "Pre Compile", "description" : "Whether to enable pre-compiling the xpath expression during initialization phase. pre-compile is enabled by default. This can be used to turn off, for example in cases the compilation phase is desired at the starting phase, such as if the application is ahead of time compiled (for example with camel-quarkus) which would then load the xpath factory of the built operating system, and not a JVM runtime." }, "property-name" : { "type" : "string", "title" : "Property Name", "description" : "Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set." }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class name of the result type (type from output) The default result type is NodeSet", "default" : "NODESET", "enum" : [ "NUMBER", "STRING", "BOOLEAN", "NODESET", "NODE" ] }, "saxon" : { "type" : "boolean", "title" : "Saxon", "description" : "Whether to use Saxon." }, "thread-safety" : { "type" : "boolean", "title" : "Thread Safety", "description" : "Whether to enable thread-safety for the returned result of the xpath expression. This applies to when using NODESET as the result type, and the returned set has multiple elements. In this situation there can be thread-safety issues if you process the NODESET concurrently such as from a Camel Splitter EIP in parallel processing mode. This option prevents concurrency issues by doing defensive copies of the nodes. It is recommended to turn this option on if you are using camel-saxon or Saxon in your application. Saxon has thread-safety issues which can be prevented by turning this option on." }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.language.XQueryExpression" : { "title" : "XQuery", "description" : "Evaluates an XQuery expressions against an XML payload.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "configuration-ref" : { "type" : "string", "title" : "Configuration Ref", "description" : "Reference to a saxon configuration instance in the registry to use for xquery (requires camel-saxon). This may be needed to add custom functions to a saxon configuration, so these custom functions can be used in xquery expressions." }, "expression" : { "type" : "string", "title" : "Expression", "description" : "The expression value in your chosen language syntax" }, "header-name" : { "type" : "string", "title" : "Header Name", "description" : "Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set." }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "namespace" : { "type" : "array", "title" : "Namespace", "description" : "Injects the XML Namespaces of prefix - uri mappings", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.PropertyDefinition" } }, "property-name" : { "type" : "string", "title" : "Property Name", "description" : "Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set." }, "result-type" : { "type" : "string", "title" : "Result Type", "description" : "Sets the class of the result type (type from output)" }, "trim" : { "type" : "boolean", "title" : "Trim", "description" : "Whether to trim the value to remove leading and trailing whitespaces and line breaks" }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name of the result type (type from output) The default result type is NodeSet" } } } ], "required" : [ "expression" ] }, "org.apache.camel.model.loadbalancer.CustomLoadBalancerDefinition" : { "title" : "Custom Load Balancer", "description" : "To use a custom load balancer implementation.", "oneOf" : [ { "type" : "string" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "ref" : { "type" : "string", "title" : "Ref", "description" : "Refers to the custom load balancer to lookup from the registry" } } } ], "required" : [ "ref" ] }, "org.apache.camel.model.loadbalancer.FailoverLoadBalancerDefinition" : { "title" : "Failover", "description" : "In case of failures the exchange will be tried on the next endpoint.", "type" : "object", "properties" : { "exception" : { "type" : "array", "title" : "Exception", "description" : "A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored", "items" : { "type" : "string" } }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "maximum-failover-attempts" : { "type" : "string", "title" : "Maximum Failover Attempts", "description" : "A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be used whether or not roundRobin is enabled or not.", "default" : "-1" }, "round-robin" : { "type" : "string", "title" : "Round Robin", "description" : "Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will continue with the next endpoint in a round robin fashion. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balancing (instead of using the next when starting)." }, "sticky" : { "type" : "string", "title" : "Sticky", "description" : "Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the last known good endpoint. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balancing (instead of using the next when starting)." } } }, "org.apache.camel.model.loadbalancer.RandomLoadBalancerDefinition" : { "title" : "Random", "description" : "The destination endpoints are selected by random.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.loadbalancer.RoundRobinLoadBalancerDefinition" : { "title" : "Round Robin", "description" : "The destination endpoints are selected in a round-robin fashion. This is a well known and classic policy, which spreads the load evenly.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.loadbalancer.StickyLoadBalancerDefinition" : { "title" : "Sticky", "description" : "Sticky load balancing using an expression to calculate a correlation key to perform the sticky load balancing.", "type" : "object", "properties" : { "correlation-expression" : { "title" : "Correlation Expression", "description" : "The correlation expression to use to calculate the correlation key", "$ref" : "#/items/definitions/org.apache.camel.model.ExpressionSubElementDefinition" }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.loadbalancer.TopicLoadBalancerDefinition" : { "title" : "Topic", "description" : "Topic which sends to all destinations.", "type" : "object", "properties" : { "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" } } }, "org.apache.camel.model.loadbalancer.WeightedLoadBalancerDefinition" : { "title" : "Weighted", "description" : "Uses a weighted load distribution ratio for each server with respect to others.", "type" : "object", "properties" : { "distribution-ratio" : { "type" : "string", "title" : "Distribution Ratio", "description" : "The distribution ratio is a delimited String consisting on integer weights separated by delimiters for example 2,3,5. The distributionRatio must match the number of endpoints and/or processors specified in the load balancer list." }, "distribution-ratio-delimiter" : { "type" : "string", "title" : "Distribution Ratio Delimiter", "description" : "Delimiter used to specify the distribution ratio. The default value is , (comma)", "default" : "," }, "id" : { "type" : "string", "title" : "Id", "description" : "The id of this node" }, "round-robin" : { "type" : "boolean", "title" : "Round Robin", "description" : "To enable round robin mode. By default the weighted distribution mode is used. The default value is false." } }, "required" : [ "distribution-ratio" ] }, "org.apache.camel.model.rest.ApiKeyDefinition" : { "title" : "Api Key", "description" : "Rest security basic auth definition", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Description", "description" : "A short description for security scheme." }, "in-cookie" : { "type" : "boolean", "title" : "In Cookie", "description" : "To use a cookie as the location of the API key." }, "in-header" : { "type" : "boolean", "title" : "In Header", "description" : "To use header as the location of the API key." }, "in-query" : { "type" : "boolean", "title" : "In Query", "description" : "To use query parameter as the location of the API key." }, "key" : { "type" : "string", "title" : "Key", "description" : "Key used to refer to this security definition" }, "name" : { "type" : "string", "title" : "Name", "description" : "The name of the header or query parameter to be used." } }, "required" : [ "key", "name" ] }, "org.apache.camel.model.rest.BasicAuthDefinition" : { "title" : "Basic Auth", "description" : "Rest security basic auth definition", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Description", "description" : "A short description for security scheme." }, "key" : { "type" : "string", "title" : "Key", "description" : "Key used to refer to this security definition" } }, "required" : [ "key" ] }, "org.apache.camel.model.rest.BearerTokenDefinition" : { "title" : "Bearer Token", "description" : "Rest security bearer token authentication definition", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Description", "description" : "A short description for security scheme." }, "format" : { "type" : "string", "title" : "Format", "description" : "A hint to the client to identify how the bearer token is formatted." }, "key" : { "type" : "string", "title" : "Key", "description" : "Key used to refer to this security definition" } }, "required" : [ "key" ] }, "org.apache.camel.model.rest.DeleteDefinition" : { "title" : "Delete", "description" : "Rest DELETE command", "type" : "object", "properties" : { "api-docs" : { "type" : "boolean", "title" : "Api Docs", "description" : "Whether to include or exclude this rest operation in API documentation. The default value is true." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level" }, "deprecated" : { "type" : "boolean", "title" : "Deprecated", "description" : "Marks this rest operation as deprecated in OpenApi documentation." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime." }, "enable-cors" : { "type" : "boolean" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "out-type" : { "type" : "string", "title" : "Out Type", "description" : "Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." }, "param" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ParamDefinition" } }, "path" : { "type" : "string", "title" : "Path", "description" : "The path mapping URIs of this REST operation such as /{id}." }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level" }, "response-message" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ResponseMessageDefinition" } }, "route-id" : { "type" : "string", "title" : "Route Id", "description" : "Sets the id of the route" }, "security" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.SecurityDefinition" } }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level" }, "to" : { "title" : "To", "description" : "The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.", "$ref" : "#/items/definitions/org.apache.camel.model.ToDefinition" }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." } } }, "org.apache.camel.model.rest.GetDefinition" : { "title" : "Get", "description" : "Rest GET command", "type" : "object", "properties" : { "api-docs" : { "type" : "boolean", "title" : "Api Docs", "description" : "Whether to include or exclude this rest operation in API documentation. The default value is true." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level" }, "deprecated" : { "type" : "boolean", "title" : "Deprecated", "description" : "Marks this rest operation as deprecated in OpenApi documentation." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime." }, "enable-cors" : { "type" : "boolean" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "out-type" : { "type" : "string", "title" : "Out Type", "description" : "Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." }, "param" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ParamDefinition" } }, "path" : { "type" : "string", "title" : "Path", "description" : "The path mapping URIs of this REST operation such as /{id}." }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level" }, "response-message" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ResponseMessageDefinition" } }, "route-id" : { "type" : "string", "title" : "Route Id", "description" : "Sets the id of the route" }, "security" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.SecurityDefinition" } }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level" }, "to" : { "title" : "To", "description" : "The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.", "$ref" : "#/items/definitions/org.apache.camel.model.ToDefinition" }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." } } }, "org.apache.camel.model.rest.HeadDefinition" : { "title" : "Head", "description" : "Rest HEAD command", "type" : "object", "properties" : { "api-docs" : { "type" : "boolean", "title" : "Api Docs", "description" : "Whether to include or exclude this rest operation in API documentation. The default value is true." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level" }, "deprecated" : { "type" : "boolean", "title" : "Deprecated", "description" : "Marks this rest operation as deprecated in OpenApi documentation." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime." }, "enable-cors" : { "type" : "boolean" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "out-type" : { "type" : "string", "title" : "Out Type", "description" : "Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." }, "param" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ParamDefinition" } }, "path" : { "type" : "string", "title" : "Path", "description" : "The path mapping URIs of this REST operation such as /{id}." }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level" }, "response-message" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ResponseMessageDefinition" } }, "route-id" : { "type" : "string", "title" : "Route Id", "description" : "Sets the id of the route" }, "security" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.SecurityDefinition" } }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level" }, "to" : { "title" : "To", "description" : "The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.", "$ref" : "#/items/definitions/org.apache.camel.model.ToDefinition" }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." } } }, "org.apache.camel.model.rest.MutualTLSDefinition" : { "title" : "Mutual TLS", "description" : "Rest security mutual TLS authentication definition", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Description", "description" : "A short description for security scheme." }, "key" : { "type" : "string", "title" : "Key", "description" : "Key used to refer to this security definition" } }, "required" : [ "key" ] }, "org.apache.camel.model.rest.OAuth2Definition" : { "title" : "Oauth2", "description" : "Rest security OAuth2 definition", "type" : "object", "properties" : { "authorization-url" : { "type" : "string", "title" : "Authorization Url", "description" : "The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Required for implicit and access code flows" }, "description" : { "type" : "string", "title" : "Description", "description" : "A short description for security scheme." }, "flow" : { "type" : "string", "title" : "Flow", "description" : "The flow used by the OAuth2 security scheme. Valid values are implicit, password, application or accessCode.", "enum" : [ "implicit", "password", "application", "clientCredentials", "accessCode", "authorizationCode" ] }, "key" : { "type" : "string", "title" : "Key", "description" : "Key used to refer to this security definition" }, "refresh-url" : { "type" : "string", "title" : "Refresh Url", "description" : "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL." }, "scopes" : { "type" : "array", "title" : "Scopes", "description" : "The available scopes for an OAuth2 security scheme", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "token-url" : { "type" : "string", "title" : "Token Url", "description" : "The token URL to be used for this flow. This SHOULD be in the form of a URL. Required for password, application, and access code flows." } }, "required" : [ "key" ] }, "org.apache.camel.model.rest.OpenIdConnectDefinition" : { "title" : "Open Id Connect", "description" : "Rest security OpenID Connect definition", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Description", "description" : "A short description for security scheme." }, "key" : { "type" : "string", "title" : "Key", "description" : "Key used to refer to this security definition" }, "url" : { "type" : "string", "title" : "Url", "description" : "OpenId Connect URL to discover OAuth2 configuration values." } }, "required" : [ "key", "url" ] }, "org.apache.camel.model.rest.ParamDefinition" : { "title" : "Param", "description" : "To specify the rest operation parameters.", "type" : "object", "properties" : { "allowable-values" : { "type" : "array", "title" : "Allowable Values", "description" : "Sets the parameter list of allowable values (enum).", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ValueDefinition" } }, "array-type" : { "type" : "string", "title" : "Array Type", "description" : "Sets the parameter array type. Required if data type is array. Describes the type of items in the array.", "default" : "string" }, "collection-format" : { "type" : "string", "title" : "Collection Format", "description" : "Sets the parameter collection format.", "default" : "csv", "enum" : [ "csv", "multi", "pipes", "ssv", "tsv" ] }, "data-format" : { "type" : "string", "title" : "Data Format", "description" : "Sets the parameter data format." }, "data-type" : { "type" : "string", "title" : "Data Type", "description" : "Sets the parameter data type.", "default" : "string" }, "default-value" : { "type" : "string", "title" : "Default Value", "description" : "Sets the parameter default value." }, "description" : { "type" : "string", "title" : "Description", "description" : "Sets the parameter description." }, "examples" : { "type" : "array", "title" : "Examples", "description" : "Sets the parameter examples.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "name" : { "type" : "string", "title" : "Name", "description" : "Sets the parameter name." }, "required" : { "type" : "boolean", "title" : "Required", "description" : "Sets the parameter required flag." }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the parameter type.", "default" : "path", "enum" : [ "body", "formData", "header", "path", "query" ] } }, "required" : [ "name" ] }, "org.apache.camel.model.rest.PatchDefinition" : { "title" : "Patch", "description" : "Rest PATCH command", "type" : "object", "properties" : { "api-docs" : { "type" : "boolean", "title" : "Api Docs", "description" : "Whether to include or exclude this rest operation in API documentation. The default value is true." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level" }, "deprecated" : { "type" : "boolean", "title" : "Deprecated", "description" : "Marks this rest operation as deprecated in OpenApi documentation." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime." }, "enable-cors" : { "type" : "boolean" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "out-type" : { "type" : "string", "title" : "Out Type", "description" : "Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." }, "param" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ParamDefinition" } }, "path" : { "type" : "string", "title" : "Path", "description" : "The path mapping URIs of this REST operation such as /{id}." }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level" }, "response-message" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ResponseMessageDefinition" } }, "route-id" : { "type" : "string", "title" : "Route Id", "description" : "Sets the id of the route" }, "security" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.SecurityDefinition" } }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level" }, "to" : { "title" : "To", "description" : "The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.", "$ref" : "#/items/definitions/org.apache.camel.model.ToDefinition" }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." } } }, "org.apache.camel.model.rest.PostDefinition" : { "title" : "Post", "description" : "Rest POST command", "type" : "object", "properties" : { "api-docs" : { "type" : "boolean", "title" : "Api Docs", "description" : "Whether to include or exclude this rest operation in API documentation. The default value is true." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level" }, "deprecated" : { "type" : "boolean", "title" : "Deprecated", "description" : "Marks this rest operation as deprecated in OpenApi documentation." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime." }, "enable-cors" : { "type" : "boolean" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "out-type" : { "type" : "string", "title" : "Out Type", "description" : "Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." }, "param" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ParamDefinition" } }, "path" : { "type" : "string", "title" : "Path", "description" : "The path mapping URIs of this REST operation such as /{id}." }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level" }, "response-message" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ResponseMessageDefinition" } }, "route-id" : { "type" : "string", "title" : "Route Id", "description" : "Sets the id of the route" }, "security" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.SecurityDefinition" } }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level" }, "to" : { "title" : "To", "description" : "The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.", "$ref" : "#/items/definitions/org.apache.camel.model.ToDefinition" }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." } } }, "org.apache.camel.model.rest.PutDefinition" : { "title" : "Put", "description" : "Rest PUT command", "type" : "object", "properties" : { "api-docs" : { "type" : "boolean", "title" : "Api Docs", "description" : "Whether to include or exclude this rest operation in API documentation. The default value is true." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level" }, "deprecated" : { "type" : "boolean", "title" : "Deprecated", "description" : "Marks this rest operation as deprecated in OpenApi documentation." }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime." }, "enable-cors" : { "type" : "boolean" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "out-type" : { "type" : "string", "title" : "Out Type", "description" : "Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." }, "param" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ParamDefinition" } }, "path" : { "type" : "string", "title" : "Path", "description" : "The path mapping URIs of this REST operation such as /{id}." }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level" }, "response-message" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ResponseMessageDefinition" } }, "route-id" : { "type" : "string", "title" : "Route Id", "description" : "Sets the id of the route" }, "security" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.SecurityDefinition" } }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level" }, "to" : { "title" : "To", "description" : "The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.", "$ref" : "#/items/definitions/org.apache.camel.model.ToDefinition" }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." } } }, "org.apache.camel.model.rest.ResponseHeaderDefinition" : { "title" : "Response Header", "description" : "To specify the rest operation response headers.", "type" : "object", "properties" : { "allowable-values" : { "type" : "array", "title" : "Allowable Values", "description" : "Sets the parameter list of allowable values.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.ValueDefinition" } }, "array-type" : { "type" : "string", "title" : "Array Type", "description" : "Sets the parameter array type. Required if data type is array. Describes the type of items in the array.", "default" : "string" }, "collection-format" : { "type" : "string", "title" : "Collection Format", "description" : "Sets the parameter collection format.", "default" : "csv", "enum" : [ "csv", "multi", "pipes", "ssv", "tsv" ] }, "data-format" : { "type" : "string", "title" : "Data Format", "description" : "Sets the parameter data format." }, "data-type" : { "type" : "string", "title" : "Data Type", "description" : "Sets the header data type.", "default" : "string" }, "description" : { "type" : "string", "title" : "Description", "description" : "Description of the parameter." }, "example" : { "type" : "string", "title" : "Example", "description" : "Sets the example" }, "name" : { "type" : "string", "title" : "Name", "description" : "Name of the parameter. This option is mandatory." } }, "required" : [ "name" ] }, "org.apache.camel.model.rest.ResponseMessageDefinition" : { "title" : "Response Message", "description" : "To specify the rest operation response messages.", "type" : "object", "properties" : { "code" : { "type" : "string", "title" : "Code", "description" : "The response code such as a HTTP status code", "default" : "200" }, "examples" : { "type" : "array", "title" : "Examples", "description" : "Examples of response messages", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "header" : { "type" : "array", "title" : "Header", "description" : "Adds a response header", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ResponseHeaderDefinition" } }, "message" : { "type" : "string", "title" : "Message", "description" : "The response message (description)" }, "response-model" : { "type" : "string", "title" : "Response Model", "description" : "The response model" } }, "required" : [ "message" ] }, "org.apache.camel.model.rest.RestBindingDefinition" : { "title" : "Rest Binding", "description" : "To configure rest binding", "type" : "object", "properties" : { "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. The default value is off", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "component" : { "type" : "string", "title" : "Component", "description" : "Sets the component name that this definition will apply to" }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json" }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "enable-cors" : { "type" : "boolean" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "out-type" : { "type" : "string", "title" : "Out Type", "description" : "Sets the class name to use for binding from POJO to output for the outgoing data The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json" }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do." }, "type" : { "type" : "string", "title" : "Type", "description" : "Sets the class name to use for binding from input to POJO for the incoming data The name of the class of the input data. Append a to the end of the name if you want the input to be an array type." } } }, "org.apache.camel.model.rest.RestConfigurationDefinition" : { "title" : "Rest Configuration", "description" : "To configure rest", "type" : "object", "properties" : { "api-component" : { "type" : "string", "title" : "Api Component", "description" : "The name of the Camel component to use as the REST API. If no API Component has been explicit configured, then Camel will lookup if there is a Camel component responsible for servicing and generating the REST API documentation, or if a org.apache.camel.spi.RestApiProcessorFactory is registered in the registry. If either one is found, then that is being used.", "enum" : [ "openapi", "swagger" ] }, "api-context-path" : { "type" : "string", "title" : "Api Context Path", "description" : "Sets a leading API context-path the REST API services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path." }, "api-context-route-id" : { "type" : "string", "title" : "Api Context Route Id", "description" : "Sets the route id to use for the route that services the REST API. The route will by default use an auto assigned route id." }, "api-host" : { "type" : "string", "title" : "Api Host", "description" : "To use a specific hostname for the API documentation (such as swagger or openapi) This can be used to override the generated host with this configured hostname" }, "api-property" : { "type" : "array", "title" : "Api Property", "description" : "Allows to configure as many additional properties for the api documentation. For example set property api.title to my cool stuff", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "api-vendor-extension" : { "type" : "boolean", "title" : "Api Vendor Extension", "description" : "Whether vendor extension is enabled in the Rest APIs. If enabled then Camel will include additional information as vendor extension (eg keys starting with x-) such as route ids, class names etc. Not all 3rd party API gateways and tools supports vendor-extensions when importing your API docs." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. The default value is off", "default" : "off", "enum" : [ "auto", "json", "json_xml", "off", "xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "component" : { "type" : "string", "title" : "Component", "description" : "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used.", "enum" : [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ] }, "component-property" : { "type" : "array", "title" : "Component Property", "description" : "Allows to configure as many additional properties for the rest component in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "consumer-property" : { "type" : "array", "title" : "Consumer Property", "description" : "Allows to configure as many additional properties for the rest consumer in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "context-path" : { "type" : "string", "title" : "Context Path", "description" : "Sets a leading context-path the REST services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path. Or for components such as camel-jetty or camel-netty-http that includes a HTTP server." }, "cors-headers" : { "type" : "array", "title" : "Cors Headers", "description" : "Allows to configure custom CORS headers.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "data-format-property" : { "type" : "array", "title" : "Data Format Property", "description" : "Allows to configure as many additional properties for the data formats in use. For example set property prettyPrint to true to have json outputted in pretty mode. The properties can be prefixed to denote the option is only for either JSON or XML and for either the IN or the OUT. The prefixes are: json.in. json.out. xml.in. xml.out. For example a key with value xml.out.mustBeJAXBElement is only for the XML data format for the outgoing. A key without a prefix is a common key for all situations.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "enable-cors" : { "type" : "boolean" }, "endpoint-property" : { "type" : "array", "title" : "Endpoint Property", "description" : "Allows to configure as many additional properties for the rest endpoint in use.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition" } }, "host" : { "type" : "string", "title" : "Host", "description" : "The hostname to use for exposing the REST service." }, "host-name-resolver" : { "type" : "string", "title" : "Host Name Resolver", "description" : "If no hostname has been explicit configured, then this resolver is used to compute the hostname the REST service will be using.", "default" : "allLocalIp", "enum" : [ "allLocalIp", "localHostName", "localIp" ] }, "inline-routes" : { "type" : "boolean", "title" : "Inline Routes", "description" : "Inline routes in rest-dsl which are linked using direct endpoints. By default, each service in Rest DSL is an individual route, meaning that you would have at least two routes per service (rest-dsl, and the route linked from rest-dsl). Enabling this allows Camel to optimize and inline this as a single route, however this requires to use direct endpoints, which must be unique per service. This option is default false." }, "json-data-format" : { "type" : "string", "title" : "Json Data Format", "description" : "Name of specific json data format to use. By default jackson will be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance." }, "port" : { "type" : "string", "title" : "Port", "description" : "The port number to use for exposing the REST service. Notice if you use servlet component then the port number configured here does not apply, as the port number in use is the actual port number the servlet component is using. eg if using Apache Tomcat its the tomcat http port, if using Apache Karaf its the HTTP service in Karaf that uses port 8181 by default etc. Though in those situations setting the port number here, allows tooling and JMX to know the port number, so its recommended to set the port number to the number that the servlet engine uses." }, "producer-api-doc" : { "type" : "string", "title" : "Producer Api Doc", "description" : "Sets the location of the api document the REST producer will use to validate the REST uri and query parameters are valid accordingly to the api document. The location of the api document is loaded from classpath by default, but you can use file: or http: to refer to resources to load from file or http url." }, "producer-component" : { "type" : "string", "title" : "Producer Component", "description" : "Sets the name of the Camel component to use as the REST producer", "enum" : [ "vertx-http", "http", "undertow", "netty-http" ] }, "scheme" : { "type" : "string", "title" : "Scheme", "description" : "The scheme to use for exposing the REST service. Usually http or https is supported. The default value is http" }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do." }, "use-x-forward-headers" : { "type" : "boolean", "title" : "Use XForward Headers", "description" : "Whether to use X-Forward headers for Host and related setting. The default value is true." }, "xml-data-format" : { "type" : "string", "title" : "Xml Data Format", "description" : "Name of specific XML data format to use. By default jaxb will be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance." } } }, "org.apache.camel.model.rest.RestDefinition" : { "title" : "Rest", "description" : "Defines a rest service using the rest-dsl", "type" : "object", "properties" : { "api-docs" : { "type" : "boolean", "title" : "Api Docs", "description" : "Whether to include or exclude this rest operation in API documentation. This option will override what may be configured on a parent level. The default value is true." }, "binding-mode" : { "type" : "string", "title" : "Binding Mode", "description" : "Sets the binding mode to use. This option will override what may be configured on a parent level The default value is auto", "default" : "off", "enum" : [ "off", "auto", "json", "xml", "json_xml" ] }, "client-request-validation" : { "type" : "boolean", "title" : "Client Request Validation", "description" : "Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error." }, "consumes" : { "type" : "string", "title" : "Consumes", "description" : "To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level" }, "delete" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.DeleteDefinition" } }, "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "disabled" : { "type" : "boolean", "title" : "Disabled", "description" : "Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime." }, "enable-cors" : { "type" : "boolean" }, "get" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.GetDefinition" } }, "head" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.HeadDefinition" } }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "patch" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.PatchDefinition" } }, "path" : { "type" : "string", "title" : "Path", "description" : "Path of the rest service, such as /foo" }, "post" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.PostDefinition" } }, "produces" : { "type" : "string", "title" : "Produces", "description" : "To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level" }, "put" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.PutDefinition" } }, "security-definitions" : { "title" : "Security Definitions", "description" : "Sets the security definitions such as Basic, OAuth2 etc.", "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestSecuritiesDefinition" }, "security-requirements" : { "type" : "array", "title" : "Security Requirements", "description" : "Sets the security requirement(s) for all endpoints.", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.SecurityDefinition" } }, "skip-binding-on-error-code" : { "type" : "boolean", "title" : "Skip Binding On Error Code", "description" : "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level" }, "tag" : { "type" : "string", "title" : "Tag", "description" : "To configure a special tag for the operations within this rest definition." } } }, "org.apache.camel.model.rest.RestPropertyDefinition" : { "title" : "Rest Property", "description" : "A key value pair", "type" : "object", "properties" : { "key" : { "type" : "string", "title" : "Key", "description" : "Property key" }, "value" : { "type" : "string", "title" : "Value", "description" : "Property value" } }, "required" : [ "key", "value" ] }, "org.apache.camel.model.rest.RestSecuritiesDefinition" : { "title" : "Rest Security Definitions", "description" : "To configure rest security definitions.", "type" : "object", "properties" : { "api-key" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.ApiKeyDefinition" }, "basic-auth" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.BasicAuthDefinition" }, "bearer" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.BearerTokenDefinition" }, "mutual-tls" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.MutualTLSDefinition" }, "oauth2" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.OAuth2Definition" }, "open-id-connect" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.OpenIdConnectDefinition" } } }, "org.apache.camel.model.rest.RestsDefinition" : { "title" : "Rests", "description" : "A series of rest services defined using the rest-dsl", "type" : "object", "properties" : { "description" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "id" : { "type" : "string", "title" : "Id", "description" : "Sets the id of this node" }, "rest" : { "type" : "array", "items" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestDefinition" } } } }, "org.apache.camel.model.rest.SecurityDefinition" : { "title" : "Rest Security", "description" : "Rest security definition", "type" : "object", "properties" : { "key" : { "type" : "string", "title" : "Key", "description" : "Key used to refer to this security definition" }, "scopes" : { "type" : "string", "title" : "Scopes", "description" : "The scopes to allow (separate multiple scopes by comma)" } }, "required" : [ "key" ] }, "org.apache.camel.model.transformer.CustomTransformerDefinition" : { "type" : "object", "properties" : { "class-name" : { "type" : "string" }, "from-type" : { "type" : "string" }, "name" : { "type" : "string" }, "ref" : { "type" : "string" }, "scheme" : { "type" : "string" }, "to-type" : { "type" : "string" } } }, "org.apache.camel.model.transformer.DataFormatTransformerDefinition" : { "type" : "object", "properties" : { "asn1" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ASN1DataFormat" }, "avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.AvroDataFormat" }, "barcode" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BarcodeDataFormat" }, "base64" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.Base64DataFormat" }, "bindy" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.BindyDataFormat" }, "cbor" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CBORDataFormat" }, "crypto" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CryptoDataFormat" }, "csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CsvDataFormat" }, "custom" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.CustomDataFormat" }, "fhir-json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirJsonDataFormat" }, "fhir-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FhirXmlDataFormat" }, "flatpack" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.FlatpackDataFormat" }, "from-type" : { "type" : "string" }, "grok" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GrokDataFormat" }, "gzip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.GzipDeflaterDataFormat" }, "hl7" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.HL7DataFormat" }, "ical" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.IcalDataFormat" }, "jackson-xml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JacksonXMLDataFormat" }, "jaxb" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JaxbDataFormat" }, "json" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonDataFormat" }, "json-api" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.JsonApiDataFormat" }, "lzf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.LZFDataFormat" }, "mime-multipart" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.MimeMultipartDataFormat" }, "name" : { "type" : "string" }, "parquet-avro" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ParquetAvroDataFormat" }, "pgp" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.PGPDataFormat" }, "protobuf" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ProtobufDataFormat" }, "rss" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.RssDataFormat" }, "scheme" : { "type" : "string" }, "soap" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SoapDataFormat" }, "swift-mt" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMtDataFormat" }, "swift-mx" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SwiftMxDataFormat" }, "syslog" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.SyslogDataFormat" }, "tar-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TarFileDataFormat" }, "thrift" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ThriftDataFormat" }, "tidy-markup" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.TidyMarkupDataFormat" }, "to-type" : { "type" : "string" }, "univocity-csv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityCsvDataFormat" }, "univocity-fixed" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityFixedDataFormat" }, "univocity-tsv" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.UniVocityTsvDataFormat" }, "xml-security" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.XMLSecurityDataFormat" }, "yaml" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.YAMLDataFormat" }, "zip-deflater" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipDeflaterDataFormat" }, "zip-file" : { "$ref" : "#/items/definitions/org.apache.camel.model.dataformat.ZipFileDataFormat" } } }, "org.apache.camel.model.transformer.EndpointTransformerDefinition" : { "type" : "object", "properties" : { "from-type" : { "type" : "string" }, "name" : { "type" : "string" }, "ref" : { "type" : "string" }, "scheme" : { "type" : "string" }, "to-type" : { "type" : "string" }, "uri" : { "type" : "string" } } }, "org.apache.camel.model.transformer.LoadTransformerDefinition" : { "type" : "object", "properties" : { "defaults" : { "type" : "boolean" }, "from-type" : { "type" : "string" }, "name" : { "type" : "string" }, "package-scan" : { "type" : "string" }, "scheme" : { "type" : "string" }, "to-type" : { "type" : "string" } } }, "org.apache.camel.model.transformer.TransformersDefinition" : { "title" : "Transformations", "description" : "To configure transformers.", "type" : "object", "properties" : { "custom-transformer" : { "$ref" : "#/items/definitions/org.apache.camel.model.transformer.CustomTransformerDefinition" }, "data-format-transformer" : { "$ref" : "#/items/definitions/org.apache.camel.model.transformer.DataFormatTransformerDefinition" }, "endpoint-transformer" : { "$ref" : "#/items/definitions/org.apache.camel.model.transformer.EndpointTransformerDefinition" }, "load-transformer" : { "$ref" : "#/items/definitions/org.apache.camel.model.transformer.LoadTransformerDefinition" } } }, "org.apache.camel.model.validator.CustomValidatorDefinition" : { "type" : "object", "properties" : { "class-name" : { "type" : "string" }, "ref" : { "type" : "string" }, "type" : { "type" : "string" } } }, "org.apache.camel.model.validator.EndpointValidatorDefinition" : { "type" : "object", "properties" : { "ref" : { "type" : "string" }, "type" : { "type" : "string" }, "uri" : { "type" : "string" } } }, "org.apache.camel.model.validator.PredicateValidatorDefinition" : { "type" : "object", "properties" : { "expression" : { "$ref" : "#/items/definitions/org.apache.camel.model.language.ExpressionDefinition" }, "type" : { "type" : "string" } } }, "org.apache.camel.model.validator.ValidatorsDefinition" : { "title" : "Validations", "description" : "To configure validators.", "type" : "object", "properties" : { "custom-validator" : { "$ref" : "#/items/definitions/org.apache.camel.model.validator.CustomValidatorDefinition" }, "endpoint-validator" : { "$ref" : "#/items/definitions/org.apache.camel.model.validator.EndpointValidatorDefinition" }, "predicate-validator" : { "$ref" : "#/items/definitions/org.apache.camel.model.validator.PredicateValidatorDefinition" } } } }, "properties" : { "beans" : { "$ref" : "#/items/definitions/org.apache.camel.dsl.yaml.deserializers.BeansDeserializer" }, "error-handler" : { "$ref" : "#/items/definitions/org.apache.camel.dsl.yaml.deserializers.ErrorHandlerBuilderDeserializer" }, "errorHandler" : { "$ref" : "#/items/definitions/org.apache.camel.dsl.yaml.deserializers.ErrorHandlerBuilderDeserializer" }, "from" : { "$ref" : "#/items/definitions/org.apache.camel.dsl.yaml.deserializers.RouteFromDefinitionDeserializer" }, "on-exception" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnExceptionDefinition" }, "onException" : { "$ref" : "#/items/definitions/org.apache.camel.model.OnExceptionDefinition" }, "route-configuration" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteConfigurationDefinition" }, "routeConfiguration" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteConfigurationDefinition" }, "route" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteDefinition" }, "route-template" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteTemplateDefinition" }, "routeTemplate" : { "$ref" : "#/items/definitions/org.apache.camel.model.RouteTemplateDefinition" }, "templated-route" : { "$ref" : "#/items/definitions/org.apache.camel.model.TemplatedRouteDefinition" }, "templatedRoute" : { "$ref" : "#/items/definitions/org.apache.camel.model.TemplatedRouteDefinition" }, "rest-configuration" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestConfigurationDefinition" }, "restConfiguration" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestConfigurationDefinition" }, "rest" : { "$ref" : "#/items/definitions/org.apache.camel.model.rest.RestDefinition" } } } }

drupal-layouts.json

{ "$id": "https://json.schemastore.org/drupal-layouts.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": { "type": "object", "properties": { "label": { "title": "The human-readable name", "type": "string" }, "description": { "title": "A description for advanced layouts", "type": "string" }, "category": { "title": "The human-readable category name", "type": "string" }, "template": { "title": "The template file to render this layout", "type": "string" }, "theme_hook": { "title": "The theme hook used to render this layout", "default": "layout", "type": "string" }, "path": { "title": "Path to resources like icon or template", "type": "string" }, "library": { "title": "The asset library", "type": "string" }, "icon": { "title": "The path to the preview image", "type": "string" }, "icon_map": { "title": "The icon map", "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "regions": { "title": "List of regions in this layout", "type": "object", "additionalProperties": { "type": "object", "properties": { "label": { "title": "The human-readable name", "type": "string" } }, "additionalProperties": true } }, "default_region": { "title": "The default region", "type": "string" }, "class": { "title": "Plugin class", "type": "string" } }, "additionalProperties": false }, "title": "JSON schema for Drupal layouts file", "type": "object" }

minecraft-tag.json

{ "$comment": "https://minecraft.fandom.com/wiki/Data_Pack", "$id": "https://json.schemastore.org/minecraft-tag.json", "$schema": "http://json-schema.org/draft-07/schema#", "description": "A tag's for a Minecraft data pack config schema", "properties": { "replace": { "type": "boolean", "default": false }, "values": { "description": "Values", "type": "array", "items": { "oneOf": [ { "anyOf": [ { "type": "string", "pattern": "^[a-z0-9_.-]+:[a-z0-9_.-]+" }, { "type": "string", "pattern": "^#[a-z0-9_.-]+:[a-z0-9_.-]+" } ] }, { "type": "object", "properties": { "id": { "anyOf": [ { "description": "An identifier for the current data pack", "type": "string", "pattern": "^[a-z0-9_.-]+:[a-z0-9_.-]+" }, { "description": "An identifier for the current data pack", "type": "string", "pattern": "^#[a-z0-9_.-]+:[a-z0-9_.-]+" } ] }, "required": { "description": "Whether it's required for the current data pack", "type": "boolean" } } } ] } } }, "required": ["values"], "title": "Minecraft Data Pack Tag", "type": "object" }

devinit.schema-6.0.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "runObject": { "type": "object", "required": ["tool"], "properties": { "tool": { "title": "The tool name", "description": "The name of the tool to run.", "type": "string", "enum": [ "apt-get-install", "azurecli-login", "choco-install", "choco-upgrade", "dotnet-restore", "dotnet-toolinstall", "enable-iis", "msi-install", "npm-install", "nuget-restore", "require-azureartifactscredentialprovider", "require-azurecli", "require-choco", "require-dotnetcoresdk", "require-dotnetframeworksdk", "require-gitsubmodule", "require-mssql", "require-nodejs", "require-npm", "require-nuget", "require-psmodule", "require-vcpkg", "require-vscomponent", "require-winget", "set-env", "vcpkg-install", "windowsfeature-disable", "windowsfeature-enable", "windowsfeature-list", "winget-install", "wsl-install" ] }, "input": { "title": "The tool input", "description": "The input varies by tool. For example, the required version number, the package-id, the input source file or source directory.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "additionalOptions": { "title": "Additional options", "description": "Additional Options to be appended to the tool's command line.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "comments": { "title": "Comments", "description": "Comments for this tool item. For documentation only; ignored by the tool.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "id": "https://json.schemastore.org/devinit.schema-6.0.json", "properties": { "$schema": { "type": "string" }, "run": { "title": "The list of tools to run", "description": "'devinit.exe init' runs this list of tools sequentially. See also 'devinit.exe run'.", "items": { "allOf": [ { "$ref": "#/definitions/runObject" } ], "anyOf": [ { "$ref": "#/definitions/runObject" } ] } }, "comments": { "title": "Comments", "description": "Comments for this file. For documentation only; ignored by the tool.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["run"], "title": "Codespaces DevInit Configuration", "type": "object" }

minecraft-template-pool.json

{ "$comment": "https://minecraft.fandom.com/wiki/Custom_world_generation#Jigsaw_pools", "$id": "https://json.schemastore.org/minecraft-template-pool.json", "$schema": "http://json-schema.org/draft-07/schema#", "description": "Configuration file defining a template pool for a data pack for Minecraft.", "properties": { "name": { "title": "Name", "description": "The namespaced ID of the pool.", "type": "string" }, "fallback": { "title": "Fallback", "description": "Can set to another template pool, which generates when the original pool cannot generate at the end of all layers.", "type": "string" }, "elements": { "title": "Elements", "description": "A list of structures to choose from.", "type": "array", "items": { "title": "Element", "type": "object", "properties": { "weight": { "title": "Weight", "description": "How likely this element is to be chosen when using this pool.", "type": "integer" }, "element": { "title": "Element", "description": "The properties of this element.", "type": "object", "properties": { "element_type": { "title": "Element Type", "type": "string", "enum": [ "minecraft:empty_pool_element", "minecraft:feature_pool_element", "minecraft:list_pool_element", "minecraft:legacy_single_pool_element", "minecraft:single_pool_element" ] }, "feature": { "title": "Feature", "description": "The namespaced id of the feature.", "type": "string" }, "location": { "title": "Location", "description": "The namespaced id of the structure to place.", "type": "string" }, "projection": { "title": "Projection", "type": "string", "enum": ["rigid", "terrain_matching"] }, "processors": { "title": "Processors", "description": "The namespaced ID of a processor if this is a string.", "type": ["string", "object"], "properties": { "processors": { "title": "Processors", "description": "A list of processors to use.", "type": "array", "items": { "title": "Processor", "type": "object", "properties": { "processor_type": { "title": "Processor Type", "description": "The namespaced id of the processor to use.", "type": "string" } } } } } }, "elements": { "title": "Elements", "description": "A list of structures to choose from.", "type": "array", "items": { "title": "Element", "type": "object", "properties": { "weight": {}, "location": { "title": "Location", "description": "The namespaced id of the structure to place.", "type": "string" }, "projection": { "title": "Projection", "type": "string", "enum": ["rigid", "terrain_matching"] }, "element_type": { "title": "Element Type", "type": "string", "enum": [ "minecraft:empty_pool_element", "minecraft:list_pool_element", "minecraft:legacy_single_pool_element", "minecraft:single_pool_element" ] }, "processors": { "title": "Processors", "description": "The namespaced ID of a processor if this is a string.", "type": ["string", "object"], "properties": { "processors": { "title": "Processors", "description": "A list of processors to use.", "type": "array", "items": { "title": "Processor", "type": "object", "properties": { "processor_type": { "title": "Processor Type", "description": "The namespaced id of the processor to use.", "type": "string" } } } } } } } } } } } } } } }, "title": "Minecraft Data Pack Template Pool", "type": "object" }

appveyor.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "#/definitions/job" } ], "definitions": { "possiblySecretString": { "anyOf": [ { "type": "string", "description": "This value will be used directly (regular string)" }, { "type": "number", "description": "This value will be treated as a string even though it is a number" }, { "title": "secret string", "type": "object", "additionalProperties": false, "properties": { "secure": { "type": "string", "description": "This should have been encrypted by the same user account to which the project belongs" } } } ] }, "commitFilter": { "title": "commit filter", "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "format": "regex", "description": "Regex for matching commit message" }, "author": { "description": "Commit author's username, name, email or regexp matching one of these.", "anyOf": [ { "type": "string", "format": "regex" }, { "type": "string" } ] }, "files": { "type": "array", "description": "Only specific files (glob patterns)", "items": { "type": "string" } } } }, "command": { "title": "command", "oneOf": [ { "type": "string", "description": "Run a batch command" }, { "type": "object", "additionalProperties": false, "properties": { "ps": { "type": "string", "description": "Run a PowerShell command" } } }, { "type": "object", "additionalProperties": false, "properties": { "pwsh": { "type": "string", "description": "Run a PowerShell Core command" } } }, { "type": "object", "description": "Run a batch command", "additionalProperties": false, "properties": { "cmd": { "type": "string" } } }, { "type": "object", "description": "Run a Bash command", "additionalProperties": false, "properties": { "sh": { "type": "string" } } } ] }, "envVarHash": { "title": "environment variable hash", "type": "object", "additionalProperties": { "$ref": "#/definitions/possiblySecretString" } }, "platform": { "enum": ["x86", "x64", "ARM", "ARM64", "Win32", "Any CPU"] }, "configuration": { "type": "string" }, "imageName": { "enum": [ "macOS", "macOS-Mojave", "macos-bigsur", "macos-monterey", "Previous macOS", "Previous macOS-Mojave", "Ubuntu", "Ubuntu1604", "Ubuntu1804", "Ubuntu2004", "Previous Ubuntu", "Previous Ubuntu1604", "Previous Ubuntu1804", "Previous Ubuntu2004", "Visual Studio 2013", "Visual Studio 2015", "Visual Studio 2017", "Visual Studio 2019", "Visual Studio 2022", "Visual Studio 2017 Preview", "Visual Studio 2019 Preview", "Previous Visual Studio 2013", "Previous Visual Studio 2015", "Previous Visual Studio 2017", "Previous Visual Studio 2019", "Previous Visual Studio 2022", "zhaw18", "WMF 5" ] }, "image": { "description": "Build worker image (VM template) -DEV_VERSION", "oneOf": [ { "type": "array", "items": { "$ref": "#/definitions/imageName" } }, { "$ref": "#/definitions/imageName" } ] }, "jobScalars": { "title": "job scalars", "type": "object", "properties": { "image": { "$ref": "#/definitions/image" }, "platform": { "description": "Build platform, i.e. x86, x64, Any CPU. This setting is optional", "oneOf": [ { "$ref": "#/definitions/platform" }, { "type": "array", "items": { "$ref": "#/definitions/platform" } } ] }, "configuration": { "description": "Build Configuration, i.e. Debug, Release, etc.", "oneOf": [ { "$ref": "#/definitions/configuration" }, { "type": "array", "items": { "$ref": "#/definitions/configuration" } } ] } }, "allOf": [ { "not": { "required": ["skip_tags"] } }, { "not": { "required": ["skip_commits"] } }, { "not": { "required": ["skip_branch_with_pr"] } }, { "not": { "required": ["skip_non_tags"] } } ] }, "job": { "title": "job", "type": "object", "properties": { "version": { "description": "Version format", "type": "string" }, "branches": { "title": "branch options", "type": "object", "description": "Branches to build", "additionalProperties": false, "properties": { "only": { "description": "Whitelist", "type": "array", "items": { "type": "string" } }, "except": { "type": "array", "description": "Blacklist", "items": { "type": "string" } } } }, "skip_tags": { "type": "boolean", "description": "Do not build on tags (GitHub and BitBucket)" }, "skip_non_tags": { "type": "boolean", "description": "Start builds on tags only (GitHub and BitBucket)" }, "skip_commits": { "description": "Skipping commits with particular message or from specific user", "$ref": "#/definitions/commitFilter" }, "only_commits": { "description": "Including commits with particular message or from specific user", "$ref": "#/definitions/commitFilter" }, "skip_branch_with_pr": { "type": "boolean", "description": "Do not build feature branch with open Pull Requests" }, "max_jobs": { "description": "Maximum number of concurrent jobs for the project", "type": "integer" }, "notifications": { "type": "array", "items": { "title": "notification", "type": "object" } }, "image": { "$ref": "#/definitions/image" }, "init": { "description": "Scripts that are called at very beginning, before repo cloning", "type": "array", "items": { "$ref": "#/definitions/command" } }, "clone_folder": { "type": "string", "description": "Clone directory" }, "shallow_clone": { "type": "boolean", "description": "Fetch repository as zip archive", "default": false }, "clone_depth": { "description": "Set git clone depth", "type": "integer" }, "hosts": { "title": "host options", "type": "object", "description": "Setting up etc\\hosts file", "additionalProperties": { "type": "string", "anyOf": [ { "format": "ipv4" }, { "format": "ipv6" } ] } }, "environment": { "description": "Environment variables", "anyOf": [ { "title": "environment options", "type": "object", "properties": { "global": { "description": "variables defined here are no different than those defined at top level of 'environment' node", "$ref": "#/definitions/envVarHash" }, "matrix": { "type": "array", "description": "an array of environment variables, each member of which is one dimension in the build matrix calculation", "items": { "$ref": "#/definitions/envVarHash" } } } }, { "$ref": "#/definitions/envVarHash" } ] }, "matrix": { "title": "matrix options", "type": "object", "additionalProperties": false, "properties": { "fast_finish": { "type": "boolean", "description": "Set this flag to immediately finish build once one of the jobs fails" }, "allow_failures": { "type": "array", "description": "This is how to allow failing jobs in the matrix", "items": { "$ref": "#/definitions/jobScalars" } }, "exclude": { "type": "array", "description": "Exclude configuration from the matrix. Works similarly to 'allow_failures' but build not even being started for excluded combination.", "items": { "$ref": "#/definitions/job" } } } }, "cache": { "type": "array", "description": "Build cache to preserve files/folders between builds", "items": { "type": "string" } }, "services": { "type": "array", "description": "Enable service required for build/tests", "items": { "enum": [ "docker", "iis", "mongodb", "msmq", "mssql", "mssql2008r2sp2", "mssql2008r2sp2rs", "mssql2012sp1", "mssql2012sp1rs", "mssql2014", "mssql2014rs", "mssql2016", "mssql2017", "mysql", "postgresql", "postgresql93", "postgresql94", "postgresql95", "postgresql96", "postgresql10", "postgresql11", "postgresql12", "postgresql13" ] } }, "install": { "description": "Scripts that run after cloning repository", "type": "array", "items": { "$ref": "#/definitions/command" } }, "assembly_info": { "title": "assembly options", "type": "object", "description": "Enable patching of AssemblyInfo.* files", "additionalProperties": false, "properties": { "patch": { "type": "boolean" }, "file": { "type": "string" }, "assembly_version": { "type": "string" }, "assembly_file_version": { "type": "string" }, "assembly_informational_version": { "type": "string" } } }, "nuget": { "title": "NuGet options", "type": "object", "description": "Automatically register private account and/or project AppVeyor NuGet feeds", "properties": { "account_feed": { "type": "boolean" }, "project_feed": { "type": "boolean" }, "disable_publish_on_pr": { "type": "boolean", "description": "Disable publishing of .nupkg artifacts to account/project feeds for pull request builds" } } }, "platform": { "description": "Build platform, i.e. x86, x64, Any CPU. This setting is optional", "oneOf": [ { "$ref": "#/definitions/platform" }, { "type": "array", "items": { "$ref": "#/definitions/platform" } } ] }, "configuration": { "description": "Build Configuration, i.e. Debug, Release, etc.", "oneOf": [ { "$ref": "#/definitions/configuration" }, { "type": "array", "items": { "$ref": "#/definitions/configuration" } } ] }, "build": { "oneOf": [ { "type": "boolean", "enum": [false] }, { "title": "build options", "type": "object", "additionalProperties": false, "properties": { "parallel": { "type": "boolean", "description": "Enable MSBuild parallel builds" }, "project": { "type": "string", "description": "Path to Visual Studio solution or project" }, "publish_wap": { "type": "boolean", "description": "Package Web Application Projects (WAP) for Web Deploy" }, "publish_wap_xcopy": { "type": "boolean", "description": "Package Web Application Projects (WAP) for XCopy deployment" }, "publish_wap_beanstalk": { "type": "boolean", "description": "Package Web Applications for AWS Elastic Beanstalk deployment" }, "publish_wap_octopus": { "type": "boolean", "description": "Package Web Applications for Octopus deployment" }, "publish_azure_webjob": { "type": "boolean", "description": "Package Azure WebJobs for Zip Push deployment" }, "publish_azure": { "type": "boolean", "description": "Package Azure Cloud Service projects and push to artifacts" }, "publish_aspnet_core": { "type": "boolean", "description": "Package ASP.NET Core projects" }, "publish_core_console": { "type": "boolean", "description": "Package .NET Core console projects" }, "publish_nuget": { "type": "boolean", "description": "Package projects with .nuspec files and push to artifacts" }, "publish_nuget_symbols": { "type": "boolean", "description": "Generate and publish NuGet symbol packages" }, "include_nuget_references": { "type": "boolean", "description": "Add -IncludeReferencedProjects option while packaging NuGet artifacts" }, "verbosity": { "enum": ["quiet", "minimal", "normal", "detailed"], "description": "MSBuild verbosity level" } } } ] }, "before_build": { "description": "Scripts to run before build", "type": "array", "items": { "$ref": "#/definitions/command" } }, "before_package": { "description": "Scripts to run *after* solution is built and *before* automatic packaging occurs (web apps, NuGet packages, Azure Cloud Services)", "type": "array", "items": { "$ref": "#/definitions/command" } }, "after_build": { "description": "Scripts to run after build", "type": "array", "items": { "$ref": "#/definitions/command" } }, "build_script": { "description": "To run your custom scripts instead of automatic MSBuild", "type": "array", "items": { "$ref": "#/definitions/command" } }, "before_test": { "description": "Scripts to run before tests", "type": "array", "items": { "$ref": "#/definitions/command" } }, "test": { "oneOf": [ { "type": "boolean", "enum": [false], "description": "To disable automatic tests" }, { "title": "test options", "description": "To run tests again only selected assemblies and/or categories", "type": "object", "additionalProperties": false, "properties": { "assemblies": { "title": "assembly options", "type": "object", "additionalProperties": false, "properties": { "only": { "type": "array", "items": { "type": "string" } }, "except": { "type": "array", "items": { "type": "string" } } } }, "categories": { "oneOf": [ { "title": "category options", "type": "object", "additionalProperties": false, "properties": { "only": { "type": "array", "items": { "type": "string" } }, "except": { "type": "array", "items": { "type": "string" } } } }, { "description": "To run tests from different categories as separate jobs in parallel", "type": "array", "items": { "oneOf": [ { "type": "string", "description": "A category common for all jobs" }, { "type": "array", "items": { "type": "string" } } ] } } ] } } } ] }, "test_script": { "description": "To run your custom scripts instead of automatic tests", "type": "array", "items": { "$ref": "#/definitions/command" } }, "after_test": { "type": "array", "description": "Scripts to run after tests", "items": { "$ref": "#/definitions/command" } }, "artifacts": { "type": "array", "items": { "title": "artifact options", "type": "object", "additionalProperties": false, "properties": { "path": { "type": "string" }, "name": { "type": "string" } }, "required": ["path"] } }, "before_deploy": { "type": "array", "description": "Scripts to run before deployment", "items": { "$ref": "#/definitions/command" } }, "deploy": { "oneOf": [ { "enum": ["off"] }, { "type": "array", "items": { "title": "deployment options", "type": "object" } } ] }, "deploy_script": { "description": "To run your custom scripts instead of provider deployments", "type": "array", "items": { "$ref": "#/definitions/command" } }, "after_deploy": { "type": "array", "description": "Scripts to run after deployment", "items": { "$ref": "#/definitions/command" } }, "on_success": { "type": "array", "description": "On successful build", "items": { "$ref": "#/definitions/command" } }, "on_failure": { "type": "array", "description": "On build failure", "items": { "$ref": "#/definitions/command" } }, "on_finish": { "type": "array", "description": "After build failure or success", "items": { "$ref": "#/definitions/command" } } } } }, "id": "https://json.schemastore.org/appveyor.json", "title": "JSON schema for AppVeyor CI configuration files" }

minecraft-dimension.json

{ "$comment": "https://minecraft.fandom.com/wiki/Custom_dimension#Dimension_syntax", "$id": "https://json.schemastore.org/minecraft-dimension.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "noise": { "title": "noise options", "type": "object", "properties": { "firstOctave": { "title": "First Octave", "description": "The lower the value, the smoother the changes in altitude will be, making biome edges smoother.", "type": "integer", "default": -7 }, "amplitudes": { "title": "Amplitudes", "description": "A list of floats. Using more values allows for greater precision. Higher absolute values seem to make the altitude reach greater absolute values.", "type": "array", "items": { "type": "number" }, "default": [1, 1] } } }, "dimensionType": { "$comment": "https://minecraft.fandom.com/wiki/Custom_dimension#Dimension_type", "title": "dimension type", "description": "Configuration file defining a dimension type for a data pack for Minecraft.", "type": "object", "properties": { "name": { "title": "Name", "description": "The resource location used for the dimension type.", "type": "string" }, "ultrawarm": { "title": "Ultrawarm", "description": "Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also lets stalactites drip lava and causes lava to spread faster and thinner.", "type": "boolean" }, "natural": { "title": "Natural", "description": "When true, nether portals can spawn zombified piglins. When false, compasses spin randomly, and using a bed to set the respawn point or sleep, is disabled.", "type": "boolean" }, "coordinate_scale": { "title": "Coordinate Scale", "description": "The multiplier applied to coordinates when traveling to the dimension.", "type": "number" }, "has_skylight": { "title": "Has Skylight", "description": "Whether the dimension has skylight access or not.", "type": "boolean" }, "has_ceiling": { "title": "Has Ceiling", "description": "Whether the dimension has a bedrock ceiling or not.", "type": "boolean" }, "ambient_light": { "title": "Ambient Light", "description": "How much light the dimension has.", "type": "number", "default": 0.5 }, "fixed_time": { "title": "Fixed Time", "description": "If this is set to a number, the time of the day is the specified value.", "anyOf": [ { "type": "boolean", "default": false }, { "type": "integer", "minimum": 0, "maximum": 24000 } ] }, "piglin_safe": { "title": "Piglin Safe", "description": "Whether piglins shake and transform to zombified piglins.", "type": "boolean" }, "bed_works": { "title": "Bed Words", "description": "When false, the bed blows up when trying to sleep.", "type": "boolean" }, "respawn_anchor_works": { "title": "Respawn Anchor Works", "description": "Whether players can charge and use respawn anchors.", "type": "boolean" }, "has_raids": { "title": "Has Raids", "description": "Whether players with the Bad Omen effect can cause a raid.", "type": "boolean" }, "logical_height": { "title": "Logical Height", "description": "The maximum height to which chorus fruits and nether portals can bring players within this dimension. This excludes portals that were already built above the limit as they still connect normally.", "type": "integer" }, "min_y": { "title": "Minimum Y", "description": "The minimum height in which blocks can exist within this dimension.", "type": "integer", "minimum": -2032, "maximum": 2031, "multipleOf": 16 }, "height": { "title": "Height", "description": "The total height in which blocks can exist within this dimension.", "type": "integer", "minimum": 0, "maximum": 4096, "multipleOf": 16 }, "infiniburn": { "title": "Infiniburn", "description": "A resource location defining what block tag to use for infiniburn.", "type": "string" }, "effects": { "title": "Effects", "description": "Determines the dimension effect used for this dimension.", "type": "string", "enum": [ "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" ], "default": "minecraft:overworld" } } } }, "description": "Configuration file defining a dimension for a data pack for Minecraft.", "properties": { "type": { "title": "Type", "description": "The namespaced ID of the dimension type.", "anyOf": [ { "type": "string", "enum": [ "minecraft:overworld", "minecraft:overworld_caves", "minecraft:the_nether", "minecraft:the_end" ] }, { "$ref": "#/definitions/dimensionType" } ] }, "generator": { "title": "generator", "description": "Generation settings used for that dimension.", "type": "object", "properties": { "type": { "title": "Type", "description": "The ID of the generator.", "type": "string", "enum": ["minecraft:flat", "minecraft:noise", "minecraft:debug"] } }, "allOf": [ { "if": { "properties": { "type": { "const": "minecraft:flat" } } }, "then": { "properties": { "settings": { "title": "superflat options", "description": "Superflat settings.", "type": "object", "properties": { "layers": { "title": "Layers", "description": "Layer settings.", "type": "array", "items": { "title": "layer options", "description": "A superflat layer. The first entry is the bottom layer, the last entry is the top layer.", "type": "object", "properties": { "height": { "title": "Height", "description": "The number of blocks in the layer.", "type": "integer" }, "block": { "title": "Block", "description": "The block the layer is made of.", "type": "string" } } } }, "biome": { "title": "Biome", "description": "The single biome of the world.", "type": "string" }, "lakes": { "title": "Lakes", "description": "Whether or not to generate lakes. If set to true, then water and lava lakes generate often even in biomes where lakes don't normally generate. Lava lakes generate surrounded by different types of stone and ores from the overworld.", "type": "boolean" }, "features": { "title": "Features", "description": "Whether or not to generate biome-specific decorations like trees, grass, flowers, cacti, etc.", "type": "boolean" }, "structures": { "title": "structure options", "description": "Structure settings.", "type": "object", "properties": { "stronghold": { "title": "stronghold options", "description": "Settings for how strongholds should be spawned.", "type": "object", "properties": { "distance": { "title": "Distance", "description": "Controls how far apart the strongholds are.", "type": "integer" }, "count": { "title": "Count", "description": "How many strongholds to generate.", "type": "integer" }, "spread": { "title": "Spread", "type": "integer" } } }, "structures": { "title": "structures", "description": "Map of structures to use in this dimension.", "type": "object", "additionalProperties": { "title": "structure", "type": "object", "properties": { "spacing": { "title": "Spacing", "description": "Average distance between two structure placement attempts of this type in chunks.", "type": "integer" }, "seperation": { "title": "Seperation", "description": "Minimum distance between two structures of this type in chunks; must be less than spacing.", "type": "integer" }, "salt": { "title": "Salt", "description": "A number that assists in randomization.", "type": "integer" } } } } } } } } } } }, { "if": { "properties": { "type": { "const": "minecraft:noise" } } }, "then": { "properties": { "seed": { "title": "Seed", "description": "The seed used to generate the dimension. In most cases, this is exactly the same as the world seed, but can be different and the dimension generated is based upon this seed and not the world seed.", "type": "integer" }, "settings": { "title": "Settings", "description": "The noise settings used in the terrain generator. Can be set to a string to use a preset defined in the worldgen/noise_settings folder with a list of customized options.", "type": ["string", "object"] }, "biome_source": { "title": "biome source", "description": "Settings dictating which biomes and biome shapes.", "type": "object", "properties": { "seed": { "title": "Seed", "description": "The seed used for biome generation.", "type": "integer" }, "biomes": { "title": "Biomes", "description": "A list of biome IDs to generate.", "type": "array" }, "type": { "title": "Type", "description": "The type of biome generation.", "type": "string", "allOf": [ { "if": { "properties": { "type": { "const": "minecraft:vanilla_layered" } } }, "then": { "description": "Default and large biome generation used in the overworld.", "properties": { "large_biomes": { "title": "Large Biomes", "description": "Whether the biomes are large.", "type": "boolean" }, "legacy_biome_init_layer": { "title": "Legacy Biome Init Layer", "description": "Whether the world was default_1_1.", "type": "boolean" } } } }, { "if": { "properties": { "type": { "const": "minecraft:fixed" } } }, "then": { "description": "A single biome.", "properties": { "biome": { "title": "Biome", "description": "The single biome to generate.", "type": "string" } } } }, { "if": { "properties": { "type": { "const": "minecraft:checkerboard" } } }, "then": { "description": "A biome generation in which biomes are square (or close to square) and repeat along the diagonals.", "properties": { "biomes": { "title": "Biomes", "description": "A list of biomes that repeat along the diagonals.", "type": "array" }, "scale": { "title": "Scale", "description": "Determines the size of the squares on an exponential scale.", "type": "integer", "minimum": 0, "maximum": 62 } } } }, { "if": { "properties": { "type": { "const": "minecraft:multi_noise" } } }, "then": { "description": "3D biome generation used in the nether.", "properties": { "altitude_noise": { "title": "Altitude Noise", "description": "How the altitude parameter is spread in the world.", "$ref": "#/definitions/noise" }, "weirdness_noise": { "title": "Weirdness Noise", "description": "Similar to altitude_noise for the weirdness parameter.", "$ref": "#/definitions/noise" }, "temperature_noise": { "title": "Temperature Noise", "description": "Similar to altitude_noise for the temperature parameter.", "$ref": "#/definitions/noise" }, "humidity_noise": { "title": "Humidity Noise", "description": "Similar to altitude_noise for the humidity parameter.", "$ref": "#/definitions/noise" } }, "anyOf": [ { "properties": { "preset": { "title": "Preset", "description": "A preset of the set of biomes to be used.", "type": "string", "enum": ["minecraft:nether"] } } }, { "properties": { "biomes": { "title": "Biomes", "description": "A list of biomes, including their likelihood.", "type": "array", "items": { "title": "biome", "type": "object", "description": "A biome and its properties.", "properties": { "biome": { "title": "Biome", "description": "The biome.", "type": "string" }, "parameters": { "title": "parameters", "description": "Represent optimal conditions for where the biome should be placed. These values do not affect the generation of terrain within biomes; they affect where the game chooses to place biomes.", "type": "object", "properties": { "altitude": { "title": "Altitude", "description": "Used to place similar biomes near each other.", "type": "number", "minimum": -2, "maximum": 2 }, "weirdness": { "title": "Weirdness", "description": "Defines how weird the biome is going to appear next to other biomes.", "type": "number", "minimum": -2, "maximum": 2 }, "offset": { "title": "Offset", "description": " Similar to the other parameters but offset is 0 everywhere, thus setting this parameter nearer to 0 gives the biome a greater edge over others, all else being equal.", "type": "number", "minimum": 0, "maximum": 1 }, "temperature": { "title": "Temperature", "description": "Used to place similar biomes near each other. This is NOT the same as the temperature value listed on Biome, it does NOT affect rain/snow or the color of leaves and grass.", "type": "number", "minimum": -2, "maximum": 2 }, "humidity": { "title": "Humidity", "description": "Used to place similar biomes near each other.", "type": "number", "minimum": -2, "maximum": 2 } } } } } } } } ] } }, { "if": { "properties": { "type": { "const": "minecraft:the_end" } } }, "then": { "description": "Biome generation used in the end with biome minecraft:the_end in the center and other end biomes around." } } ] } } } } } } ] } }, "title": "Minecraft Data Pack Dimension", "type": "object" }

grunt-watch-task.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": { "$ref": "#/definitions/target" }, "definitions": { "target": { "required": ["files"], "properties": { "files": { "type": "array", "description": "One or more files to watch.", "items": { "type": "string" } }, "tasks": { "type": "array", "description": "One or more tasks to run.", "items": { "type": "string" } }, "options": { "$ref": "#/definitions/options" } } }, "optionsWithEvents": { "oneOf": [ { "properties": { "events": { "description": "Specify the type watch event that trigger the specified task.", "type": "array", "items": { "$ref": "#/definitions/eventType" } } } }, { "properties": { "events": { "$ref": "#/definitions/eventType" } } } ] }, "eventType": { "type": "string", "description": "Specify the type watch event that trigger the specified task.", "default": "all", "enum": ["all", "changed", "added", "deleted"] }, "options": { "type": "object", "description": "One or more files to watch.", "allOf": [ { "$ref": "#/definitions/optionsWithEvents" } ], "properties": { "spawn": { "type": "boolean", "description": "Whether to spawn task runs in a child process.", "default": true }, "interrupt": { "type": "boolean", "description": "As files are modified this watch task will spawn tasks in child processes.", "default": false }, "debounceDelay": { "type": "integer", "description": "How long to wait before emitting events in succession for the same filepath and status. For example if your Gruntfile.js file was changed, a 'changed' event will only fire again after the given milliseconds.", "default": 500 }, "interval": { "type": "integer", "description": "The interval is passed to 'fs.watchFile'. Since 'interval' is only used by 'fs.watchFile' and this watcher also uses 'fs.watch'; it is recommended to ignore this option.", "default": 100 }, "reload": { "type": "boolean", "description": "By default, if Gruntfile.js is being watched, then changes to it will trigger the watch task to restart, and reload the Gruntfile.js changes. When reload is set to true, changes to any of the watched files will trigger the watch task to restart. This is especially useful if your Gruntfile.js is dependent on other files.", "default": false }, "forever": { "type": "boolean", "description": "This is only a task level option and cannot be configured per target. By default the watch task will duck punch grunt.fatal and grunt.warn to try and prevent them from exiting the watch process. If you don't want grunt.fatal and grunt.warn to be overridden set the forever option to false.", "default": true }, "atBegin": { "type": "boolean", "description": "This option will trigger the run of each specified task at startup of the watcher.", "default": false }, "livereload": { "type": ["boolean", "number"], "description": "If enabled a live reload server will be started with the watch task per target. Then after the indicated tasks have run, the live reload server will be triggered with the modified files.", "default": false }, "cwd": { "type": ["string", "object"], "description": "Ability to set the current working directory." }, "livereloadOnError": { "type": "boolean", "description": "Option to prevent the livereload if the executed tasks encountered an error. If set to false , the livereload will only be triggered if all tasks completed successfully.", "default": true } } } }, "id": "https://json.schemastore.org/grunt-watch-task.json", "properties": { "options": { "$ref": "#/definitions/options" } }, "title": "JSON schema for the Grunt Watch task", "type": "object" }

traefik-v2-file-provider.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "httpRouter": { "type": "object", "description": "A router is in charge of connecting incoming requests to the services that can handle them. In the process, routers may use pieces of middleware to update the request, or act before forwarding the request to the service.", "properties": { "entryPoints": { "type": "array", "description": "If not specified, HTTP routers will accept requests from all defined entry points. If you want to limit the router scope to a set of entry points, set the entryPoints option.", "items": { "type": "string" } }, "rule": { "type": "string", "description": "Rules are a set of matchers configured with values, that determine if a particular request matches specific criteria. If the rule is verified, the router becomes active, calls middlewares, and then forwards the request to the service." }, "priority": { "type": "integer", "description": "To avoid path overlap, routes are sorted, by default, in descending order using rules length. The priority is directly equal to the length of the rule, and so the longest length has the highest priority. A value of 0 for the priority is ignored: priority = 0 means that the default rules length sorting is used.", "default": 0, "minimum": 0 }, "middlewares": { "type": "array", "description": "You can attach a list of middlewares to each HTTP router. The middlewares will take effect only if the rule matches, and before forwarding the request to the service. Middlewares are applied in the same order as their declaration in router.", "items": { "type": "string" } }, "service": { "type": "string", "description": "Each request must eventually be handled by a service, which is why each router definition should include a service target, which is basically where the request will be passed along to. HTTP routers can only target HTTP services (not TCP services)." }, "tls": { "type": "object", "description": "When a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only (and that the router should ignore HTTP (non TLS) requests). Traefik will terminate the SSL connections (meaning that it will send decrypted data to the services). If you need to define the same route for both HTTP and HTTPS requests, you will need to define two different routers: one with the tls section, one without.", "properties": { "options": { "type": "string", "description": "The options field enables fine-grained control of the TLS parameters. It refers to a TLS Options and will be applied only if a Host rule is defined." }, "certResolver": { "type": "string", "description": "If certResolver is defined, Traefik will try to generate certificates based on routers Host & HostSNI rules." }, "domains": { "type": "array", "description": "You can set SANs (alternative domains) for each main domain. Every domain must have A/AAAA records pointing to Traefik. Each domain & SAN will lead to a certificate request.", "items": { "type": "object", "properties": { "main": { "type": "string", "description": "Main defines the main domain name." }, "sans": { "type": "array", "description": "SANs defines the subject alternative domain names.", "items": { "type": "string" } } } } } } } }, "additionalProperties": false, "required": ["rule", "service"] }, "httpLoadBalancerService": { "type": "object", "description": "The load balancers are able to load balance the requests between multiple instances of your programs.\n\nEach service has a load-balancer, even if there is only one server to forward traffic to.", "properties": { "servers": { "type": "array", "description": "Servers declare a single instance of your program.", "minItems": 1, "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The url option point to a specific instance. Paths in the servers' url have no effect. If you want the requests to be sent to a specific path on your servers, configure your routers to use a corresponding middleware (e.g. the AddPrefix or ReplacePath) middlewares." } }, "required": ["url"] } }, "sticky": { "type": "object", "description": "When sticky sessions are enabled, a cookie is set on the initial request and response to let the client know which server handles the first response. On subsequent requests, to keep the session alive with the same server, the client should resend the same cookie.", "properties": { "cookie": { "type": "object", "properties": { "name": { "type": "string", "description": "The default cookie name is an abbreviation of a sha1 (ex: _1d52e)." }, "secure": { "type": "boolean", "default": false }, "httpOnly": { "type": "boolean", "default": false }, "sameSite": { "type": "string", "description": "Can be none, lax, strict or empty.", "default": "" } } } } }, "healthCheck": { "type": "object", "description": "Configure health check to remove unhealthy servers from the load balancing rotation. Traefik will consider your servers healthy as long as they return status codes between 2XX and 3XX to the health check requests (carried out every interval). Traefik keeps monitoring the health of unhealthy servers. If a server has recovered (returning 2xx -> 3xx responses again), it will be added back to the load balancer rotation pool.", "properties": { "method": { "type": "string", "description": "If defined, will apply this Method for the health check request." }, "path": { "type": "string", "description": "path is appended to the server URL to set the health check endpoint." }, "scheme": { "type": "string", "description": "If defined, will replace the server URL scheme for the health check endpoint" }, "hostname": { "type": "string", "description": "If defined, will apply Host header hostname to the health check request." }, "port": { "type": "integer", "description": "If defined, will replace the server URL port for the health check endpoint." }, "interval": { "type": "string", "description": "Defines the frequency of the health check calls. Interval is to be given in a format understood by `time.ParseDuration`. The interval must be greater than the timeout. If configuration doesn't reflect this, the interval will be set to timeout + 1 second." }, "timeout": { "type": "string", "description": "Defines the maximum duration Traefik will wait for a health check request before considering the server failed (unhealthy). Timeout is to be given in a format understood by `time.ParseDuration`." }, "headers": { "type": "object", "description": "Defines custom headers to be sent to the health check endpoint.", "additionalProperties": { "type": "string" } }, "followRedirects": { "type": "boolean", "description": "Defines whether redirects should be followed during the health check calls (default: true).", "default": true } } }, "passHostHeader": { "type": "boolean", "description": "The passHostHeader allows to forward client Host header to server. By default, passHostHeader is true.", "default": true }, "responseForwarding": { "type": "object", "description": "Defines how Traefik forwards the response from the backend server to the client.", "properties": { "flushInterval": { "type": "string", "description": "Specifies the interval in between flushes to the client while copying the response body. It is a duration in milliseconds, defaulting to 100. A negative value means to flush immediately after each write to the client. The flushInterval is ignored when ReverseProxy recognizes a response as a streaming response; for such responses, writes are flushed to the client immediately." } } }, "serversTransport": { "type": "string" } }, "additionalProperties": false, "required": ["servers"] }, "httpWeightedService": { "type": "object", "description": "The WRR is able to load balance the requests between multiple services based on weights.\n\nThis strategy is only available to load balance between services and not between servers.", "properties": { "services": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "weight": { "type": "number" } } } }, "sticky": { "type": "object", "description": "When sticky sessions are enabled, a cookie is set on the initial request and response to let the client know which server handles the first response. On subsequent requests, to keep the session alive with the same server, the client should resend the same cookie.", "properties": { "cookie": { "type": "object", "properties": { "name": { "type": "string", "description": "The default cookie name is an abbreviation of a sha1 (ex: _1d52e)." }, "secure": { "type": "boolean", "default": false }, "httpOnly": { "type": "boolean", "default": false }, "sameSite": { "type": "string", "description": "Can be none, lax, strict or empty.", "default": "" } } } } }, "healthCheck": { "type": "object" } }, "additionalProperties": false }, "httpMirroringService": { "type": "object", "description": "The mirroring is able to mirror requests sent to a service to other services. Please note that by default the whole request is buffered in memory while it is being mirrored. See the maxBodySize option for how to modify this behaviour.", "properties": { "service": { "type": "string" }, "maxBodySize": { "type": "integer", "description": "maxBodySize is the maximum size allowed for the body of the request. If the body is larger, the request is not mirrored. Default value is -1, which means unlimited size.", "default": -1 }, "mirrors": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "percent": { "type": "number", "minimum": 0, "maximum": 100 } } } }, "healthCheck": { "type": "object" } }, "additionalProperties": false }, "httpFailoverService": { "type": "object", "properties": { "service": { "type": "string" }, "fallback": { "type": "string" }, "healthCheck": { "type": "object" } }, "additionalProperties": false }, "httpService": { "type": "object", "description": "The Services are responsible for configuring how to reach the actual services that will eventually handle the incoming requests.", "oneOf": [ { "properties": { "loadBalancer": { "$ref": "#/definitions/httpLoadBalancerService" } }, "additionalProperties": false }, { "properties": { "weighted": { "$ref": "#/definitions/httpWeightedService" } }, "additionalProperties": false }, { "properties": { "mirroring": { "$ref": "#/definitions/httpMirroringService" } }, "additionalProperties": false }, { "properties": { "failover": { "$ref": "#/definitions/httpFailoverService" } }, "additionalProperties": false } ] }, "addPrefixMiddleware": { "type": "object", "description": "The AddPrefix middleware updates the URL Path of the request before forwarding it.", "properties": { "prefix": { "type": "string", "description": "prefix is the string to add before the current path in the requested URL. It should include the leading slash (/)." } }, "additionalProperties": false }, "basicAuthMiddleware": { "type": "object", "description": "The BasicAuth middleware is a quick way to restrict access to your services to known users. If both users and usersFile are provided, the two are merged. The contents of usersFile have precedence over the values in users.", "properties": { "users": { "type": "array", "description": "The users option is an array of authorized users. Each user will be declared using the `name:hashed-password` format.", "items": { "type": "string" } }, "usersFile": { "type": "string", "description": "The usersFile option is the path to an external file that contains the authorized users for the middleware.\n\nThe file content is a list of `name:hashed-password`." }, "realm": { "type": "string", "description": "You can customize the realm for the authentication with the realm option. The default value is traefik.", "default": "traefik" }, "headerField": { "type": "string", "description": "You can define a header field to store the authenticated user using the headerField option." }, "removeHeader": { "type": "boolean", "description": "Set the removeHeader option to true to remove the authorization header before forwarding the request to your service. (Default value is false.)", "default": false } } }, "bufferingMiddleware": { "type": "object", "description": "The Buffering middleware gives you control on how you want to read the requests before sending them to services.\n\nWith Buffering, Traefik reads the entire request into memory (possibly buffering large requests into disk), and rejects requests that are over a specified limit.\n\nThis can help services deal with large data (multipart/form-data for example), and can minimize time spent sending data to a service.", "properties": { "maxRequestBodyBytes": { "type": "integer", "description": "With the maxRequestBodyBytes option, you can configure the maximum allowed body size for the request (in Bytes).\n\nIf the request exceeds the allowed size, it is not forwarded to the service and the client gets a 413 (Request Entity Too Large) response." }, "memRequestBodyBytes": { "type": "integer", "description": "You can configure a threshold (in Bytes) from which the request will be buffered on disk instead of in memory with the memRequestBodyBytes option." }, "maxResponseBodyBytes": { "type": "integer", "description": "With the maxResponseBodyBytes option, you can configure the maximum allowed response size from the service (in Bytes).\n\nIf the response exceeds the allowed size, it is not forwarded to the client. The client gets a 413 (Request Entity Too Large) response instead." }, "memResponseBodyBytes": { "type": "integer", "description": "You can configure a threshold (in Bytes) from which the response will be buffered on disk instead of in memory with the memResponseBodyBytes option." }, "retryExpression": { "type": "string", "description": "You can have the Buffering middleware replay the request with the help of the retryExpression option." } }, "additionalProperties": false }, "chainMiddleware": { "type": "object", "description": "The Chain middleware enables you to define reusable combinations of other pieces of middleware. It makes reusing the same groups easier.", "properties": { "middlewares": { "type": "array", "minItems": 1, "items": { "type": "string" } } }, "additionalProperties": false }, "circuitBreakerMiddleware": { "type": "object", "description": "The circuit breaker protects your system from stacking requests to unhealthy services (resulting in cascading failures).\n\nWhen your system is healthy, the circuit is closed (normal operations). When your system becomes unhealthy, the circuit becomes open and the requests are no longer forwarded (but handled by a fallback mechanism).\n\nTo assess if your system is healthy, the circuit breaker constantly monitors the services.", "properties": { "expression": { "type": "string", "description": "You can specify an expression that, once matched, will trigger the circuit breaker (and apply the fallback mechanism instead of calling your services)." }, "checkPeriod": { "type": "string", "description": "The interval between successive checks of the circuit breaker condition (when in standby state)" }, "fallbackDuration": { "type": "string", "description": "The duration for which the circuit breaker will wait before trying to recover (from a tripped state)." }, "recoveryDuration": { "type": "string", "description": "The duration for which the circuit breaker will try to recover (as soon as it is in recovering state)." } }, "additionalProperties": false }, "compressMiddleware": { "type": "object", "description": "The Compress middleware enables the gzip compression.", "properties": { "excludedContentTypes": { "type": "array", "description": "excludedContentTypes specifies a list of content types to compare the Content-Type header of the incoming requests to before compressing.\n\nThe requests with content types defined in excludedContentTypes are not compressed.\n\nContent types are compared in a case-insensitive, whitespace-ignored manner.", "items": { "type": "string" } }, "minResponseBodyBytes": { "description": "specifies the minimum amount of bytes a response body must have to be compressed.", "type": "integer" } }, "additionalProperties": false }, "contentTypeMiddleware": { "type": "object", "description": "The Content-Type middleware - or rather its unique autoDetect option - specifies whether to let the Content-Type header, if it has not been set by the backend, be automatically set to a value derived from the contents of the response.\n\nAs a proxy, the default behavior should be to leave the header alone, regardless of what the backend did with it. However, the historic default was to always auto-detect and set the header if it was nil, and it is going to be kept that way in order to support users currently relying on it. This middleware exists to enable the correct behavior until at least the default one can be changed in a future version.", "properties": { "autoDetect": { "type": "boolean", "description": "autoDetect specifies whether to let the Content-Type header, if it has not been set by the backend, be automatically set to a value derived from the contents of the response.", "default": false } }, "additionalProperties": false }, "digestAuthMiddleware": { "type": "object", "description": "The DigestAuth middleware is a quick way to restrict access to your services to known users. If both users and usersFile are provided, the two are merged. The contents of usersFile have precedence over the values in users.", "properties": { "users": { "type": "array", "description": "The users option is an array of authorized users. Each user will be declared using the `name:realm:encoded-password` format.", "items": { "type": "string" } }, "usersFile": { "type": "string", "description": "The usersFile option is the path to an external file that contains the authorized users for the middleware.\n\nThe file content is a list of `name:realm:encoded-password`." }, "realm": { "type": "string", "description": "You can customize the realm for the authentication with the realm option. The default value is traefik.", "default": "traefik" }, "headerField": { "type": "string", "description": "You can customize the header field for the authenticated user using the headerField option." }, "removeHeader": { "type": "boolean", "description": "Set the removeHeader option to true to remove the authorization header before forwarding the request to your service. (Default value is false.)", "default": false } }, "additionalProperties": false }, "errorsMiddleware": { "type": "object", "description": "The ErrorPage middleware returns a custom page in lieu of the default, according to configured ranges of HTTP Status codes. The error page itself is not hosted by Traefik.", "properties": { "status": { "type": "array", "description": "The status that will trigger the error page.\n\nThe status code ranges are inclusive (500-599 will trigger with every code between 500 and 599, 500 and 599 included). You can define either a status code like 500 or ranges with a syntax like 500-599.", "items": { "type": "string" } }, "service": { "type": "string", "description": "The service that will serve the new requested error page." }, "query": { "type": "string", "description": "The URL for the error page (hosted by service). You can use {status} in the query, that will be replaced by the received status code." } }, "additionalProperties": false }, "forwardAuthMiddleware": { "type": "object", "description": "The ForwardAuth middleware delegate the authentication to an external service. If the service response code is 2XX, access is granted and the original request is performed. Otherwise, the response from the authentication server is returned.", "properties": { "address": { "type": "string", "description": "The address option defines the authentication server address." }, "tls": { "type": "object", "description": "The tls option is the TLS configuration from Traefik to the authentication server.", "properties": { "ca": { "type": "string", "description": "Certificate Authority used for the secured connection to the authentication server." }, "caOptional": { "type": "boolean", "description": "Policy used for the secured connection with TLS Client Authentication to the authentication server. Requires tls.ca to be defined." }, "cert": { "type": "string", "description": "Public certificate used for the secured connection to the authentication server." }, "key": { "type": "string", "description": "Private certificate used for the secure connection to the authentication server." }, "insecureSkipVerify": { "type": "boolean", "description": "If insecureSkipVerify is true, TLS for the connection to authentication server accepts any certificate presented by the server and any host name in that certificate." } }, "dependencies": { "caOptional": ["ca"] } }, "trustForwardHeader": { "type": "boolean", "description": "Set the trustForwardHeader option to true to trust all the existing X-Forwarded-* headers." }, "authResponseHeaders": { "type": "array", "description": "The authResponseHeaders option is the list of the headers to copy from the authentication server to the request.", "items": { "type": "string" } }, "authResponseHeadersRegex": { "type": "string", "description": "The authResponseHeadersRegex option is the regex to match headers to copy from the authentication server response and set on forwarded request, after stripping all headers that match the regex." }, "authRequestHeaders": { "type": "array", "description": "The authRequestHeaders option is the list of the headers to copy from the request to the authentication server.", "items": { "type": "string" } } }, "additionalProperties": false }, "headersMiddleware": { "type": "object", "description": "The Headers middleware can manage the requests/responses headers.", "properties": { "customRequestHeaders": { "type": "object", "description": "The customRequestHeaders option lists the Header names and values to apply to the request.", "additionalProperties": { "type": "string" } }, "customResponseHeaders": { "type": "object", "description": "The customResponseHeaders option lists the Header names and values to apply to the response.", "additionalProperties": { "type": "string" } }, "accessControlAllowCredentials": { "type": "boolean", "description": "The accessControlAllowCredentials indicates whether the request can include user credentials." }, "accessControlAllowHeaders": { "type": "array", "description": "The accessControlAllowHeaders indicates which header field names can be used as part of the request.", "items": { "type": "string" } }, "accessControlAllowMethods": { "type": "array", "description": "The accessControlAllowMethods indicates which methods can be used during requests.", "items": { "type": "string" } }, "accessControlAllowOriginList": { "type": "array", "description": "The accessControlAllowOriginList indicates whether a resource can be shared by returning different values.\n\nA wildcard origin * can also be configured, and will match all requests. If this value is set by a backend server, it will be overwritten by Traefik\n\nThis value can contain a list of allowed origins.", "items": { "type": "string" } }, "accessControlAllowOriginListRegex": { "type": "array", "description": "The accessControlAllowOriginListRegex option is the counterpart of the accessControlAllowOriginList option with regular expressions instead of origin values.", "items": { "type": "string" } }, "accessControlExposeHeaders": { "type": "array", "description": "The accessControlExposeHeaders indicates which headers are safe to expose to the api of a CORS API specification.", "items": { "type": "string" } }, "accessControlMaxAge": { "type": "integer", "description": "The accessControlMaxAge indicates how long (in seconds) a preflight request can be cached." }, "addVaryHeader": { "type": "boolean", "description": "The addVaryHeader is used in conjunction with accessControlAllowOriginList to determine whether the vary header should be added or modified to demonstrate that server responses can differ based on the value of the origin header." }, "allowedHosts": { "type": "array", "description": "The allowedHosts option lists fully qualified domain names that are allowed.", "items": { "type": "string" } }, "hostsProxyHeaders": { "type": "array", "description": "The hostsProxyHeaders option is a set of header keys that may hold a proxied hostname value for the request.", "items": { "type": "string" } }, "sslRedirect": { "type": "boolean", "description": "The sslRedirect is set to true, then only allow https requests." }, "sslTemporaryRedirect": { "type": "boolean", "description": "Set the sslTemporaryRedirect to true to force an SSL redirection using a 302 (instead of a 301)." }, "sslHost": { "type": "string", "description": "The sslHost option is the host name that is used to redirect http requests to https." }, "sslProxyHeaders": { "type": "object", "description": "The sslProxyHeaders option is set of header keys with associated values that would indicate a valid https request. Useful when using other proxies with header like: \"X-Forwarded-Proto\": \"https\".", "additionalProperties": { "type": "string" } }, "sslForceHost": { "type": "boolean", "description": "Set sslForceHost to true and set SSLHost to forced requests to use SSLHost even the ones that are already using SSL." }, "stsSeconds": { "type": "integer", "description": "The stsSeconds is the max-age of the Strict-Transport-Security header. If set to 0, would NOT include the header." }, "stsIncludeSubdomains": { "type": "boolean", "description": "The stsIncludeSubdomains is set to true, the includeSubDomains directive will be appended to the Strict-Transport-Security header." }, "stsPreload": { "type": "boolean", "description": "Set stsPreload to true to have the preload flag appended to the Strict-Transport-Security header." }, "forceSTSHeader": { "type": "boolean", "description": "Set forceSTSHeader to true, to add the STS header even when the connection is HTTP." }, "frameDeny": { "type": "boolean", "description": "Set frameDeny to true to add the X-Frame-Options header with the value of DENY." }, "customFrameOptionsValue": { "type": "string", "description": "The customFrameOptionsValue allows the X-Frame-Options header value to be set with a custom value. This overrides the FrameDeny option." }, "contentTypeNosniff": { "type": "boolean", "description": "Set contentTypeNosniff to true to add the X-Content-Type-Options header with the value nosniff." }, "browserXssFilter": { "type": "boolean", "description": "Set browserXssFilter to true to add the X-XSS-Protection header with the value 1; mode=block." }, "customBrowserXSSValue": { "type": "string", "description": "The customBrowserXssValue option allows the X-XSS-Protection header value to be set with a custom value. This overrides the BrowserXssFilter option." }, "contentSecurityPolicy": { "type": "string", "description": "The contentSecurityPolicy option allows the Content-Security-Policy header value to be set with a custom value." }, "publicKey": { "type": "string", "description": "The publicKey implements HPKP to prevent MITM attacks with forged certificates." }, "referrerPolicy": { "type": "string", "description": "The referrerPolicy allows sites to control when browsers will pass the Referer header to other sites." }, "featurePolicy": { "type": "string", "description": "The featurePolicy allows sites to control browser features." }, "permissionsPolicy": { "type": "string", "description": "The permissionsPolicy allows sites to control browser features." }, "isDevelopment": { "type": "boolean", "description": "Set isDevelopment to true when developing. The AllowedHosts, SSL, and STS options can cause some unwanted effects. Usually testing happens on http, not https, and on localhost, not your production domain.\nIf you would like your development environment to mimic production with complete Host blocking, SSL redirects, and STS headers, leave this as false." } }, "additionalProperties": false }, "ipStrategy": { "type": "object", "description": "The ipStrategy option defines parameters that set how Traefik will determine the client IP.", "properties": { "depth": { "type": "integer", "description": "The depth option tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right). If depth is greater than the total number of IPs in X-Forwarded-For, then the client IP will be empty. depth is ignored if its value is lesser than or equal to 0." }, "excludedIPs": { "type": "array", "description": "excludedIPs tells Traefik to scan the X-Forwarded-For header and pick the first IP not in the list. If depth is specified, excludedIPs is ignored.", "items": { "type": "string" } } }, "additionalProperties": false }, "ipWhiteListMiddleware": { "type": "object", "description": "IPWhitelist accepts / refuses requests based on the client IP.", "properties": { "sourceRange": { "type": "array", "description": "The sourceRange option sets the allowed IPs (or ranges of allowed IPs by using CIDR notation).", "items": { "type": "string" } }, "ipStrategy": { "$ref": "#/definitions/ipStrategy" } }, "additionalProperties": false }, "sourceCriterion": { "type": "object", "description": "SourceCriterion defines what criterion is used to group requests as originating from a common source. The precedence order is ipStrategy, then requestHeaderName, then requestHost. If none are set, the default is to use the requestHost.", "properties": { "ipStrategy": { "$ref": "#/definitions/ipStrategy" }, "requestHeaderName": { "type": "string", "description": "Requests having the same value for the given header are grouped as coming from the same source." }, "requestHost": { "type": "boolean", "description": "Whether to consider the request host as the source." } }, "additionalProperties": false }, "inFlightReqMiddleware": { "type": "object", "description": "To proactively prevent services from being overwhelmed with high load, a limit on the number of simultaneous in-flight requests can be applied.", "properties": { "amount": { "type": "integer", "description": "The amount option defines the maximum amount of allowed simultaneous in-flight request. The middleware will return an HTTP 429 Too Many Requests if there are already amount requests in progress (based on the same sourceCriterion strategy)." }, "sourceCriterion": { "$ref": "#/definitions/sourceCriterion" } }, "additionalProperties": false }, "passTLSClientCertMiddleware": { "type": "object", "description": "PassTLSClientCert adds in header the selected data from the passed client tls certificate.", "properties": { "pem": { "type": "boolean", "description": "The pem option sets the X-Forwarded-Tls-Client-Cert header with the escape certificate." }, "info": { "type": "object", "description": "The info option select the specific client certificate details you want to add to the X-Forwarded-Tls-Client-Cert-Info header. The value of the header will be an escaped concatenation of all the selected certificate details.", "properties": { "notAfter": { "type": "boolean", "description": "Set the notAfter option to true to add the Not After information from the Validity part." }, "notBefore": { "type": "boolean", "description": "Set the notBefore option to true to add the Not Before information from the Validity part." }, "sans": { "type": "boolean", "description": "Set the sans option to true to add the Subject Alternative Name information from the Subject Alternative Name part." }, "subject": { "type": "object", "description": "The subject select the specific client certificate subject details you want to add to the X-Forwarded-Tls-Client-Cert-Info header.", "properties": { "country": { "type": "boolean", "description": "Set the country option to true to add the country information into the subject." }, "province": { "type": "boolean", "description": "Set the province option to true to add the province information into the subject." }, "locality": { "type": "boolean", "description": "Set the locality option to true to add the locality information into the subject." }, "organization": { "type": "boolean", "description": "Set the organization option to true to add the organization information into the subject." }, "commonName": { "type": "boolean", "description": "Set the commonName option to true to add the commonName information into the subject." }, "serialNumber": { "type": "boolean", "description": "Set the serialNumber option to true to add the serialNumber information into the subject." }, "domainComponent": { "type": "boolean", "description": "Set the domainComponent option to true to add the domainComponent information into the subject." } } }, "issuer": { "type": "object", "description": "The issuer select the specific client certificate issuer details you want to add to the X-Forwarded-Tls-Client-Cert-Info header.", "properties": { "country": { "type": "boolean", "description": "Set the country option to true to add the country information into the issuer." }, "province": { "type": "boolean", "description": "Set the province option to true to add the province information into the issuer." }, "locality": { "type": "boolean", "description": "Set the locality option to true to add the locality information into the issuer." }, "organization": { "type": "boolean", "description": "Set the organization option to true to add the organization information into the issuer." }, "commonName": { "type": "boolean", "description": "Set the commonName option to true to add the commonName information into the issuer." }, "serialNumber": { "type": "boolean", "description": "Set the serialNumber option to true to add the serialNumber information into the issuer." }, "domainComponent": { "type": "boolean", "description": "Set the domainComponent option to true to add the domainComponent information into the issuer." } } } } } }, "additionalProperties": false }, "pluginMiddleware": { "type": "object", "description": "Some plugins will need to be configured by adding a dynamic configuration.", "additionalProperties": { "type": "object" } }, "rateLimitMiddleware": { "type": "object", "description": "The RateLimit middleware ensures that services will receive a fair number of requests, and allows one to define what fair is.", "properties": { "average": { "description": "average is the maximum rate, by default in requests by second, allowed for the given source.\n\nIt defaults to 0, which means no rate limiting.\n\nThe rate is actually defined by dividing average by period. So for a rate below 1 req/s, one needs to define a period larger than a second.", "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "period": { "oneOf": [ { "type": "string" }, { "type": "number", "default": 1 } ], "description": "period, in combination with average, defines the actual maximum rate.\n\nIt defaults to 1 second." }, "burst": { "type": "number", "description": "burst is the maximum number of requests allowed to go through in the same arbitrarily small period of time.\n\nIt defaults to 1.", "default": 1 }, "sourceCriterion": { "$ref": "#/definitions/sourceCriterion" } }, "additionalProperties": false }, "redirectRegexMiddleware": { "type": "object", "description": "RegexRedirect redirect a request from an url to another with regex matching and replacement.", "properties": { "permanent": { "type": "boolean", "description": "Set the permanent option to true to apply a permanent redirection." }, "regex": { "type": "string", "description": "The regex option is the regular expression to match and capture elements from the request URL." }, "replacement": { "type": "string", "description": "The replacement option defines how to modify the URL to have the new target URL. Care should be taken when defining replacement expand variables: $1x is equivalent to ${1x}, not ${1}x (see Regexp.Expand), so use ${1} syntax." } }, "additionalProperties": false }, "redirectSchemeMiddleware": { "type": "object", "description": "RedirectScheme redirect request from a scheme to another.", "properties": { "permanent": { "type": "boolean", "description": "Set the permanent option to true to apply a permanent redirection." }, "scheme": { "type": "string", "description": "The scheme option defines the scheme of the new url." }, "port": { "type": "string", "description": "The port option defines the port of the new url. Port in this configuration is a string, not a numeric value." } }, "additionalProperties": false }, "replacePathMiddleware": { "type": "object", "description": "Replace the path of the request url. It will replace the actual path by the specified one and will store the original path in a X-Replaced-Path header.", "properties": { "path": { "type": "string", "description": "The path option defines the path to use as replacement in the request url." } }, "additionalProperties": false }, "replacePathRegexMiddleware": { "type": "object", "description": "The ReplaceRegex replace a path from an url to another with regex matching and replacement. It will replace the actual path by the specified one and store the original path in a X-Replaced-Path header.", "properties": { "regex": { "type": "string", "description": "The regex option is the regular expression to match and capture the path from the request URL." }, "replacement": { "type": "string", "description": "The replacement option defines how to modify the path to have the new target path. Care should be taken when defining replacement expand variables: $1x is equivalent to ${1x}, not ${1}x (see Regexp.Expand), so use ${1} syntax." } }, "additionalProperties": false }, "retryMiddleware": { "type": "object", "description": "The Retry middleware is in charge of reissuing a request a given number of times to a backend server if that server does not reply. To be clear, as soon as the server answers, the middleware stops retrying, regardless of the response status.", "properties": { "attempts": { "type": "integer", "description": "The attempts option defines how many times the request should be retried." }, "initialInterval": { "type": "string", "description": "The initialInterval option defines the first wait time in the exponential backoff series." } }, "additionalProperties": false, "required": ["attempts"] }, "stripPrefixMiddleware": { "type": "object", "description": "Remove the specified prefixes from the URL path. It will strip the matching path prefix and will store the matching path prefix in a X-Forwarded-Prefix header.", "properties": { "prefixes": { "type": "array", "description": "The prefixes option defines the prefixes to strip from the request URL", "items": { "type": "string" } }, "forceSlash": { "type": "boolean", "description": "The forceSlash option makes sure that the resulting stripped path is not the empty string, by replacing it with / when necessary.\n\nThis option was added to keep the initial (non-intuitive) behavior of this middleware, in order to avoid introducing a breaking change.\n\nIt's recommended to explicitly set forceSlash to false." } }, "additionalProperties": false }, "stripPrefixRegexMiddleware": { "type": "object", "description": "Remove the matching prefixes from the URL path. It will strip the matching path prefix and will store the matching path prefix in a X-Forwarded-Prefix header.", "properties": { "regex": { "type": "array", "description": "The regex option is the regular expression to match the path prefix from the request URL.", "items": { "type": "string" } } }, "additionalProperties": false }, "httpMiddleware": { "type": "object", "oneOf": [ { "properties": { "addPrefix": { "$ref": "#/definitions/addPrefixMiddleware" } }, "additionalProperties": false }, { "properties": { "basicAuth": { "$ref": "#/definitions/basicAuthMiddleware" } }, "additionalProperties": false }, { "properties": { "buffering": { "$ref": "#/definitions/bufferingMiddleware" } }, "additionalProperties": false }, { "properties": { "chain": { "$ref": "#/definitions/chainMiddleware" } }, "additionalProperties": false }, { "properties": { "circuitBreaker": { "$ref": "#/definitions/circuitBreakerMiddleware" } }, "additionalProperties": false }, { "properties": { "compress": { "$ref": "#/definitions/compressMiddleware" } }, "additionalProperties": false }, { "properties": { "contentType": { "$ref": "#/definitions/contentTypeMiddleware" } }, "additionalProperties": false }, { "properties": { "digestAuth": { "$ref": "#/definitions/digestAuthMiddleware" } }, "additionalProperties": false }, { "properties": { "errors": { "$ref": "#/definitions/errorsMiddleware" } }, "additionalProperties": false }, { "properties": { "forwardAuth": { "$ref": "#/definitions/forwardAuthMiddleware" } }, "additionalProperties": false }, { "properties": { "headers": { "$ref": "#/definitions/headersMiddleware" } }, "additionalProperties": false }, { "properties": { "ipWhiteList": { "$ref": "#/definitions/ipWhiteListMiddleware" } }, "additionalProperties": false }, { "properties": { "inFlightReq": { "$ref": "#/definitions/inFlightReqMiddleware" } }, "additionalProperties": false }, { "properties": { "passTLSClientCert": { "$ref": "#/definitions/passTLSClientCertMiddleware" } }, "additionalProperties": false }, { "properties": { "plugin": { "$ref": "#/definitions/pluginMiddleware" } }, "additionalProperties": false }, { "properties": { "rateLimit": { "$ref": "#/definitions/rateLimitMiddleware" } }, "additionalProperties": false }, { "properties": { "redirectRegex": { "$ref": "#/definitions/redirectRegexMiddleware" } }, "additionalProperties": false }, { "properties": { "redirectScheme": { "$ref": "#/definitions/redirectSchemeMiddleware" } }, "additionalProperties": false }, { "properties": { "replacePath": { "$ref": "#/definitions/replacePathMiddleware" } }, "additionalProperties": false }, { "properties": { "replacePathRegex": { "$ref": "#/definitions/replacePathRegexMiddleware" } }, "additionalProperties": false }, { "properties": { "retry": { "$ref": "#/definitions/retryMiddleware" } }, "additionalProperties": false }, { "properties": { "stripPrefix": { "$ref": "#/definitions/stripPrefixMiddleware" } }, "additionalProperties": false }, { "properties": { "stripPrefixRegex": { "$ref": "#/definitions/stripPrefixRegexMiddleware" } }, "additionalProperties": false } ] }, "tcpRouter": { "type": "object", "description": "If both HTTP routers and TCP routers listen to the same entry points, the TCP routers will apply before the HTTP routers. If no matching route is found for the TCP routers, then the HTTP routers will take over.", "properties": { "entryPoints": { "type": "array", "description": "If not specified, TCP routers will accept requests from all defined entry points. If you want to limit the router scope to a set of entry points, set the entry points option.", "items": { "type": "string" } }, "middlewares": { "type": "array", "items": { "type": "string" } }, "rule": { "type": "string", "description": "It is important to note that the Server Name Indication is an extension of the TLS protocol. Hence, only TLS routers will be able to specify a domain name with that rule. However, non-TLS routers will have to explicitly use that rule with * (every domain) to state that every non-TLS request will be handled by the router." }, "service": { "type": "string", "description": "You must attach a TCP service per TCP router. Services are the target for the router. TCP routers can only target TCP services (not HTTP services)." }, "priority": { "type": "integer", "description": "To avoid path overlap, routes are sorted, by default, in descending order using rules length. The priority is directly equal to the length of the rule, and so the longest length has the highest priority. A value of 0 for the priority is ignored: priority = 0 means that the default rules length sorting is used.", "default": 0, "minimum": 0 }, "tls": { "type": "object", "description": "When a TLS section is specified, it instructs Traefik that the current router is dedicated to TLS requests only (and that the router should ignore non-TLS requests).\n\nBy default, a router with a TLS section will terminate the TLS connections, meaning that it will send decrypted data to the services.", "properties": { "passthrough": { "type": "boolean", "description": "A TLS router will terminate the TLS connection by default. However, the passthrough option can be specified to set whether the requests should be forwarded \"as is\", keeping all data encrypted.", "default": false }, "options": { "type": "string", "description": "The options field enables fine-grained control of the TLS parameters. It refers to a TLS Options and will be applied only if a Host rule is defined." }, "certResolver": { "type": "string", "description": "If certResolver is defined, Traefik will try to generate certificates based on routers Host & HostSNI rules." }, "domains": { "type": "array", "description": "You can set SANs (alternative domains) for each main domain. Every domain must have A/AAAA records pointing to Traefik. Each domain & SAN will lead to a certificate request.", "items": { "type": "object", "properties": { "main": { "type": "string", "description": "Main defines the main domain name." }, "sans": { "type": "array", "description": "SANs defines the subject alternative domain names.", "items": { "type": "string" } } } } } } } }, "additionalProperties": false, "required": ["rule", "service"] }, "tcpLoadBalancerService": { "type": "object", "properties": { "servers": { "type": "array", "description": "Servers declare a single instance of your program.", "minItems": 1, "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address option (IP:Port) point to a specific instance." } }, "required": ["address"] } }, "terminationDelay": { "type": "number", "description": "As a proxy between a client and a server, it can happen that either side (e.g. client side) decides to terminate its writing capability on the connection (i.e. issuance of a FIN packet). The proxy needs to propagate that intent to the other side, and so when that happens, it also does the same on its connection with the other side (e.g. backend side).\n\nHowever, if for some reason (bad implementation, or malicious intent) the other side does not eventually do the same as well, the connection would stay half-open, which would lock resources for however long.\n\nTo that end, as soon as the proxy enters this termination sequence, it sets a deadline on fully terminating the connections on both sides.\n\nThe termination delay controls that deadline. It is a duration in milliseconds, defaulting to 100. A negative value means an infinite deadline (i.e. the connection is never fully terminated by the proxy itself).", "default": 100 }, "proxyProtocol": { "type": "object", "properties": { "version": { "type": "integer" } } } }, "additionalProperties": false, "required": ["servers"] }, "tcpWeightedService": { "type": "object", "properties": { "services": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string" }, "weight": { "type": "number" } }, "additionalProperties": false, "required": ["name", "weight"] } } }, "additionalProperties": false, "required": ["services"] }, "tcpService": { "type": "object", "oneOf": [ { "properties": { "loadBalancer": { "$ref": "#/definitions/tcpLoadBalancerService" } }, "additionalProperties": false }, { "properties": { "weighted": { "$ref": "#/definitions/tcpWeightedService" } }, "additionalProperties": false } ] }, "udpRouter": { "type": "object", "properties": { "entryPoints": { "type": "array", "description": "If not specified, UDP routers will accept packets from all defined (UDP) entry points. If one wants to limit the router scope to a set of entry points, one should set the entry points option.", "items": { "type": "string" } }, "service": { "type": "string", "description": "There must be one (and only one) UDP service referenced per UDP router. Services are the target for the router." } }, "additionalProperties": false, "required": ["service"] }, "udpLoadBalancerService": { "type": "object", "description": "The servers load balancer is in charge of balancing the requests between the servers of the same service.", "properties": { "servers": { "type": "array", "description": "The servers field defines all the servers that are part of this load-balancing group, i.e. each address (IP:Port) on which an instance of the service's program is deployed.", "minItems": 1, "items": { "type": "object", "properties": { "address": { "type": "string" } }, "required": ["address"] } } }, "additionalProperties": false, "required": ["servers"] }, "udpWeightedService": { "type": "object", "properties": { "services": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string" }, "weight": { "type": "number" } }, "additionalProperties": false, "required": ["name", "weight"] } } }, "additionalProperties": false, "required": ["services"] }, "udpService": { "type": "object", "oneOf": [ { "properties": { "loadBalancer": { "$ref": "#/definitions/udpLoadBalancerService" } }, "additionalProperties": false }, { "properties": { "weighted": { "$ref": "#/definitions/udpWeightedService" } }, "additionalProperties": false } ] } }, "description": "Traefik v2 Dynamic Configuration File Provider", "id": "https://json.schemastore.org/traefik-v2-file-provider.json", "properties": { "http": { "type": "object", "properties": { "routers": { "type": "object", "additionalProperties": { "$ref": "#/definitions/httpRouter" } }, "services": { "type": "object", "additionalProperties": { "$ref": "#/definitions/httpService" } }, "middlewares": { "type": "object", "description": "Attached to the routers, pieces of middleware are a means of tweaking the requests before they are sent to your service (or before the answer from the services are sent to the clients).\n\nThere are several available middleware in Traefik, some can modify the request, the headers, some are in charge of redirections, some add authentication, and so on.\n\nPieces of middleware can be combined in chains to fit every scenario.", "additionalProperties": { "$ref": "#/definitions/httpMiddleware" } } } }, "tcp": { "type": "object", "properties": { "routers": { "type": "object", "additionalProperties": { "$ref": "#/definitions/tcpRouter" } }, "services": { "type": "object", "description": "Each of the fields of the service section represents a kind of service. Which means, that for each specified service, one of the fields, and only one, has to be enabled to define what kind of service is created. Currently, the two available kinds are LoadBalancer, and Weighted.", "additionalProperties": { "$ref": "#/definitions/tcpService" } } } }, "udp": { "type": "object", "additionalProperties": false, "properties": { "routers": { "type": "object", "description": "Similarly to TCP, as UDP is the transport layer, there is no concept of a request, so there is no notion of an URL path prefix to match an incoming UDP packet with. Furthermore, as there is no good TLS support at the moment for multiple hosts, there is no Host SNI notion to match against either. Therefore, there is no criterion that could be used as a rule to match incoming packets in order to route them. So UDP \"routers\" at this time are pretty much only load-balancers in one form or another.", "additionalProperties": { "$ref": "#/definitions/udpRouter" } }, "services": { "type": "object", "description": "Each of the fields of the service section represents a kind of service. Which means, that for each specified service, one of the fields, and only one, has to be enabled to define what kind of service is created. Currently, the two available kinds are LoadBalancer, and Weighted.", "additionalProperties": { "$ref": "#/definitions/udpService" } } } }, "tls": { "type": "object", "description": "Configures the TLS connection, TLS options, and certificate stores.", "additionalProperties": false, "properties": { "certificates": { "type": "array", "items": { "type": "object", "properties": { "certFile": { "type": "string" }, "keyFile": { "type": "string" }, "stores": { "type": "array", "description": "A list of stores can be specified here to indicate where the certificates should be stored. Although the stores list will actually be ignored and automatically set to [\"default\"].", "items": { "type": "string" } } } } }, "options": { "type": "object", "description": "The TLS options allow one to configure some parameters of the TLS connection.", "additionalProperties": false, "patternProperties": { "[a-zA-Z0-9-_]+": { "type": "object", "properties": { "minVersion": { "type": "string", "description": "Minimum TLS Version" }, "maxVersion": { "type": "string", "description": "Maximum TLS Version. It is discouraged to use of this setting to disable TLS1.3. The recommended approach is to update the clients to support TLS1.3." }, "cipherSuites": { "type": "array", "description": "Cipher suites defined for TLS 1.2 and below cannot be used in TLS 1.3, and vice versa. With TLS 1.3, the cipher suites are not configurable (all supported cipher suites are safe in this case).", "items": { "type": "string" } }, "curvePreferences": { "type": "array", "description": "This option allows to set the preferred elliptic curves in a specific order.\n\nThe names of the curves defined by crypto (e.g. CurveP521) and the RFC defined names (e.g. secp521r1) can be used.", "items": { "type": "string" } }, "sniStrict": { "type": "boolean", "description": "With strict SNI checking enabled, Traefik won't allow connections from clients that do not specify a server_name extension or don't match any certificate configured on the tlsOption." }, "preferServerCipherSuites": { "type": "boolean", "description": "This option allows the server to choose its most preferred cipher suite instead of the client's. Please note that this is enabled automatically when minVersion or maxVersion are set." }, "clientAuth": { "type": "object", "description": "Traefik supports mutual authentication, through the clientAuth section.", "properties": { "caFiles": { "type": "array", "description": "For authentication policies that require verification of the client certificate, the certificate authority for the certificate should be set here.", "items": { "type": "string" } }, "clientAuthType": { "type": "string" } } } } } } }, "stores": { "type": "object", "description": "Any store definition other than the default one (named default) will be ignored, and there is therefore only one globally available TLS store.", "patternProperties": { "[a-zA-Z0-9-_]+": { "type": "object", "additionalProperties": false, "properties": { "defaultCertificate": { "type": "object", "additionalProperties": false, "description": "Traefik can use a default certificate for connections without a SNI, or without a matching domain. If no default certificate is provided, Traefik generates and uses a self-signed certificate.", "properties": { "certFile": { "type": "string" }, "keyFile": { "type": "string" } } }, "defaultGeneratedCert": { "type": "object", "additionalProperties": false, "description": "GeneratedCert defines the default generated certificate configuration.", "properties": { "resolver": { "type": "string", "description": "Resolver is the name of the resolver that will be used to issue the DefaultCertificate." }, "domain": { "type": "object", "description": "Domain is the domain definition for the DefaultCertificate.", "properties": { "main": { "type": "string", "description": "Main defines the main domain name." }, "sans": { "type": "array", "description": "SANs defines the subject alternative domain names.", "items": { "type": "string" } } } } } } } } } } } } }, "type": "object" }

schema-pro.json

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/project", "$ref": "#/$defs/Project", "$defs": { "AUR": { "properties": { "name": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "commit_author": { "$ref": "#/$defs/CommitAuthor" }, "commit_msg_template": { "type": "string" }, "description": { "type": "string" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "skip_upload": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "url_template": { "type": "string" }, "maintainers": { "items": { "type": "string" }, "type": "array" }, "contributors": { "items": { "type": "string" }, "type": "array" }, "provides": { "items": { "type": "string" }, "type": "array" }, "conflicts": { "items": { "type": "string" }, "type": "array" }, "depends": { "items": { "type": "string" }, "type": "array" }, "optdepends": { "items": { "type": "string" }, "type": "array" }, "backup": { "items": { "type": "string" }, "type": "array" }, "rel": { "type": "string" }, "package": { "type": "string" }, "git_url": { "type": "string" }, "git_ssh_command": { "type": "string" }, "private_key": { "type": "string" }, "goamd64": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "After": { "properties": { "hooks": { "$ref": "#/$defs/Hooks" } }, "additionalProperties": false, "type": "object" }, "Announce": { "properties": { "skip": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "twitter": { "$ref": "#/$defs/Twitter" }, "mastodon": { "$ref": "#/$defs/Mastodon" }, "reddit": { "$ref": "#/$defs/Reddit" }, "slack": { "$ref": "#/$defs/Slack" }, "discord": { "$ref": "#/$defs/Discord" }, "teams": { "$ref": "#/$defs/Teams" }, "smtp": { "$ref": "#/$defs/SMTP" }, "mattermost": { "$ref": "#/$defs/Mattermost" }, "linkedin": { "$ref": "#/$defs/LinkedIn" }, "telegram": { "$ref": "#/$defs/Telegram" }, "webhook": { "$ref": "#/$defs/Webhook" }, "opencolletive": { "$ref": "#/$defs/OpenCollective" } }, "additionalProperties": false, "type": "object" }, "Archive": { "properties": { "id": { "type": "string" }, "builds": { "items": { "type": "string" }, "type": "array" }, "builds_info": { "$ref": "#/$defs/FileInfo" }, "name_template": { "type": "string" }, "format": { "type": "string", "enum": [ "tar", "tgz", "tar.gz", "zip", "gz", "tar.xz", "txz", "binary" ], "default": "tar.gz" }, "format_overrides": { "items": { "$ref": "#/$defs/FormatOverride" }, "type": "array" }, "wrap_in_directory": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "strip_parent_binary_folder": { "type": "boolean" }, "files": { "items": { "$ref": "#/$defs/File" }, "type": "array" }, "meta": { "type": "boolean" }, "allow_different_binary_count": { "type": "boolean" }, "hooks": { "$ref": "#/$defs/ArchiveHooks" }, "templated_files": { "items": { "$ref": "#/$defs/TemplatedFile" }, "type": "array" }, "rlcp": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "you can now remove this" } }, "additionalProperties": false, "type": "object" }, "ArchiveHooks": { "properties": { "before": { "$ref": "#/$defs/Hooks" }, "after": { "$ref": "#/$defs/Hooks" } }, "additionalProperties": false, "type": "object" }, "Before": { "properties": { "hooks": { "$ref": "#/$defs/Hooks" } }, "additionalProperties": false, "type": "object" }, "Blob": { "properties": { "bucket": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "disableSSL": { "type": "boolean" }, "folder": { "type": "string" }, "kmskey": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "endpoint": { "type": "string" }, "extra_files": { "items": { "$ref": "#/$defs/ExtraFile" }, "type": "array" }, "disable": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "templated_extra_files": { "items": { "$ref": "#/$defs/TemplatedExtraFile" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Build": { "properties": { "id": { "type": "string" }, "goos": { "items": { "type": "string" }, "type": "array" }, "goarch": { "items": { "type": "string" }, "type": "array" }, "goarm": { "items": { "type": "string" }, "type": "array" }, "gomips": { "items": { "type": "string" }, "type": "array" }, "goamd64": { "items": { "type": "string" }, "type": "array" }, "targets": { "items": { "type": "string" }, "type": "array" }, "ignore": { "items": { "$ref": "#/$defs/IgnoredBuild" }, "type": "array" }, "dir": { "type": "string" }, "main": { "type": "string" }, "binary": { "type": "string" }, "hooks": { "$ref": "#/$defs/BuildHookConfig" }, "builder": { "type": "string" }, "mod_timestamp": { "type": "string" }, "skip": { "type": "boolean" }, "gobinary": { "type": "string" }, "command": { "type": "string" }, "no_unique_dist_dir": { "type": "boolean" }, "no_main_check": { "type": "boolean" }, "buildmode": { "type": "string" }, "ldflags": { "$ref": "#/$defs/StringArray" }, "tags": { "$ref": "#/$defs/FlagArray" }, "flags": { "$ref": "#/$defs/FlagArray" }, "asmflags": { "$ref": "#/$defs/StringArray" }, "gcflags": { "$ref": "#/$defs/StringArray" }, "env": { "items": { "type": "string" }, "type": "array" }, "overrides": { "items": { "$ref": "#/$defs/BuildDetailsOverride" }, "type": "array" }, "prebuilt": { "$ref": "#/$defs/PreBuiltOptions" } }, "additionalProperties": false, "type": "object" }, "BuildDetailsOverride": { "properties": { "goos": { "type": "string" }, "goarch": { "type": "string" }, "goarm": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "gomips": { "type": "string" }, "goamd64": { "type": "string" }, "buildmode": { "type": "string" }, "ldflags": { "$ref": "#/$defs/StringArray" }, "tags": { "$ref": "#/$defs/FlagArray" }, "flags": { "$ref": "#/$defs/FlagArray" }, "asmflags": { "$ref": "#/$defs/StringArray" }, "gcflags": { "$ref": "#/$defs/StringArray" }, "env": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "BuildHookConfig": { "properties": { "pre": { "$ref": "#/$defs/Hooks" }, "post": { "$ref": "#/$defs/Hooks" } }, "additionalProperties": false, "type": "object" }, "Changelog": { "properties": { "filters": { "$ref": "#/$defs/Filters" }, "sort": { "type": "string", "enum": [ "asc", "desc", "" ], "default": "" }, "skip": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "use": { "type": "string", "enum": [ "git", "github", "github-native", "gitlab" ], "default": "git" }, "groups": { "items": { "$ref": "#/$defs/ChangelogGroup" }, "type": "array" }, "divider": { "type": "string" }, "abbrev": { "type": "integer" }, "paths": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "ChangelogGroup": { "properties": { "title": { "type": "string" }, "regexp": { "type": "string" }, "order": { "type": "integer" }, "groups": { "items": { "$ref": "#/$defs/ChangelogSubgroup" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "ChangelogSubgroup": { "properties": { "title": { "type": "string" }, "regexp": { "type": "string" }, "order": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Checksum": { "properties": { "name_template": { "type": "string" }, "algorithm": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "disable": { "type": "boolean" }, "extra_files": { "items": { "$ref": "#/$defs/ExtraFile" }, "type": "array" }, "templated_extra_files": { "items": { "$ref": "#/$defs/TemplatedExtraFile" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Chocolatey": { "properties": { "name": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "package_source_url": { "type": "string" }, "owners": { "type": "string" }, "title": { "type": "string" }, "authors": { "type": "string" }, "project_url": { "type": "string" }, "url_template": { "type": "string" }, "icon_url": { "type": "string" }, "copyright": { "type": "string" }, "license_url": { "type": "string" }, "require_license_acceptance": { "type": "boolean" }, "project_source_url": { "type": "string" }, "docs_url": { "type": "string" }, "bug_tracker_url": { "type": "string" }, "tags": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "release_notes": { "type": "string" }, "dependencies": { "items": { "$ref": "#/$defs/ChocolateyDependency" }, "type": "array" }, "skip_publish": { "type": "boolean" }, "api_key": { "type": "string" }, "source_repo": { "type": "string" }, "goamd64": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ChocolateyDependency": { "properties": { "id": { "type": "string" }, "version": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "CommitAuthor": { "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Content": { "properties": { "src": { "type": "string" }, "dst": { "type": "string" }, "type": { "type": "string", "enum": [ "symlink", "ghost", "config", "config|noreplace", "dir", "tree", "" ], "default": "" }, "packager": { "type": "string" }, "file_info": { "$ref": "#/$defs/ContentFileInfo" } }, "additionalProperties": false, "type": "object", "required": [ "dst" ] }, "ContentFileInfo": { "properties": { "owner": { "type": "string" }, "group": { "type": "string" }, "mode": { "type": "integer" }, "mtime": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "type": "object" }, "Contents": { "items": { "$ref": "#/$defs/Content" }, "type": "array" }, "Discord": { "properties": { "enabled": { "type": "boolean" }, "message_template": { "type": "string" }, "author": { "type": "string" }, "color": { "type": "string" }, "icon_url": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Docker": { "properties": { "id": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "goos": { "type": "string" }, "goarch": { "type": "string" }, "goarm": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "goamd64": { "type": "string" }, "dockerfile": { "type": "string" }, "image_templates": { "items": { "type": "string" }, "type": "array" }, "skip_build": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "skip_push": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "extra_files": { "items": { "type": "string" }, "type": "array" }, "build_flag_templates": { "items": { "type": "string" }, "type": "array" }, "push_flags": { "items": { "type": "string" }, "type": "array" }, "use": { "type": "string" }, "templated_files": { "items": { "$ref": "#/$defs/TemplatedExtraFileWithMode" }, "type": "array" }, "templated_dockerfile": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "DockerManifest": { "properties": { "id": { "type": "string" }, "name_template": { "type": "string" }, "skip_push": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "image_templates": { "items": { "type": "string" }, "type": "array" }, "create_flags": { "items": { "type": "string" }, "type": "array" }, "push_flags": { "items": { "type": "string" }, "type": "array" }, "use": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "EnvFiles": { "properties": { "github_token": { "type": "string" }, "gitlab_token": { "type": "string" }, "gitea_token": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ExtraFile": { "properties": { "glob": { "type": "string" }, "name_template": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "File": { "oneOf": [ { "type": "string" }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/t", "$defs": { "FileInfo": { "properties": { "owner": { "type": "string" }, "group": { "type": "string" }, "mode": { "type": "integer" }, "mtime": { "type": "string" } }, "additionalProperties": false, "type": "object" } }, "properties": { "src": { "type": "string" }, "dst": { "type": "string" }, "strip_parent": { "type": "boolean" }, "info": { "$ref": "#/$defs/FileInfo" } }, "additionalProperties": false, "type": "object" } ] }, "FileInfo": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/file-info", "$ref": "#/$defs/FileInfo", "$defs": { "FileInfo": { "properties": { "owner": { "type": "string" }, "group": { "type": "string" }, "mode": { "type": "integer" }, "mtime": { "type": "string" } }, "additionalProperties": false, "type": "object" } } }, "Filters": { "properties": { "include": { "items": { "type": "string" }, "type": "array" }, "exclude": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FlagArray": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "FormatOverride": { "properties": { "goos": { "type": "string" }, "format": { "type": "string", "enum": [ "tar", "tgz", "tar.gz", "zip", "gz", "tar.xz", "txz", "binary" ], "default": "tar.gz" } }, "additionalProperties": false, "type": "object" }, "Fury": { "properties": { "account": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "formats": { "items": { "type": "string" }, "type": "array" }, "secret_name": { "type": "string" }, "skip": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Git": { "properties": { "tag_sort": { "type": "string" }, "prerelease_suffix": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GitHubURLs": { "properties": { "api": { "type": "string" }, "upload": { "type": "string" }, "download": { "type": "string" }, "skip_tls_verify": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "GitLabURLs": { "properties": { "api": { "type": "string" }, "download": { "type": "string" }, "skip_tls_verify": { "type": "boolean" }, "use_package_registry": { "type": "boolean" }, "use_job_token": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "GitRepoRef": { "properties": { "url": { "type": "string" }, "ssh_command": { "type": "string" }, "private_key": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GiteaURLs": { "properties": { "api": { "type": "string" }, "download": { "type": "string" }, "skip_tls_verify": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "GoMod": { "properties": { "proxy": { "type": "boolean" }, "env": { "items": { "type": "string" }, "type": "array" }, "gobinary": { "type": "string" }, "mod": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Homebrew": { "properties": { "name": { "type": "string" }, "repository": { "$ref": "#/$defs/RepoRef" }, "commit_author": { "$ref": "#/$defs/CommitAuthor" }, "commit_msg_template": { "type": "string" }, "folder": { "type": "string" }, "caveats": { "type": "string" }, "install": { "type": "string" }, "extra_install": { "type": "string" }, "post_install": { "type": "string" }, "dependencies": { "items": { "$ref": "#/$defs/HomebrewDependency" }, "type": "array" }, "test": { "type": "string" }, "conflicts": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "skip_upload": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "download_strategy": { "type": "string" }, "url_template": { "type": "string" }, "custom_require": { "type": "string" }, "custom_block": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "goarm": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "goamd64": { "type": "string" }, "service": { "type": "string" }, "alternative_names": { "items": { "type": "string" }, "type": "array" }, "tap": { "$ref": "#/$defs/RepoRef", "description": "use repository instead" }, "plist": { "type": "string", "description": "use service instead" } }, "additionalProperties": false, "type": "object" }, "HomebrewDependency": { "oneOf": [ { "type": "string" }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/homebrew-dependency", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } }, "additionalProperties": false, "type": "object" } ] }, "Hooks": { "oneOf": [ { "type": "string" }, { "items": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/hook", "oneOf": [ { "type": "string" }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/t", "properties": { "dir": { "type": "string" }, "cmd": { "type": "string" }, "env": { "items": { "type": "string" }, "type": "array" }, "output": { "type": "boolean" } }, "additionalProperties": false, "type": "object" } ] }, "type": "array" } ] }, "IgnoredBuild": { "properties": { "goos": { "type": "string" }, "goarch": { "type": "string" }, "goarm": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "gomips": { "type": "string" }, "goamd64": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Include": { "properties": { "from_url": { "$ref": "#/$defs/IncludeFromURL" }, "from_file": { "$ref": "#/$defs/IncludeFromFile" } }, "additionalProperties": false, "type": "object" }, "IncludeFromFile": { "properties": { "path": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "path" ] }, "IncludeFromURL": { "properties": { "url": { "type": "string" }, "headers": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object", "required": [ "url" ] }, "IncludedMarkdown": { "oneOf": [ { "type": "string" }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/include", "$defs": { "IncludeFromFile": { "properties": { "path": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "path" ] }, "IncludeFromURL": { "properties": { "url": { "type": "string" }, "headers": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object", "required": [ "url" ] } }, "properties": { "from_url": { "$ref": "#/$defs/IncludeFromURL" }, "from_file": { "$ref": "#/$defs/IncludeFromFile" } }, "additionalProperties": false, "type": "object" } ] }, "Ko": { "properties": { "id": { "type": "string" }, "build": { "type": "string" }, "main": { "type": "string" }, "working_dir": { "type": "string" }, "base_image": { "type": "string" }, "labels": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "repository": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "creation_time": { "type": "string" }, "ko_data_creation_time": { "type": "string" }, "sbom": { "type": "string" }, "ldflags": { "items": { "type": "string" }, "type": "array" }, "flags": { "items": { "type": "string" }, "type": "array" }, "env": { "items": { "type": "string" }, "type": "array" }, "bare": { "type": "boolean" }, "preserve_import_paths": { "type": "boolean" }, "base_import_paths": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "Krew": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "repository": { "$ref": "#/$defs/RepoRef" }, "commit_author": { "$ref": "#/$defs/CommitAuthor" }, "commit_msg_template": { "type": "string" }, "caveats": { "type": "string" }, "short_description": { "type": "string" }, "description": { "type": "string" }, "homepage": { "type": "string" }, "url_template": { "type": "string" }, "goarm": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "goamd64": { "type": "string" }, "skip_upload": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "index": { "$ref": "#/$defs/RepoRef", "description": "use repository instead" } }, "additionalProperties": false, "type": "object" }, "LinkedIn": { "properties": { "enabled": { "type": "boolean" }, "message_template": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Mastodon": { "properties": { "enabled": { "type": "boolean" }, "message_template": { "type": "string" }, "server": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "server" ] }, "Matrix": { "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Mattermost": { "properties": { "enabled": { "type": "boolean" }, "message_template": { "type": "string" }, "title_template": { "type": "string" }, "color": { "type": "string" }, "channel": { "type": "string" }, "username": { "type": "string" }, "icon_emoji": { "type": "string" }, "icon_url": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Milestone": { "properties": { "repo": { "$ref": "#/$defs/Repo" }, "close": { "type": "boolean" }, "fail_on_error": { "type": "boolean" }, "name_template": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Monorepo": { "properties": { "tag_prefix": { "type": "string" }, "dir": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPM": { "properties": { "file_name_template": { "type": "string" }, "package_name": { "type": "string" }, "epoch": { "type": "string" }, "release": { "type": "string" }, "prerelease": { "type": "string" }, "version_metadata": { "type": "string" }, "dependencies": { "items": { "type": "string" }, "type": "array" }, "recommends": { "items": { "type": "string" }, "type": "array" }, "suggests": { "items": { "type": "string" }, "type": "array" }, "conflicts": { "items": { "type": "string" }, "type": "array" }, "umask": { "type": "integer" }, "replaces": { "items": { "type": "string" }, "type": "array" }, "provides": { "items": { "type": "string" }, "type": "array" }, "contents": { "$ref": "#/$defs/Contents" }, "scripts": { "$ref": "#/$defs/NFPMScripts" }, "rpm": { "$ref": "#/$defs/NFPMRPM" }, "deb": { "$ref": "#/$defs/NFPMDeb" }, "apk": { "$ref": "#/$defs/NFPMAPK" }, "archlinux": { "$ref": "#/$defs/NFPMArchLinux" }, "templated_contents": { "$ref": "#/$defs/Contents" }, "templated_scripts": { "$ref": "#/$defs/NFPMScripts" }, "overrides": { "patternProperties": { ".*": { "$ref": "#/$defs/NFPMOverridables" } }, "type": "object" }, "id": { "type": "string" }, "builds": { "items": { "type": "string" }, "type": "array" }, "formats": { "items": { "type": "string" }, "type": "array" }, "section": { "type": "string" }, "priority": { "type": "string" }, "vendor": { "type": "string" }, "homepage": { "type": "string" }, "maintainer": { "type": "string" }, "description": { "type": "string" }, "license": { "type": "string" }, "bindir": { "type": "string" }, "changelog": { "type": "string" }, "meta": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "NFPMAPK": { "properties": { "scripts": { "$ref": "#/$defs/NFPMAPKScripts" }, "signature": { "$ref": "#/$defs/NFPMAPKSignature" } }, "additionalProperties": false, "type": "object" }, "NFPMAPKScripts": { "properties": { "preupgrade": { "type": "string" }, "postupgrade": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMAPKSignature": { "properties": { "key_file": { "type": "string" }, "key_name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMArchLinux": { "properties": { "pkgbase": { "type": "string" }, "packager": { "type": "string" }, "scripts": { "$ref": "#/$defs/NFPMArchLinuxScripts" } }, "additionalProperties": false, "type": "object" }, "NFPMArchLinuxScripts": { "properties": { "preupgrade": { "type": "string" }, "postupgrade": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMDeb": { "properties": { "scripts": { "$ref": "#/$defs/NFPMDebScripts" }, "triggers": { "$ref": "#/$defs/NFPMDebTriggers" }, "breaks": { "items": { "type": "string" }, "type": "array" }, "signature": { "$ref": "#/$defs/NFPMDebSignature" }, "lintian_overrides": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "NFPMDebScripts": { "properties": { "rules": { "type": "string" }, "templates": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMDebSignature": { "properties": { "key_file": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMDebTriggers": { "properties": { "interest": { "items": { "type": "string" }, "type": "array" }, "interest_await": { "items": { "type": "string" }, "type": "array" }, "interest_noawait": { "items": { "type": "string" }, "type": "array" }, "activate": { "items": { "type": "string" }, "type": "array" }, "activate_await": { "items": { "type": "string" }, "type": "array" }, "activate_noawait": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "NFPMOverridables": { "properties": { "file_name_template": { "type": "string" }, "package_name": { "type": "string" }, "epoch": { "type": "string" }, "release": { "type": "string" }, "prerelease": { "type": "string" }, "version_metadata": { "type": "string" }, "dependencies": { "items": { "type": "string" }, "type": "array" }, "recommends": { "items": { "type": "string" }, "type": "array" }, "suggests": { "items": { "type": "string" }, "type": "array" }, "conflicts": { "items": { "type": "string" }, "type": "array" }, "umask": { "type": "integer" }, "replaces": { "items": { "type": "string" }, "type": "array" }, "provides": { "items": { "type": "string" }, "type": "array" }, "contents": { "$ref": "#/$defs/Contents" }, "scripts": { "$ref": "#/$defs/NFPMScripts" }, "rpm": { "$ref": "#/$defs/NFPMRPM" }, "deb": { "$ref": "#/$defs/NFPMDeb" }, "apk": { "$ref": "#/$defs/NFPMAPK" }, "archlinux": { "$ref": "#/$defs/NFPMArchLinux" }, "templated_contents": { "$ref": "#/$defs/Contents" }, "templated_scripts": { "$ref": "#/$defs/NFPMScripts" } }, "additionalProperties": false, "type": "object" }, "NFPMRPM": { "properties": { "summary": { "type": "string" }, "group": { "type": "string" }, "compression": { "type": "string" }, "signature": { "$ref": "#/$defs/NFPMRPMSignature" }, "scripts": { "$ref": "#/$defs/NFPMRPMScripts" }, "prefixes": { "items": { "type": "string" }, "type": "array" }, "packager": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMRPMScripts": { "properties": { "pretrans": { "type": "string" }, "posttrans": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMRPMSignature": { "properties": { "key_file": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFPMScripts": { "properties": { "preinstall": { "type": "string" }, "postinstall": { "type": "string" }, "preremove": { "type": "string" }, "postremove": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Nightly": { "properties": { "name_template": { "type": "string" }, "tag_name": { "type": "string" }, "publish_release": { "type": "boolean" }, "keep_single_release": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "Nix": { "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "repository": { "$ref": "#/$defs/RepoRef" }, "commit_author": { "$ref": "#/$defs/CommitAuthor" }, "commit_msg_template": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "goamd64": { "type": "string" }, "skip_upload": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "url_template": { "type": "string" }, "install": { "type": "string" }, "extra_install": { "type": "string" }, "post_install": { "type": "string" }, "description": { "type": "string" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "dependencies": { "items": { "$ref": "#/$defs/NixDependency" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "NixDependency": { "oneOf": [ { "type": "string" }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/t", "properties": { "name": { "type": "string" }, "os": { "type": "string", "enum": [ "linux", "darwin" ] } }, "additionalProperties": false, "type": "object", "required": [ "name" ] } ] }, "OpenCollective": { "properties": { "enabled": { "type": "boolean" }, "slug": { "type": "string" }, "title_template": { "type": "string" }, "message_template": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Partial": { "properties": { "by": { "type": "string", "enum": [ "goos", "target" ], "default": "goos" } }, "additionalProperties": false, "type": "object" }, "PreBuiltOptions": { "properties": { "path": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Project": { "properties": { "project_name": { "type": "string" }, "env": { "items": { "type": "string" }, "type": "array" }, "release": { "$ref": "#/$defs/Release" }, "milestones": { "items": { "$ref": "#/$defs/Milestone" }, "type": "array" }, "brews": { "items": { "$ref": "#/$defs/Homebrew" }, "type": "array" }, "nix": { "items": { "$ref": "#/$defs/Nix" }, "type": "array" }, "winget": { "items": { "$ref": "#/$defs/Winget" }, "type": "array" }, "aurs": { "items": { "$ref": "#/$defs/AUR" }, "type": "array" }, "krews": { "items": { "$ref": "#/$defs/Krew" }, "type": "array" }, "kos": { "items": { "$ref": "#/$defs/Ko" }, "type": "array" }, "scoops": { "items": { "$ref": "#/$defs/Scoop" }, "type": "array" }, "builds": { "items": { "$ref": "#/$defs/Build" }, "type": "array" }, "archives": { "items": { "$ref": "#/$defs/Archive" }, "type": "array" }, "nfpms": { "items": { "$ref": "#/$defs/NFPM" }, "type": "array" }, "snapcrafts": { "items": { "$ref": "#/$defs/Snapcraft" }, "type": "array" }, "snapshot": { "$ref": "#/$defs/Snapshot" }, "checksum": { "$ref": "#/$defs/Checksum" }, "dockers": { "items": { "$ref": "#/$defs/Docker" }, "type": "array" }, "docker_manifests": { "items": { "$ref": "#/$defs/DockerManifest" }, "type": "array" }, "artifactories": { "items": { "$ref": "#/$defs/Upload" }, "type": "array" }, "uploads": { "items": { "$ref": "#/$defs/Upload" }, "type": "array" }, "blobs": { "items": { "$ref": "#/$defs/Blob" }, "type": "array" }, "publishers": { "items": { "$ref": "#/$defs/Publisher" }, "type": "array" }, "changelog": { "$ref": "#/$defs/Changelog" }, "dist": { "type": "string" }, "signs": { "items": { "$ref": "#/$defs/Sign" }, "type": "array" }, "docker_signs": { "items": { "$ref": "#/$defs/Sign" }, "type": "array" }, "env_files": { "$ref": "#/$defs/EnvFiles" }, "before": { "$ref": "#/$defs/Before" }, "after": { "$ref": "#/$defs/After" }, "source": { "$ref": "#/$defs/Source" }, "gomod": { "$ref": "#/$defs/GoMod" }, "announce": { "$ref": "#/$defs/Announce" }, "sboms": { "items": { "$ref": "#/$defs/SBOM" }, "type": "array" }, "chocolateys": { "items": { "$ref": "#/$defs/Chocolatey" }, "type": "array" }, "git": { "$ref": "#/$defs/Git" }, "report_sizes": { "type": "boolean" }, "metadata": { "$ref": "#/$defs/ProjectMetadata" }, "template_files": { "items": { "$ref": "#/$defs/TemplateFile" }, "type": "array" }, "universal_binaries": { "items": { "$ref": "#/$defs/UniversalBinary" }, "type": "array" }, "upx": { "items": { "$ref": "#/$defs/UPX" }, "type": "array" }, "force_token": { "type": "string", "enum": [ "github", "gitlab", "gitea", "" ], "default": "" }, "github_urls": { "$ref": "#/$defs/GitHubURLs" }, "gitlab_urls": { "$ref": "#/$defs/GitLabURLs" }, "gitea_urls": { "$ref": "#/$defs/GiteaURLs" }, "includes": { "items": { "$ref": "#/$defs/Include" }, "type": "array" }, "variables": { "type": "object" }, "monorepo": { "$ref": "#/$defs/Monorepo" }, "partial": { "$ref": "#/$defs/Partial" }, "nightly": { "$ref": "#/$defs/Nightly" }, "furies": { "items": { "$ref": "#/$defs/Fury" }, "type": "array" }, "scoop": { "$ref": "#/$defs/Scoop", "description": "use scoops instead" }, "build": { "$ref": "#/$defs/Build", "description": "use builds instead" } }, "additionalProperties": false, "type": "object" }, "ProjectMetadata": { "properties": { "mod_timestamp": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Publisher": { "properties": { "name": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "checksum": { "type": "boolean" }, "signature": { "type": "boolean" }, "dir": { "type": "string" }, "cmd": { "type": "string" }, "env": { "items": { "type": "string" }, "type": "array" }, "extra_files": { "items": { "$ref": "#/$defs/ExtraFile" }, "type": "array" }, "disable": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "templated_extra_files": { "items": { "$ref": "#/$defs/TemplatedExtraFile" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "PullRequest": { "properties": { "enabled": { "type": "boolean" }, "base": { "$ref": "#/$defs/PullRequestBase" }, "draft": { "type": "boolean" }, "check_boxes": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "PullRequestBase": { "oneOf": [ { "type": "string" }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/goreleaser/goreleaser/pkg/config/pull-request-base", "properties": { "owner": { "type": "string" }, "name": { "type": "string" }, "branch": { "type": "string" } }, "additionalProperties": false, "type": "object" } ] }, "Reddit": { "properties": { "enabled": { "type": "boolean" }, "application_id": { "type": "string" }, "username": { "type": "string" }, "title_template": { "type": "string" }, "url_template": { "type": "string" }, "sub": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Release": { "properties": { "github": { "$ref": "#/$defs/Repo" }, "gitlab": { "$ref": "#/$defs/Repo" }, "gitea": { "$ref": "#/$defs/Repo" }, "draft": { "type": "boolean" }, "replace_existing_draft": { "type": "boolean" }, "target_commitish": { "type": "string" }, "tag": { "type": "string" }, "disable": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "skip_upload": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "prerelease": { "type": "string" }, "make_latest": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "name_template": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "extra_files": { "items": { "$ref": "#/$defs/ExtraFile" }, "type": "array" }, "discussion_category_name": { "type": "string" }, "mode": { "type": "string", "enum": [ "keep-existing", "append", "prepend", "replace" ], "default": "keep-existing" }, "templated_extra_files": { "items": { "$ref": "#/$defs/TemplatedExtraFile" }, "type": "array" }, "header": { "$ref": "#/$defs/IncludedMarkdown" }, "footer": { "$ref": "#/$defs/IncludedMarkdown" } }, "additionalProperties": false, "type": "object" }, "Repo": { "properties": { "owner": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "RepoRef": { "properties": { "owner": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "branch": { "type": "string" }, "git": { "$ref": "#/$defs/GitRepoRef" }, "pull_request": { "$ref": "#/$defs/PullRequest" } }, "additionalProperties": false, "type": "object" }, "SBOM": { "properties": { "id": { "type": "string" }, "cmd": { "type": "string" }, "env": { "items": { "type": "string" }, "type": "array" }, "args": { "items": { "type": "string" }, "type": "array" }, "documents": { "items": { "type": "string" }, "type": "array" }, "artifacts": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "SMTP": { "properties": { "enabled": { "type": "boolean" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": "string" }, "from": { "type": "string" }, "to": { "items": { "type": "string" }, "type": "array" }, "subject_template": { "type": "string" }, "body_template": { "type": "string" }, "insecure_skip_verify": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "Scoop": { "properties": { "name": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "repository": { "$ref": "#/$defs/RepoRef" }, "folder": { "type": "string" }, "commit_author": { "$ref": "#/$defs/CommitAuthor" }, "commit_msg_template": { "type": "string" }, "homepage": { "type": "string" }, "description": { "type": "string" }, "license": { "type": "string" }, "url_template": { "type": "string" }, "persist": { "items": { "type": "string" }, "type": "array" }, "skip_upload": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "pre_install": { "items": { "type": "string" }, "type": "array" }, "post_install": { "items": { "type": "string" }, "type": "array" }, "depends": { "items": { "type": "string" }, "type": "array" }, "shortcuts": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "goamd64": { "type": "string" }, "bucket": { "$ref": "#/$defs/RepoRef", "description": "use repository instead" } }, "additionalProperties": false, "type": "object" }, "Sign": { "properties": { "id": { "type": "string" }, "cmd": { "type": "string" }, "args": { "items": { "type": "string" }, "type": "array" }, "signature": { "type": "string" }, "artifacts": { "type": "string", "enum": [ "all", "manifests", "images", "checksum", "source", "package", "archive", "binary", "sbom" ] }, "ids": { "items": { "type": "string" }, "type": "array" }, "stdin": { "type": "string" }, "stdin_file": { "type": "string" }, "env": { "items": { "type": "string" }, "type": "array" }, "certificate": { "type": "string" }, "output": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "Slack": { "properties": { "enabled": { "type": "boolean" }, "message_template": { "type": "string" }, "channel": { "type": "string" }, "username": { "type": "string" }, "icon_emoji": { "type": "string" }, "icon_url": { "type": "string" }, "blocks": { "items": { "$ref": "#/$defs/SlackBlock" }, "type": "array" }, "attachments": { "items": { "$ref": "#/$defs/SlackAttachment" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "SlackAttachment": { "properties": { "Internal": true }, "additionalProperties": false, "type": "object", "required": [ "Internal" ] }, "SlackBlock": { "properties": { "Internal": true }, "additionalProperties": false, "type": "object", "required": [ "Internal" ] }, "Snapcraft": { "properties": { "name_template": { "type": "string" }, "publish": { "type": "boolean" }, "id": { "type": "string" }, "builds": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "base": { "type": "string" }, "license": { "type": "string" }, "grade": { "type": "string" }, "channel_templates": { "items": { "type": "string" }, "type": "array" }, "confinement": { "type": "string" }, "assumes": { "items": { "type": "string" }, "type": "array" }, "layout": { "patternProperties": { ".*": { "$ref": "#/$defs/SnapcraftLayoutMetadata" } }, "type": "object" }, "apps": { "patternProperties": { ".*": { "$ref": "#/$defs/SnapcraftAppMetadata" } }, "type": "object" }, "hooks": { "type": "object" }, "plugs": { "type": "object" }, "disable": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "extra_files": { "items": { "$ref": "#/$defs/SnapcraftExtraFiles" }, "type": "array" }, "templated_extra_files": { "items": { "$ref": "#/$defs/SnapcraftExtraFiles" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "SnapcraftAppMetadata": { "properties": { "command": { "type": "string" }, "args": { "type": "string" }, "adapter": { "type": "string" }, "after": { "items": { "type": "string" }, "type": "array" }, "aliases": { "items": { "type": "string" }, "type": "array" }, "autostart": { "type": "string" }, "before": { "items": { "type": "string" }, "type": "array" }, "bus_name": { "type": "string" }, "command_chain": { "items": { "type": "string" }, "type": "array" }, "common_id": { "type": "string" }, "completer": { "type": "string" }, "daemon": { "type": "string" }, "desktop": { "type": "string" }, "environment": { "type": "object" }, "extensions": { "items": { "type": "string" }, "type": "array" }, "install_mode": { "type": "string" }, "passthrough": { "type": "object" }, "plugs": { "items": { "type": "string" }, "type": "array" }, "post_stop_command": { "type": "string" }, "refresh_mode": { "type": "string" }, "reload_command": { "type": "string" }, "restart_condition": { "type": "string" }, "restart_delay": { "type": "string" }, "slots": { "items": { "type": "string" }, "type": "array" }, "sockets": { "type": "object" }, "start_timeout": { "type": "string" }, "stop_command": { "type": "string" }, "stop_mode": { "type": "string" }, "stop_timeout": { "type": "string" }, "timer": { "type": "string" }, "watchdog_timeout": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "command" ] }, "SnapcraftExtraFiles": { "properties": { "source": { "type": "string" }, "destination": { "type": "string" }, "mode": { "type": "integer" } }, "additionalProperties": false, "type": "object", "required": [ "source" ] }, "SnapcraftLayoutMetadata": { "properties": { "symlink": { "type": "string" }, "bind": { "type": "string" }, "bind_file": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Snapshot": { "properties": { "name_template": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Source": { "properties": { "name_template": { "type": "string" }, "format": { "type": "string", "enum": [ "tar", "tgz", "tar.gz", "zip" ], "default": "tar.gz" }, "enabled": { "type": "boolean" }, "prefix_template": { "type": "string" }, "files": { "items": { "$ref": "#/$defs/File" }, "type": "array" }, "templated_files": { "items": { "$ref": "#/$defs/TemplatedFile" }, "type": "array" }, "rlcp": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "you can now remove this" } }, "additionalProperties": false, "type": "object" }, "StringArray": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "Teams": { "properties": { "enabled": { "type": "boolean" }, "title_template": { "type": "string" }, "message_template": { "type": "string" }, "color": { "type": "string" }, "icon_url": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Telegram": { "properties": { "enabled": { "type": "boolean" }, "message_template": { "type": "string" }, "chat_id": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "parse_mode": { "type": "string", "enum": [ "MarkdownV2", "HTML" ], "default": "MarkdownV2" } }, "additionalProperties": false, "type": "object" }, "TemplateFile": { "properties": { "id": { "type": "string" }, "src": { "type": "string" }, "dst": { "type": "string" }, "mode": { "type": "integer" } }, "additionalProperties": false, "type": "object", "required": [ "src", "dst" ] }, "TemplatedExtraFile": { "properties": { "src": { "type": "string" }, "dst": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "TemplatedExtraFileWithMode": { "properties": { "src": { "type": "string" }, "dst": { "type": "string" }, "mode": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "TemplatedFile": { "properties": { "src": { "type": "string" }, "dst": { "type": "string" }, "info": { "$ref": "#/$defs/FileInfo" } }, "additionalProperties": false, "type": "object" }, "Twitter": { "properties": { "enabled": { "type": "boolean" }, "message_template": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "UPX": { "properties": { "enabled": { "type": "boolean" }, "ids": { "items": { "type": "string" }, "type": "array" }, "goos": { "items": { "type": "string" }, "type": "array" }, "goarch": { "items": { "type": "string" }, "type": "array" }, "goarm": { "items": { "type": "string" }, "type": "array" }, "goamd64": { "items": { "type": "string" }, "type": "array" }, "binary": { "type": "string" }, "compress": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "best", "" ], "default": "" }, "lzma": { "type": "boolean" }, "brute": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "UniversalBinary": { "properties": { "id": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "name_template": { "type": "string" }, "replace": { "type": "boolean" }, "hooks": { "$ref": "#/$defs/BuildHookConfig" }, "mod_timestamp": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Upload": { "properties": { "name": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "exts": { "items": { "type": "string" }, "type": "array" }, "target": { "type": "string" }, "username": { "type": "string" }, "mode": { "type": "string" }, "method": { "type": "string" }, "checksum_header": { "type": "string" }, "client_x509_cert": { "type": "string" }, "client_x509_key": { "type": "string" }, "trusted_certificates": { "type": "string" }, "checksum": { "type": "boolean" }, "signature": { "type": "boolean" }, "custom_artifact_name": { "type": "boolean" }, "custom_headers": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "matrix": { "$ref": "#/$defs/Matrix" } }, "additionalProperties": false, "type": "object" }, "Webhook": { "properties": { "enabled": { "type": "boolean" }, "skip_tls_verify": { "type": "boolean" }, "message_template": { "type": "string" }, "endpoint_url": { "type": "string" }, "headers": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "content_type": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Winget": { "properties": { "name": { "type": "string" }, "package_identifier": { "type": "string" }, "publisher": { "type": "string" }, "publisher_url": { "type": "string" }, "publisher_support_url": { "type": "string" }, "copyright": { "type": "string" }, "copyright_url": { "type": "string" }, "author": { "type": "string" }, "path": { "type": "string" }, "repository": { "$ref": "#/$defs/RepoRef" }, "commit_author": { "$ref": "#/$defs/CommitAuthor" }, "commit_msg_template": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "goamd64": { "type": "string" }, "skip_upload": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "url_template": { "type": "string" }, "short_description": { "type": "string" }, "description": { "type": "string" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "license_url": { "type": "string" }, "release_notes": { "type": "string" }, "release_notes_url": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" } }, "description": "goreleaser configuration definition file" }

template.json

{ "$id": "https://json.schemastore.org/template.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "datatype": { "description": "Indicates limitations on the valid values a symbol may be assigned. When specified, the symbol value is attempted to be converted to this type. The datatype \"choice\" is supported only for parameter symbols and requires providing symbols.choices configuration for the symbol.", "anyOf": [ { "enum": ["choice", "bool", "float", "int", "hex", "text"] }, { "pattern": "^(integer|string)$" } ] }, "generatorConstant": { "properties": { "generator": { "enum": ["constant"] }, "parameters": { "properties": { "value": { "description": "The constant value to be assigned to the symbol.", "type": "string" } } } } }, "generatorGuid": { "properties": { "generator": { "enum": ["guid"] }, "parameters": { "properties": { "format": { "deprecated": true, "deprecationMessage": "This property is not maintained and may be removed in the future. Use defaultFormat instead, or use 'guids' section.", "description": "This property is not maintained and may be removed in the future. Use defaultFormat instead, or use 'guids' section.", "type": "string" }, "defaultFormat": { "description": "The format of guid to be generated. Accepts a single value from ('n', 'd', 'b', 'p', 'x') for lowercase output or ('N', 'D', 'B', 'P', 'X') for uppercase output. The formats are defined in Guid.ToString() method documentation.", "type": "string" } } } } }, "generatorNow": { "properties": { "generator": { "enum": ["now"] }, "parameters": { "properties": { "format": { "description": "The format string to use when converting the date-time to a string representation.", "type": "string" }, "utc": { "description": "If true, use UTC time. If false, use local time.", "type": "boolean" } } } } }, "generatorRandom": { "properties": { "generator": { "enum": ["random"] }, "parameters": { "required": ["low"], "properties": { "low": { "description": "An integer value indicating the low-end of the range to generate the random number in.", "type": "integer" }, "high": { "description": "An integer value indicating the high-end of the range to generate the random number in. If not explicitly provided, defaults to int.MaxValue.", "type": "integer" } } } } }, "generatorRegex": { "properties": { "generator": { "enum": ["regex"] }, "parameters": { "properties": { "source": { "description": "The name of a different parameter in the template configuration. A copy of its value will be used by this generator's regex to generate the value for this parameter. The value of the source parameter is not modified.", "type": "string" }, "steps": { "description": "An ordered list of key-value pairs indicating the regex replacement actions. Each element of the list must contain exactly the keys 'regex' and 'replacement' - along with their values. These replacements will be applied to the result of the previous replacement (except the first, which acts on the original value from the source).", "type": "array", "items": { "required": ["regex", "replacement"], "properties": { "regex": { "description": "The regular expression to use to locate the sequence to replace.", "type": "string" }, "replacement": { "description": "The replacement for any sequences matched by the supplied regular expression.", "type": "string" } } } } } } } }, "generatorRegexMatch": { "properties": { "generator": { "enum": ["regexMatch"] }, "datatype": { "enum": ["bool"] }, "parameters": { "properties": { "source": { "description": "The symbol to search for a match. Its value will be used by this generator's regex to evaluate if there is a match. The value of the source parameter is not modified.", "type": "string" }, "pattern": { "description": "The regular expression to use to match.", "type": "string" } } } } }, "generatorCoalesce": { "properties": { "generator": { "enum": ["coalesce"] }, "parameters": { "type": "object", "required": ["sourceVariableName", "fallbackVariableName"], "properties": { "sourceVariableName": { "type": "string", "description": "The name of the symbol whose value will be inspected - if the value is effectively equal to the default value, the value of the symbol referred to by fallbackVariableName is used, otherwise the value of this symbol." }, "defaultValue": { "type": "string", "description": "The value to consider as being the default - if the value of the symbol referred to by sourceVariableName is equal to this, the value of the symbol referred to in fallbackVariableName is used instead.", "default": "" }, "fallbackVariableName": { "type": "string", "description": "The name of the symbol to return the value of if the symbol referred to by sourceVariableName has a value equal to the value of defaultValue." } } } } }, "generatorCasing": { "properties": { "generator": { "enum": ["casing"] }, "parameters": { "required": ["source"], "properties": { "source": { "description": "The name of the symbol whose value should have its case changed.", "type": "string" }, "toLower": { "description": "Whether the case changed to should be lower case, if false, the value is made to be uppercase instead.", "type": "boolean", "default": true } } } } }, "generatorPort": { "properties": { "generator": { "enum": ["port"] }, "parameters": { "properties": { "low": { "description": "The lower bound of acceptable port numbers.", "type": "integer", "default": 1024 }, "high": { "description": "The upper bound of acceptable port numbers.", "type": "integer", "default": 65535 }, "fallback": { "description": "The port number to use if no free ports could be found.", "type": "integer", "default": 0 } } } } }, "generatorSwitch": { "properties": { "generator": { "enum": ["switch"] }, "parameters": { "properties": { "evaluator": { "description": "The style of evaluator to use.", "enum": ["C++", "C++2", "MSBUILD", "VB"], "default": "C++" }, "datatype": { "$ref": "#/definitions/datatype" }, "cases": { "description": "The set of cases to test for. The first one, in document order, to return true's value is used, if none return true, empty string is returned.", "type": "array", "items": { "type": "object", "required": ["condition", "value"], "properties": { "condition": { "description": "An expression to be interpreted by the specified evaluator type.", "type": "string" }, "value": { "description": "The value to return if the condition evaluates to true.", "type": "string" } } } } } } } }, "generatorJoin": { "properties": { "generator": { "enum": ["join"] }, "parameters": { "properties": { "separator": { "description": "The value used as the separator between the values to be concatenated, notice that you can use \"/\" as folder separator also on Windows since File API will convert it into \"\\\".", "default": "", "type": "string" }, "removeEmptyValues": { "description": "Indication whether null and empty strings should be removed from joining to prevent repetitive separators.", "default": "false", "type": "boolean" }, "symbols": { "description": "All values to concatenate.", "type": "array", "items": { "type": "object", "required": ["value"], "properties": { "type": { "description": "\"ref\" to reference value from another symbol or \"const\" for string constant, defaults to \"const\".", "enum": ["ref", "const"] }, "value": { "description": "Either name of another symbol or string constant.", "type": "string" } } } } } } } }, "guid": { "pattern": "^\\{?[0-9A-Fa-f]{8}[-]?([0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}\\}?$", "description": "A guid string to be replaced in source files. Format and casing is not significant in the config as format and casing is preserved based on the particular guid in processed file(s).", "type": "string" }, "ice": { "anyOf": [ { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, { "type": "string" } ] }, "modifier": { "type": "object", "properties": { "condition": { "description": "Boolean condition to indicate if the sources configuration should be included or ignored. If the condition evaluates to true or is not provided, the sources config will be used for creating the template. If it evaluates to false, the sources config will be ignored.", "type": "string" }, "exclude": { "description": "The set of globbing patterns indicating the content that was included by sources.include that should not be processed.", "allOf": [ { "$ref": "#/definitions/ice" } ], "default": [ "**/[Bb]in/**", "**/[Oo]bj/**", ".template.config/**/*", "**/*.filelist", "**/*.user", "**/*.lock.json" ] }, "include": { "description": "The set of globbing patterns indicating the content to process in the path referred to by the source.", "allOf": [ { "$ref": "#/definitions/ice" } ], "default": ["**/*"] }, "copyOnly": { "description": "The set of globbing patterns indicating the content that was included by sources.include, that hasn't been excluded by sources.exclude that should be placed in the user's directory without modification.", "allOf": [ { "$ref": "#/definitions/ice" } ], "default": ["**/node_modules/**/*"] }, "rename": { "description": "The set of explicit renames to perform. Each key is a path to a file in the source, each value is a path to the target location.", "type": "object", "additionalProperties": { "type": "string" } } } }, "source": { "type": "object", "allOf": [ { "$ref": "#/definitions/modifier" } ], "properties": { "modifiers": { "description": "A list of additional source information which gets added to the top-level source information, based on evaluation the corresponding source.modifiers.condition.", "type": "array", "items": { "$ref": "#/definitions/modifier" } }, "source": { "description": "The path in the template content (relative to the directory containing the .template.config folder) that should be processed.", "type": "string", "default": "./" }, "target": { "description": "The path (relative to the directory the user has specified) that content should be written to.", "type": "string", "default": "./" } } } }, "properties": { "author": { "description": "The author of the template.", "type": "string" }, "classifications": { "description": "Zero or more characteristics of the template that a user might search for it by.", "type": "array", "items": { "type": "string", "minLength": 1 } }, "defaultName": { "description": "The name to use during creation if no name has been specified by the user or provided from the host.", "type": "string", "minLength": 1 }, "generatorVersions": { "description": "The semantic version range of the Microsoft.TemplateEngine.Orchestrator.RunnableProjects package that this template is usable with. In older versions of the engine, the four octet version string is used but is matched against a constant which was never changed from 1.0.0.0 - either syntax is now accepted, however the four octet string will not be changed from 1.0.0.0.", "type": "string", "default": "[1.0.0.0-*)" }, "groupIdentity": { "description": "The ID of the group this template belongs to. When combined with the \"tags\" section, this allows multiple templates to be displayed as one, with the the decision for which one to use being presented as a choice in each one of the pivot categories (keys).", "type": "string", "minLength": 1 }, "guids": { "description": "A list of guids which appear in the template source and should be replaced in the template output. For each guid listed, a replacement guid is generated, and replaces all occurrences of the source guid in the output.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/guid" } }, "identity": { "description": "A unique name for this template.", "type": "string", "minLength": 1 }, "name": { "description": "The name for the template that users should see.", "type": "string", "minLength": 1 }, "placeholderFilename": { "description": "A filename that will be completely ignored except to indicate that its containing directory should be copied. This allows creation of an empty directory in the created template, by having a corresponding source directory containing just the placeholder file. Completely empty directories are ignored.", "type": "string", "default": "-.-" }, "postActions": { "description": "Defines an ordered list of actions to perform after template generation. The post action information is provided to the creation broker, to act on as appropriate.", "type": "array", "items": { "type": "object", "allOf": [ { "required": ["actionId", "manualInstructions"], "properties": { "actionId": { "description": "A guid uniquely defining the action. The value must correspond to a post-action known by the broker.", "allOf": [ { "$ref": "#/definitions/guid" } ] }, "args": { "description": "A list of key-value pairs to use when performing the action. The specific parameters required / allowed are defined by the action itself.", "type": "object" }, "condition": { "description": "A C++ style expression that, if it evaluates to 'false' causes the post-action to be skipped. This expression may refer to any symbols that have been defined.", "type": "string" }, "continueOnError": { "description": "If this action fails, the value of continueOnError indicates whether to attempt the next action, or stop processing the post actions. Should be set to true when subsequent actions rely on the success of the current action.", "type": "boolean", "default": false }, "description": { "description": "A human-readable description of the action.", "type": "string" }, "id": { "description": "Defines identifier to be used when localizing the post action artifacts.", "type": "string" }, "applyFileRenamesToArgs": { "type": "array", "items": { "type": "string" }, "description": "A list of arguments names from 'args' to which the file renames configured in symbols should be applied." }, "applyFileRenamesToManualInstructions": { "description": "If set to true, the file renames configured in symbols should be applied to manual instructions.", "type": "boolean", "default": false }, "manualInstructions": { "description": "An ordered list of possible instructions to display if the action cannot be performed. Each element in the list must contain a key named \"text\", whose value contains the instructions. Each element may also optionally provide a key named \"condition\" - a Boolean evaluate-able string. The first instruction whose condition is false or blank will be considered valid, all others are ignored.", "type": "array", "items": { "type": "object", "required": ["text"], "properties": { "condition": { "type": "string" }, "text": { "type": "string" }, "id": { "description": "Defines identifier to be used when localizing the manual instructions.", "type": "string" } } } } } }, { "oneOf": [ { "not": { "required": ["actionId"], "properties": { "actionId": { "enum": [ "AC1156F7-BB77-4DB8-B28F-24EEBCCA1E5C", "3A7C4B45-1F5D-4A30-959A-51B88E82B5D2", "B17581D1-C5C9-4489-8F0A-004BE667B814", "cb9a6cf3-4f5c-4860-b9d2-03a574959774", "210D431B-A78B-4D2F-B762-4ED3E3EA9025", "D396686C-DE0E-4DE6-906D-291CD29FC5DE", "84C0DA21-51C8-4541-9940-6CA19AF04EE6" ] } } } }, { "description": "Instruction display - shows a message given by description and manualInstructions as well as an optional command line to ask the user to execute.", "properties": { "actionId": { "enum": ["AC1156F7-BB77-4DB8-B28F-24EEBCCA1E5C"] }, "args": { "properties": { "executable": { "description": "The executable to instruct the user to run.", "type": "string" }, "args": { "description": "The arguments to instruct the user to run the executable with - if executable is not specified, this value is unused.", "type": "string" } } } } }, { "description": "Process start - starts a process.", "properties": { "actionId": { "enum": ["3A7C4B45-1F5D-4A30-959A-51B88E82B5D2"] }, "args": { "required": ["executable"], "properties": { "redirectStandardOutput": { "description": "Whether or not to redirect stdout for the process (prevents output from being displayed if true).", "type": "boolean", "default": true }, "redirectStandardError": { "description": "Defines whether or not the stderr should be redirected. If the output is redirected, it prevents it from being displayed.", "type": "boolean", "default": true }, "executable": { "description": "The executable to run.", "type": "string" }, "args": { "description": "The arguments to supply to the executable.", "type": "string" } } } } }, { "description": "Add reference - adds a reference to a project, package or framework assembly.", "properties": { "actionId": { "enum": ["B17581D1-C5C9-4489-8F0A-004BE667B814"] }, "args": { "required": ["referenceType", "reference"], "properties": { "referenceType": { "description": "The type of reference to add. project = A project to project reference. package = A NuGet package reference. framework - A framework assembly reference.", "type": "string", "enum": ["project", "package", "framework"], "default": "false" }, "projectFileExtensions": { "description": "Must be a literal extension for the project file(s) of interest, may be a semicolon delimited list. If unspecified, any project file (*.*proj) is allowed.", "type": "string" }, "reference": { "description": "The reference to be added (if referenceType=package, this is the package ID; if referenceType=framework, this is the path or assembly name; if referenceType=project, this is the path to the project reference to add).", "type": "string" }, "version": { "description": "The version of the package reference to add, applicable only if referenceType=package.", "type": "string" }, "targetFiles": { "oneOf": [ { "type": "array", "items": { "type": "string", "uniqueItems": true }, "description": "An array of files that should be processed. If not specified, the project file in output directory or its closest parent directory will be used." }, { "type": "string", "description": "A semicolon delimited list of files that should be processed. If not specified, the project file in output directory or its closest parent directory will be used." } ] } } } } }, { "description": "chmod - runs chmod on a particular file.", "properties": { "actionId": { "enum": ["cb9a6cf3-4f5c-4860-b9d2-03a574959774"] }, "args": { "type": "object", "description": "The permissions to set: the key-value pairs, where the key is a permission, and the value is a file or array of files to apply the permission to.", "additionalProperties": { "oneOf": [ { "type": "array", "items": { "type": "string", "uniqueItems": true }, "description": "The set of files (or patterns) to apply the permission specified in the property name to." }, { "type": "string", "description": "The file (or pattern) to apply the permission specified in the property name to." } ] } } } }, { "description": "NuGet package restore - restores NuGet packages for all primary outputs with file extensions *.proj or *.sln.", "properties": { "actionId": { "enum": ["210D431B-A78B-4D2F-B762-4ED3E3EA9025"] }, "args": { "properties": { "files": { "oneOf": [ { "type": "array", "items": { "type": "string", "uniqueItems": true }, "description": "An array of files that should be restored. If not specified, all primary outputs are restored." }, { "type": "string", "description": "A semicolon delimited list of files that should be restored. If not specified, all primary outputs are restored." } ] } } } } }, { "description": "Add to solution - Adds one or more of the primary outputs to the first sln file found (searches up the directory tree from the output folder).", "properties": { "actionId": { "enum": ["D396686C-DE0E-4DE6-906D-291CD29FC5DE"] }, "args": { "properties": { "primaryOutputIndexes": { "type": "string", "description": "A semicolon delimited list of indexes of the primary outputs that should be added to the solution, if not specified, all primary outputs are used." }, "solutionFolder": { "type": "string", "description": "The destination solution folder path to add the projects to. Can't be used with 'inRoot'. Optional." }, "inRoot": { "type": "boolean", "description": "Places the projects in the root of the solution, rather than creating a solution folder. Cannot be used with 'solutionFolder'. Optional. Available since .NET SDK 7.0.200." }, "projectFiles": { "oneOf": [ { "type": "array", "items": { "type": "string", "uniqueItems": true }, "description": "An array of project files that should be added to solution. If not specified, primary outputs will be used instead." }, { "type": "string", "description": "A semicolon delimited list of files that should be added to solution. If not specified, primary outputs will be used instead." } ] } } } } }, { "description": "Open in editor - Adds one or more of the primary outputs to the first sln file found (searches up the directory tree from the output folder).", "properties": { "actionId": { "enum": ["84C0DA21-51C8-4541-9940-6CA19AF04EE6"] }, "args": { "properties": { "files": { "type": "string", "description": "A semicolon delimited list of indexes of the primary outputs that should be opened in the editor." } } } } } ] } ] } }, "precedence": { "description": "A value used to determine how preferred this template is among the other templates with the same groupIdentity (higher values are more preferred).", "type": ["integer", "string"], "pattern": "^([0-9]+)$", "default": 0 }, "preferDefaultName": { "description": "Indicated which behaviour to use when no `--name` is specified during template creation. If `true` it will use the template's `defaultName`. If no `defaultName` is found, or `preferDefaultName` is `false` it uses the fallback (output folder).", "type": ["boolean"] }, "preferNameDirectory": { "description": "Indicates whether to create a directory for the template if name is specified but an output directory is not set (instead of creating the content directly in the current directory).", "type": "boolean" }, "primaryOutputs": { "description": "A list of important output paths created during template generation. These paths need to be added to the newly created project at the end of template creation.", "type": "array", "items": { "type": "object", "required": ["path"], "properties": { "path": { "description": "The path to the file in the template content whose corresponding output file should be included as a primary output.", "type": "string" }, "condition": { "description": "The condition for including the specified path in the primary outputs set.", "type": "string", "default": "true" } } } }, "shortName": { "oneOf": [ { "description": "A shorthand name for selecting the template in CLI environment. The template short name should be unique across all the installed templates.", "type": "string" }, { "type": "array", "description": "A shorthand name for selecting the template in CLI environment. The first element is a primary choice, and will be used in scenarios which allow only single value for the short name. The template short name should be unique across all the installed templates.", "items": { "type": "string" } } ], "minLength": 1 }, "sourceName": { "description": "The text in the source content to replace with the name the user specifies. The value of the 'sourceName' is available in built-in 'name' symbol that can be used as the source for creating other symbols and condition expressions. See important information about how to select correct 'sourceName' in https://github.com/dotnet/templating/wiki/Naming-and-default-value-forms.", "type": "string" }, "sources": { "description": "The set of mappings in the template content to user directories.", "type": "array", "items": { "$ref": "#/definitions/source" }, "default": { "source": "./", "target": "./" } }, "forms": { "type": "object", "description": "Custom value forms used by the template.", "additionalProperties": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The identifier for the value form component that will be used to transform the value." } }, "oneOf": [ { "not": { "required": ["identifier"], "properties": { "identifier": { "enum": [ "lowerCaseInvariant", "xmlEncode", "safe_name", "lower_safe_name", "upperCaseInvariant", "replace", "safe_namespace", "lower_safe_namespace", "chain", "lowerCase", "identity", "upperCase", "jsonEncode", "firstLowerCase", "firstLowerCaseInvariant", "firstUpperCase", "firstUpperCaseInvariant", "titleCase", "kebabCase" ] } } } }, { "description": "Lowercases the source value in a culture invariant way.", "properties": { "identifier": { "enum": ["lowerCaseInvariant"] } } }, { "description": "XML encodes the source value.", "properties": { "identifier": { "enum": ["xmlEncode"] } } }, { "description": "Converts the source value to a string suitable for a C# identifier.", "properties": { "identifier": { "enum": ["safe_name"] } } }, { "description": "Converts the source value to a lowercase string suitable for a C# identifier.", "properties": { "identifier": { "enum": ["lower_safe_name"] } } }, { "required": ["pattern", "replacement"], "description": "Performs a regular expression replacement on the source value.", "properties": { "identifier": { "enum": ["replace"] }, "pattern": { "description": "A regular expression whose matches will be replaced with the literal value specified in replacement.", "type": "string" }, "replacement": { "description": "The value to replace the matches of the specified pattern in the source value with.", "type": "string" } } }, { "description": "Converts the source value to a string suitable for a C# namespace.", "properties": { "identifier": { "enum": ["safe_namespace"] } } }, { "description": "Converts the source value to a lowercase string suitable for a C# namespace.", "properties": { "identifier": { "enum": ["lower_safe_namespace"] } } }, { "required": ["steps"], "description": "Performs a series of transforms.", "properties": { "identifier": { "enum": ["chain"] }, "steps": { "type": "array", "items": { "type": "string", "description": "The name of the form to apply to the previous step (or source value if this is the first step)." } } } }, { "description": "Changes the case of source value to lower-case.", "properties": { "identifier": { "enum": ["lowerCase"] } } }, { "description": "Returns the source value.", "properties": { "identifier": { "enum": ["identity"] } } }, { "description": "Converts the source value to upper-case using the casing rules of the current culture.", "properties": { "identifier": { "enum": ["upperCase"] } } }, { "description": "Converts the source value to upper-case using the casing rules of the invariant culture.", "properties": { "identifier": { "enum": ["upperCaseInvariant"] } } }, { "description": "JSON encodes the source value.", "properties": { "identifier": { "enum": ["jsonEncode"] } } }, { "description": "Converts the first letter of the value to lowercase using the casing rules of the current culture.", "properties": { "identifier": { "enum": ["firstLowerCase"] } } }, { "description": "Converts the first letter of the value to lowercase using the casing rules of the invariant culture.", "properties": { "identifier": { "enum": ["firstLowerCaseInvariant"] } } }, { "description": "Converts the first letter of the value to uppercase using the casing rules of the current culture.", "properties": { "identifier": { "enum": ["firstUpperCase"] } } }, { "description": "Converts the first letter of the value to uppercase using the casing rules of the invariant culture.", "properties": { "identifier": { "enum": ["firstUpperCaseInvariant"] } } }, { "description": "Converts the value to title case using the casing rules of the current culture.", "properties": { "identifier": { "enum": ["titleCase"] } } }, { "description": "Converts the value to kebab case using the casing rules of the invariant culture.", "properties": { "identifier": { "enum": ["kebabCase"] } } } ] } }, "symbols": { "description": "The symbols section defines variables and their values, the values may be the defined in terms of other symbols. When a defined symbol name is encountered anywhere in the template definition, it is replaced by the value defined in this configuration. The symbols configuration is a collection of key-value pairs. The keys are the symbol names, and the value contains key-value-pair configuration information on how to assign the symbol a value.", "type": "object", "additionalProperties": { "type": "object", "required": ["type"], "properties": { "datatype": { "$ref": "#/definitions/datatype" }, "type": { "type": "string", "enum": ["bind", "derived", "generated", "parameter", "computed"] } }, "oneOf": [ { "required": ["binding"], "properties": { "type": { "description": "The symbol binds value from external sources.", "enum": ["bind"] }, "binding": { "description": "The source and the name of parameter to take the value from. The syntax is: <external source>:<parameter name>. Well known external sources are: host - a value that is defined by the template engine host; env - environment variable.", "type": "string" }, "defaultValue": { "description": "The value assigned to the symbol if no value was provided from external source(s).", "type": "string" }, "replaces": { "type": "string", "description": "The text to replace with the value of this symbol." }, "fileRename": { "type": "string", "description": "Defines the portion of file names which will be replaced by symbol value." }, "onlyIf": { "type": "array", "items": { "type": "object", "properties": { "after": { "description": "The replacement string occurs after this value.", "type": "string" }, "before": { "description": "The replacement string occurs before this value.", "type": "string" } } } } } }, { "required": ["valueSource", "valueTransform"], "properties": { "type": { "description": "The value of this symbol is derived from the value of another symbol by the application of value forms.", "enum": ["derived"] }, "valueSource": { "type": "string", "description": "The name of the symbol that the value should be derived from." }, "valueTransform": { "type": "string", "description": "The name of the value form that should be applied to the source value to use as the value of this symbol." }, "defaultValue": { "description": "The value assigned to the symbol if no value was provided.", "type": "string" }, "replaces": { "type": "string", "description": "The text to replace with the value of this symbol." }, "fileRename": { "type": "string", "description": "Defines the portion of file names which will be replaced by symbol value." }, "onlyIf": { "type": "array", "items": { "type": "object", "properties": { "after": { "description": "The replacement string occurs after this value.", "type": "string" }, "before": { "description": "The replacement string occurs before this value.", "type": "string" } } } } } }, { "required": ["generator"], "properties": { "type": { "description": "Defines the high level configuration of symbol.", "enum": ["generated"] }, "replaces": { "type": "string", "description": "The text to replace with the value of this symbol." }, "fileRename": { "type": "string", "description": "Defines the portion of file names which will be replaced by symbol value." }, "onlyIf": { "type": "array", "items": { "type": "object", "properties": { "after": { "description": "The replacement string occurs after this value.", "type": "string" }, "before": { "description": "The replacement string occurs before this value.", "type": "string" } } } } }, "oneOf": [ { "$ref": "#/definitions/generatorCasing" }, { "$ref": "#/definitions/generatorCoalesce" }, { "$ref": "#/definitions/generatorConstant" }, { "$ref": "#/definitions/generatorGuid" }, { "$ref": "#/definitions/generatorNow" }, { "$ref": "#/definitions/generatorPort" }, { "$ref": "#/definitions/generatorRandom" }, { "$ref": "#/definitions/generatorRegex" }, { "$ref": "#/definitions/generatorRegexMatch" }, { "$ref": "#/definitions/generatorSwitch" }, { "$ref": "#/definitions/generatorJoin" } ] }, { "properties": { "type": { "description": "Defines the high level configuration of symbol.", "enum": ["parameter"] }, "isRequired": { "oneOf": [ { "type": "boolean", "description": "Flag indicating whether the parameter has to be specified on the input." }, { "type": "string", "description": "Condition indicating whether the parameter has to be specified on the input." } ] }, "isEnabled": { "oneOf": [ { "type": "boolean", "description": "Flag indicating parameter visibility." }, { "type": "string", "description": "Condition indicating parameter visibility." } ] }, "choices": { "description": "An array listing the valid choices for a symbol whose datatype = choice. If not provided, there are no valid choices for the symbol, so it can never be assigned a value.", "type": "array", "items": { "required": ["choice"], "properties": { "choice": { "description": "A valid value for the symbol.", "type": "string" }, "description": { "description": "Help text describing the meaning of the corresponding value.", "type": "string" }, "displayName": { "type": "string", "description": "The friendly name of the choice to be displayed to the user. This property can be localized." } } } }, "defaultValue": { "description": "The value assigned to the symbol if no value for it is provided by the user or host.", "type": "string" }, "description": { "description": "The description of the parameter.", "type": "string" }, "replaces": { "type": "string", "description": "The text to replace with the value of this symbol." }, "fileRename": { "type": "string", "description": "The element defines the portion of file names which will be replaced by symbol value." }, "onlyIf": { "type": "array", "items": { "type": "object", "properties": { "after": { "description": "The replacement string occurs after this value.", "type": "string" }, "before": { "description": "The replacement string occurs before this value.", "type": "string" } } } }, "allowMultipleValues": { "description": "Indication whether multiple values can be specified for a parameter. Valid only for datatype = choice.", "type": "boolean", "default": false }, "enableQuotelessLiterals": { "description": "Indication whether implicit symbols for each choice value should be added to parameter collection. This allows condition syntax without using quotes for choice literals. Valid only for datatype = choice.", "type": "boolean", "default": false }, "displayName": { "type": "string", "description": "The friendly name of the symbol to be displayed to the user. This property can be localized." }, "forms": { "type": "object", "properties": { "global": { "oneOf": [ { "type": "array", "items": { "type": "string", "uniqueItems": true }, "description": "An array of the forms applied to the parameter symbol. Note that the forms should produce the different result on the value of 'replaces' and 'fileRename' properties. Use the form in the template content to apply corresponding transformation to the value given by the user as the parameter." }, { "type": "string", "description": "The form applied to the parameter symbol. Note that the forms should produce the different result on the value of 'replaces' and 'fileRename' properties. Use the form in the template content to apply corresponding transformation to the value given by the user as the parameter." } ] } } } } }, { "properties": { "type": { "description": "Defines the high level configuration of symbol.", "enum": ["computed"] }, "value": { "description": "An evaluate-able condition whose result defines the value of the symbol.", "type": "string" } } } ] } }, "baselines": { "description": "Alternate sets of defaults for symbols.", "type": "object", "additionalProperties": { "type": "object", "description": "A named set of alternate defaults.", "properties": { "description": { "type": "string", "description": "A string to use to indicate the intent of the baseline." }, "defaultOverrides": { "description": "A lookup of symbol names to new defaults.", "type": "object", "additionalProperties": { "type": "string", "description": "An updated default value for the specified symbol." } } } } }, "tags": { "description": "Common information about templates, these are effectively interchangeable with choice type parameter symbols.", "type": "object", "required": ["type"], "properties": { "language": { "description": "The programming language the template primarily contains or is intended for use with.", "type": "string" }, "type": { "description": "The type of template: project or item.", "enum": ["project", "item", "solution"] } } }, "thirdPartyNotices": { "description": "An URL for a document indicating any libraries used by the template that are not owned/provided by the template author.", "type": "string" }, "description": { "type": "string", "description": "A description of the template's purpose or contents for use in help." }, "constraints": { "description": "The constraints section defines the restrictions when the template can be run. Available since .NET SDK 7.0.100.", "type": "object", "additionalProperties": { "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "description": "Constraint type." }, "args": { "description": "Constraints arguments." } }, "oneOf": [ { "not": { "required": ["type"], "properties": { "type": { "enum": [ "os", "host", "workload", "sdk-version", "project-capability" ] } } }, "properties": { "args": { "type": ["array", "object", "string"] } } }, { "description": "Operating system constraint. Allows to restrict the template to be run only on specific operating systems.", "properties": { "type": { "enum": ["os"] }, "args": { "oneOf": [ { "type": "string", "enum": ["Windows", "Linux", "OSX"] }, { "type": "array", "items": { "type": "string", "enum": ["Windows", "Linux", "OSX"] } } ] } } }, { "description": "Host constraint. Allows to restrict the template to be run only on specific applications using template engine.", "properties": { "type": { "enum": ["host"] }, "args": { "type": "array", "items": { "type": "object", "required": ["hostname"], "properties": { "hostname": { "type": "string", "description": "The identifier of supported host. Commonly used identifiers are: 'dotnetcli'' - .NET SDK, 'vs' - Visual Studio, 'vs-mac' - Visual Studio for Mac, 'ide' - Visual Studio (any platform).", "oneOf": [ { "not": { "enum": ["dotnetcli", "vs", "vs-mac", "ide"] } }, { "enum": ["dotnetcli", "vs", "vs-mac", "ide"] } ] }, "version": { "type": "string", "description": "The supported version of the host. May be an exact version, float version or version range. Refer to https://docs.microsoft.com/en-us/nuget/concepts/package-versioning for more info." } } } } } }, { "description": "Installed workload constraint. Allows to restrict the template to be run only on host with specific workloads installed.", "properties": { "type": { "enum": ["workload"] }, "args": { "oneOf": [ { "type": "string", "description": "supported workload (running host need to have at least one of the requested workloads installed)." }, { "type": "array", "items": { "type": "string", "description": "supported workload (running host need to have at least one of the requested workloads installed)." } } ] } } }, { "description": "SDK version constraint. Allows to restrict the template to be run only on specific .NET SDK version(s).", "properties": { "type": { "enum": ["sdk-version"] }, "args": { "oneOf": [ { "type": "string", "description": "The supported version of the SDK. May be an exact version, float version or version range. Refer to https://docs.microsoft.com/en-us/nuget/concepts/package-versioning for more info." }, { "type": "array", "items": { "type": "string", "description": "The supported version of the SDK. May be an exact version, float version or version range. Refer to https://docs.microsoft.com/en-us/nuget/concepts/package-versioning for more info." } } ] } } }, { "description": "The project context constraint. Allows to restrict the item template to be run only on inside .NET project with certain capabilities.", "properties": { "type": { "enum": ["project-capability"] }, "args": { "type": "string", "description": "Project capability expression that should be satisfied by the project. Refer to https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualstudio.shell.interop.vsprojectcapabilityexpressionmatcher for more info." } } } ] } } }, "required": [ "author", "classifications", "identity", "name", "shortName", "tags" ], "title": "JSON schema .NET template configuration (template.json).", "type": "object" }

webextension.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, "definitions": { "action": { "type": "object", "properties": { "browser_style": { "description": "Use this to include a stylesheet in your popup that will make it look consistent with the browser's UI and with other add-ons that use the browser_style property. Although this key defaults to false, it's recommended that you include it and set it to true.", "type": "boolean", "default": false }, "default_icon": { "$ref": "#/definitions/icon" }, "default_popup": { "type": "string", "description": "The popup appears when the user clicks the icon." }, "default_title": { "type": "string", "description": "Tooltip for the main toolbar icon." } } }, "command": { "type": "object", "properties": { "description": { "type": "string" }, "suggested_key": { "type": "object", "properties": { "default": { "type": "string" }, "mac": { "type": "string" }, "linux": { "type": "string" }, "windows": { "type": "string" }, "chromeos": { "type": "string" }, "ios": { "type": "string" }, "android": { "type": "string" } } } } }, "icon": { "type": ["string", "object"], "additionalProperties": false, "patternProperties": { "^[1-9]\\d*$": { "type": "string" } } }, "content_security_policy": { "type": "string", "description": "This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.", "default": "script-src 'self'; object-src 'self'" }, "glob_pattern": { "type": "string" }, "match_pattern": { "type": "string", "pattern": "^((\\*|http|https|file|ftp|chrome-extension):\\/\\/(\\*|\\*\\.[^\\/\\*]+|[^\\/\\*]+)?(\\/.*))|<all_urls>$" }, "permissions": { "type": "array", "uniqueItems": true, "items": { "anyOf": [ { "type": "string" }, { "enum": [ "<all_urls>", "activeTab", "alarms", "bookmarks", "browsingData", "contextMenus", "contextualIdentities", "cookies", "downloads", "downloads.open", "geolocation", "history", "identity", "idle", "management", "nativeMessaging", "notifications", "proxy", "sessions", "storage", "tabs", "topSites", "webNavigation", "webRequest", "webRequestBlocking" ] } ] } }, "scripts": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "id": "https://json.schemastore.org/webextension.json", "properties": { "applications": { "type": "object", "description": "The applications key contains keys that are specific to a particular host application.", "properties": { "gecko": { "type": "object", "properties": { "id": { "type": "string", "description": "id is the extension ID", "pattern": "^\\{[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}\\}$|^[A-Za-z0-9-._]*@[A-Za-z0-9-._]+$" }, "strict_min_version": { "type": "string", "description": "Minimum version of Gecko to support. Defaults to '42a1'. (Requires Gecko 45)", "default": "42a1" }, "strict_max_version": { "type": "string", "description": "Maximum version of Gecko to support. Defaults to '*'. (Requires Gecko 45)", "default": "*" }, "update_url": { "type": "string", "description": "Link to an add-on update manifest. (Requires Gecko 45)", "format": "uri" } } } } }, "author": { "description": "\"The extension's author, intended for display in the browser's user interface. If the developer key is supplied and it contains the \"name\" property, it will override the author key. There's no way to specify multiple authors.\"", "type": "string" }, "background": { "type": "object", "description": "The background page is an HTML page that runs in the extension process. It exists for the lifetime of your extension, and only one instance of it at a time is active.", "properties": { "persistent": { "type": "boolean", "description": "When false, makes the background page an event page (loaded only when needed).", "default": true }, "page": { "description": "Specify the HTML of the background page.", "type": "string" }, "scripts": { "description": "A background page will be generated by the extension system that includes each of the files listed in the scripts property.", "type": "array", "items": { "type": "string" } } } }, "browser_action": { "allOf": [ { "$ref": "#/properties/page_action" } ], "description": "browser action is a button that your extension adds to the browser's toolbar. The button has an icon, and may optionally have a popup whose content is specified using HTML, CSS, and JavaScript.", "properties": { "default_area": { "description": "Defines the part of the browser in which the button is initially placed.", "enum": ["navbar", "menupanel", "tabstrip", "personaltoolbar"], "default": "navbar" } } }, "chrome_settings_overrides": { "description": "Use the chrome_settings_overrides key to override certain browser settings", "type": "object", "properties": { "homepage": { "description": "Defines the page to be used as the browser's homepage.", "type": "string" } } }, "chrome_url_overrides": { "description": "Use the chrome_url_overrides key to provide a custom replacement for the documents loaded into various special pages usually provided by the browser itself.", "type": "object", "properties": { "bookmarks": { "description": "Provide a replacement for the page that shows the bookmarks.", "type": "string" }, "history": { "description": "Provide a replacement for the page that shows the browsing history.", "type": "string" }, "newtab": { "description": "Provide a replacement for the document that's shown in the \"new tab\" page", "type": "string" } } }, "commands": { "type": "object", "description": "Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension.", "properties": { "_execute_browser_action": { "$ref": "#/definitions/command" }, "_execute_page_action": { "$ref": "#/definitions/command" }, "_execute_sidebar_action": { "$ref": "#/definitions/command" } }, "additionalProperties": { "$ref": "#/definitions/command" } }, "content_scripts": { "type": "array", "description": "Content scripts are JavaScript files that run in the context of web pages.", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "required": ["matches"], "additionalProperties": false, "properties": { "matches": { "type": "array", "description": "Specifies which pages this content script will be injected into.", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/definitions/match_pattern" } }, "exclude_matches": { "type": "array", "description": "Excludes pages that this content script would otherwise be injected into.", "uniqueItems": true, "items": { "$ref": "#/definitions/match_pattern" } }, "css": { "type": "array", "description": "The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.", "uniqueItems": true, "items": { "type": "string" } }, "js": { "$ref": "#/definitions/scripts", "description": "The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array." }, "run_at": { "type": "string", "description": "Controls when the files in js are injected.", "enum": ["document_start", "document_end", "document_idle"], "default": "document_idle" }, "all_frames": { "type": "boolean", "description": "Controls whether the content script runs in all frames of the matching page, or only the top frame.", "default": false }, "include_globs": { "type": "array", "description": "Applied after matches to include only those URLs that also match this glob. Intended to emulate the @include Greasemonkey keyword.", "uniqueItems": true, "items": { "$ref": "#/definitions/glob_pattern" } }, "exclude_globs": { "type": "array", "description": "Applied after matches to exclude URLs that match this glob. Intended to emulate the @exclude Greasemonkey keyword.", "uniqueItems": true, "items": { "$ref": "#/definitions/glob_pattern" } }, "match_about_blank": { "type": "boolean", "description": "Whether to insert the content script on about:blank and about:srcdoc.", "default": false } } } }, "content_security_policy": { "$ref": "#/definitions/content_security_policy" }, "default_locale": { "type": "string", "description": "Specifies the subdirectory of _locales that contains the default strings for this extension.", "default": "en" }, "description": { "type": "string", "description": "A plain text description of the extension" }, "developer": { "type": "object", "description": "The name of the extension's developer and their homepage URL, intended for display in the browser's user interface.", "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "devtools_page": { "type": "string", "description": "A DevTools extension adds functionality to the Chrome DevTools. It can add new UI panels and sidebars, interact with the inspected page, get information about network requests, and more." }, "experiment_apis": { "type": "object", "items": { "type": "object", "required": ["schema"], "properties": { "child": { "type": "object", "required": ["paths", "script", "scopes"], "properties": { "paths": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "scopes": { "type": "array", "items": { "type": "string" } }, "script": { "type": "string" } } }, "parent": { "type": "object", "required": ["paths", "scopes", "scripts"], "properties": { "events": { "type": "array", "items": { "type": "string" } }, "paths": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "scopes": { "type": "array", "items": { "type": "string" } }, "script": { "type": "string" } } }, "schema": { "type": "string" } } } }, "homepage_url": { "type": "string", "description": "The URL of the homepage for this add-on. The add-on management page will contain a link to this URL.", "format": "uri" }, "icons": { "description": "One or more icons that represent the extension, app, or theme. Recommended format: PNG; also BMP, GIF, ICO, JPEG.", "additionalProperties": false, "patternProperties": { "^[1-9]\\d*$": { "type": "string" } } }, "incognito": { "type": "string", "description": "Specify how this extension will behave if allowed to run in incognito mode.", "enum": ["spanning", "split", "not_allowed"], "default": "spanning" }, "manifest_version": { "type": "integer", "description": "One integer specifying the version of the manifest file format your package requires.", "enum": [2] }, "name": { "type": "string", "description": "The name of the extension", "minLength": 2, "maxLength": 45 }, "omnibox": { "type": "object", "description": "The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox.", "required": ["keyword"], "properties": { "keyword": { "type": "string", "description": "The keyword that will trigger your extension." } } }, "optional_permissions": { "description": "Use the optional_permissions key to list permissions which you want to ask for at runtime, after your add-on has been installed.", "type": "array", "uniqueItems": true, "items": { "anyOf": [ { "type": "string" }, { "enum": [ "activeTab", "background", "bookmarks", "clipboardRead", "clipboardWrite", "contentSettings", "contextMenus", "cookies", "debugger", "geolocation", "history", "idle", "management", "notifications", "pageCapture", "tabs", "topSites", "webNavigation", "webRequest", "webRequestBlocking" ] } ] } }, "options_ui": { "type": "object", "description": "Use the options_ui key to define an options page for your add-on.", "required": ["page"], "properties": { "page": { "type": "string", "description": "The path to an HTML file containing the specification of your options page." }, "browser_style": { "type": "boolean", "default": true, "description": "Use this to include a stylesheet in your page that will make it look consistent with the browser's UI and with other add-ons that use the browser_style property." }, "open_in_tab": { "type": "boolean", "default": false, "description": "If true, the options page will open in a normal browser tab, rather than being integrated into the browser's add-ons manager." } } }, "page_action": { "description": "Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages.", "type": "object", "properties": { "browser_style": { "description": "Use this to include a stylesheet in your popup that will make it look consistent with the browser's UI and with other add-ons that use the browser_style property. Although this key defaults to false, it's recommended that you include it and set it to true.", "type": "boolean", "default": false }, "default_icon": { "$ref": "#/definitions/icon" }, "default_popup": { "type": "string", "description": "The popup appears when the user clicks the icon." }, "default_title": { "type": "string", "description": "Tooltip for the main toolbar icon." } } }, "permissions": { "$ref": "#/definitions/permissions", "description": "Permissions help to limit damage if your extension or app is compromised by malware. Some permissions are also displayed to users before installation, as detailed in Permission Warnings." }, "protocol_handlers": { "type": "array", "description": "Use this key to register one of more web-based protocol handlers.", "items": { "type": "object", "description": "Use this object to register a single web-based protocol handler", "properties": { "protocol": { "description": "A string defining the protocol.", "anyOf": [ { "enum": [ "bitcoin", "geo", "im", "irc", "ircs", "magnet", "mailto", "mms", "news", "nntp", "sip", "sms", "smsto", "ssh", "tel", "urn", "webcal", "wtai", "xmpp" ], "description": "A pre-existing protocol allowed for use with WebExtensions. See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/protocol_handlers for more information." }, { "type": "string", "pattern": "^(ext|web)\\+[0-9a-z]+", "description": "A custom-named protocol. These MUST be prefixed with 'web+' or 'ext+', followed by a string consisting of only lower-case ASCII characters." } ] }, "name": { "description": "A string representing the name of the protocol handler. This will be displayed to the user when they are being asked if they want this handler to open the link.", "type": "string" }, "uriTemplate": { "description": "A string representing the URL of the handler. This string must include \"%s\" as a placeholder: this will be replaced with the escaped URL of the document to be handled. This URL might be a true URL, or it could be a phone number, email address, or so forth.", "pattern": "%s" } } } }, "short_name": { "type": "string", "description": "The short name is typically used where there is insufficient space to display the full name.", "minLength": 2, "maxLength": 12 }, "sidebar_action": { "type": "object", "description": "A sidebar is a pane that is displayed at the left-hand side of the browser window, next to the web page. The browser provides a UI that enables the user to see the currently available sidebars and to select a sidebar to display.", "properties": { "default_icon": { "$ref": "#/definitions/icon" }, "default_panel": { "type": "string", "description": "The path to an HTML file that specifies the sidebar's contents." }, "default_title": { "type": "string", "description": "Title for the sidebar. This is used in the browser UI for listing and opening sidebars, and is displayed at the top of the sidebar when it is open." } } }, "version": { "description": "One to four dot-separated integers identifying the version of this extension.", "pattern": "^(?:\\d{1,5}\\.){0,3}\\d{1,5}$" }, "web_accessible_resources": { "type": "array", "description": "An array of strings specifying the paths (relative to the package root) of packaged resources that are expected to be usable in the context of a web page.", "uniqueItems": true, "items": { "type": "string" } } }, "required": ["manifest_version", "name", "version"], "title": "JSON schema for WebExtensions manifest files", "type": "object" }

gitversion.json

{ "$id": "https://json.schemastore.org/gitversion.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "default": {}, "description": "Output from the GitVersion tool, describing the current version of the repo it was executed from", "properties": { "Major": { "$id": "#/properties/Major", "type": "integer", "title": "Major version part", "description": "", "default": 0, "examples": [0] }, "Minor": { "$id": "#/properties/Minor", "type": "integer", "title": "Minor version part", "description": "", "default": 0, "examples": [7] }, "Patch": { "$id": "#/properties/Patch", "type": "integer", "title": "Patch version part", "description": "", "default": 0, "examples": [1] }, "PreReleaseTag": { "$id": "#/properties/PreReleaseTag", "type": "string", "title": "Pre-release tag", "description": "", "default": "", "examples": ["alpha"] }, "PreReleaseTagWithDash": { "$id": "#/properties/PreReleaseTagWithDash", "type": "string", "title": "Pre-release tag with dash", "description": "", "default": "", "examples": ["-alpha"] }, "PreReleaseLabel": { "$id": "#/properties/PreReleaseLabel", "type": "string", "title": "Pre-release label", "description": "", "default": "", "examples": ["alpha"] }, "PreReleaseNumber": { "$id": "#/properties/PreReleaseNumber", "type": "integer", "title": "Pre-release number", "description": "", "default": 0, "examples": [1] }, "WeightedPreReleaseNumber": { "$id": "#/properties/WeightedPreReleaseNumber", "type": "integer", "title": "Weighted pre-release number", "description": "A summation of branch specific pre-release-weight and the PreReleaseNumber. It can be used to obtain a monotonically increasing version number across the branches", "default": 0, "examples": [55001] }, "BuildMetaData": { "$id": "#/properties/BuildMetaData", "type": "string", "title": "Build metadata", "description": "", "default": "", "examples": [""] }, "BuildMetaDataPadded": { "$id": "#/properties/BuildMetaDataPadded", "type": "string", "title": "Build metadata, padded", "description": "", "default": "", "examples": [""] }, "FullBuildMetaData": { "$id": "#/properties/FullBuildMetaData", "type": "string", "title": "Full build metadata", "description": "Includes branch and commit hash", "default": "", "examples": ["Branch.master.Sha.3a34284b9e04010912f491ce662c813ebfdcae0b"] }, "MajorMinorPatch": { "$id": "#/properties/MajorMinorPatch", "type": "string", "title": "Major.Minor.Patch version", "description": "", "default": "", "examples": ["0.7.1"] }, "SemVer": { "$id": "#/properties/SemVer", "type": "string", "title": "Semantic version", "description": "", "default": "", "examples": ["0.7.1-alpha.1"] }, "LegacySemVer": { "$id": "#/properties/LegacySemVer", "type": "string", "title": "Legacy semantic version", "description": "For pre v2.0 compatibility", "default": "", "examples": ["0.7.1-alpha1"] }, "LegacySemVerPadded": { "$id": "#/properties/LegacySemVerPadded", "type": "string", "title": "Legacy semantic version, padded", "description": "", "default": "", "examples": ["0.7.1-alpha0001"] }, "AssemblySemVer": { "$id": "#/properties/AssemblySemVer", "type": "string", "title": "Assembly semantic version", "description": "Semantic version for windows/.NET assembly use. If configured as Major.Minor, gives you the ability to roll out hot fixes to your assembly without breaking existing applications that may be referencing it.", "default": "", "examples": ["0.7.0.0"] }, "AssemblySemFileVer": { "$id": "#/properties/AssemblySemFileVer", "type": "string", "title": "Semantic version for windows/.NET assembly file use. May be used to contain the full version number when AssemblyVersion is set to Major.Minor", "description": "", "default": "", "examples": ["0.7.1.0"] }, "FullSemVer": { "$id": "#/properties/FullSemVer", "type": "string", "title": "Full semantic version", "description": "", "default": "", "examples": ["0.7.1-alpha.1"] }, "InformationalVersion": { "$id": "#/properties/InformationalVersion", "type": "string", "title": "Informational version", "description": "Combined version and build metadata", "default": "", "examples": [ "0.7.1-alpha.1+Branch.master.Sha.3a34284b9e04010912f491ce662c813ebfdcae0b" ] }, "BranchName": { "$id": "#/properties/BranchName", "type": "string", "title": "Branch name", "description": "Repository branch name", "default": "", "examples": ["master"] }, "EscapedBranchName": { "$id": "#/properties/EscapedBranchName", "type": "string", "title": "Escaped branch name", "description": "Repository branch name, containing only alphanumeric characters and -", "default": "", "examples": ["master"] }, "Sha": { "$id": "#/properties/Sha", "type": "string", "title": "SHA", "description": "The commit hash that was used for the build", "default": "", "examples": ["3a34284b9e04010912f491ce662c813ebfdcae0b"], "maxLength": 40, "minLength": 40 }, "ShortSha": { "$id": "#/properties/ShortSha", "type": "string", "title": "Short SHA", "description": "A shorter representation of the build commit hash", "default": "", "examples": ["3a34284"], "maxLength": 7, "minLength": 7 }, "NuGetVersionV2": { "$id": "#/properties/NuGetVersionV2", "type": "string", "title": "NuGet version v2", "description": "NuGet package version string, using semantic version v2.0", "default": "", "examples": ["0.7.1-alpha0001"] }, "NuGetVersion": { "$id": "#/properties/NuGetVersion", "type": "string", "title": "NuGet version", "description": "NuGet package version string, without semantic version v2.0 format", "default": "", "examples": ["0.7.1-alpha0001"] }, "NuGetPreReleaseTagV2": { "$id": "#/properties/NuGetPreReleaseTagV2", "type": "string", "title": "NuGet pre-release tag v2", "description": "NuGet package pre-release tag for semantic version v2.0", "default": "", "examples": ["alpha0001"] }, "NuGetPreReleaseTag": { "$id": "#/properties/NuGetPreReleaseTag", "type": "string", "title": "NuGetPreReleaseTag", "description": "NuGet package pre-release tag, without semantic version v2.0 format", "default": "", "examples": ["alpha0001"] }, "VersionSourceSha": { "$id": "#/properties/VersionSourceSha", "type": "string", "title": "Version source SHA", "description": "The hash of the commit used as version source", "default": "", "examples": ["1014284b9e04010912f491ce662c813ebfdcaccd"] }, "CommitsSinceVersionSource": { "$id": "#/properties/CommitsSinceVersionSource", "type": "integer", "title": "Commits since version source", "description": "The number of commits made since the version source commit", "default": 0, "examples": [1] }, "CommitsSinceVersionSourcePadded": { "$id": "#/properties/CommitsSinceVersionSourcePadded", "type": "string", "title": "Commits since version source, padded", "description": "The number of commits made since the version source commit (zero-padded)", "default": "", "examples": ["0001"], "maxLength": 4, "minLength": 4 }, "CommitDate": { "$id": "#/properties/CommitDate", "type": "string", "title": "Commit date", "description": "", "default": "", "examples": ["2020-05-09"] } }, "required": [ "Major", "Minor", "Patch", "PreReleaseTag", "PreReleaseTagWithDash", "PreReleaseLabel", "PreReleaseNumber", "WeightedPreReleaseNumber", "BuildMetaData", "BuildMetaDataPadded", "FullBuildMetaData", "MajorMinorPatch", "SemVer", "LegacySemVer", "LegacySemVerPadded", "AssemblySemVer", "AssemblySemFileVer", "FullSemVer", "InformationalVersion", "BranchName", "EscapedBranchName", "Sha", "ShortSha", "NuGetVersionV2", "NuGetVersion", "NuGetPreReleaseTagV2", "NuGetPreReleaseTag", "VersionSourceSha", "CommitsSinceVersionSource", "CommitsSinceVersionSourcePadded", "CommitDate" ], "title": "GitVersion Variables", "type": "object" }

container-structure-test.json

{ "$comment": "https://github.com/GoogleContainerTools/container-structure-test", "$id": "https://json.schemastore.org/container-structure-test.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "envVar": { "$id": "#/definitions/envVar", "type": "object", "additionalProperties": false, "required": ["key", "value"], "properties": { "key": { "type": "string", "description": "The name of the environment variables" }, "value": { "type": "string", "description": "The value of the environment variable" } } }, "label": { "$id": "#/definitions/label", "type": "object", "additionalProperties": false, "required": ["key", "value"], "properties": { "key": { "type": "string", "description": "The name of the label" }, "value": { "type": "string", "description": "The value of the label" }, "isRegex": { "type": "boolean", "description": "Interpreted the value as regex" } } } }, "description": "The Container Structure Tests provide a powerful framework to validate the structure of a container image. These tests can be used to check the output of commands in an image, as well as verify metadata and contents of the filesystem", "properties": { "schemaVersion": { "type": "string", "description": "The schema version of Structure Tests.", "default": "2.0.0" }, "commandTests": { "type": "array", "description": "A list of command tests", "items": { "type": "object", "required": ["name", "command"], "properties": { "name": { "type": "string", "description": "The name of the test" }, "setup": { "type": "array", "description": "A list of commands (each with optional flags) to run before the actual command under test.", "items": { "type": "array", "items": { "type": "string" } } }, "teardown": { "type": "array", "description": "A list of commands (each with optional flags) to run after the actual command under test.", "items": { "type": "array", "items": { "type": "string" } } }, "envVars": { "type": "array", "items": { "$ref": "#/definitions/envVar" } }, "command": { "type": "string", "description": "The command to run in the test." }, "args": { "type": "array", "description": "The arguments to pass to the command.", "items": { "type": "string" } }, "expectedOutput": { "type": "array", "description": "List of regexes that should match the stdout from running the command.", "minItems": 1, "items": { "type": "string" } }, "excludedOutput": { "type": "array", "description": "List of regexes that should not match the stdout from running the command..", "minItems": 1, "items": { "type": "string" } }, "expectedError": { "type": "array", "description": "List of regexes that should match the stderr from running the command.", "minItems": 1, "items": { "type": "string" } }, "excludedError": { "type": "array", "description": "List of regexes that should not match the stderr from running the command.", "minItems": 1, "items": { "type": "string" } }, "exitCode": { "type": "integer", "description": "Exit code that the command should exit with." } } } }, "fileExistenceTests": { "type": "array", "description": "File existence tests check to make sure a specific file (or directory) exist within the file system of the image. No contents of the files or directories are checked. These tests can also be used to ensure a file or directory is not present in the file system.", "items": { "type": "object", "required": ["name", "path", "shouldExist"], "properties": { "name": { "type": "string", "description": "The name of the test" }, "path": { "type": "string", "description": "Path to the file or directory under test", "default": "/" }, "shouldExist": { "type": "boolean", "description": "Whether or not the specified file or directory should exist in the file system", "default": true }, "permissions": { "type": "string", "description": "The expected Unix permission string (e.g. drwxrwxrwx) of the files or directory." }, "uid": { "type": "number", "description": "The expected Unix user ID of the owner of the file or directory." }, "gid": { "type": "number", "description": "The expected Unix group ID of the owner of the file or directory." }, "isExecutableBy": { "type": "string", "description": "Checks if file is executable by a given user. ", "enum": ["owner", "group", "any", "other"] } } } }, "fileContentTests": { "description": "File content tests open a file on the file system and check its contents. These tests assume the specified file is a file, and that it exists", "type": "array", "items": { "type": "object", "required": ["name", "path"], "properties": { "name": { "type": "string", "description": "The name of the test" }, "path": { "type": "string", "description": "Path to the file under test" }, "expectedContents": { "type": "array", "description": "List of regexes that should match the contents of the file", "minItems": 1, "items": { "type": "string" } }, "excludedContents": { "type": "array", "description": "List of regexes that should not match the contents of the file", "minItems": 1, "items": { "type": "string" } } } } }, "licenseTests": { "description": "License tests check a list of copyright files and makes sure all licenses are allowed at Google. By default it will look at where Debian lists all copyright files, but can also look at an arbitrary list of files.", "type": "array", "items": { "type": "object", "required": ["debian"], "properties": { "debian": { "type": "boolean", "default": true, "description": "if the image is based on Debian, check where Debian lists all licenses." }, "files": { "type": "array", "description": "A list of other files to check.", "minItems": 1, "items": { "type": "string" } } } } }, "metadataTest": { "type": "object", "properties": { "env": { "type": "array", "description": "A list of environment variable key/value pairs that should be set in the container.", "minItems": 1, "items": { "$ref": "#/definitions/envVar" } }, "labels": { "type": "array", "description": "A list of image labels key/value pairs that should be set on the container.", "minItems": 1, "items": { "$ref": "#/definitions/label" } }, "entrypoint": { "type": "array", "description": "The entrypoint of the container", "minItems": 1, "items": { "type": "string" } }, "cmd": { "type": "array", "description": "The CMD specified in the container", "minItems": 1, "items": { "type": "string" } }, "exposedPorts": { "type": "array", "description": "The ports exposed in the container.", "minItems": 1, "items": { "type": "string" } }, "unexposedPorts": { "type": "array", "description": "The ports NOT exposed in the container.", "minItems": 1, "items": { "type": "string" } }, "volumes": { "type": "array", "description": "The volumes exposed in the container.", "minItems": 1, "items": { "type": "string" } }, "unmountedVolumes": { "type": "array", "description": "The volumes NOT exposed in the container", "minItems": 1, "items": { "type": "string" } }, "workdir": { "type": "string", "description": "The default working directory of the container." } } }, "globalEnvVars": { "type": "array", "description": "A list of environment variables can optionally be specified as part of the test setup. ", "minItems": 1, "items": { "$ref": "#/definitions/envVar" } } }, "required": ["schemaVersion"], "title": "Container Structure Tests", "type": "object" }

github-discussion.json

{ "$comment": "https://docs.github.com/en/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms", "$id": "https://json.schemastore.org/github-discussion.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "title": { "description": "A default title that will be pre-populated in the discussion submission form.", "type": "string" }, "labels": { "description": "Labels that will automatically be added to discussions created with this template.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "body": { "description": "Definition of the input types in the discussion form", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["markdown", "textarea", "input", "dropdown", "checkboxes"] }, "attributes": { "type": "object", "properties": { "label": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" } } }, "validations": { "type": "object", "properties": { "required": { "type": "boolean" } } } } } } }, "required": ["body"], "type": "object" }

lerna.json

{ "$id": "https://json.schemastore.org/lerna", "$schema": "http://json-schema.org/draft-07/schema#", "description": "Lerna is a tool used in JavaScript monorepo projects. The lerna.json file is\nused to configure lerna to to best fit your project.", "properties": { "version": { "description": "The current version of the repository (or independent).", "type": "string" }, "npmClient": { "description": "Specify which client to run commands with (change to \"yarn\" to run commands with yarn. Defaults to \"npm\".", "type": "string" }, "npmClientArgs": { "description": "Array of strings that will be passed as arguments to the npmClient.", "type": "array", "items": { "type": "string" } }, "useWorkspaces": { "description": "Enable workspaces integration when using Yarn.", "type": "boolean" }, "workspaces": { "description": "Array of globs to use a workspace locations.", "type": "array", "items": { "type": "string" } }, "packages": { "description": "Array of globs to use a package locations.", "type": "array", "items": { "type": "string" } }, "ignoreChanges": { "description": "Array of globs of files to ignore when detecting changed packages.", "type": "array", "items": { "type": "string" } }, "command": { "description": "Options for the CLI commands.", "type": "object", "properties": { "publish": { "description": "Options for the publish command.", "type": "object", "properties": { "ignoreChanges": { "description": "An array of globs that won't be included in \"lerna changed/publish\". Use this to prevent publishing of a new version unnecessarily for changes, such as fixing a README.md typo.", "type": ["string", "array"], "items": { "type": "string" } }, "message": { "description": "A custom commit message when performing version updates for publication. See https://github.com/lerna/lerna/tree/master/commands/version#--message-msg for more information.", "type": "string" } } }, "bootstrap": { "description": "Options for the bootstrap command.", "type": "object", "properties": { "ignore": { "description": "An array of globs that won't be bootstrapped when running \"lerna bootstrap\" command.", "type": ["string", "array"], "items": { "type": "string" } }, "npmClientArgs": { "description": "Array of strings that will be passed as arguments directly to \"npm install\" during the \"lerna bootstrap\" command.", "type": "array", "items": { "type": "string" } } } }, "init": { "description": "Options for the init command.", "type": "object", "properties": { "exact": { "description": "Use lerna 1.x behavior of \"exact\" comparison. It will enforce the exact match for all subsequent executions.", "type": "boolean" } } }, "run": { "description": "Options for the run command.", "type": "object", "properties": { "npmClient": { "description": "Which npm client should be used when running package scripts.", "type": "string" } } }, "version": { "description": "Options for the version command.", "type": "object", "properties": { "allowBranch": { "description": "A whitelist of globs that match git branches where \"lerna version\" is enabled.", "type": ["string", "array"], "items": { "type": "string" } }, "message": { "description": "A custom commit message when performing version updates for publication. See https://github.com/lerna/lerna/tree/master/commands/version#--message-msg for more information.", "type": "string" } } } } } }, "title": "A JSON schema for lerna.json files", "type": "object" }

specif-1.1.json

{ "$id": "https://specif.de/v1.1/schema#", "$schema": "https://json-schema.org/draft/2019-09/schema", "definitions": { "SpecifId": { "description": "A globally unique identifier.", "type": "string", "pattern": "^[_a-zA-Z]{1}[_a-zA-Z0-9.-]*$" }, "SpecifAlternativeId": { "description": "A list of pointers to resources resp. statements which have been merged to this one.", "type": "object", "properties": { "id": { "description": "A string with a valid identifier of a model-element", "$ref": "#/definitions/SpecifId" }, "revision": { "description": "If missing, the latest revision is implied.", "$ref": "#/definitions/SpecifRevision" }, "project": { "description": "A string with a valid project identifier in case the identifier is not globally unique.", "$ref": "#/definitions/SpecifId" } }, "additionalProperties": false, "required": ["id"] }, "SpecifAlternativeIds": { "description": "The list of consolidated items to be used in case a consolidated item shall be updated.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifAlternativeId" } }, "SpecifRevision": { "description": "A globally unique revision tag with one or multiple blocks with alphanumeric characters separated by a special character [.:,;/-]. Sequential as well as branching/merging notations are possible.", "type": "string", "pattern": "^(?:[0-9a-zA-Z]+[.:,;/-])*[0-9a-zA-Z]+$" }, "SpecifReplaces": { "description": "For change and configuration management; the first revision has 0 entries, a simple modification has 1 entry and the result of a merge has 2 entries.", "type": "array", "maxItems": 2, "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifRevision" } }, "SpecifKey": { "description": "A key for a particular revision of an identifiable item, e.g. of a resource. A key consists of a globally unique identifier and a revision. No or an undefined revision means the latest revision of the identified item.", "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "revision": { "description": "If missing, the latest revision is implied.", "$ref": "#/definitions/SpecifRevision" } }, "additionalProperties": false, "required": ["id"] }, "SpecifKeys": { "description": "A list of keys referencing items such as propertyClasses, resourceClasses or statementClasses; any list must have >0 entries including those of any parent element.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifKey" } }, "SpecifRights": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": ["title", "url"] }, "SpecifOrg": { "type": "object", "properties": { "organizationName": { "type": "string" } }, "required": ["organizationName"] }, "SpecifCreatedBy": { "description": "The creator of the SpecIF data-set (file). If specified, at least an e-mail address must be given.", "type": "object", "properties": { "familyName": { "type": "string" }, "givenName": { "type": "string" }, "org": { "$ref": "#/definitions/SpecifOrg" }, "email": { "type": "string", "format": "email" } }, "required": ["email"] }, "SpecifText": { "description": "A good class name indicates it's role. The use of a vocabulary-term is recommended, which in turn can be translated to any natural or domain language.", "type": "string" }, "SpecifTextFormat": { "type": "string", "enum": ["plain", "xhtml"] }, "SpecifMultiLanguageText": { "description": "A list of items with text and language properties. If the information is be provided in multiple languages, the language must be specified for proper selection; it is however not required by the schema to avoid a lot of overhead in most cases with a single language.", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "text": { "description": "A string containing some text.", "type": "string" }, "format": { "description": "By default, the format is assumed 'plain'.", "$ref": "#/definitions/SpecifTextFormat" }, "language": { "description": "An IETF language tag such as 'en', 'en-US, 'fr' or 'de'.", "type": "string" } }, "additionalProperties": false, "required": ["text"] } }, "SpecifValue": { "oneOf": [ { "description": "For properties with a dataType other than 'xs:string'.", "type": "string" }, { "description": "For properties with dataType 'xs:string'.", "$ref": "#/definitions/SpecifMultiLanguageText" } ] }, "SpecifValues": { "description": "If 'multiple' of the propertyClass is undefined or false, the array must contain one item. If the value is unknown, omit the whole property. By default, the class' value applies.", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifValue" } }, "SpecifEnumeratedValue": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "value": { "$ref": "#/definitions/SpecifValue" } }, "required": ["id", "value"] }, "SpecifEnumeratedValues": { "type": "array", "title": "Enumerated Values", "description": "Enumerated values for the given dataType. If 'multiple' is true 0..n options may be selected, otherwise exactly one must be selected.", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifEnumeratedValue" } }, "SpecifDateTime": { "description": "An ISO-8601 dateTime string. For reduced accuracy, any number of values may be dropped, but only from right to left.", "type": "string", "format": "date-time" }, "SpecifIcon": { "description": "A symbol for display as a prefix to titles; applicable to all instances of the class. Is usually a XML-encoded UTF-8 symbol, can be an URL or dataURL.", "type": "string" }, "SpecifInstantiation": { "description": "Indicates whether an instance of the class is created automatically, manually or both. All is allowed, if the property is omitted. The class is abstract and cannot be instantiated, if the property list is present, but empty.", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": ["auto", "user"] } }, "SpecifDataType": { "oneOf": [ { "type": "object", "properties": { "type": { "description": "The corresponding definition in https://www.w3.org/TR/xmlschema-2/ applies.", "type": "string", "title": "Data-type 'Boolean'", "enum": ["xs:boolean"] }, "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "type", "changedAt"] }, { "type": "object", "properties": { "type": { "description": "The corresponding definition in https://www.w3.org/TR/xmlschema-2/ applies.", "type": "string", "title": "Data-type 'dateTime', 'duration' or 'URI'", "enum": ["xs:dateTime", "xs:duration", "xs:anyURI"] }, "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "enumeration": { "description": "An optional list of values to choose from for a specific instance; multiple values are allowed, if 'multiple' is set to 'true'.", "$ref": "#/definitions/SpecifEnumeratedValues" }, "multiple": { "description": "Indicates whether multiple values are allowed; by default the value is 'false'.", "type": "boolean" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "type", "changedAt"] }, { "type": "object", "properties": { "type": { "description": "The corresponding definition in https://www.w3.org/TR/xmlschema-2/ applies.", "type": "string", "title": "Data-type 'Integer'", "enum": ["xs:integer"] }, "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "minInclusive": { "type": "number", "title": "Minimum Value of a Number", "description": "Optional use by dataTypes 'xs:integer' and 'xs:double'." }, "maxInclusive": { "type": "number", "title": "Maximum Value of a Number", "description": "Optional use by dataTypes 'xs:integer' and 'xs:double'." }, "enumeration": { "description": "An optional list of values to choose from for a specific instance; multiple values are allowed, if 'multiple' is set to 'true'.", "$ref": "#/definitions/SpecifEnumeratedValues" }, "multiple": { "description": "Indicates whether multiple values are allowed; by default the value is 'false'.", "type": "boolean" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "type", "changedAt"] }, { "type": "object", "properties": { "type": { "description": "The corresponding definition in https://www.w3.org/TR/xmlschema-2/ applies.", "type": "string", "title": "Data-type 'Double'", "enum": ["xs:double"] }, "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "fractionDigits": { "description": "Optional use by dataType 'xs:double', indicates the number of decimals.", "type": "integer", "title": "Number of fraction digits of a Decimal Number", "minimum": 1 }, "minInclusive": { "description": "Optional use by dataTypes 'xs:integer' and 'xs:double'.", "type": "number", "title": "Minimum Value of a Number" }, "maxInclusive": { "description": "Optional use by dataTypes 'xs:integer' and 'xs:double'.", "type": "number", "title": "Maximum Value of a Number" }, "enumeration": { "description": "An optional list of values to choose from for a specific instance; multiple values are allowed, if 'multiple' is set to 'true'.", "$ref": "#/definitions/SpecifEnumeratedValues" }, "multiple": { "description": "Indicates whether multiple values are allowed; by default the value is 'false'.", "type": "boolean" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "type", "changedAt"] }, { "type": "object", "properties": { "type": { "description": "The corresponding definition in https://www.w3.org/TR/xmlschema-2/ applies.", "type": "string", "title": "Data-type 'String' with plain or formatted text. The property's text object MAY specify the format and language.", "enum": ["xs:string"] }, "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "maxLength": { "description": "Optional use by dataType 'xs:string'.", "type": "integer", "title": "Maximum String Length", "minimum": 0 }, "enumeration": { "description": "An optional list of values to choose from for a specific instance; multiple values are allowed, if 'multiple' is set to 'true'.", "$ref": "#/definitions/SpecifEnumeratedValues" }, "multiple": { "description": "Indicates whether multiple values are allowed; by default the value is 'false'.", "type": "boolean" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "type", "changedAt"] } ] }, "SpecifPropertyClass": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "dataType": { "description": "Must be a member of dataTypes.", "$ref": "#/definitions/SpecifKey" }, "multiple": { "description": "Optional use by all propertyClasses. Indicates whether multiple values can be given. If omitted, the 'multiple' property of the dataType applies; by default the value is 'false'.", "type": "boolean" }, "values": { "description": "An optional list of default values in case the instantiated resource's or statement's property is missing.", "$ref": "#/definitions/SpecifValues" }, "format": { "description": "The default format of a property's text value. Is superseded by a text value's format attribute.", "$ref": "#/definitions/SpecifTextFormat" }, "unit": { "description": "The unit of a property's numeric value; preferrably an SI unit symbol such as 'm^3/kg' (Système international (d'unités)) or a currency symbol.", "type": "string" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "dataType", "changedAt"] }, "SpecifResourceClass": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "extends": { "description": "Must be a member of resourceClasses.", "$ref": "#/definitions/SpecifKey" }, "icon": { "$ref": "#/definitions/SpecifIcon" }, "isHeading": { "type": "boolean" }, "instantiation": { "$ref": "#/definitions/SpecifInstantiation" }, "propertyClasses": { "description": "A list of keys referencing propertyClasses; a base resourceClass must have at least one propertyClass, whereas an extending class may have none.", "$ref": "#/definitions/SpecifKeys" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "propertyClasses", "changedAt"] }, "SpecifStatementClass": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "title": { "$ref": "#/definitions/SpecifText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "extends": { "description": "Must be a member of statementClasses.", "$ref": "#/definitions/SpecifKey" }, "icon": { "$ref": "#/definitions/SpecifIcon" }, "instantiation": { "$ref": "#/definitions/SpecifInstantiation" }, "isUndirected": { "description": "Indicates that an instance's subject and object are equivalent and can be exchanged without change in meaning.", "type": "boolean" }, "propertyClasses": { "description": "A list of keys referencing propertyClasses; a statementClass may exist without propertyClasses.", "$ref": "#/definitions/SpecifKeys" }, "subjectClasses": { "description": "A list of keys referencing eligible resource and statement classes for a statement's subject; if missing, all resource or statement classes are eligible.", "$ref": "#/definitions/SpecifKeys" }, "objectClasses": { "description": "A list of keys referencing eligible resource and statement classes for a statement's object; if missing, all resource or statement classes are eligible.", "$ref": "#/definitions/SpecifKeys" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "additionalProperties": false, "required": ["id", "title", "changedAt"] }, "SpecifProperty": { "type": "object", "properties": { "class": { "description": "Must be a member of 'propertyClasses'. In addition, it must be listed in the propertyClasses of the respective resource's or statement's (or any of it's parent's) class.", "$ref": "#/definitions/SpecifKey" }, "values": { "$ref": "#/definitions/SpecifValues" } }, "required": ["class", "values"] }, "SpecifProperties": { "description": "A list of properties of a resource or statement; the number of properties including any parent's properties must be >0.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifProperty" } }, "SpecifResource": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "alternativeIds": { "$ref": "#/definitions/SpecifAlternativeIds" }, "class": { "$ref": "#/definitions/SpecifKey", "description": "Must be a member of resourceClasses." }, "language": { "description": "An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the resource. Is superseded by a property's language value.", "type": "string" }, "properties": { "$ref": "#/definitions/SpecifProperties" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "required": ["id", "class", "properties", "changedAt"] }, "SpecifStatement": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "alternativeIds": { "$ref": "#/definitions/SpecifAlternativeIds" }, "class": { "$ref": "#/definitions/SpecifKey", "description": "Must be a member of statementClasses." }, "language": { "description": "An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the statement. Is superseded by a property's language value.", "type": "string" }, "subject": { "description": "Must be a member of resources or statements.", "$ref": "#/definitions/SpecifKey" }, "object": { "description": "Must be a member of resources or statements.", "$ref": "#/definitions/SpecifKey" }, "properties": { "description": "If there is no title property, the statementClass' title applies.", "$ref": "#/definitions/SpecifProperties" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "required": ["id", "class", "subject", "object", "changedAt"] }, "SpecifNode": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "title": { "description": "The node's label; if missing, the value of the referenced resource's title property is applied.", "$ref": "#/definitions/SpecifMultiLanguageText" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "resource": { "description": "The pointer to the resource to be displayed at this position.", "$ref": "#/definitions/SpecifKey" }, "nodes": { "description": "The next hierarchy level.", "$ref": "#/definitions/SpecifNodes" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "required": ["id", "resource", "changedAt"] }, "SpecifNodes": { "description": "A list of pointers to resources; may be nested forming a tree, i.e. a hierarchy of pointers.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifNode" } }, "SpecifFile": { "type": "object", "properties": { "id": { "$ref": "#/definitions/SpecifId" }, "title": { "description": "The file's name.", "type": "string" }, "description": { "$ref": "#/definitions/SpecifMultiLanguageText" }, "url": { "description": "An absolute or relative URL to the file; will be of format 'uri-reference' in future. If missing, the title applies.", "type": "string" }, "type": { "description": "The file's media type (formerly MIME-type) according to https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "replaces": { "$ref": "#/definitions/SpecifReplaces" }, "changedAt": { "$ref": "#/definitions/SpecifDateTime" }, "changedBy": { "type": "string" } }, "required": ["id", "title", "type", "changedAt"] } }, "description": "The Specification Integration Facility (SpecIF) integrates partial system models from different methods and tools in a semantic net. Collaborators shall browse, search and audit engineering results in a common context. Also, the exchange of model information between organizations and tools is facilitated. SpecIF represents the visible, i.e. the diagrams and the text, as well as the semantics of system specifications.", "properties": { "$schema": { "description": "An absolute URL pointing to this SpecIF schema. Supports both specif.de and schemastore.org.", "type": "string", "format": "uri", "pattern": "^https?:\\/\\/(specif\\.de\\/v1\\.1\\/schema|json\\.schemastore\\.org\\/specif-1\\.1)\\.json$" }, "id": { "$ref": "#/definitions/SpecifId" }, "revision": { "$ref": "#/definitions/SpecifRevision" }, "title": { "description": "The project's name; if missing, the first hierarchy node's title applies.", "$ref": "#/definitions/SpecifMultiLanguageText" }, "description": { "description": "The project's description; if missing, the first hierarchy node's description applies.", "$ref": "#/definitions/SpecifMultiLanguageText" }, "isExtension": { "description": "Indicates that the project is not schema-compliant on its own; by default the value is 'false'. Of course, it is expected that once extended the project is schema-compliant.", "type": "boolean" }, "generator": { "type": "string" }, "generatorVersion": { "type": "string" }, "rights": { "$ref": "#/definitions/SpecifRights" }, "createdAt": { "$ref": "#/definitions/SpecifDateTime" }, "createdBy": { "$ref": "#/definitions/SpecifCreatedBy" }, "language": { "description": "An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the project. Is superseded by a resource's, statement's or property's language value. By default, 'en' is assumed.", "type": "string" }, "dataTypes": { "description": "The base data types for use by property class definitions.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifDataType" } }, "propertyClasses": { "description": "Class definition of a property for resources or statements. Is a sub-element of the respective resourceClass or statementClass. If no revision or change information is specified, the respective values of the parent element apply.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifPropertyClass" } }, "resourceClasses": { "description": "The class definitions for resources.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifResourceClass" } }, "statementClasses": { "description": "The class definitions for statements in subject-predicate-object statements, where subject and object are resources.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifStatementClass" } }, "resources": { "description": "The resources such as diagrams, model elements or requirements.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifResource" } }, "statements": { "description": "Subject-predicate-Object statements, where subject and object are resources. In other terms, statements are directed relations between two resources building a semantic net.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifStatement" } }, "hierarchies": { "description": "A list of hierarchies with pointers to resources; may be nested to build a tree, i.e. a hierarchy of pointers.", "$ref": "#/definitions/SpecifNodes" }, "files": { "description": "A list of files being referenced by a resource's or statement's property of dataType XHTML using an <object> tag. A file should have a media type as defined by IANA (see below).", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/SpecifFile" } } }, "required": [ "$schema", "id", "dataTypes", "propertyClasses", "resourceClasses", "statementClasses", "resources", "statements", "hierarchies" ], "title": "JSON-Schema for SpecIF v1.1", "type": "object" }

tson.json

{ "$id": "https://raw.githubusercontent.com/spectral-discord/TSON/main/schema/tson.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "TSON Schema", "type": "object", "properties": { "tunings": { "type": "array", "description": "List of tuning objects", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The tuning's name" }, "description": { "type": "string", "description": "A description of the tuning" }, "id": { "type": "string", "description": "A unique identifier for the tuning" }, "scales": { "type": "array", "description": "List of scale objects", "minItems": 1, "items": { "type": "object", "properties": { "notes": { "type": "array", "description": "A list of the scale's notes", "minItems": 1, "uniqueItems": true, "items": { "oneOf": [ { "type": "object", "properties": { "frequency ratio": { "description": "The note's frequency ratio", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "ratio": { "description": "The note's frequency ratio", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "name": { "type": "string", "description": "The note's name" } }, "additionalProperties": true }, { "description": "The note's frequency ratio", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] } ] } }, "reference": { "type": "object", "description": "A reference frequency that is used to map the note's frequency ratios to real frequencies values (ie., in Hz).\nCan be either a number (optionally appended with \" Hz\") or an object containing a frequency and an optional note that references one of the note names from the scale's notes list.\nIf no note name is provided, the reference frequency will be mapped to the frequency ratio \"1\".", "properties": { "frequency": { "description": "The reference frequency - a number, optionally with \" Hz\" appended", "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$" } ] }, "note": { "type": "string", "description": "The name of the note that should be mapped onto the reference frequency" } }, "required": [ "frequency" ], "additionalProperties": true }, "repeat ratio": { "description": "The frequency ratio at which the scale's notes will repeat", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "repeat": { "description": "The frequency ratio at which the scale's notes will repeat", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "max frequency": { "description": "A maximum frequency for the scale.\nWhen mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped above the provided frequency.", "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$" } ] }, "max": { "description": "A maximum frequency for the scale.\nWhen mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped above the provided frequency.", "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$" } ] }, "maximum": { "description": "A maximum frequency for the scale.\nWhen mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped above the provided frequency.", "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$" } ] }, "min frequency": { "description": "A minimum frequency for the scale.\nWhen mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped below the provided frequency.", "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$" } ] }, "minimum": { "description": "A minimum frequency for the scale.\nWhen mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped below the provided frequency.", "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$" } ] }, "min": { "description": "A minimum frequency for the scale.\nWhen mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped below the provided frequency.", "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$" } ] }, "spectrum": { "type": "string", "description": "The spectrum of the tones that should be used for this tuning.\nThis enables multiple, scale-dependent spectra to be used within a single tuning." } }, "required": [ "notes", "reference" ], "additionalProperties": true, "allOf": [ { "not": { "required": [ "repeat", "repeat ratio" ] } }, { "oneOf": [ { "required": [ "min" ] }, { "required": [ "minimum" ] }, { "required": [ "min frequency" ] }, { "not": { "oneOf": [ { "required": [ "min" ] }, { "required": [ "minimum" ] }, { "required": [ "min frequency" ] }, { "required": [ "min", "minimum" ] }, { "required": [ "min", "min frequency" ] }, { "required": [ "minimum", "min frequency" ] } ] } } ] }, { "oneOf": [ { "required": [ "max" ] }, { "required": [ "maximum" ] }, { "required": [ "max frequency" ] }, { "not": { "oneOf": [ { "required": [ "max" ] }, { "required": [ "maximum" ] }, { "required": [ "max frequency" ] }, { "required": [ "max", "maximum" ] }, { "required": [ "max", "max frequency" ] }, { "required": [ "maximum", "max frequency" ] } ] } } ] } ] } } }, "required": [ "id", "scales" ], "additionalProperties": true } }, "spectra": { "type": "array", "description": "A list of spectrum objects", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The spectrum's name" }, "description": { "type": "string", "description": "A description of the spectrum" }, "id": { "type": "string", "description": "A unique identifier for the spectrum" }, "partial distribution": { "type": "array", "description": "A list of partials that should be used to reconstruct the spectrum", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "frequency ratio": { "description": "The partial's frequency ratio", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "ratio": { "description": "The partial's frequency ratio", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "amplitude weight": { "description": "The partial's amplitude weight.\nThis determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "weight": { "description": "The partial's amplitude weight.\nThis determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] } }, "additionalProperties": true, "allOf": [ { "if": { "propertyNames": { "enum": [ "frequency ratio", "ratio" ] }, "minProperties": 2 }, "then": false, "else": { "oneOf": [ { "required": [ "frequency ratio" ] }, { "required": [ "ratio" ] } ] } }, { "if": { "propertyNames": { "enum": [ "amplitude weight", "weight" ] }, "minProperties": 2 }, "then": false, "else": { "oneOf": [ { "required": [ "amplitude weight" ] }, { "required": [ "weight" ] } ] } } ] } }, "partials": { "type": "array", "description": "A list of partials that should be used to reconstruct the spectrum", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "frequency ratio": { "description": "The partial's frequency ratio", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "ratio": { "description": "The partial's frequency ratio", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "amplitude weight": { "description": "The partial's amplitude weight.\nThis determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] }, "weight": { "description": "The partial's amplitude weight.\nThis determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.", "oneOf": [ { "type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$" }, { "type": "number" } ] } }, "additionalProperties": true, "allOf": [ { "if": { "propertyNames": { "enum": [ "frequency ratio", "ratio" ] }, "minProperties": 2 }, "then": false, "else": { "oneOf": [ { "required": [ "frequency ratio" ] }, { "required": [ "ratio" ] } ] } }, { "if": { "propertyNames": { "enum": [ "amplitude weight", "weight" ] }, "minProperties": 2 }, "then": false, "else": { "oneOf": [ { "required": [ "amplitude weight" ] }, { "required": [ "weight" ] } ] } } ] } } }, "required": [ "id" ], "additionalProperties": true, "if": { "propertyNames": { "enum": [ "partials", "partial distribution" ] }, "minProperties": 2 }, "then": false, "else": { "oneOf": [ { "required": [ "partials" ] }, { "required": [ "partial distribution" ] } ] } } }, "sets": { "type": "array", "description": "A list of set objects", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the set" }, "name": { "type": "string", "description": "The set's name" }, "description": { "type": "string", "description": "A description of the set" }, "members": { "type": "array", "description": "A list of set member objects", "minItems": 1, "items": { "type": "object", "properties": { "tuning": { "type": "string", "description": "A reference of a tuning's ID" }, "spectrum": { "type": "string", "description": "A reference of a spectrum's ID" }, "override scale spectra": { "type": "boolean", "description": "If true, the set's spectrum should be applied to all scales in the set's tuning, overriding any spectra that are references by the scales." } }, "additionalProperties": true } } }, "required": [ "id", "members" ], "additionalProperties": true } } }, "additionalProperties": true, "anyOf": [ { "required": [ "tunings" ] }, { "required": [ "spectra" ] }, { "required": [ "sets" ] } ] }

config_schema.json

{ "$schema": "http://json-schema.org/draft-06/schema#", "additionalProperties": false, "definitions": { "GeneralConfig": { "additionalProperties": false, "description": "General configuration settings.", "properties": { "artifact_regions": { "description": "List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources", "items": { "description": "AWS Region name", "examples": [ "us-east-1" ], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string" }, "type": "array" }, "auth": { "additionalProperties": { "type": "string" }, "description": "AWS authentication section", "examples": [ { "cn-northwest-1": "china-profile", "default": "my-default-profile", "us-east-2": "specific-profile-for-us-east-2" } ], "type": "object" }, "parameters": { "additionalProperties": { "anyOf": [ { "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, { "type": "boolean" }, { "type": "integer" }, { "type": "string" } ] }, "description": "Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence", "type": "object" }, "posthooks": { "description": "hooks to execute after executing tests", "items": { "$ref": "#/definitions/HookData" }, "type": "array" }, "prehooks": { "description": "hooks to execute prior to executing tests", "items": { "$ref": "#/definitions/HookData" }, "type": "array" }, "regions": { "description": "List of AWS regions", "items": { "description": "AWS Region name", "examples": [ "us-east-1" ], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string" }, "type": "array" }, "s3_bucket": { "description": "Name of S3 bucket to upload project to, if left out a bucket will be auto-generated", "examples": [ "my-s3-bucket-name" ], "type": "string" }, "s3_regional_buckets": { "description": "Enable regional auto-buckets.", "examples": [ true, false ], "type": "boolean" }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags to apply to CloudFormation template", "examples": [ { "CostCenter": "1001" } ], "type": "object" } }, "type": "object" }, "HookData": { "additionalProperties": false, "description": "Hook definition", "properties": { "config": { "description": "hook configuration", "type": "object" }, "type": { "description": "hook type", "type": "string" } }, "type": "object" }, "ProjectConfig": { "additionalProperties": false, "description": "Project specific configuration section", "properties": { "artifact_regions": { "description": "List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources", "items": { "description": "AWS Region name", "examples": [ "us-east-1" ], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string" }, "type": "array" }, "auth": { "additionalProperties": { "type": "string" }, "description": "AWS authentication section", "examples": [ { "cn-northwest-1": "china-profile", "default": "my-default-profile", "us-east-2": "specific-profile-for-us-east-2" } ], "type": "object" }, "az_blacklist": { "description": "List of Availablilty Zones ID's to exclude when generating availability zones", "items": { "description": "Availability Zone ID, eg.: 'use1-az1'", "examples": [ "usw2-laz1-az1", "use2-az2" ], "pattern": "(afs1-az1|afs1-az2|afs1-az3|afs1-los1-az1|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne1-tpe1-az1|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|aps1-ccu1-az1|aps1-del1-az1|aps2-az1|aps2-az2|aps2-az3|apse1-az1|apse1-az2|apse1-az3|apse1-bkk1-az1|apse2-az1|apse2-az2|apse2-az3|apse2-per1-az1|apse3-az1|apse3-az2|apse3-az3|apse4-az1|apse4-az2|apse4-az3|cac1-az1|cac1-az2|cac1-az4|euc1-az1|euc1-az2|euc1-az3|euc1-ham1-az1|euc1-waw1-az1|euc2-az1|euc2-az2|euc2-az3|eun1-az1|eun1-az2|eun1-az3|eun1-cph1-az1|eun1-hel1-az1|eus1-az1|eus1-az2|eus1-az3|eus2-az1|eus2-az2|eus2-az3|euw1-az1|euw1-az2|euw1-az3|euw2-az1|euw2-az2|euw2-az3|euw3-az1|euw3-az2|euw3-az3|mec1-az1|mec1-az2|mec1-az3|mes1-az1|mes1-az2|mes1-az3|mes1-mct1-az1|sae1-az1|sae1-az2|sae1-az3|use1-atl1-az1|use1-az1|use1-az2|use1-az3|use1-az4|use1-az5|use1-az6|use1-bos1-az1|use1-bue1-az1|use1-chi1-az1|use1-dfw1-az1|use1-iah1-az1|use1-lim1-az1|use1-mci1-az1|use1-mia1-az1|use1-msp1-az1|use1-nyc1-az1|use1-phl1-az1|use1-qro1-az1|use1-scl1-az1|use2-az1|use2-az2|use2-az3|usw1-az1|usw1-az3|usw2-az1|usw2-az2|usw2-az3|usw2-az4|usw2-den1-az1|usw2-las1-az1|usw2-lax1-az1|usw2-lax1-az2|usw2-pdx1-az1|usw2-phx1-az1|usw2-sea1-az1)", "type": "string" }, "type": "array" }, "build_submodules": { "description": "Build Lambda zips recursively for submodules, set to false to disable", "examples": [ true, false ], "type": "boolean" }, "lambda_source_path": { "description": "Path relative to the project root containing Lambda zip files, default is 'lambda_functions/source'", "examples": [ "functions/source" ], "type": "string" }, "lambda_zip_path": { "description": "Path relative to the project root to place Lambda zip files", "examples": [ "functions/packages" ], "type": "string" }, "name": { "description": "Project name, used as s3 key prefix when uploading objects", "examples": [ "my-project-name" ], "pattern": "^[a-z0-9-/]*$", "type": "string" }, "org_id": { "description": "Organization ID to use when launching CFN Stacks. starts with o-. It is found on Organization Settings page", "type": "string" }, "owner": { "description": "email address for project owner (not used at present)", "examples": [ "[email protected]" ], "type": "string" }, "package_lambda": { "description": "Package Lambda functions into zips before uploading to s3, set to false to disable", "examples": [ true, false ], "type": "boolean" }, "parameters": { "additionalProperties": { "anyOf": [ { "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, { "type": "boolean" }, { "type": "integer" }, { "type": "string" } ] }, "description": "Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence", "type": "object" }, "posthooks": { "description": "hooks to execute after executing tests", "items": { "$ref": "#/definitions/HookData" }, "type": "array" }, "prehooks": { "description": "hooks to execute prior to executing tests", "items": { "$ref": "#/definitions/HookData" }, "type": "array" }, "regions": { "description": "List of AWS regions", "items": { "description": "AWS Region name", "examples": [ "us-east-1" ], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string" }, "type": "array" }, "role_name": { "description": "Role name to use when launching CFN Stacks.", "type": "string" }, "s3_bucket": { "description": "Name of S3 bucket to upload project to, if left out a bucket will be auto-generated", "examples": [ "my-s3-bucket-name" ], "pattern": "^[a-z0-9-]*$", "type": "string" }, "s3_enable_sig_v2": { "description": "Enable (deprecated) sigv2 access to auto-generated buckets", "examples": [ true, false ], "type": "boolean" }, "s3_object_acl": { "default": "private", "description": "ACL for uploaded s3 objects", "examples": [ "bucket-owner-read", "private" ], "pattern": "^(bucket-owner-full-control|bucket-owner-read|authenticated-read|aws-exec-read|public-read-write|public-read|private)$", "type": "string" }, "s3_regional_buckets": { "description": "Enable regional auto-buckets.", "examples": [ true, false ], "type": "boolean" }, "shorten_stack_name": { "description": "Shorten stack names generated for tests, set to true to enable", "examples": [ true, false ], "type": "boolean" }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags to apply to CloudFormation template", "examples": [ { "CostCenter": "1001" } ], "type": "object" }, "template": { "description": "path to template file relative to the project config file path", "examples": [ "cloudformation_templates/" ], "type": "string" } }, "type": "object" }, "TestConfig": { "additionalProperties": false, "description": "Test specific configuration section.", "properties": { "artifact_regions": { "description": "List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources", "items": { "description": "AWS Region name", "examples": [ "us-east-1" ], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string" }, "type": "array" }, "auth": { "additionalProperties": { "type": "string" }, "description": "AWS authentication section", "examples": [ { "cn-northwest-1": "china-profile", "default": "my-default-profile", "us-east-2": "specific-profile-for-us-east-2" } ], "type": "object" }, "az_blacklist": { "description": "List of Availablilty Zones ID's to exclude when generating availability zones", "items": { "description": "Availability Zone ID, eg.: 'use1-az1'", "examples": [ "usw2-laz1-az1", "use2-az2" ], "pattern": "(afs1-az1|afs1-az2|afs1-az3|afs1-los1-az1|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne1-tpe1-az1|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|aps1-ccu1-az1|aps1-del1-az1|aps2-az1|aps2-az2|aps2-az3|apse1-az1|apse1-az2|apse1-az3|apse1-bkk1-az1|apse2-az1|apse2-az2|apse2-az3|apse2-per1-az1|apse3-az1|apse3-az2|apse3-az3|apse4-az1|apse4-az2|apse4-az3|cac1-az1|cac1-az2|cac1-az4|euc1-az1|euc1-az2|euc1-az3|euc1-ham1-az1|euc1-waw1-az1|euc2-az1|euc2-az2|euc2-az3|eun1-az1|eun1-az2|eun1-az3|eun1-cph1-az1|eun1-hel1-az1|eus1-az1|eus1-az2|eus1-az3|eus2-az1|eus2-az2|eus2-az3|euw1-az1|euw1-az2|euw1-az3|euw2-az1|euw2-az2|euw2-az3|euw3-az1|euw3-az2|euw3-az3|mec1-az1|mec1-az2|mec1-az3|mes1-az1|mes1-az2|mes1-az3|mes1-mct1-az1|sae1-az1|sae1-az2|sae1-az3|use1-atl1-az1|use1-az1|use1-az2|use1-az3|use1-az4|use1-az5|use1-az6|use1-bos1-az1|use1-bue1-az1|use1-chi1-az1|use1-dfw1-az1|use1-iah1-az1|use1-lim1-az1|use1-mci1-az1|use1-mia1-az1|use1-msp1-az1|use1-nyc1-az1|use1-phl1-az1|use1-qro1-az1|use1-scl1-az1|use2-az1|use2-az2|use2-az3|usw1-az1|usw1-az3|usw2-az1|usw2-az2|usw2-az3|usw2-az4|usw2-den1-az1|usw2-las1-az1|usw2-lax1-az1|usw2-lax1-az2|usw2-pdx1-az1|usw2-phx1-az1|usw2-sea1-az1)", "type": "string" }, "type": "array" }, "parameters": { "additionalProperties": { "anyOf": [ { "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, { "type": "boolean" }, { "type": "integer" }, { "type": "string" } ] }, "default": {}, "description": "Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence", "type": "object" }, "posthooks": { "description": "hooks to execute after executing tests", "items": { "$ref": "#/definitions/HookData" }, "type": "array" }, "prehooks": { "description": "hooks to execute prior to executing tests", "items": { "$ref": "#/definitions/HookData" }, "type": "array" }, "regions": { "description": "List of AWS regions", "items": { "description": "AWS Region name", "examples": [ "us-east-1" ], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string" }, "type": "array" }, "role_name": { "description": "Role name to use when launching CFN Stacks.", "type": "string" }, "s3_bucket": { "description": "Name of S3 bucket to upload project to, if left out a bucket will be auto-generated", "examples": [ "my-s3-bucket-name" ], "pattern": "^[a-z0-9-]*$", "type": "string" }, "s3_regional_buckets": { "description": "Enable regional auto-buckets.", "examples": [ true, false ], "type": "boolean" }, "stack_name": { "description": "Cloudformation Stack Name", "type": "string" }, "stack_name_prefix": { "description": "Prefix to apply to generated CFN Stack Name", "type": "string" }, "stack_name_suffix": { "description": "Suffix to apply to generated CFN Stack Name", "type": "string" }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags to apply to CloudFormation template", "examples": [ { "CostCenter": "1001" } ], "type": "object" }, "template": { "description": "path to template file relative to the project config file path", "examples": [ "cloudformation_templates/" ], "type": "string" } }, "type": "object" } }, "description": "Taskcat configuration file", "properties": { "general": { "$ref": "#/definitions/GeneralConfig", "default": { "artifact_regions": null, "auth": null, "parameters": null, "posthooks": null, "prehooks": null, "regions": null, "s3_bucket": null, "s3_regional_buckets": null, "tags": null } }, "project": { "$ref": "#/definitions/ProjectConfig", "default": { "artifact_regions": null, "auth": null, "az_blacklist": null, "build_submodules": null, "lambda_source_path": null, "lambda_zip_path": null, "name": null, "org_id": null, "owner": null, "package_lambda": null, "parameters": null, "posthooks": null, "prehooks": null, "regions": null, "role_name": null, "s3_bucket": null, "s3_enable_sig_v2": null, "s3_object_acl": null, "s3_regional_buckets": null, "shorten_stack_name": null, "tags": null, "template": null } }, "tests": { "additionalProperties": { "$ref": "#/definitions/TestConfig" }, "default": {}, "type": "object" } }, "type": "object" }

cryproj.53.schema.json

{ "$comment": "JSON Schema for CRYENGINE 5.3", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "cvars": { "$id": "/definitions/cvars", "type": "string", "title": "Variable name", "description": "CVar name", "default": "sys_target_platforms", "enum": [ "a_poseAlignerDebugDraw", "a_poseAlignerEnable", "a_poseAlignerForceLock", "a_poseAlignerForceNoIntersections", "a_poseAlignerForceNoRootOffset", "a_poseAlignerForceTargetSmoothing", "a_poseAlignerForceWeightOne", "ac_ColliderModeAI", "ac_ColliderModePlayer", "ac_debugAnimEffects", "ac_debugAnimTarget", "ac_debugColliderMode", "ac_debugEntityParams", "ac_DebugFilter", "ac_debugLocations", "ac_debugLocationsGraphs", "ac_debugMotionParams", "ac_debugMovementControlMethods", "ac_debugText", "ac_debugXXXValues", "ac_disableSlidingContactEvents", "ac_enableExtraSolidCollider", "ac_entityAnimClamp", "ac_forceSimpleMovement", "ac_frametime", "ac_movementControlMethodFilter", "ac_movementControlMethodHor", "ac_movementControlMethodVer", "ac_templateMCMs", "ac_useMovementPrediction", "ac_useQueuedRotation", "ag_debugExactPos", "ag_defaultAIStance", "ag_travelSpeedSmoothing", "ag_turnAngleSmoothing", "ag_turnSpeedParamScale", "ag_turnSpeedSmoothing", "ai_AdjustPathsAroundDynamicObstacles", "ai_AgentStatsDist", "ai_AllowedToHit", "ai_AllowedToHitPlayer", "ai_AllTime", "ai_AmbientFireEnable", "ai_AmbientFireQuota", "ai_AmbientFireUpdateInterval", "ai_AttemptStraightPath", "ai_BannedNavSoTime", "ai_BeautifyPath", "ai_BigBrushCheckLimitSize", "ai_BubblesSystem", "ai_BubblesSystemAlertnessFilter", "ai_BubblesSystemAllowPrototypeDialogBubbles", "ai_BubblesSystemDecayTime", "ai_BubblesSystemFontSize", "ai_BubblesSystemNameFilter", "ai_BubblesSystemUseDepthTest", "ai_BurstWhileMovingDestinationRange", "ai_CheckWalkabilityOptimalSectionLength", "ai_CodeCoverageMode", "ai_CollisionAvoidanceAgentExtraFat", "ai_CollisionAvoidanceAgentTimeHorizon", "ai_CollisionAvoidanceClampVelocitiesWithNavigationMesh", "ai_CollisionAvoidanceEnableRadiusIncrement", "ai_CollisionAvoidanceMinSpeed", "ai_CollisionAvoidanceObstacleTimeHorizon", "ai_CollisionAvoidancePathEndCutoffRange", "ai_CollisionAvoidanceRadiusIncrementDecreaseRate", "ai_CollisionAvoidanceRadiusIncrementIncreaseRate", "ai_CollisionAvoidanceRange", "ai_CollisionAvoidanceSmartObjectCutoffRange", "ai_CollisionAvoidanceTargetCutoffRange", "ai_CollisionAvoidanceTimestep", "ai_CollisionAvoidanceUpdateVelocities", "ai_CommunicationForceTestVoicePack", "ai_CommunicationManagerHeighThresholdForTargetPosition", "ai_CompatibilityMode", "ai_CoolMissesBoxHeight", "ai_CoolMissesBoxSize", "ai_CoolMissesCooldown", "ai_CoolMissesMaxLightweightEntityMass", "ai_CoolMissesMinMissDistance", "ai_CoolMissesProbability", "ai_CoverExactPositioning", "ai_CoverMaxEyeCount", "ai_CoverPredictTarget", "ai_CoverSpacing", "ai_CoverSystem", "ai_CrouchVisibleRange", "ai_CrowdControlInPathfind", "ai_DebugBehaviorSelection", "ai_DebugCheckWalkability", "ai_DebugCheckWalkabilityRadius", "ai_DebugCollisionAvoidanceForceSpeed", "ai_DebugDraw", "ai_DebugDrawAdaptiveUrgency", "ai_DebugDrawAmbientFire", "ai_DebugDrawArrowLabelsVisibilityDistance", "ai_DebugDrawAStarOpenList", "ai_DebugDrawAStarOpenListTime", "ai_DebugDrawBannedNavsos", "ai_DebugDrawCollisionAvoidance", "ai_DebugDrawCollisionAvoidanceAgentName", "ai_DebugDrawCommunication", "ai_DebugDrawCommunicationHistoryDepth", "ai_DebugDrawCoolMisses", "ai_DebugDrawCover", "ai_DebugDrawCoverLocations", "ai_DebugDrawCoverOccupancy", "ai_DebugDrawCoverPlanes", "ai_DebugDrawCoverSampler", "ai_DebugDrawCrowdControl", "ai_DebugDrawDamageControl", "ai_DebugDrawDamageParts", "ai_DebugDrawDynamicCoverSampler", "ai_DebugDrawDynamicHideObjectsRange", "ai_DebugDrawEnabledActors", "ai_DebugDrawEnabledPlayers", "ai_DebugDrawExpensiveAccessoryQuota", "ai_DebugDrawFireCommand", "ai_DebugDrawFlight2", "ai_DebugDrawGroups", "ai_DebugDrawHidespotRange", "ai_DebugDrawHideSpotSearchRays", "ai_DebugDrawLightLevel", "ai_DebugDrawNavigation", "ai_DebugDrawNavigationWorldMonitor", "ai_DebugDrawPhysicsAccess", "ai_DebugDrawPlayerActions", "ai_DebugDrawReinforcements", "ai_DebugDrawStanceSize", "ai_DebugDrawVegetationCollisionDist", "ai_DebugDrawVisionMap", "ai_DebugDrawVisionMapObservables", "ai_DebugDrawVisionMapObservers", "ai_DebugDrawVisionMapObserversFOV", "ai_DebugDrawVisionMapStats", "ai_DebugDrawVisionMapVisibilityChecks", "ai_DebugDrawVolumeVoxels", "ai_DebugGlobalPerceptionScale", "ai_DebugHideSpotName", "ai_DebugInterestSystem", "ai_DebugMovementSystem", "ai_DebugMovementSystemActorRequests", "ai_DebugPathfinding", "ai_DebugPerceptionManager", "ai_DebugRangeSignaling", "ai_DebugSignalTimers", "ai_DebugTacticalPoints", "ai_DebugTacticalPointsBlocked", "ai_DebugTargetSilhouette", "ai_DebugTargetTracksAgent", "ai_DebugTargetTracksConfig", "ai_DebugTargetTracksConfig_Filter", "ai_DebugTargetTracksTarget", "ai_DebugTimestamps", "ai_DebugWalkabilityCache", "ai_DrawAgentFOV", "ai_DrawAgentStats", "ai_DrawAgentStatsGroupFilter", "ai_DrawAreas", "ai_DrawAttentionTargetPositions", "ai_DrawBadAnchors", "ai_DrawBulletEvents", "ai_DrawCollisionEvents", "ai_DrawDistanceLUT", "ai_DrawExplosions", "ai_DrawFakeDamageInd", "ai_DrawFakeHitEffects", "ai_DrawFakeTracers", "ai_DrawFireEffectDecayRange", "ai_DrawFireEffectEnabled", "ai_DrawFireEffectMaxAngle", "ai_DrawFireEffectMinDistance", "ai_DrawFireEffectMinTargetFOV", "ai_DrawFireEffectTimeScale", "ai_DrawFormations", "ai_DrawGetEnclosingFailures", "ai_DrawGoals", "ai_DrawGrenadeEvents", "ai_DrawGroupTactic", "ai_DrawHidespots", "ai_DrawModifiers", "ai_DrawModularBehaviorTreeStatistics", "ai_DrawNode", "ai_DrawNodeLinkCutoff", "ai_DrawNodeLinkType", "ai_DrawOffset", "ai_DrawPath", "ai_DrawPathAdjustment", "ai_DrawPathFollower", "ai_DrawPerceptionDebugging", "ai_DrawPerceptionHandlerModifiers", "ai_DrawPerceptionIndicators", "ai_DrawPerceptionModifiers", "ai_DrawPlayerRanges", "ai_DrawProbableTarget", "ai_DrawRadar", "ai_DrawRadarDist", "ai_DrawReadibilities", "ai_DrawRefPoints", "ai_DrawSelectedTargets", "ai_DrawShooting", "ai_DrawSmartObjects", "ai_DrawSoundEvents", "ai_DrawStats", "ai_DrawTargets", "ai_DrawTrajectory", "ai_DrawType", "ai_DrawUpdate", "ai_DynamicHidespotsEnabled", "ai_DynamicVolumeUpdateTime", "ai_DynamicWaypointUpdateTime", "ai_EnableCoolMisses", "ai_EnableORCA", "ai_EnablePerceptionStanceVisibleRange", "ai_EnableWarningsErrors", "ai_EnableWaterOcclusion", "ai_ExtraForbiddenRadiusDuringBeautification", "ai_ExtraRadiusDuringBeautification", "ai_ExtraVehicleAvoidanceRadiusBig", "ai_ExtraVehicleAvoidanceRadiusSmall", "ai_FilterAgentName", "ai_FlowNodeAlertnessCheck", "ai_ForceAGAction", "ai_ForceAGSignal", "ai_ForceAllowStrafing", "ai_ForceLookAimTarget", "ai_ForcePosture", "ai_ForceSerializeAllObjects", "ai_ForceStance", "ai_IgnoreBulletRainStimulus", "ai_IgnorePlayer", "ai_IgnoreSoundStimulus", "ai_IgnoreVisibilityChecks", "ai_IgnoreVisualStimulus", "ai_IncludeNonColEntitiesInNavigation", "ai_InterestSystem", "ai_InterestSystemCastRays", "ai_IntersectionTesterQuota", "ai_IslandConnectionsSystemProfileMemory", "ai_LayerSwitchDynamicLinkBump", "ai_LayerSwitchDynamicLinkBumpDuration", "ai_LobThrowMinAllowedDistanceFromFriends", "ai_LobThrowPercentageOfDistanceToTargetUsedForInaccuracySimulation", "ai_LobThrowTimePredictionForFriendPositions", "ai_LobThrowUseRandomForInaccuracySimulation", "ai_Locate", "ai_LogConsoleVerbosity", "ai_LogFileVerbosity", "ai_LogModularBehaviorTreeExecutionStacks", "ai_LogSignals", "ai_MinActorDynamicObstacleAvoidanceRadius", "ai_MNMAllowDynamicRegenInEditor", "ai_MNMDebugAccessibility", "ai_MNMEditorBackgroundUpdate", "ai_MNMPathfinderConcurrentRequests", "ai_MNMPathFinderDebug", "ai_MNMPathfinderMT", "ai_MNMPathfinderPositionInTrianglePredictionType", "ai_MNMPathFinderQuota", "ai_MNMProfileMemory", "ai_MNMRaycastImplementation", "ai_ModularBehaviorTree", "ai_MovementSystemPathReplanningEnabled", "ai_NavGenThreadJobs", "ai_NavigationSystemMT", "ai_NetworkDebug", "ai_NoUpdate", "ai_ObstacleSizeThreshold", "ai_OutputPersonalLogToConsole", "ai_OverlayMessageDuration", "ai_PathfinderAvoidanceCostForGroupMates", "ai_PathfinderDangerCostForAttentionTarget", "ai_PathfinderDangerCostForExplosives", "ai_PathfinderExplosiveDangerMaxThreatDistance", "ai_PathfinderExplosiveDangerRadius", "ai_PathfinderGroupMatesAvoidanceRadius", "ai_PathfinderUpdateTime", "ai_PathfindTimeLimit", "ai_PathStringPullingIterations", "ai_PlayerAffectedByLight", "ai_PredictivePathFollowing", "ai_ProfileGoals", "ai_ProneVisibleRange", "ai_RadiusForAutoForbidden", "ai_RayCasterQuota", "ai_RecordCommunicationStats", "ai_Recorder", "ai_Recorder_Auto", "ai_Recorder_Buffer", "ai_RecordLog", "ai_RODAliveTime", "ai_RODAmbientFireInc", "ai_RODCombatRangeMod", "ai_RODCoverFireTimeMod", "ai_RODDirInc", "ai_RODFakeHitChance", "ai_RODKillRangeMod", "ai_RODKillZoneInc", "ai_RODLowHealthMercyTime", "ai_RODMoveInc", "ai_RODReactionDarkIllumInc", "ai_RODReactionDirInc", "ai_RODReactionDistInc", "ai_RODReactionLeanInc", "ai_RODReactionMediumIllumInc", "ai_RODReactionSuperDarkIllumInc", "ai_RODReactionTime", "ai_RODStanceInc", "ai_ShowBehaviorCalls", "ai_ShowNavAreas", "ai_SightRangeDarkIllumMod", "ai_SightRangeMediumIllumMod", "ai_SightRangeSuperDarkIllumMod", "ai_SimpleWayptPassability", "ai_SmartPathFollower_decelerationHuman", "ai_SmartPathFollower_decelerationVehicle", "ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathRunAndSprint", "ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathWalk", "ai_SmartPathFollower_useAdvancedPathShortcutting", "ai_SmartPathFollower_useAdvancedPathShortcutting_debug", "ai_SOMSpeedCombat", "ai_SOMSpeedRelaxed", "ai_SoundPerception", "ai_StatsDisplayMode", "ai_StatsTarget", "ai_SteepSlopeAcrossValue", "ai_SteepSlopeUpValue", "ai_SystemUpdate", "ai_TacticalPointsDebugDrawMode", "ai_TacticalPointsDebugFadeMode", "ai_TacticalPointsDebugScaling", "ai_TacticalPointsDebugTime", "ai_TacticalPointsWarnings", "ai_TacticalPointUpdateTime", "ai_TargetTracking", "ai_TargetTracks_GlobalTargetLimit", "ai_UpdateAllAlways", "ai_UpdateInterval", "ai_UpdateProxy", "ai_UseCalculationStopperCounter", "ai_UseSimplePathfindingHeuristic", "ai_UseSmartPathFollower", "ai_UseSmartPathFollower_AABB_based", "ai_UseSmartPathFollower_LookAheadDistance", "ai_VisionMapNumberOfPVSUpdatesPerFrame", "ai_VisionMapNumberOfVisibilityUpdatesPerFrame", "ai_WaterOcclusion", "ban_timeout", "br_breakmaxworldsize", "br_breakworldoffsetx", "br_breakworldoffsety", "c_shakeMult", "ca_AllowMultipleEffectsOfSameName", "ca_AnimWarningLevel", "ca_ApplyJointVelocitiesMode", "ca_AttachmentCullingRation", "ca_AttachmentCullingRationMP", "ca_AttachmentMergingMemoryBudget", "ca_AttachmentTextureMemoryBudget", "ca_CharEditModel", "ca_cloth_air_resistance", "ca_cloth_damping", "ca_cloth_friction", "ca_cloth_max_safe_step", "ca_cloth_max_timestep", "ca_cloth_stiffness", "ca_cloth_stiffness_norm", "ca_cloth_stiffness_tang", "ca_cloth_thickness", "ca_cloth_vars_reset", "ca_ClothBlending", "ca_ClothBypassSimulation", "ca_ClothMaxChars", "ca_DBAUnloadRemoveTime", "ca_DBAUnloadUnregisterTime", "ca_DeathBlendTime", "ca_DebugADIKTargets", "ca_DebugAnimationStreaming", "ca_DebugAnimMemTracking", "ca_DebugAnimUpdates", "ca_DebugAnimUsage", "ca_DebugAnimUsageOnFileAccess", "ca_DebugCommandBuffer", "ca_DebugCriticalErrors", "ca_DebugFacial", "ca_DebugFacialEyes", "ca_DebugModelCache", "ca_DebugSegmentation", "ca_DebugSkeletonEffects", "ca_DebugSWSkinning", "ca_DecalSizeMultiplier", "ca_disable_thread", "ca_DisableAnimationUnloading", "ca_DisableAuxPhysics", "ca_DrawAimIKVEGrid", "ca_DrawAimPoses", "ca_DrawAllSimulatedSockets", "ca_DrawAttachmentOBB", "ca_DrawAttachmentProjection", "ca_DrawAttachments", "ca_DrawAttachmentsMergedForShadows", "ca_DrawBaseMesh", "ca_DrawBBox", "ca_DrawBinormals", "ca_DrawCC", "ca_DrawCGA", "ca_DrawCHR", "ca_DrawCloth", "ca_DrawDecalsBBoxes", "ca_DrawEmptyAttachments", "ca_DrawLocator", "ca_DrawLookIK", "ca_DrawNormals", "ca_DrawPose", "ca_DrawPositionPost", "ca_DrawSkeleton", "ca_DrawTangents", "ca_DrawVEGInfo", "ca_DrawWireframe", "ca_DumpUsedAnims", "ca_eyes_procedural", "ca_FacialAnimationRadius", "ca_FilterJoints", "ca_ForceUpdateSkeletons", "ca_KeepModels", "ca_lipsync_debug", "ca_lipsync_phoneme_crossfade", "ca_lipsync_phoneme_offset", "ca_lipsync_phoneme_strength", "ca_lipsync_vertex_drag", "ca_LoadUncompressedChunks", "ca_LockFeetWithIK", "ca_MemoryDefragEnabled", "ca_MemoryDefragPoolSize", "ca_MemoryUsageLog", "ca_MinInPlaceCAFStreamSize", "ca_MotionBlurMovementThreshold", "ca_NoAnim", "ca_ParametricPoolSize", "ca_physicsProcessImpact", "ca_PrecacheAnimationSets", "ca_PreloadAllCAFs", "ca_ReloadAllCHRPARAMS", "ca_SampleQuatHemisphereFromCurrentPose", "ca_SaveAABB", "ca_SerializeSkeletonAnim", "ca_SnapToVGrid", "ca_StoreAnimNamesOnLoad", "ca_StreamCHR", "ca_StreamDBAInPlace", "ca_thread", "ca_thread0Affinity", "ca_thread1Affinity", "ca_UnloadAnimationCAF", "ca_UnloadAnimationDBA", "ca_useADIKTargets", "ca_UseAimIK", "ca_UseAssetDefinedLod", "ca_UseDecals", "ca_UseFacialAnimation", "ca_UseIMG_AIM", "ca_UseIMG_CAF", "ca_UseJointMasking", "ca_UseLookIK", "ca_UseMorph", "ca_UsePhysics", "ca_UseRecoil", "ca_UseScaling", "ca_vaBlendCullingDebug", "ca_vaBlendCullingThreshold", "ca_vaBlendEnable", "ca_vaBlendPostSkinning", "ca_vaEnable", "ca_Validate", "ca_vaProfile", "ca_vaScaleFactor", "ca_vaSkipVertexAnimationLOD", "ca_vaUpdateTangents", "capture_file_format", "capture_file_name", "capture_file_prefix", "capture_folder", "capture_frame_once", "capture_frames", "cl_AISystem", "cl_bandwidth", "cl_camera_noise", "cl_camera_noise_freq", "cl_comment", "cl_DefaultNearPlane", "cl_DisableHUDText", "cl_ETColorOverrideB", "cl_ETColorOverrideEnable", "cl_ETColorOverrideG", "cl_ETColorOverrideR", "cl_ETFontSizeMultiplier", "cl_ETHideAIDebug", "cl_ETHideAll", "cl_ETHideBehaviour", "cl_ETHideFlowgraph", "cl_ETHideReadability", "cl_ETHideScriptBind", "cl_ETLog", "cl_ETMaxDisplayDistance", "cl_nickname", "cl_packetRate", "cl_serveraddr", "cl_serverpassword", "cl_serverport", "cl_tokenid", "cl_useCurrentUserNameAsDefault", "cl_ViewApplyHmdOffset", "cl_ViewSystemDebug", "cl_voice_recording", "cl_voice_volume", "co_coopAnimDebug", "co_slideWhileStreaming", "co_usenewcoopanimsystem", "con_debug", "con_display_last_messages", "con_line_buffer_size", "con_restricted", "con_showonload", "connect_repeatedly_num_attempts", "connect_repeatedly_time_between_attempts", "cvDoVerboseWindowTitle", "d3d11_CBUpdateStats", "d3d11_debugBreakOnce", "d3d11_debugBreakOnMsgID", "d3d11_debugMuteMsgID", "d3d11_debugMuteSeverity", "d3d11_debugruntime", "d3d11_forcedFeatureLevel", "d3d11_preventDriverThreading", "demo_ai", "demo_file", "demo_finish_cmd", "demo_finish_memreplay_sizer", "demo_finish_memreplay_stop", "demo_fixed_timestep", "demo_game_state", "demo_max_frames", "demo_noinfo", "demo_num_orientations", "demo_num_runs", "demo_panoramic", "demo_profile", "demo_quit", "demo_restart_level", "demo_save_every_frame", "demo_savestats", "demo_screenshot_frame", "demo_scroll_pause", "demo_time_of_day", "demo_use_hmd_rotation", "demo_vtune", "dlc_directory", "doc_use_subfolder_for_crash_backup", "doc_validate_surface_types", "drs_dialogAudio", "drs_dialogBinaryFileFormat", "drs_dialogEntityRtpcName", "drs_dialogGlobalRtpcName", "drs_dialogsDefaultMaxQueueTime", "drs_dialogsDefaultPauseAfterLines", "drs_dialogsSamePriorityCancels", "drs_dialogSubtitles", "drs_fileFormat", "drs_loggingOptions", "ds_AutoReloadScripts", "ds_LevelNameOverride", "ds_LoadExcelScripts", "ds_LoadSoundsSync", "ds_LogLevel", "ds_PrecacheSounds", "ds_WarnOnMissingLoc", "e_3dEngineLogAlways", "e_3dEngineTempPoolSize", "e_AutoPrecacheCameraJumpDist", "e_AutoPrecacheCgf", "e_AutoPrecacheTerrainAndProcVeget", "e_AutoPrecacheTexturesAndShaders", "e_BBoxes", "e_Brushes", "e_BrushUseTerrainColor", "e_CacheNearestCubePicking", "e_CameraFreeze", "e_CameraGoto", "e_CameraRotationSpeed", "e_CGFMaxFileSize", "e_CharLodMin", "e_CheckOcclusion", "e_CheckOcclusionOutputQueueSize", "e_CheckOcclusionQueueSize", "e_CheckOctreeObjectsBoxSize", "e_Clouds", "e_CoverageBuffer", "e_CoverageBufferAABBExpand", "e_CoverageBufferBias", "e_CoverageBufferCullIndividualBrushesMaxNodeSize", "e_CoverageBufferDebug", "e_CoverageBufferDebugFreeze", "e_CoverageBufferDrawOccluders", "e_CoverageBufferEarlyOut", "e_CoverageBufferEarlyOutDelay", "e_CoverageBufferOccludersViewDistRatio", "e_CoverageBufferRastPolyLimit", "e_CoverageBufferReproj", "e_CoverageBufferShowOccluder", "e_CoverageBufferTerrain", "e_CoverageBufferTerrainExpand", "e_CoverCgfDebug", "e_CullVegActivation", "e_DebugDraw", "e_DebugDrawFilter", "e_DebugDrawListBBoxIndex", "e_DebugDrawListFilter", "e_DebugDrawListSize", "e_DebugDrawShowOnlyCompound", "e_DebugDrawShowOnlyLod", "e_DebugGeomPrep", "e_DebugLights", "e_Decals", "e_DecalsAllowGameDecals", "e_DecalsClip", "e_DecalsDeferredDynamic", "e_DecalsDeferredDynamicDepthScale", "e_DecalsDeferredDynamicMinSize", "e_DecalsDeferredStatic", "e_DecalsForceDeferred", "e_DecalsHitCache", "e_DecalsLifeTimeScale", "e_DecalsMaxTrisInObject", "e_DecalsMaxUpdatesPerFrame", "e_DecalsMaxValidFrames", "e_DecalsMerge", "e_DecalsNeighborMaxLifeTime", "e_DecalsOverlapping", "e_DecalsPlacementTestAreaSize", "e_DecalsPlacementTestMinDepth", "e_DecalsPreCreate", "e_DecalsRange", "e_DecalsScissor", "e_DefaultMaterial", "e_DeferredPhysicsEvents", "e_DeformableObjects", "e_DisplayMemoryUsageIcon", "e_DynamicDistanceShadows", "e_DynamicLights", "e_DynamicLightsConsistentSortOrder", "e_DynamicLightsForceDeferred", "e_DynamicLightsFrameIdVisTest", "e_DynamicLightsMaxCount", "e_DynamicLightsMaxEntityLights", "e_Entities", "e_EntitySuppressionLevel", "e_Fog", "e_FogVolumes", "e_FoliageBranchesDamping", "e_FoliageBranchesStiffness", "e_FoliageBranchesTimeout", "e_FoliageBrokenBranchesDamping", "e_FoliageStiffness", "e_FoliageWindActivationDist", "e_ForceDetailLevelForScreenRes", "e_GeomCacheBufferSize", "e_GeomCacheDebug", "e_GeomCacheDebugDrawMode", "e_GeomCacheDebugFilter", "e_GeomCacheDecodeAheadTime", "e_GeomCacheLerpBetweenFrames", "e_GeomCacheMaxBufferAheadTime", "e_GeomCacheMaxPlaybackFromMemorySize", "e_GeomCacheMinBufferAheadTime", "e_GeomCachePreferredDiskRequestSize", "e_GeomCaches", "e_GI", "e_GsmCastFromTerrain", "e_GsmDepthBoundsDebug", "e_GsmLodsNum", "e_GsmRange", "e_GsmRangeStep", "e_GsmStats", "e_HwOcclusionCullingWater", "e_JointStrengthScale", "e_levelStartupFrameDelay", "e_levelStartupFrameNum", "e_LightVolumes", "e_LightVolumesDebug", "e_LodCompMaxSize", "e_LodFaceArea", "e_LodFaceAreaTargetSize", "e_LodMax", "e_LodMin", "e_LodMinTtris", "e_LodRatio", "e_Lods", "e_LodsForceUse", "e_LodTransitionSpriteDistRatio", "e_LodTransitionSpriteMinDist", "e_LodTransitionTime", "e_MaxDrawCalls", "e_MaxViewDistance", "e_MaxViewDistFullDistCamHeight", "e_MaxViewDistSpecLerp", "e_MergedMeshes", "e_MergedMeshesActiveDist", "e_MergedMeshesBulletLifetime", "e_MergedMeshesBulletScale", "e_MergedMeshesBulletSpeedFactor", "e_MergedMeshesClusterVisualization", "e_MergedMeshesClusterVisualizationDimension", "e_MergedMeshesDebug", "e_MergedMeshesDeformViewDistMod", "e_MergedMeshesInstanceDist", "e_MergedMeshesLodRatio", "e_MergedMeshesOutdoorOnly", "e_MergedMeshesPool", "e_MergedMeshesPoolSpines", "e_MergedMeshesTesselationSupport", "e_MergedMeshesUseSpines", "e_MergedMeshesViewDistRatio", "e_ObjectLayersActivation", "e_ObjectLayersActivationPhysics", "e_Objects", "e_ObjectsTreeBBoxes", "e_ObjectsTreeNodeMinSize", "e_ObjectsTreeNodeSizeRatio", "e_ObjFastRegister", "e_ObjQuality", "e_ObjShadowCastSpec", "e_ObjStats", "e_OcclusionCullingViewDistRatio", "e_OcclusionLazyHideFrames", "e_OcclusionVolumes", "e_OcclusionVolumesViewDistRatio", "e_OnDemandMaxSize", "e_OnDemandPhysics", "e_Particles", "e_ParticlesAllowRuntimeLoad", "e_ParticlesAnimBlend", "e_ParticlesAudio", "e_ParticlesConvertPfx1", "e_ParticlesCullAgainstOcclusionBuffer", "e_ParticlesCullAgainstViewFrustum", "e_ParticlesDebug", "e_ParticlesDumpMemoryAfterMapLoad", "e_ParticlesForceSeed", "e_ParticlesGI", "e_ParticleShadowsNumGSMs", "e_ParticlesIndexPoolSize", "e_ParticlesLightMinColorThreshold", "e_ParticlesLightMinRadiusThreshold", "e_ParticlesLights", "e_ParticlesLightsViewDistRatio", "e_ParticlesLod", "e_ParticlesMaxDrawScreen", "e_ParticlesMaxScreenFill", "e_ParticlesMinDrawAlpha", "e_ParticlesMinDrawPixels", "e_ParticlesMinPhysicsDynamicBounds", "e_ParticlesMotionBlur", "e_ParticlesObjectCollisions", "e_ParticlesPoolSize", "e_ParticlesPreload", "e_ParticlesProfile", "e_ParticlesProfiler", "e_ParticlesProfilerCountBudget", "e_ParticlesProfilerOutputFolder", "e_ParticlesProfilerOutputName", "e_ParticlesProfilerTimingBudget", "e_ParticlesQuality", "e_ParticlesSerializeNamedFields", "e_ParticlesShadows", "e_ParticlesSoftIntersect", "e_ParticlesSortQuality", "e_ParticlesThread", "e_ParticlesUseLevelSpecificLibs", "e_ParticlesVertexPoolSize", "e_PermanentRenderObjects", "e_PhysFoliage", "e_PhysMinCellSize", "e_PhysOceanCell", "e_PhysProxyTriLimit", "e_Portals", "e_PortalsBigEntitiesFix", "e_PortalsBlend", "e_PortalsMaxRecursion", "e_PrecacheLevel", "e_PreloadDecals", "e_PreloadMaterials", "e_PrepareDeformableObjectsAtLoadTime", "e_ProcVegetation", "e_ProcVegetationMaxCacheLevels", "e_ProcVegetationMaxChunksInCache", "e_ProcVegetationMaxObjectsInChunk", "e_ProcVegetationMaxSectorsInCache", "e_ProcVegetationMaxViewDistance", "e_Recursion", "e_RecursionViewDistRatio", "e_Render", "e_RenderMeshCollisionTolerance", "e_RenderMeshUpdateAsync", "e_RNTmpDataPoolMaxFrames", "e_Roads", "e_Ropes", "e_ScissorDebug", "e_ScreenShot", "e_ScreenShotDebug", "e_ScreenShotFileFormat", "e_ScreenShotHeight", "e_ScreenShotMapCamHeight", "e_ScreenShotMapCenterX", "e_ScreenShotMapCenterY", "e_ScreenShotMapOrientation", "e_ScreenShotMapSizeX", "e_ScreenShotMapSizeY", "e_ScreenShotMinSlices", "e_ScreenShotQuality", "e_ScreenShotWidth", "e_Shadows", "e_ShadowsAdaptScale", "e_ShadowsBlendCascades", "e_ShadowsBlendCascadesVal", "e_ShadowsCacheObjectLod", "e_ShadowsCacheRenderCharacters", "e_ShadowsCacheUpdate", "e_ShadowsCascadesCentered", "e_ShadowsCascadesDebug", "e_ShadowsCastViewDistRatio", "e_ShadowsCastViewDistRatioLights", "e_ShadowsClouds", "e_ShadowsConstBias", "e_ShadowsConstBiasHQ", "e_ShadowsDebug", "e_ShadowsFrustums", "e_ShadowsLodBiasFixed", "e_ShadowsLodBiasInvis", "e_ShadowsMasksLimit", "e_ShadowsMaxTexRes", "e_ShadowsPerObject", "e_ShadowsPerObjectResolutionScale", "e_ShadowsPoolSize", "e_ShadowsResScale", "e_ShadowsSlopeBias", "e_ShadowsSlopeBiasHQ", "e_ShadowsTessellateCascades", "e_ShadowsTessellateDLights", "e_ShadowsUpdateViewDistRatio", "e_sketch_mode", "e_SkyBox", "e_SkyQuality", "e_SkyType", "e_SkyUpdateRate", "e_Sleep", "e_SQTestBegin", "e_SQTestCount", "e_SQTestDelay", "e_SQTestDistance", "e_SQTestExitOnFinish", "e_SQTestMip", "e_SQTestMoveSpeed", "e_SQTestTextureName", "e_StaticInstancing", "e_StaticInstancingMinInstNum", "e_StatObjBufferRenderTasks", "e_StatObjMerge", "e_StatObjMergeMaxTrisPerDrawCall", "e_StatObjPreload", "e_StatObjRenderFilter", "e_StatObjRenderFilterMode", "e_StatObjStoreMesh", "e_StatObjTessellationMode", "e_StatObjValidate", "e_StatoscopeAllowFpsOverride", "e_StatoscopeConnectTimeout", "e_StatoscopeCreateLogFilePerLevel", "e_StatoscopeDataGroups", "e_StatoscopeDumpAll", "e_StatoscopeEnabled", "e_StatoscopeFilenameUseBuildInfo", "e_StatoscopeFilenameUseDatagroups", "e_StatoscopeFilenameUseMap", "e_StatoscopeFilenameUseTag", "e_StatoscopeFilenameUseTime", "e_StatoscopeIvDataGroups", "e_StatoscopeLogDestination", "e_StatoscopeMaxNumFuncsPerFrame", "e_StatoscopeMinFuncLengthMs", "e_StatoscopeScreenCapWhenGPULimited", "e_StatoscopeScreenshotCapturePeriod", "e_StatoscopeWriteTimeout", "e_StreamAutoMipFactorMax", "e_StreamAutoMipFactorMaxDVD", "e_StreamAutoMipFactorMin", "e_StreamAutoMipFactorSpeedThreshold", "e_StreamCgf", "e_StreamCgfDebug", "e_StreamCgfDebugFilter", "e_StreamCgfDebugHeatMap", "e_StreamCgfDebugMinObjSize", "e_StreamCgfFastUpdateMaxDistance", "e_StreamCgfGridUpdateDistance", "e_StreamCgfMaxNewTasksPerUpdate", "e_StreamCgfMaxTasksInProgress", "e_StreamCgfPoolSize", "e_StreamCgfUpdatePerNodeDistance", "e_StreamCgfVisObjPriority", "e_StreamInstances", "e_StreamInstancesDistRatio", "e_StreamInstancesMaxTasks", "e_StreamPredictionAhead", "e_StreamPredictionAheadDebug", "e_StreamPredictionAlwaysIncludeOutside", "e_StreamPredictionBoxRadius", "e_StreamPredictionDistanceFar", "e_StreamPredictionDistanceNear", "e_StreamPredictionMaxVisAreaRecursion", "e_StreamPredictionMinFarZoneDistance", "e_StreamPredictionMinReportDistance", "e_StreamPredictionTexelDensity", "e_StreamPredictionUpdateTimeSlice", "e_StreamSaveStartupResultsIntoXML", "e_Sun", "e_SunAngleSnapDot", "e_SunAngleSnapSec", "e_svoDebug", "e_svoDispatchX", "e_svoDispatchY", "e_svoDVR", "e_svoDVR_DistRatio", "e_svoEnabled", "e_svoLoadTree", "e_svoMaxAreaSize", "e_svoMaxBricksOnCPU", "e_svoMaxBrickUpdates", "e_svoMaxNodeSize", "e_svoMaxStreamRequests", "e_svoMinNodeSize", "e_svoRender", "e_svoRootSize", "e_svoTI_Active", "e_svoTI_AnalyticalGI", "e_svoTI_AnalyticalOccluders", "e_svoTI_AnalyticalOccludersRange", "e_svoTI_AnalyticalOccludersSoftness", "e_svoTI_Apply", "e_svoTI_AsyncCompute", "e_svoTI_ConeMaxLength", "e_svoTI_ConstantAmbientDebug", "e_svoTI_Diffuse_Cache", "e_svoTI_Diffuse_Spr", "e_svoTI_DiffuseAmplifier", "e_svoTI_DiffuseBias", "e_svoTI_DiffuseConeWidth", "e_svoTI_DualTracing", "e_svoTI_DynLights", "e_svoTI_EmissiveMultiplier", "e_svoTI_ForceGIForAllLights", "e_svoTI_GsmCascadeLod", "e_svoTI_HalfresKernelPrimary", "e_svoTI_HalfresKernelSecondary", "e_svoTI_HighGlossOcclusion", "e_svoTI_InjectionMultiplier", "e_svoTI_IntegrationMode", "e_svoTI_LowSpecMode", "e_svoTI_MinReflectance", "e_svoTI_MinVoxelOpacity", "e_svoTI_NumberOfBounces", "e_svoTI_ObjectsLod", "e_svoTI_ObjectsMaxViewDistance", "e_svoTI_PointLightsMultiplier", "e_svoTI_PortalsDeform", "e_svoTI_PortalsInject", "e_svoTI_PropagationBooster", "e_svoTI_Reflect_Vox_Max", "e_svoTI_Reflect_Vox_Max_Overhead", "e_svoTI_Reflect_Vox_MaxEdit", "e_svoTI_ResScaleAir", "e_svoTI_ResScaleBase", "e_svoTI_RsmConeMaxLength", "e_svoTI_RsmUseColors", "e_svoTI_RT_MaxDist", "e_svoTI_Saturation", "e_svoTI_Shadow_Sev", "e_svoTI_SkipNonGILights", "e_svoTI_SkyColorMultiplier", "e_svoTI_SkyLightBottomMultiplier", "e_svoTI_Specular_FromDiff", "e_svoTI_Specular_Reproj", "e_svoTI_Specular_Sev", "e_svoTI_SpecularAmplifier", "e_svoTI_SSAOAmount", "e_svoTI_SSDepthTrace", "e_svoTI_SunRSMInject", "e_svoTI_TemporalFilteringBase", "e_svoTI_TraceVoxels", "e_svoTI_TranslucentBrightness", "e_svoTI_Troposphere_Active", "e_svoTI_Troposphere_Brightness", "e_svoTI_Troposphere_CloudGen_Freq", "e_svoTI_Troposphere_CloudGen_FreqStep", "e_svoTI_Troposphere_CloudGen_Height", "e_svoTI_Troposphere_CloudGen_Scale", "e_svoTI_Troposphere_CloudGenTurb_Freq", "e_svoTI_Troposphere_CloudGenTurb_Scale", "e_svoTI_Troposphere_Density", "e_svoTI_Troposphere_Ground_Height", "e_svoTI_Troposphere_Layer0_Dens", "e_svoTI_Troposphere_Layer0_Height", "e_svoTI_Troposphere_Layer0_Rand", "e_svoTI_Troposphere_Layer1_Dens", "e_svoTI_Troposphere_Layer1_Height", "e_svoTI_Troposphere_Layer1_Rand", "e_svoTI_Troposphere_Snow_Height", "e_svoTI_Troposphere_Subdivide", "e_svoTI_UpdateGeometry", "e_svoTI_UpdateLighting", "e_svoTI_UseLightProbes", "e_svoTI_UseTODSkyColor", "e_svoTI_VegetationMaxOpacity", "e_svoTI_VoxelizaionLODRatio", "e_svoTI_VoxelizaionPostpone", "e_svoTI_VoxelizeHiddenObjects", "e_svoTI_VoxelizeUnderTerrain", "e_svoTI_VoxelOpacityMultiplier", "e_svoVoxDistRatio", "e_svoVoxelPoolResolution", "e_svoVoxGenRes", "e_svoVoxNodeRatio", "e_Terrain", "e_TerrainBBoxes", "e_TerrainDeformations", "e_TerrainDetailMaterials", "e_TerrainDetailMaterialsDebug", "e_TerrainDetailMaterialsViewDistXY", "e_TerrainDetailMaterialsViewDistZ", "e_TerrainDrawThisSectorOnly", "e_TerrainLodDistRatio", "e_TerrainLodRatio", "e_TerrainLodRatioHolesMin", "e_TerrainMeshInstancingMinLod", "e_TerrainMeshInstancingShadowBias", "e_TerrainMeshInstancingShadowLodRatio", "e_TerrainOcclusionCulling", "e_TerrainOcclusionCullingDebug", "e_TerrainOcclusionCullingMaxDist", "e_TerrainOcclusionCullingMaxSteps", "e_TerrainOcclusionCullingPrecision", "e_TerrainOcclusionCullingPrecisionDistRatio", "e_TerrainOcclusionCullingStepSize", "e_TerrainOcclusionCullingStepSizeDelta", "e_TerrainTextureLodRatio", "e_TerrainTextureStreamingDebug", "e_TerrainTextureStreamingPoolItemsNum", "e_Tessellation", "e_TessellationMaxDistance", "e_texeldensity", "e_TimeOfDay", "e_TimeOfDayDebug", "e_TimeOfDaySpeed", "e_UseConsoleMtl", "e_Vegetation", "e_VegetationBending", "e_VegetationBoneInfo", "e_VegetationMinSize", "e_VegetationSprites", "e_VegetationSpritesBatching", "e_VegetationSpritesDistanceCustomRatioMin", "e_VegetationSpritesDistanceRatio", "e_VegetationSpritesMinDistance", "e_VegetationSpritesScaleFactor", "e_VegetationUseTerrainColor", "e_VegetationUseTerrainColorDistance", "e_ViewDistCompMaxSize", "e_ViewDistMin", "e_ViewDistRatio", "e_ViewDistRatioCustom", "e_ViewDistRatioDetail", "e_ViewDistRatioLights", "e_ViewDistRatioPortals", "e_ViewDistRatioVegetation", "e_VolObjShadowStrength", "e_VolumetricFog", "e_WaterOcean", "e_WaterOceanBottom", "e_WaterOceanFFT", "e_WaterRipplesDebug", "e_WaterTessellationAmount", "e_WaterTessellationAmountX", "e_WaterTessellationAmountY", "e_WaterTessellationSwathWidth", "e_WaterVolumes", "e_WaterWaves", "e_WaterWavesTessellationAmount", "e_Wind", "e_WindAreas", "e_WindBendingAreaStrength", "e_WindBendingDistRatio", "e_WindBendingStrength", "ed_enableAssetPickers", "ed_indexfiles", "ed_keepEditorActive", "ed_killmemory_size", "ed_logFileChanges", "ed_PhysToolHitExplPress0", "ed_PhysToolHitExplPress1", "ed_PhysToolHitExplR", "ed_PhysToolHitProjMass", "ed_PhysToolHitProjVel0", "ed_PhysToolHitProjVel1", "ed_PhysToolHitVelMax", "ed_PhysToolHitVelMin", "ed_useDevManager", "es_activateEntity", "es_bboxes", "es_CharZOffsetSpeed", "es_deactivateEntity", "es_DebrisLifetimeScale", "es_debug", "es_debug_not_seen_timeout", "es_debugDrawEntityIDs", "es_debugEntityLifetime", "es_DebugEntityUsage", "es_DebugEntityUsageFilter", "es_DebugEvents", "es_DebugFindEntity", "es_DebugTimers", "es_DisableTriggers", "es_DrawAreaDebug", "es_DrawAreaGrid", "es_DrawAreas", "es_DrawAudioProxyZRay", "es_DrawProximityTriggers", "es_enable_full_script_save", "es_EntityUpdatePosDelta", "es_FarPhysTimeout", "es_helpers", "es_HitCharacters", "es_HitDeadBodies", "es_ImpulseScale", "es_LayerDebugInfo", "es_LayerSaveLoadSerialization", "es_log_collisions", "es_MaxImpulseAdjMass", "es_MaxJointFx", "es_MaxPhysDist", "es_MaxPhysDistCloth", "es_MaxPhysDistInvisible", "es_MinImpulseVel", "es_not_seen_timeout", "es_profileentities", "es_removeEntity", "es_SaveLoadUseLUANoSaveFlag", "es_SortUpdatesByClass", "es_SplashThreshold", "es_SplashTimeout", "es_UpdateAI", "es_UpdateCollision", "es_UpdateCollisionScript", "es_UpdateContainer", "es_UpdateEntities", "es_UpdatePhysics", "es_UpdateScript", "es_UpdateTimer", "es_UsePhysVisibilityChecks", "es_VisCheckForUpdate", "ExitOnQuit", "ffs_debug", "fg_abortOnLoadError", "fg_debugmodules", "fg_debugmodules_filter", "fg_iDebugNextStep", "fg_iEnableFlowgraphNodeDebugging", "fg_inspectorLog", "fg_noDebugText", "fg_profile", "fg_SystemEnable", "g_aimdebug", "g_allowDisconnectIfUpdateFails", "g_allowSaveLoadInEditor", "g_asynclevelload", "g_breakage_debug", "g_breakage_mem_limit", "g_breakage_particles_limit", "g_breakageFadeDelay", "g_breakageFadeTime", "g_breakagelog", "g_breakageMinAxisInertia", "g_breakageNoDebrisCollisions", "g_breakageTreeDec", "g_breakageTreeInc", "g_breakageTreeIncGlass", "g_breakageTreeMax", "g_breakImpulseScale", "g_breaktimeoutframes", "g_debug_stats", "g_debugAspectChanges", "g_debugAspectFilterClass", "g_debugAspectFilterEntity", "g_debugAspectTrap", "g_debugAspectTrapCount", "g_debugDialogBuffers", "g_debugHardwareMouse", "g_debugRMI", "g_debugSaveLoadMemory", "g_disableInputKeyFlowNodeInDevMode", "g_disableSequencePlayback", "g_disableWinKeys", "g_displayCheckpointName", "g_distanceForceNoIk", "g_distanceForceNoLegRaycasts", "g_enableitems", "g_enableloadingscreen", "g_EnableLoadSave", "g_enableMergedMeshRuntimeAreas", "g_forceFastUpdate", "g_gameplayAnalyst", "g_glassAutoShatter", "g_glassAutoShatterMinArea", "g_glassAutoShatterOnExplosions", "g_glassForceTimeout", "g_glassForceTimeoutSpread", "g_glassMaxPanesToBreakPerFrame", "g_glassNoDecals", "g_glassSystemEnable", "g_groundAlignAll", "g_groundeffectsdebug", "g_handleEvents", "g_hostMigrationServerDelay", "g_immersive", "g_joint_breaking", "g_landingBobLandTimeFactor", "g_landingBobTimeFactor", "g_language", "g_languageAudio", "g_localPacketRate", "g_manualFrameStepFrequency", "g_multiplayerEnableVehicles", "g_no_breaking_by_objects", "g_no_secondary_breaking", "g_playerInteractorRadius", "g_procedural_breaking", "g_saveLoadBasicEntityOptimization", "g_saveLoadExtendedLog", "g_saveLoadUseExportedEntityList", "g_showUpdateState", "g_spectatorCollisions", "g_statisticsMode", "g_syncClassRegistry", "g_tree_cut_reuse_dist", "g_userNeverAutoSignsIn", "g_useSinglePosition", "g_useXMLCPBinForSaveLoad", "g_visibilityTimeout", "g_visibilityTimeoutTime", "g_waterHitOnly", "g_XMLCPBAddExtraDebugInfoToXmlDebugFiles", "g_XMLCPBBlockQueueLimit", "g_XMLCPBGenerateXmlDebugFiles", "g_XMLCPBSizeReportThreshold", "g_XMLCPBUseExtraZLibCompression", "gfx_ampserver", "gfx_debugdraw", "gfx_draw", "gfx_enabled", "gfx_FlashReloadEnabled", "gfx_FlashReloadTime", "gfx_inputevents_triggerrepeat", "gfx_inputevents_triggerstart", "gfx_loadtimethread", "gfx_reloadonlanguagechange", "gfx_uiaction_enable", "gfx_uiaction_folder", "gfx_uiaction_log", "gfx_uiaction_log_filter", "gfx_uievents_editorenabled", "gpu_particle_physics", "gt_show", "gt_showFilter", "gt_showLines", "gt_showPosX", "gt_showPosY", "hmd_device", "hmd_info", "hmd_resolution_scale", "hmd_social_screen", "hmd_social_screen_keep_aspect", "hmd_tracking_origin", "http_password", "i_bufferedkeys", "i_debug", "i_debugDigitalButtons", "i_forcefeedback", "i_inventory_capacity", "i_itemSystemDebugMemStats", "i_kinectDebug", "i_kinectXboxConnect", "i_kinectXboxConnectIP", "i_kinectXboxConnectPort", "i_kinGlobalExpCorrectionFactor", "i_kinGlobalExpDeviationRadius", "i_kinGlobalExpJitterRadius", "i_kinGlobalExpPredictionFactor", "i_kinGlobalExpSmoothFactor", "i_kinSkeletonMovedDistance", "i_kinSkeletonSmoothType", "i_listActionMaps", "i_lying_item_limit_mp", "i_lying_item_limit_sp", "i_mouse_accel", "i_mouse_accel_max", "i_mouse_buffered", "i_mouse_inertia", "i_mouse_sensitivity", "i_mouse_smooth", "i_precache", "i_seatedTracking", "i_useKinect", "i_xinput", "i_xinput_deadzone_handling", "i_xinput_poll_time", "log_EnableRemoteConsole", "log_IncludeTime", "log_Module", "log_SpamDelay", "log_tick", "log_Verbosity", "log_VerbosityOverridesWriteToFile", "log_WriteToFile", "log_WriteToFileVerbosity", "lua_CodeCoverage", "lua_debugger", "lua_stackonmalloc", "lua_StopOnError", "MemInfo", "MemStats", "MemStatsMaxDepth", "MemStatsThreshold", "mfx_Debug", "mfx_DebugFlowGraphFX", "mfx_DebugVisual", "mfx_DebugVisualFilter", "mfx_Enable", "mfx_EnableAttachedEffects", "mfx_EnableFGEffects", "mfx_ParticleImpactThresh", "mfx_pfx_maxDist", "mfx_pfx_maxScale", "mfx_pfx_minScale", "mfx_RaisedSoundImpactThresh", "mfx_SerializeFGEffects", "mfx_SoundImpactThresh", "mfx_Timeout", "mi_defaultMaterial", "mi_lazyLodGeneration", "mn_allowEditableDatabasesInPureGame", "mn_LogToFile", "mn_override_preview_file", "mn_sequence_path", "mov_cameraPrecacheTime", "mov_debugSequences", "mov_NoCutscenes", "mov_overrideCam", "movie_physicalentity_animation_lerp", "movie_timeJumpTransitionTime", "net_availableBandwidthClient", "net_availableBandwidthServer", "net_backofftimeout", "net_breakage_sync_entities", "net_bw_aggressiveness", "net_channelstats", "net_connectivity_detection_interval", "net_debug_draw_scale", "net_debugChannelIndex", "net_debugEntityInfo", "net_debugEntityInfoClassName", "net_debugInfo", "net_debugVerboseLevel", "net_dedi_scheduler_client_base_port", "net_dedi_scheduler_server_port", "net_defaultBandwidthShares", "net_defaultPacketRate", "net_defaultPacketRateIdle", "net_disconnect_on_rmi_error", "net_enable_tfrc", "net_enable_voice_chat", "net_enable_watchdog_timer", "net_fragment_expiration_time", "net_highlatencythreshold", "net_highlatencytimelimit", "net_inactivitytimeout", "net_inactivitytimeoutDevmode", "net_keepalive_time", "net_lan_scanport_first", "net_lan_scanport_num", "net_lanbrowser", "net_lobbyUpdateFrequency", "net_log", "net_log_remote_methods", "net_max_fragmented_packets_per_source", "net_maxpacketsize", "net_meminfo", "net_minTCPFriendlyBitRate", "net_netMsgDispatcherDebug", "net_netMsgDispatcherLogging", "net_netMsgDispatcherWarnThreshold", "net_new_queue_behaviour", "net_numNetIDHighBitBits", "net_numNetIDLowBitBits", "net_numNetIDMediumBitBits", "net_packet_read_debug_output", "net_packetfragmentlossrate", "net_PacketLagMax", "net_PacketLagMin", "net_PacketLossRate", "net_phys_debug", "net_phys_lagsmooth", "net_phys_pingsmooth", "net_ping_time", "net_profile_budget_logging", "net_profile_budget_logname", "net_profile_deep_bandwidth_logging", "net_profile_deep_bandwidth_logname", "net_profile_enable", "net_profile_logging", "net_profile_logname", "net_profile_show_socket_measurements", "net_profile_untouched_delay", "net_profile_worst_num_channels", "net_receiveQueueSize", "net_remotetimeestimationwarning", "net_safetysleeps", "net_scheduler_debug", "net_scheduler_debug_mode", "net_scheduler_expiration_period", "net_sendQueueSize", "net_sim_loadprofiles", "net_SimUseProfile", "net_socketBoostTimeout", "net_socketMaxTimeout", "net_socketMaxTimeoutMultiplayer", "net_stats_login", "net_stats_pass", "osm_debug", "osm_enabled", "osm_fbMinScale", "osm_fbScaleDeltaDown", "osm_fbScaleDeltaUp", "osm_historyLength", "osm_stress", "osm_targetFPS", "osm_targetFPSTolerance", "p_accuracy_LCPCG", "p_accuracy_LCPCG_no_improvement", "p_accuracy_MC", "p_approx_caps_len", "p_break_on_validation", "p_CharacterIK", "p_check_out_of_bounds", "p_collision_mode", "p_cull_distance", "p_damping_group_size", "p_debug_explosions", "p_debug_joints", "p_do_step", "p_draw_helpers", "p_draw_helpers_num", "p_draw_helpers_opacity", "p_enforce_contacts", "p_ent_grid_use_obb", "p_fixed_timestep", "p_fly_mode", "p_force_sync", "p_GEB_max_cells", "p_gravity_z", "p_group_damping", "p_joint_damage_accum", "p_joint_damage_accum_threshold", "p_joint_gravity_step", "p_jump_to_profile_ent", "p_lattice_max_iters", "p_limit_simple_solver_energy", "p_list_active_objects", "p_log_lattice_tension", "p_max_approx_caps", "p_max_bone_velocity", "p_max_contact_gap", "p_max_contact_gap_player", "p_max_contact_gap_simple", "p_max_contacts", "p_max_debris_mass", "p_max_entity_cells", "p_max_LCPCG_contacts", "p_max_LCPCG_fruitless_iters", "p_max_LCPCG_iters", "p_max_LCPCG_microiters", "p_max_LCPCG_microiters_final", "p_max_LCPCG_subiters", "p_max_LCPCG_subiters_final", "p_max_MC_iters", "p_max_MC_mass_ratio", "p_max_MC_vel", "p_max_object_splashes", "p_max_plane_contacts", "p_max_plane_contacts_distress", "p_max_player_velocity", "p_max_substeps", "p_max_substeps_large_group", "p_max_unproj_vel", "p_max_velocity", "p_max_world_step", "p_min_LCPCG_improvement", "p_min_MC_iters", "p_min_separation_speed", "p_net_debugDraw", "p_net_extrapmax", "p_net_interp", "p_net_sequencefrequency", "p_num_bodies_large_group", "p_num_startup_overload_checks", "p_num_threads", "p_penalty_scale", "p_physics_library", "p_players_can_break", "p_profile", "p_profile_entities", "p_profile_functions", "p_prohibit_unprojection", "p_proxy_highlight_range", "p_proxy_highlight_threshold", "p_ray_fadeout", "p_ray_peak_time", "p_rope_collider_size_limit", "p_single_step_mode", "p_skip_redundant_colldet", "p_splash_dist0", "p_splash_dist1", "p_splash_force0", "p_splash_force1", "p_splash_vel0", "p_splash_vel1", "p_tick_breakable", "p_time_granularity", "p_unproj_vel_scale", "p_use_distance_contacts", "p_use_unproj_vel", "p_wireframe_distance", "pp_LoadOnlineAttributes", "pp_RichSaveGames", "pp_RSFDebugWrite", "pp_RSFDebugWriteOnLoad", "profile", "profile_additionalsub", "profile_allthreads", "profile_callstack", "profile_deep", "profile_disk", "profile_disk_budget", "profile_disk_max_draw_items", "profile_disk_max_items", "profile_disk_timeframe", "profile_disk_type_filter", "profile_filter", "profile_filter_thread", "profile_graph", "profile_graphScale", "profile_log", "profile_network", "profile_pagefaults", "profile_peak", "profile_peak_display", "profile_sampler", "profile_sampler_max_samples", "profile_smooth", "profile_weighting", "profileStreaming", "q_Renderer", "q_ShaderFX", "q_ShaderGeneral", "q_ShaderGlass", "q_ShaderHDR", "q_ShaderIce", "q_ShaderMetal", "q_ShaderPostProcess", "q_ShaderShadow", "q_ShaderSky", "q_ShaderTerrain", "q_ShaderVegetation", "q_ShaderWater", "r_3MonHack", "r_3MonHackHUDFOVX", "r_3MonHackHUDFOVY", "r_3MonHackLeftCGFOffsetX", "r_3MonHackRightCGFOffsetX", "r_AllowLiveMoCap", "r_AntialiasingMode", "r_AntialiasingModeDebug", "r_AntialiasingModeEditor", "r_AntialiasingModeSCull", "r_AntialiasingTAAFalloffHiFreq", "r_AntialiasingTAAFalloffLowFreq", "r_AntialiasingTAAPattern", "r_AntialiasingTAASharpening", "r_ArmourPulseSpeedMultiplier", "r_auxGeom", "r_Batching", "r_BatchType", "r_Beams", "r_BreakOnError", "r_Brightness", "r_buffer_banksize", "r_buffer_enable_lockless_updates", "r_buffer_pool_defrag_dynamic", "r_buffer_pool_defrag_max_moves", "r_buffer_pool_defrag_static", "r_buffer_pool_max_allocs", "r_buffer_sli_workaround", "r_CBufferUseNativeDepth", "r_Character_NoDeform", "r_ChromaticAberration", "r_CloakFadeByDist", "r_CloakFadeLightScale", "r_CloakFadeMaxDistSq", "r_CloakFadeMinDistSq", "r_CloakFadeMinValue", "r_CloakHeatScale", "r_cloakHighlightStrength", "r_CloakInterferenceSparksAlpha", "r_CloakLightScale", "r_CloakMinAmbientIndoors", "r_CloakMinAmbientOutdoors", "r_CloakMinLightValue", "r_CloakRefractionFadeByDist", "r_CloakRefractionFadeMaxDistSq", "r_CloakRefractionFadeMinDistSq", "r_CloakRefractionFadeMinValue", "r_CloakRenderInThermalVision", "r_CloakSparksAlpha", "r_CloakTransitionLightScale", "r_CloudsDebug", "r_CloudsUpdateAlways", "r_ColorBits", "r_ColorGrading", "r_ColorGradingCharts", "r_ColorGradingChartsCache", "r_ColorGradingFilters", "r_ColorGradingLevels", "r_ColorGradingSelectiveColor", "r_ColorRangeCompression", "r_ComputeSkinning", "r_ComputeSkinningDebugDraw", "r_ComputeSkinningMorphs", "r_ComputeSkinningTangents", "r_ConditionalRendering", "r_ConsoleBackbufferHeight", "r_ConsoleBackbufferWidth", "r_constantbuffer_banksize", "r_constantbuffer_watermarm", "r_Contrast", "r_CustomResHeight", "r_CustomResMaxSize", "r_CustomResPreview", "r_CustomResWidth", "r_CustomVisions", "r_D3D12AsynchronousCompute", "r_D3D12BatchResourceBarriers", "r_D3D12EarlyResourceBarriers", "r_D3D12HardwareComputeQueue", "r_D3D12HardwareCopyQueue", "r_D3D12SubmissionThread", "r_D3D12WaitableSwapChain", "r_DebugFontRendering", "r_DebugGBuffer", "r_DebugLayerEffect", "r_DebugLights", "r_DebugLightVolumes", "r_DebugRefraction", "r_DebugRenderMode", "r_DeferredDecals", "r_deferredDecalsDebug", "r_DeferredShadingAmbient", "r_DeferredShadingAmbientLights", "r_DeferredShadingAmbientSClear", "r_DeferredShadingAreaLights", "r_DeferredShadingDBTstencil", "r_DeferredShadingDebug", "r_DeferredShadingDepthBoundsTest", "r_DeferredShadingEnvProbes", "r_DeferredShadingFilterGBuffer", "r_DeferredShadingLBuffersFmt", "r_DeferredShadingLightLodRatio", "r_DeferredShadingLights", "r_DeferredShadingLightStencilRatio", "r_DeferredShadingLightVolumes", "r_DeferredShadingScissor", "r_DeferredShadingSortLights", "r_DeferredShadingSSS", "r_DeferredShadingStencilPrepass", "r_DeferredShadingTiled", "r_DeferredShadingTiledDebug", "r_DeferredShadingTiledHairQuality", "r_DepthBits", "r_DepthOfField", "r_DepthOfFieldBokehQuality", "r_DepthOfFieldDilation", "r_DepthOfFieldMode", "r_DetailDistance", "r_DetailTextures", "r_DisplayInfo", "r_displayinfoTargetFPS", "r_dofMinZ", "r_dofMinZBlendMult", "r_dofMinZScale", "r_DrawNearFarPlane", "r_DrawNearFoV", "r_DrawNearShadows", "r_DrawNearZRange", "r_Driver", "r_durango_async_dips", "r_durango_async_dips_sync", "r_DynTexAtlasCloudsMaxSize", "r_DynTexAtlasDynTexSrcSize", "r_DynTexAtlasSpritesMaxSize", "r_DynTexAtlasVoxTerrainMaxSize", "r_DynTexMaxSize", "r_DynTexSourceSharedRTHeight", "r_DynTexSourceSharedRTWidth", "r_DynTexSourceUseSharedRT", "r_enable_full_gpu_sync", "r_enableAltTab", "r_enableAuxGeom", "r_EnableDebugLayer", "r_EnvCMResolution", "r_EnvTexResolution", "r_EnvTexUpdateInterval", "r_ExcludeMesh", "r_ExcludeShader", "r_FlareHqShafts", "r_Flares", "r_FlaresChromaShift", "r_FlaresIrisShaftMaxPolyNum", "r_FlaresTessellationRatio", "r_FlashMatTexResQuality", "r_FogDepthTest", "r_FogShadows", "r_FogShadowsMode", "r_FogShadowsWater", "r_Fullscreen", "r_FullscreenNativeRes", "r_FullscreenPreemption", "r_FullscreenWindow", "r_Gamma", "r_GeomCacheInstanceThreshold", "r_GeomInstancing", "r_GeomInstancingDebug", "r_GeomInstancingThreshold", "r_GetScreenShot", "r_GpuParticles", "r_GpuParticlesConstantRadiusBoundingBoxes", "r_GpuPhysicsFluidDynamicsDebug", "r_GraphicsPipeline", "r_GraphStyle", "r_HDRBloom", "r_HDRBloomQuality", "r_HDRDebug", "r_HDREyeAdaptationMode", "r_HDREyeAdaptationSpeed", "r_HDRGrainAmount", "r_HDRRangeAdapt", "r_HDRRangeAdaptationSpeed", "r_HDRRangeAdaptLBufferMax", "r_HDRRangeAdaptLBufferMaxRange", "r_HDRRangeAdaptMax", "r_HDRRangeAdaptMaxRange", "r_HDRRendering", "r_HDRTexFormat", "r_HDRVignetting", "r_Height", "r_HeightMapAO", "r_HeightMapAOAmount", "r_HeightMapAORange", "r_HeightMapAOResolution", "r_HideSunInCubemaps", "r_ImposterRatio", "r_ImpostersDraw", "r_ImpostersUpdatePerFrame", "r_LightsSinglePass", "r_Log", "r_LogShaders", "r_LogTexStreaming", "r_LogVBuffers", "r_LogVidMem", "r_MaterialsBatching", "r_MaxSuitPulseSpeedMultiplier", "r_MeasureOverdrawScale", "r_MergeShadowDrawcalls", "r_MeshInstancePoolSize", "r_MeshPoolSize", "r_MeshPrecache", "r_minimizeLatency", "r_MotionBlur", "r_MotionBlurCameraMotionScale", "r_MotionBlurGBufferVelocity", "r_MotionBlurMaxViewDist", "r_MotionBlurQuality", "r_MotionBlurShutterSpeed", "r_MotionBlurThreshold", "r_MotionVectors", "r_MouseCursorTexture", "r_MSAA", "r_MSAA_debug", "r_MSAA_quality", "r_MSAA_samples", "r_MSAA_threshold_depth", "r_MSAA_threshold_normal", "r_MultiGPU", "r_MultiThreaded", "r_MultiThreadedDrawing", "r_MultiThreadedDrawingMinJobSize", "r_NightVision", "r_NightVisionBrightLevel", "r_NightVisionCamMovNoiseAmount", "r_NightVisionCamMovNoiseBlendSpeed", "r_NightVisionFinalMul", "r_NightVisionSonarLifetime", "r_NightVisionSonarMultiplier", "r_NightVisionSonarRadius", "r_NoDraw", "r_NoDrawNear", "r_NoDrawShaders", "r_NoHWGamma", "r_NormalsLength", "r_overrideDXGIAdapter", "r_overrideDXGIOutput", "r_overrideDXGIOutputFS", "r_overrideRefreshRate", "r_overrideScanlineOrder", "r_OverscanBorderScaleX", "r_OverscanBorderScaleY", "r_OverscanBordersDrawDebugView", "r_ParticlesAmountGI", "r_ParticlesDebug", "r_ParticlesHalfRes", "r_ParticlesHalfResAmount", "r_ParticlesHalfResBlendMode", "r_ParticlesInstanceVertices", "r_ParticlesRefraction", "r_ParticlesSoftIsec", "r_ParticlesTessellation", "r_ParticlesTessellationTriSize", "r_ParticleVerticePoolSize", "r_PostProcessEffects", "r_PostProcessFilters", "r_PostProcessGameFx", "r_PostProcessHUD3D", "r_PostProcessHUD3DCache", "r_PostProcessHUD3DDebugView", "r_PostProcessHUD3DGlowAmount", "r_PostProcessHUD3DShadowAmount", "r_PostProcessHUD3DStencilClear", "r_PostProcessNanoGlassDebugView", "r_PostProcessParamsBlending", "r_PostprocessParamsBlendingTimeScale", "r_PostProcessReset", "r_PredicatedTiling", "r_PrintMemoryLeaks", "r_profiler", "r_profilerTargetFPS", "r_Rain", "r_RainAmount", "r_RainDistMultiplier", "r_RainDropsEffect", "r_RainIgnoreNearest", "r_RainMaxViewDist", "r_RainMaxViewDist_Deferred", "r_RainOccluderSizeTreshold", "r_RC_AutoInvoke", "r_ReadZBufferDirectlyFromVMEM", "r_Reflections", "r_ReflectionsOffset", "r_ReflectionsQuality", "r_ReflectTextureSlots", "r_Refraction", "r_RefractionPartialResolves", "r_RefractionPartialResolvesDebug", "r_ReleaseAllResourcesOnExit", "r_ReloadShaders", "r_RenderMeshHashGridUnitSize", "r_RenderTargetPoolSize", "r_ReprojectOnlyStaticObjects", "r_ReverseDepth", "r_Scissor", "r_ShaderCompilerDontCache", "r_ShaderCompilerFolderName", "r_ShaderCompilerFolderSuffix", "r_ShaderCompilerPort", "r_ShaderCompilerServer", "r_ShaderEmailCCs", "r_ShaderEmailTags", "r_ShadersAllowCompilation", "r_ShadersAsyncActivation", "r_ShadersAsyncCompiling", "r_ShadersAsyncMaxThreads", "r_ShadersCacheDeterministic", "r_ShadersCompileAutoActivate", "r_ShadersCompileCompatible", "r_ShadersCompileStrict", "r_ShadersDebug", "r_ShadersDurango", "r_ShadersDX11", "r_ShadersEditing", "r_ShadersExport", "r_ShadersGL4", "r_ShadersGLES3", "r_ShadersIgnoreIncludesChanging", "r_ShadersImport", "r_ShadersLazyUnload", "r_ShadersLogCacheMisses", "r_ShadersOrbis", "r_ShadersPrecacheAllLights", "r_ShadersRemoteCompiler", "r_ShadersSubmitRequestline", "r_ShadowBluriness", "r_ShadowCastingLightsMaxCount", "r_ShadowGen", "r_ShadowGenDepthClip", "r_ShadowGenMode", "r_ShadowJittering", "r_ShadowMaskStencilPrepass", "r_ShadowPass", "r_ShadowPoolMaxFrames", "r_ShadowPoolMaxTimeslicedUpdatesPerFrame", "r_ShadowsAdaptionMin", "r_ShadowsAdaptionRangeClamp", "r_ShadowsAdaptionSize", "r_ShadowsBias", "r_ShadowsCache", "r_ShadowsCacheFormat", "r_ShadowsCacheResolutions", "r_ShadowsDepthBoundNV", "r_ShadowsGridAligned", "r_ShadowsMaskDownScale", "r_ShadowsMaskResolution", "r_ShadowsNearestMapResolution", "r_ShadowsParticleAnimJitterAmount", "r_ShadowsParticleJitterAmount", "r_ShadowsParticleKernelSize", "r_ShadowsParticleNormalEffect", "r_ShadowsPCFiltering", "r_ShadowsScreenSpace", "r_ShadowsStencilPrePass", "r_ShadowsUseClipVolume", "r_ShadowTexFormat", "r_Sharpening", "r_ShowBufferUsage", "r_ShowDynTextures", "r_ShowDynTexturesFilter", "r_ShowDynTexturesMaxCount", "r_ShowLightBounds", "r_ShowLines", "r_ShowNormals", "r_ShowTangents", "r_ShowTexture", "r_ShowTimeGraph", "r_ShowVideoMemoryStats", "r_SilhouettePOM", "r_SkipAlphaTested", "r_Snow", "r_SnowDisplacement", "r_SnowFlakeClusters", "r_SnowHalfRes", "r_SoftAlphaTest", "r_SonarVision", "r_ssdo", "r_ssdoAmountAmbient", "r_ssdoAmountDirect", "r_ssdoAmountReflection", "r_ssdoColorBleeding", "r_ssdoHalfRes", "r_ssdoRadius", "r_ssdoRadiusMax", "r_ssdoRadiusMin", "r_SSReflections", "r_SSReflHalfRes", "r_Stats", "r_statsMinDrawCalls", "r_StencilBits", "r_StereoDevice", "r_StereoEnableMgpu", "r_StereoEyeDist", "r_StereoFlipEyes", "r_StereoGammaAdjustment", "r_StereoHudScreenDist", "r_stereoMirrorProjection", "r_StereoMode", "r_StereoNearGeoScale", "r_StereoOutput", "r_stereoScaleCoefficient", "r_StereoScreenDist", "r_StereoStrength", "r_sunshafts", "r_Supersampling", "r_SupersamplingFilter", "r_SyncToFrameFence", "r_TessellationDebug", "r_TessellationTriangleSize", "r_TexAtlasSize", "r_TexBindMode", "r_TexelsPerMeter", "r_TexLog", "r_TexMaxAnisotropy", "r_TexMinAnisotropy", "r_TexNoAnisoAlphaTest", "r_TexNoLoad", "r_TexPostponeLoading", "r_TexPreallocateAtlases", "r_TextureCompiling", "r_TextureCompilingIndicator", "r_TextureCompressor", "r_TextureLodDistanceRatio", "r_texturesskiplowermips", "r_TexturesStreaming", "r_TexturesStreamingDebug", "r_TexturesStreamingDebugDumpIntoLog", "r_TexturesStreamingDebugFilter", "r_TexturesStreamingDebugMinMip", "r_TexturesStreamingDebugMinSize", "r_texturesstreamingDeferred", "r_TexturesStreamingDisableNoStreamDuringLoad", "r_texturesstreamingJobUpdate", "r_TexturesStreamingMaxRequestedJobs", "r_TexturesStreamingMaxRequestedMB", "r_TexturesStreamingMinReadSizeKB", "r_texturesstreamingMinUsableMips", "r_TexturesStreamingMipBias", "r_TexturesStreamingMipClampDVD", "r_TexturesStreamingMipFading", "r_TexturesStreamingNoUpload", "r_TexturesStreamingOnlyVideo", "r_TexturesStreamingPostponeMips", "r_TexturesStreamingPostponeThresholdKB", "r_texturesstreamingPostponeThresholdMip", "r_TexturesStreamingPrecacheRounds", "r_texturesstreamingSkipMips", "r_TexturesStreamingSuppress", "r_TexturesStreamingSync", "r_TexturesStreamingUpdateType", "r_TexturesStreamPoolSecondarySize", "r_TexturesStreamPoolSize", "r_ThermalVision", "r_ThermalVisionViewCloakFlickerMaxIntensity", "r_ThermalVisionViewCloakFlickerMinIntensity", "r_ThermalVisionViewCloakFrequencyPrimary", "r_ThermalVisionViewCloakFrequencySecondary", "r_ThermalVisionViewDistance", "r_transient_pool_size", "r_TransparentPasses", "r_TranspDepthFixup", "r_Unlit", "r_UpdateInstances", "r_UseDisplacementFactor", "r_UseESRAM", "r_UseHWSkinning", "r_UseMaterialLayers", "r_UseMergedPosts", "r_UsePersistentRTForModelHUD", "r_UseShadowsPool", "r_UseZPass", "r_ValidateDraw", "r_VegetationSpritesDebug", "r_VegetationSpritesGenAlways", "r_VegetationSpritesMaxLightingUpdates", "r_VegetationSpritesNoGen", "r_VegetationSpritesTexRes", "r_VisAreaClipLightsPerPixel", "r_VolumetricClouds", "r_VolumetricCloudsPipeline", "r_VolumetricCloudsRaymarchStepNum", "r_VolumetricCloudsShadowResolution", "r_VolumetricCloudsStereoReprojection", "r_VolumetricCloudsTemporalReprojection", "r_VolumetricFogDownscaledSunShadow", "r_VolumetricFogDownscaledSunShadowRatio", "r_VolumetricFogMinimumLightBulbSize", "r_VolumetricFogReprojectionBlendFactor", "r_VolumetricFogReprojectionMode", "r_VolumetricFogSample", "r_VolumetricFogShadow", "r_VolumetricFogSunLightCorrection", "r_VolumetricFogTexDepth", "r_VolumetricFogTexScale", "r_VrProjectionPreset", "r_VrProjectionType", "r_VSync", "r_WaterCaustics", "r_WaterCausticsDeferred", "r_WaterCausticsDistance", "r_WaterGodRays", "r_WaterGodRaysDistortion", "r_WaterReflections", "r_WaterReflectionsMGPU", "r_WaterReflectionsMinVisiblePixelsUpdate", "r_WaterReflectionsMinVisUpdateDistanceMul", "r_WaterReflectionsMinVisUpdateFactorMul", "r_WaterReflectionsQuality", "r_WaterReflectionsUseMinOffset", "r_WaterTessellationHW", "r_WaterUpdateDistance", "r_WaterUpdateFactor", "r_WaterUpdateThread", "r_WaterVolumeCaustics", "r_WaterVolumeCausticsDensity", "r_WaterVolumeCausticsMaxDist", "r_WaterVolumeCausticsRes", "r_WaterVolumeCausticsSnapFactor", "r_Width", "r_WindowIconTexture", "r_wireframe", "r_ZFightingDepthScale", "r_ZFightingExtrude", "r_ZPassDepthSorting", "r_ZPassOnly", "r_ZPrepassMaxDist", "rc_debugVerboseLevel", "rcon_password", "s_AudioEventPoolSize", "s_AudioImplName", "s_AudioLoggingOptions", "s_AudioObjectPoolSize", "s_AudioObjectsDebugFilter", "s_AudioObjectsRayType", "s_AudioPrimaryPoolSize", "s_AudioProxiesInitType", "s_AudioStandaloneFilePoolSize", "s_AudioTriggersDebugFilter", "s_DefaultStandaloneFilesAudioTrigger", "s_DrawAudioDebug", "s_FileCacheManagerDebugFilter", "s_FileCacheManagerSize", "s_FullObstructionMaxDistance", "s_IgnoreWindowFocus", "s_OcclusionHighDistance", "s_OcclusionMaxDistance", "s_OcclusionMaxSyncDistance", "s_OcclusionMediumDistance", "s_OcclusionRayLengthOffset", "s_PositionUpdateThreshold", "s_SDLMixerPrimaryPoolSize", "s_SDLMixerStandaloneFileExtension", "s_ShowActiveAudioObjectsOnly", "s_TickWithMainThread", "s_VelocityTrackingThreshold", "sc_DisplayCriticalErrors", "sc_EnableScriptPartitioning", "sc_EntityDebugConfig", "sc_EntityDebugFilter", "sc_EntityDebugTextPos", "sc_ExperimentalFeatures", "sc_IgnorePAKFiles", "sc_IgnoreUnderscoredFolders", "sc_LogFileMessageTypes", "sc_LogFileStreams", "sc_LogToFile", "sc_RootFolder", "sc_RunUnitTests", "sensor_Debug", "sensor_DebugRange", "STAP_DEBUG", "STAP_DISABLE", "STAP_LOCK_EFFECTOR", "STAP_OVERRIDE_TRACK_FACTOR", "STAP_TRANSLATION_FEATHER", "STAP_TRANSLATION_FUDGE", "stats_FpsBuckets", "stats_PakFile", "stats_Particles", "stats_RenderBatchStats", "stats_RenderSummary", "stats_Warnings", "sv_AISystem", "sv_autoconfigurl", "sv_bandwidth", "sv_bind", "sv_DedicatedCPUPercent", "sv_DedicatedCPUVariance", "sv_DedicatedMaxRate", "sv_dumpstats", "sv_dumpstatsperiod", "sv_gamerules", "sv_gamerulesdefault", "sv_lanonly", "sv_levelrotation", "sv_LoadAllLayersForResList", "sv_map", "sv_maxmemoryusage", "sv_maxplayers", "sv_maxspectators", "sv_packetRate", "sv_password", "sv_port", "sv_ranked", "sv_requireinputdevice", "sv_servername", "sv_timeofdayenable", "sv_timeofdaylength", "sv_timeofdaystart", "sv_timeout_disconnect", "sw_debugInfo", "sw_draw_bbox", "sw_gridSize", "sys_affinity", "sys_AI", "sys_asserts", "sys_audio_disable", "sys_bp_frames", "sys_bp_frames_threshold", "sys_bp_time_threshold", "sys_budget_frametime", "sys_budget_numdrawcalls", "sys_budget_numpolys", "sys_budget_soundchannels", "sys_budget_soundCPU", "sys_budget_soundmem", "sys_budget_streamingthroughput", "sys_budget_sysmem", "sys_budget_videomem", "sys_build_folder", "sys_crashrpt", "sys_crashrpt_appname", "sys_crashrpt_appversion", "sys_crashrpt_email", "sys_crashrpt_privacypolicy", "sys_crashrpt_server", "sys_DeactivateConsole", "sys_deferAudioUpdateOptim", "sys_display_threads", "sys_dll_ai", "sys_dll_game", "sys_dll_response_system", "sys_dump_aux_threads", "sys_dump_type", "sys_enable_budgetmonitoring", "sys_enable_crash_handler", "sys_entities", "sys_error_debugbreak", "sys_filesystemCaseSensitivity", "sys_firstlaunch", "sys_flash", "sys_flash_address_space", "sys_flash_allow_reset_mesh_cache", "sys_flash_check_filemodtime", "sys_flash_curve_tess_error", "sys_flash_debugdraw", "sys_flash_debugdraw_depth", "sys_flash_debuglog", "sys_flash_edgeaa", "sys_flash_info", "sys_flash_info_histo_scale", "sys_flash_info_peak_exclude", "sys_flash_info_peak_tolerance", "sys_flash_log_options", "sys_flash_reset_mesh_cache", "sys_flash_static_pool_size", "sys_flash_stereo_maxparallax", "sys_flash_use_arenas", "sys_flash_video_soundvolume", "sys_flash_video_subaudiovolume", "sys_flash_warning_level", "sys_float_exceptions", "sys_force_installtohdd_mode", "sys_game_folder", "sys_game_name", "sys_highrestimer", "sys_ime", "sys_initpreloadpacks", "sys_intromoviesduringinit", "sys_job_system_enable", "sys_job_system_filter", "sys_job_system_max_worker", "sys_job_system_profiler", "sys_keyboard", "sys_keyboard_break", "sys_limit_phys_thread_count", "sys_livecreate", "sys_LoadFrontendShaderCache", "sys_localization_debug", "sys_localization_encode", "sys_localization_folder", "sys_LocalMemoryDiagramAlpha", "sys_LocalMemoryDiagramDistance", "sys_LocalMemoryDiagramRadius", "sys_LocalMemoryDiagramStreamingSpeedDistance", "sys_LocalMemoryDiagramStreamingSpeedRadius", "sys_LocalMemoryDiagramWidth", "sys_LocalMemoryDrawText", "sys_LocalMemoryGeometryLimit", "sys_LocalMemoryGeometryStreamingSpeedLimit", "sys_LocalMemoryInnerViewDistance", "sys_LocalMemoryLogText", "sys_LocalMemoryMaxMSecBetweenCalls", "sys_LocalMemoryObjectAlpha", "sys_LocalMemoryObjectHeight", "sys_LocalMemoryObjectWidth", "sys_LocalMemoryOptimalMSecPerSec", "sys_LocalMemoryOuterViewDistance", "sys_LocalMemoryStreamingSpeedObjectLength", "sys_LocalMemoryStreamingSpeedObjectWidth", "sys_LocalMemoryTextureLimit", "sys_LocalMemoryTextureStreamingSpeedLimit", "sys_LocalMemoryWarningRatio", "sys_log_asserts", "sys_logallocations", "sys_max_step", "sys_MaxFPS", "sys_maxTimeStepForMovieSystem", "sys_memory_debug", "sys_MemoryDeadListSize", "sys_menupreloadpacks", "sys_min_step", "sys_no_crash_dialog", "sys_noupdate", "sys_PakDisableNonLevelRelatedPaks", "sys_PakInMemorySizeLimit", "sys_PakLoadCache", "sys_PakLoadModePaks", "sys_PakLogAllFileAccess", "sys_PakLogInvalidFileAccess", "sys_PakLogMissingFiles", "sys_PakMessageInvalidFileAccess", "sys_PakPriority", "sys_PakReadSlice", "sys_PakSaveFastLoadResourceList", "sys_PakSaveLevelResourceList", "sys_PakSaveMenuCommonResourceList", "sys_PakSaveTotalResourceList", "sys_PakStreamCache", "sys_PakTotalInMemorySizeLimit", "sys_PakValidateFileHash", "sys_perfhud", "sys_perfhud_fpsBucketsExclusive", "sys_perfhud_pause", "sys_physics", "sys_physics_enable_MT", "sys_preload", "sys_ProfileLevelLoading", "sys_ProfileLevelLoadingDump", "sys_rendersplashscreen", "sys_resource_cache_folder", "sys_root", "sys_scale3DMouseTranslation", "sys_Scale3DMouseYPR", "sys_screensaver_allowed", "sys_simple_http_base_port", "sys_SimulateTask", "sys_spec", "sys_spec_full", "sys_spec_gameeffects", "sys_spec_light", "sys_spec_objectdetail", "sys_spec_particles", "sys_spec_physics", "sys_spec_postprocessing", "sys_spec_quality", "sys_spec_shading", "sys_spec_shadows", "sys_spec_sound", "sys_spec_texture", "sys_spec_textureresolution", "sys_spec_volumetriceffects", "sys_spec_water", "sys_SSInfo", "sys_streaming_debug", "sys_streaming_debug_filter", "sys_streaming_debug_filter_file_name", "sys_streaming_debug_filter_min_time", "sys_streaming_in_blocks", "sys_streaming_max_bandwidth", "sys_streaming_max_finalize_per_frame", "sys_streaming_memory_budget", "sys_streaming_requests_grouping_time_period", "sys_streaming_resetstats", "sys_streaming_use_optical_drive_thread", "sys_target_platforms", "sys_trackview", "sys_UncachedStreamReads", "sys_update_profile_time", "sys_use_mono", "sys_usePlatformSavingAPI", "sys_usePlatformSavingAPIEncryption", "sys_user_folder", "sys_UserAnalyticsCollect", "sys_UserAnalyticsLogging", "sys_UserAnalyticsServerAddress", "sys_version", "sys_vr_support", "sys_vtune", "sys_warnings", "sys_WER", "t_Debug", "t_FixedStep", "t_MaxStep", "t_Scale", "t_Smoothing", "v_autoDisable", "v_clientPredict", "v_clientPredictAdditionalTime", "v_clientPredictMaxTime", "v_clientPredictSmoothing", "v_clientPredictSmoothingConst", "v_debug_flip_over", "v_debug_mem", "v_debug_reorient", "v_debugCollisionDamage", "v_debugdraw", "v_debugSuspensionIK", "v_debugVehicle", "v_debugViewAbove", "v_debugViewAboveH", "v_debugViewDetach", "v_disable_hull", "v_disableEntry", "v_draw_components", "v_draw_helpers", "v_draw_passengers", "v_draw_seats", "v_draw_tm", "v_driverControlledMountedGuns", "v_enableMannequin", "v_FlippedExplosionPlayerMinDistance", "v_FlippedExplosionRetryTimeMS", "v_FlippedExplosionTimeToExplode", "v_goliathMode", "v_independentMountedGuns", "v_lights", "v_lights_enable_always", "v_playerTransitions", "v_ragdollPassengers", "v_serverControlled", "v_set_passenger_tm", "v_show_all", "v_slipFrictionModFront", "v_slipFrictionModRear", "v_slipSlopeFront", "v_slipSlopeRear", "v_staticTreadDeform", "v_testClientPredict", "v_transitionAnimations", "v_vehicle_quality" ] }, "commands": { "$id": "/definitions/commands", "type": "string", "title": "Command name", "description": "Console command name", "default": "", "enum": [ "_TestFormatMessage", "ai_CheckGoalpipes", "ai_commTest", "ai_commTestStop", "ai_DebugAgent", "ai_debugMNMAgentType", "ai_dumpCheckpoints", "ai_MNMCalculateAccessibility", "ai_MNMComputeConnectedIslands", "ai_NavigationReloadConfig", "ai_Recorder_Start", "ai_Recorder_Stop", "ai_reload", "ai_resetCommStats", "ai_writeCommStats", "audit_cvars", "ban", "ban_remove", "ban_status", "Bind", "ca_DebugText", "ca_DefaultTransitionInterpolationType", "connect", "connect_repeatedly", "ConsoleHide", "ConsoleShow", "demo", "demo_StartDemoChain", "demo_StartDemoLevel", "disconnect", "disconnectchannel", "drs_sendSignal", "ds_Dump", "ds_DumpSessions", "ds_Reload", "dump_action_maps", "dump_maps", "dump_stats", "DumpCommandsVars", "DumpVars", "e_DebugDrawListCMD", "e_ParticleListEffects", "e_ParticleListEmitters", "e_ParticleMemory", "e_ReloadSurfaces", "e_StatoscopeAddUserMarker", "ed_disable_game_mode", "ed_goto", "ed_killmemory", "ed_randomize_variations", "eqp_DumpPacks", "es_AudioListenerOffset", "es_compile_area_grid", "es_debugAnim", "es_dump_entities", "es_dump_entity_classes_in_use", "exec", "ffs_PlayEffect", "ffs_Reload", "ffs_StopAllEffects", "fg_InspectAction", "fg_InspectEntity", "fg_Inspector", "fg_reloadClasses", "fg_writeDocumentation", "g_dump_stats", "g_dumpClassRegistry", "g_saveLoadDumpEntity", "gamedata_playback", "gamedata_record", "gamedata_stop_record_or_playback", "gfx_reload_all", "gt_AddToDebugList", "gt_RemoveFromDebugList", "hmd_recenter_pose", "http_startserver", "http_stopserver", "i_dropitem", "i_giveallitems", "i_giveammo", "i_givedebugitems", "i_giveitem", "i_listitems", "i_reloadActionMaps", "i_saveweaponposition", "kick", "kickid", "load", "LoadConfig", "LocalizationDumpLoadedInfo", "lua_debugger_show", "lua_dump_coverage", "lua_dump_state", "lua_garbagecollect", "lua_reload_script", "map", "memDumpAllocs", "memReplayAddSizerTree", "memReplayDumpSymbols", "memReplayInfo", "memReplayLabel", "memReplayPause", "memReplayResume", "memReplayStop", "memResetAllocs", "mfx_Reload", "mfx_ReloadFGEffects", "mn_DebugAI", "mn_listAssets", "mn_reload", "mono_reload", "mov_goToFrameEditor", "net_dump_object_state", "net_DumpMessageApproximations", "net_getChannelPerformanceMetrics", "net_netMsgDispatcherClearStats", "net_pb_cl_enable", "net_pb_sv_enable", "net_set_cdkey", "net_setChannelPerformanceMetrics", "open_url", "osm_setFBScale", "play", "py", "q_Quality", "r_ColorGradingChartImage", "r_DumpFontNames", "r_DumpFontTexture", "r_getposteffectparamf", "r_OptimiseShaders", "r_OverscanBorders", "r_PrecacheShaderList", "r_setposteffectparamf", "r_ShowRenderTarget", "r_StatsShaderList", "rcon_command", "rcon_connect", "rcon_disconnect", "rcon_startserver", "rcon_stopserver", "readabilityReload", "record", "RecordClip", "ReloadDialogData", "RunUnitTests", "s_ExecuteTrigger", "s_SetRtpc", "s_SetSwitchState", "s_StopTrigger", "save", "save_genstrings", "SaveLevelStats", "sc_CriticalError", "sc_FatalError", "sc_rpcShow", "sc_SaveAllScriptFiles", "Screenshot", "sensor_SetOctreeBounds", "sensor_SetOctreeDepth", "so_reload", "status", "stopdemo", "stoprecording", "sys_crashrpt_generate", "sys_crashtest", "sys_crashtest_thread", "sys_job_system_dump_job_list", "sys_LvlRes_finalstep", "sys_LvlRes_findunused", "sys_reload_plugin", "sys_RestoreSpec", "sys_StroboscopeDumpResults", "sys_StroboscopeStart", "sys_StroboscopeStop", "sys_threads_dump_thread_config_list", "test_delegate", "test_playersBounds", "test_profile", "test_reset", "unload", "v_dump_classes", "v_exit_player", "v_reload_system", "version", "VisRegTest", "voice_mute", "wait_frames", "wait_seconds" ] } }, "id": "https://json.schemastore.org/cryproj.53.schema", "properties": { "console_variables": { "$id": "/properties/console_variables", "type": "array", "uniqueItems": true, "items": { "$id": "/properties/console_variables/items", "type": "object", "properties": { "name": { "$id": "/properties/console_variables/items/properties/name", "$ref": "#/definitions/cvars" }, "value": { "$id": "/properties/console_variables/items/properties/value", "type": "string", "title": "Value of the CVar", "description": "The default value of the CVar", "default": "pc,ps4,xboxone,linux" } }, "required": ["name", "value"] } }, "content": { "$id": "/properties/content", "type": "object", "properties": { "assets": { "$id": "/properties/content/properties/assets", "type": "array", "items": { "$id": "/properties/content/properties/assets/items", "type": "string", "title": "Assets folder", "description": "This indicates where the assets are stored", "default": "Assets", "examples": ["Assets"] } }, "code": { "$id": "/properties/content/properties/code", "type": "array", "items": { "$id": "/properties/content/properties/code/items", "type": "string", "title": "Code folder", "description": "This indicates where the code is stored", "default": "Code", "examples": ["Code"] } }, "libs": { "$id": "/properties/content/properties/libs", "type": "array", "items": { "$id": "/properties/content/properties/libs/items", "type": "object", "properties": { "name": { "$id": "/properties/content/properties/libs/items/properties/name", "type": "string", "title": "Lib's name", "default": "", "examples": ["Blank"] }, "shared": { "$id": "/properties/content/properties/libs/items/properties/shared", "type": "object", "properties": { "any": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/any", "type": "string", "title": "Lib's name to import for all the supported platforms", "default": "", "examples": ["CryGameSDK"] }, "win_x64": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x64", "type": "string", "title": "Lib's name to import for the win_x64 platform", "default": "", "examples": ["bin/win_x64/Game.dll"] }, "win_x86": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x86", "type": "string", "title": "Lib's name to import for the win_x86 platform", "default": "", "examples": ["bin/win_x86/Game.dll"] } } } } } } }, "required": ["code"] }, "info": { "$id": "/properties/info", "type": "object", "properties": { "name": { "$id": "/properties/info/properties/name", "type": "string", "title": "Project name", "description": "This indicates the project name", "default": "", "examples": ["MyFancyProject"] }, "guid": { "$id": "/properties/info/properties/guid", "type": "string", "title": "Project GUID", "default": "", "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" } }, "required": ["name"] }, "require": { "$id": "/properties/require", "type": "object", "properties": { "engine": { "$id": "/properties/require/properties/engine", "type": "string", "title": "Engine version", "description": "This indicates which engine version will be used", "default": "", "examples": ["engine-5.4"], "enum": ["engine-5.3"] }, "plugins": { "$id": "/properties/require/properties/plugins", "type": "array", "items": { "$id": "/properties/require/properties/plugins/items", "type": "object", "properties": { "path": { "$id": "/properties/require/properties/plugins/items/properties/path", "type": "string", "title": "Plugin name", "description": "Required plugin's name", "examples": [ "CryDefaultEntities", "CrySensorSystem", "CryPerceptionSystem", "CryUserAnalytics", "CryOSVR", "CryOculusVR", "CryOpenVR", "CryLobby" ] }, "type": { "$id": "/properties/require/properties/plugins/items/properties/type", "type": "string", "title": "Plugin type", "description": "EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one", "default": "", "examples": ["EPluginType::Native", "EPluginType::Managed"], "enum": ["EPluginType::Native", "EPluginType::Managed"] }, "platforms": { "$id": "/properties/plugins/items/properties/platforms", "type": "array", "items": { "$id": "/properties/plugins/items/properties/platforms/items", "type": "string", "title": "This plugin will be used only by these platforms", "default": "", "examples": ["PS4"], "enum": ["pc", "ps4", "xboxone", "linux"] } } }, "required": ["path", "type"] } } }, "required": ["engine"] }, "type": { "$id": "/properties/type", "type": "string", "title": "", "default": "", "examples": [""] }, "version": { "$id": "/properties/version", "type": "integer", "title": "Project version", "default": 1, "examples": [1] }, "console_commands": { "$id": "/properties/console_commands", "type": "array", "uniqueItems": true, "items": { "$id": "/properties/console_commands/items", "type": "object", "properties": { "name": { "$id": "/properties/console_commands/items/properties/name", "$ref": "#/definitions/commands" }, "value": { "$id": "/properties/console_commands/items/properties/value", "type": "string", "title": "Value of the command", "description": "Arguments that has to be passed to the command. Leave empty if it has not parameters", "default": "" } }, "required": ["name", "value"] } } }, "required": ["content", "info", "require", "version"], "title": "CryProj schema", "type": "object" }

vars.json

{ "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/vars.json", "$schema": "http://json-schema.org/draft-07/schema", "anyOf": [ { "additionalProperties": false, "patternProperties": { "^(?!(False|None|True|and|any_errors_fatal|as|assert|async|await|become|become_exe|become_flags|become_method|become_user|break|check_mode|class|collections|connection|continue|debugger|def|del|diff|elif|else|environment|except|fact_path|finally|for|force_handlers|from|gather_facts|gather_subset|gather_timeout|global|handlers|hosts|if|ignore_errors|ignore_unreachable|import|in|is|lambda|max_fail_percentage|module_defaults|name|no_log|nonlocal|not|or|order|pass|port|post_tasks|pre_tasks|raise|remote_user|return|roles|run_once|serial|strategy|tags|tasks|throttle|timeout|try|vars|vars_files|vars_prompt|while|with|yield)$)[a-zA-Z_][\\w]*$": {} }, "type": "object" }, { "pattern": "^\\$ANSIBLE_VAULT;", "type": "string" }, { "type": "null" } ], "examples": [ "playbooks/vars/*.yml", "vars/*.yml", "defaults/*.yml", "host_vars/*.yml", "group_vars/*.yml" ], "markdownDescription": "See [Using Variables](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html)", "title": "Ansible Vars Schema" }

mtad.json

{ "$id": "http://example.com/MTA/mtad.yaml", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "generic-memory": { "type": "string", "pattern": "^[1-9][0-9]*(M|MB|G|GB|m|mb|g|gb)$" }, "module-type": { "type": "string", "anyOf": [ { "enum": [ "application", "binary", "business-logging", "com.sap.application.content", "com.sap.html5.application-content", "com.sap.portal.site-content", "com.sap.xs.hdi", "com.sap.xs.hdi-dynamic", "custom", "dotnet_core", "go", "java", "java.tomcat", "java.tomee", "javascript.nodejs", "nodejs", "php", "python", "ruby", "staticfile" ] }, { "type": "string" } ] }, "module-parameters": { "type": "object", "properties": { "app-name": { "description": "The name of the application in the Cloud Foundry environment to be deployed for this module, based on the module name.", "type": "string" }, "buildpack": { "description": "The name or the URL of a custom buildpack required by the application.", "type": "string" }, "buildpacks": { "description": "An array of buildpacks. If a buildpack parameter already exists, it will be overwritten by the buildpacks listed in the buildpacks parameter, so that you have to include it in the array.", "$ref": "#/definitions/module-parameters-buildpacks" }, "command": { "description": "A custom command required to start the application.", "type": "string" }, "create-service-broker": { "description": "Specifies whether [true|false] a service broker should be registered for the application module; default value is: false.", "type": "boolean" }, "dependency-type": { "description": "Defines the memory allocated to the application.", "type": "string", "enum": ["hard", "soft"] }, "disk-quota": { "description": "The disk space that will be available to the application. This parameter requires a unit of measurement M, MB, G, or GB in upper or lower case.", "$ref": "#/definitions/generic-memory" }, "docker": { "description": "Creates a module from a docker image. When using a docker image parameter, we do not need to specify the module in the MANIFEST.mf file.When uploading a docker image, the content of a module is not needed.", "$ref": "#/definitions/module-parameters-docker" }, "domain": { "description": "The domain on which the application will be available later.", "type": "string" }, "domains": { "description": "The domains on which the application will be available later. The resulting application routes will be the Cartesian product of the domains and hosts. That is, a separate route for each host is constructed on each domain.", "$ref": "#/definitions/module-parameters-domains" }, "enable-ssh": { "description": "Enables use of SSH within an application. Supported for the Diego container runtime environment only.", "type": "boolean" }, "health-check-type": { "description": "Defines how the module will be monitored for availability.", "type": "string", "enum": ["port", "process", "http"] }, "health-check-timeout": { "description": "The timeout is the amount of time (in seconds) allowed to elapse between starting up an app and the first healthy response.", "type": "integer" }, "health-check-invocation-timeout": { "description": "The timeout in seconds for individual health check requests for http and port health checks.", "type": "integer" }, "health-check-http-endpoint": { "description": "A http health check defaults to using '/' as its endpoint, but you can specify a custom endpoint.", "type": "string", "pattern": "^/.+" }, "host": { "description": "The hostname or subdomain where an application is available later.", "type": "string" }, "hosts": { "description": "The hostnames or subdomain where an application is available later.", "$ref": "#/definitions/module-parameters-hosts" }, "idle-domain": { "description": "The idle domain on which the idle application will be available during blue-green deploy.", "type": "string" }, "idle-domains": { "description": "The domains on which the idle application will be available during blue-green deploy. The resulting application routes will be the Cartesian product of the domains and hosts. That is, a separate route for each host is constructed on each domain.", "$ref": "#/definitions/module-parameters-domains" }, "idle-host": { "description": "The hostname or subdomain where the idle application will be available during blue-green deploy.", "type": "string" }, "idle-hosts": { "description": "The hostnames or subdomain where the idle application will be available during blue-green deploy.", "$ref": "#/definitions/module-parameters-hosts" }, "instances": { "description": "The number of application instances that will be started during the deployment.", "type": "number", "minimum": 0 }, "keep-existing": { "description": "Defines the application attributes which will be kept after the deployment or blue-green deployment has finished. The supported attributes which could be kept are application environment, application bindings and application routes. If not specified, the default values are false, which indicates that each application attribute will be updated with the new values presented in the deployment descriptor.", "$ref": "#/definitions/module-parameters-keep-existing" }, "keep-existing-routes": { "description": "When specified on module level, it indicates if the existing routes of the module's corresponding application should be kept even if they are not defined within the deployment and/or extension descriptors.When specified on global level, under the parameters section of the descriptor, it indicates if the existing routes of all applications within that MTA should be kept.The module-level variant of the parameter has priority over the global parameter.This parameter is typically used when users want to keep the routes they have mapped manually by using the cf map-route command. We discourage this approach, as manual operations could lead to inconsistent deployment results and difficult troubleshooting. We recommend you to define all routes in the deployment and/or extension descriptors, which allows for their automatic management.", "type": "boolean" }, "memory": { "description": "Defines the memory allocated to the application.", "$ref": "#/definitions/generic-memory" }, "no-route": { "description": "Defines if a route should be assigned to the application.", "type": "boolean" }, "no-start": { "description": "Start/do not start the application during deployment. This parameter setting overrides the command-line option --no-start. If you explicitly set the no-start to false for the module foo in the example provided, then the module foo is started on deployment, even if you also specify the command-line option --no-start with the cf deploy command.", "type": "boolean" }, "restart-on-env-change": { "description": "Specifies whether an application should be restarted if an environment variable has been changed in one of the following categories: vcap-application, vcap-services, user-provided. If you set these parameters to false, the changes in environment are not consumable by a running instances of the application. If your application depends on the latest environment, it might become outdated.", "$ref": "#/definitions/module-parameters-restart-on-env-change" }, "routes": { "description": "A parameter that lists multiple HTTP routes. It is a combination of the old parameters host, domain, port and route-path, which encompasses the full addresses to which to bind a module. In case the new routes parameter and the old ones are available, the routes value is used and the values of the old parameters are ignored. Each route for the application is created if it does not already exist. A routes parameter consists of one or many HTTP routes following the pattern myhost.my.domain/path", "$ref": "#/definitions/module-parameters-routes" }, "service-broker-name": { "description": "The name of the service broker in the Cloud Foundry environment to be created and registered for the specified application module.", "type": "string" }, "service-broker-password": { "description": "The password used for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true.", "type": "string" }, "service-broker-space-scoped": { "description": "Makes the service plans of the broker visible only within the targeted space.", "type": "boolean" }, "service-broker-url": { "description": "Specifies the value of the service broker universal resource locator (URL) to register; service requests are sent to this URL. The parameter is mandatory if create-service-broker: true.", "type": "string" }, "service-broker-user": { "description": "The name of the user required for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true.", "type": "string" }, "stack": { "description": "Use this parameter to define which prebuilt root file system (rootfs) you want to use.", "type": "string" }, "tasks": { "description": "Specify tasks, which are available for execution in the current droplet of the application. Also provide use of environment variables which are specified with the env scope.", "$ref": "#/definitions/module-parameters-tasks" }, "upload-timeout": { "description": "The application upload timeout in seconds.", "type": "number", "minimum": 0 } } }, "module-parameters-buildpacks": { "type": "array", "items": { "type": "string" } }, "module-parameters-domains": { "type": "array", "items": { "type": "string" } }, "module-parameters-hosts": { "type": "array", "items": { "type": "string" } }, "module-parameters-routes": { "type": "array", "items": { "type": "object", "required": ["route"], "properties": { "route": { "type": "string" } } } }, "module-parameters-tasks": { "type": "array", "items": { "type": "object", "required": ["name", "command"], "properties": { "name": { "description": "The task name.", "type": "string" }, "command": { "description": "The command to be executed.", "type": "string" }, "memory": { "description": "Defines the memory that is available to the Cloud Foundry task.", "$ref": "#/definitions/generic-memory" }, "disk-quota": { "description": "Defines the disk space that is available to the Cloud Foundry task.", "$ref": "#/definitions/generic-memory" } } } }, "module-parameters-docker": { "type": "object", "properties": { "image": { "description": "An image parameter is a docker image from the Docker Hub or somewhere else. eg. cloudfoundry/test-app", "type": "string" }, "username": { "description": "The username is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.", "type": "string" }, "password": { "description": "The password is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.", "type": "string" } } }, "module-parameters-keep-existing": { "type": "object", "properties": { "env": { "description": "Keep the existing environment", "type": "boolean" }, "service-bindings": { "description": "Keep the existing Service bindings", "type": "boolean" }, "routes": { "description": "Keep the existing routes", "type": "boolean" } } }, "module-parameters-restart-on-env-change": { "type": "array", "items": { "properties": { "vcap-application": { "description": "Restart on vcap-application env change", "type": "boolean" }, "vcap-services": { "description": "Restart on vcap-services env change", "type": "boolean" }, "user-provided": { "description": "Restart on user-provided env change", "type": "boolean" } } } }, "module-requires": { "type": "array", "items": { "type": "object", "required": ["name"], "properties": { "name": { "description": "An MTA internal name which must match either a provided name, a resource name, or a module name within the same MTA.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "list": { "description": "All required and found configuration data sets will be assembled into a JSON array and provided to the module by the lookup name as specified by the value of 'list'.", "type": "string" }, "properties": { "description": "Required properties can be mapped from provided properties. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string", "type": "object" }, "properties-metadata": { "description": "Additional information about the required dependency's properties.", "$ref": "#/definitions/properties-metadata" }, "parameters": { "description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the module at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string", "$ref": "#/definitions/module-requires-parameters" }, "parameters-metadata": { "description": "Additional information about the required dependency's parameters.", "$ref": "#/definitions/properties-metadata" } } } }, "module-requires-parameters": { "type": "object", "properties": { "content-target": { "description": "Specify that the resource would be used as a target for the module content deployment.", "type": "boolean" } } }, "module-provides": { "type": "array", "items": { "type": "object", "required": ["name"], "properties": { "name": { "description": "An MTA internal name which can used by a requiring module.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "public": { "description": "Indicates, that the provided properties shall be made publicly available by the deployer. Default value is false.", "type": "boolean" }, "properties": { "description": "Property names and values make up the configuration data which is to be provided to requiring modules at runtime", "type": "object" }, "properties-metadata": { "description": "Additional information about the provided dependency's properties.", "$ref": "#/definitions/properties-metadata" }, "parameters": { "description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the module at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string", "$ref": "#/definitions/module-provides-parameters" }, "parameters-metadata": { "description": "Additional information about the provided dependency's parameters.", "$ref": "#/definitions/properties-metadata" } } } }, "module-provides-parameters": { "type": "object", "properties": { "visibility": { "type": "array", "items": { "$ref": "#/definitions/resource-configuration-target" } } } }, "resource-type": { "type": "string", "anyOf": [ { "enum": [ "org.cloudfoundry.managed-service", "org.cloudfoundry.existing-service", "org.cloudfoundry.existing-service-key", "org.cloudfoundry.user-provided-service", "configuration" ] }, { "type": "string" } ] }, "resource-requires": { "type": "array", "items": { "type": "object", "required": ["name"], "properties": { "name": { "description": "An MTA internal name which must match either a provided name, or a resource name within the same MTA.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "properties": { "description": "Required properties can be mapped from provided properties. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string", "type": "object" }, "properties-metadata": { "description": "Additional information about the required dependency's properties.", "$ref": "#/definitions/properties-metadata" }, "parameters": { "description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the resource at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string", "type": "object" }, "parameters-metadata": { "description": "Additional information about the required dependency's parameters.", "$ref": "#/definitions/properties-metadata" } } } }, "resource-parameters": { "type": "object", "properties": { "service": { "description": "Name of the service to create.", "type": "string", "anyOf": [ { "enum": [ "application-logs", "auditlog", "rabbitmq", "autoscaler", "portal-services", "fs-storage", "hana", "jobscheduler", "xsuaa", "connectivity", "destination", "feature-flags", "redis", "ml-foundation-services", "mongodb", "objectstore", "postgresql" ] }, { "type": "string" } ] }, "service-key-name": { "description": "Used when consuming an existing service key. Specifies the name of the service key. See Consumption of existing service keys for more information.", "type": "string" }, "service-name": { "description": "Service instance name. Default value is the resource name.", "type": "string" }, "service-broker": { "description": "The name of the service broker to be used.", "type": "string" }, "service-plan": { "description": "Name of the service plan to be used.", "type": "string" }, "service-tags": { "description": "Some services employ a list of custom tags, which provide an easier way for applications to parse <VCAP_SERVICES> for credentials. You can provide custom tags when creating a service instance. For more information, see Service Tags.", "type": "array", "items": { "type": "string" } }, "siteId": { "description": "A globally unique ID (GUID) for your Fiori LaunchPad site.", "type": "string" }, "config": { "description": "Map value, containing the service creation configuration, for example, url and user credentials (user and password).", "type": "object" }, "syslog-drain-url": { "description": "URL to which logs for bound applications are streamed.", "type": "string" }, "skip-service-updates": { "description": "Map value, containing the service components (parameters, plan, tags) to skip when updating a service.", "$ref": "#/definitions/resource-skip-service-updates" }, "provider-nid": { "description": "When used for cross-MTA dependency resolution the provider-nid is always 'mta'.", "type": "string", "enum": ["mta"] }, "provider-id": { "description": "The resource from the provider MTA <mta-id>:<mta-provides-dependency-name>.", "type": "string" }, "version": { "description": "The version of the provider MTA.", "type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(-(0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(\\.(0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\\+[0-9a-zA-Z-]+(\\.[0-9a-zA-Z-]+)*)?$" }, "target": { "description": "The name of the organization and space in which the provider MTA is deployed.", "$ref": "#/definitions/resource-configuration-target" } } }, "resource-skip-service-updates": { "type": "object", "properties": { "parameters": { "description": "The configuration parameters which will be passed to the service broker.", "type": "boolean" }, "plan": { "description": "The service plan.", "type": "boolean" }, "tags": { "description": "The custom tags for a service instance.", "type": "boolean" }, "syslog-drain-url": { "description": "URL to which logs for bound applications are streamed.", "type": "boolean" } } }, "resource-configuration-target": { "type": "object", "properties": { "org": { "description": "The org in which the configuration will be looked for", "type": "string" }, "space": { "description": "The space in which the configuration will be looked for", "type": "string" } } }, "properties-metadata": { "type": "object", "additionalProperties": { "type": "object", "properties": { "overwritable": { "description": "Default value is true.", "type": "boolean" }, "optional": { "description": "Default value is false.", "type": "boolean" } } } }, "hooks": { "type": "array", "items": { "type": "object", "required": ["name", "type"], "properties": { "name": { "description": "An internal name which can be used for documentation purposes and shown by the deployer.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "type": { "description": "Defines the type of action that should be executed by the deployer.", "type": "string", "default": "task", "enum": ["task"] }, "phases": { "description": "A list of strings that define the points at which the hook must be executed.", "type": "array", "items": { "type": "string", "enum": [ "application.before-stop.live", "application.before-stop.idle", "application.after-stop.live", "application.after-stop.idle", "application.before-unmap-routes", "deploy.application.before-stop", "blue-green.application.before-stop.idle", "blue-green.application.before-stop.live", "deploy.application.after-stop", "blue-green.application.after-stop.idle", "blue-green.application.after-stop.live", "deploy.application.before-unmap-routes", "blue-green.application.before-unmap-routes.live", "blue-green.application.before-unmap-routes.idle", "deploy.application.before-start", "blue-green.application.before-start.idle", "blue-green.application.before-start.live" ] } }, "parameters": { "description": "Configuration parameters that are used when executing the hook to the target runtime environment.", "$ref": "#/definitions/hooks-parameters" }, "parameters-metadata": { "description": "Additional information about the hook's parameters.", "$ref": "#/definitions/properties-metadata" }, "requires": { "description": "List of names either matching a resource name or a provided dependency name provided within the same MTA that are required by this hook.", "type": "array", "items": { "type": "object", "required": ["name"], "properties": { "name": { "description": "An MTA internal name which must match either a provided name, or a resource name within the same MTA.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "parameters": { "description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the hook at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string", "type": "object" }, "parameters-metadata": { "description": "Additional information about the hook's parameters.", "$ref": "#/definitions/properties-metadata" } } } } } } }, "hooks-parameters": { "type": "object", "required": ["command"], "properties": { "name": { "description": "Defines the name of the Cloud Foundry task that should be executed.", "type": "string" }, "command": { "description": "Defines the actual command that is executed as a Cloud Foundry task.", "type": "string" }, "memory": { "description": "Defines the memory that is available to the Cloud Foundry task.", "$ref": "#/definitions/generic-memory" }, "disk-quota": { "description": "Defines the disk space that is available to the Cloud Foundry task.", "$ref": "#/definitions/generic-memory" } } } }, "description": "MTA deployment descriptor schema v3.3. Contains Cloud Foundry specific types and parameters.", "properties": { "_schema-version": { "description": "Used to indicate to an MTA processing tool (e.g. a deployer), which schema version was taken as the base when authoring a descriptor.", "type": "string", "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)$", "default": "3.3.0" }, "ID": { "description": "A globally unique ID of this MTA. Unlimited string of unicode characters.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "version": { "description": "Application version. Shall follow the semantic versioning standard.", "type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(-(0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(\\.(0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\\+[0-9a-zA-Z-]+(\\.[0-9a-zA-Z-]+)*)?$" }, "description": { "description": "A non-translatable description of this MTA. This is not a text for application users.", "type": "string" }, "provider": { "description": "The provider or vendor of this software.", "type": "string" }, "copyright": { "description": "A copyright statement from the provider.", "type": "string" }, "parameters": { "description": "Global parameters related to the MTA application.", "type": "object" }, "parameters-metadata": { "description": "Additional information about the MTA's parameters.", "$ref": "#/definitions/properties-metadata" }, "hooks": { "description": "A list of hooks that will be executed for the MTA.", "$ref": "#/definitions/hooks" }, "modules": { "description": "A list of modules to be deployed by the MTA application.", "type": "array", "items": { "type": "object", "required": ["name", "type"], "properties": { "name": { "description": "The module name which must be unique and cannot be the same as any provided property set or resource name.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "type": { "description": "The module type that defines the design-time tools for the module.", "$ref": "#/definitions/module-type" }, "description": { "description": "A free text describing this module.", "type": "string" }, "path": { "description": "The path to a folder that contains the module artifacts.", "type": "string" }, "deployed-after": { "description": "A list containing the names of the modules that must be deployed prior to this one.", "type": "array", "items": { "type": "string" } }, "properties": { "description": "A collection of key-value pairs that are available to the module at runtime.", "type": "object" }, "properties-metadata": { "description": "Additional information about the module's properties.", "$ref": "#/definitions/properties-metadata" }, "parameters": { "description": "Configuration parameters that are used when deploying the module to the target runtime environment.", "$ref": "#/definitions/module-parameters" }, "parameters-metadata": { "description": "Additional information about the module's parameters.", "$ref": "#/definitions/properties-metadata" }, "hooks": { "description": "A list of hooks that will be executed for the module.", "$ref": "#/definitions/hooks" }, "requires": { "description": "List of names either matching a resource name or a name provided by another module within the same MTA that are required by this module.", "$ref": "#/definitions/module-requires" }, "provides": { "description": "List of provided names (MTA internal) to which properties can be attached", "$ref": "#/definitions/module-provides" } } } }, "resources": { "description": "A list of resources to be deployed by the MTA application.", "type": "array", "items": { "type": "object", "required": ["name"], "properties": { "name": { "description": "The resource name which must be unique and cannot be the same as any provided property set or resource name.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "type": { "description": "The resource type that defines the design-time tools for the resource.", "$ref": "#/definitions/resource-type" }, "active": { "description": "If a resource is declared to be active, it is allocated and bound according to declared requirements. Default value is true.", "type": "boolean" }, "optional": { "description": "A resource can be declared to be optional, if the MTA can compensate for its non-existence. Default value is false.", "type": "boolean" }, "description": { "description": "A free text describing this resource.", "type": "string" }, "processed-after": { "description": "A list containing the names of the resources that must be processed prior to this one.", "type": "array", "items": { "type": "string" } }, "properties": { "description": "Property names and values make up the configuration data which is to be provided to requiring modules at runtime.", "type": "object" }, "properties-metadata": { "description": "Additional information about the resource's properties.", "$ref": "#/definitions/properties-metadata" }, "parameters": { "description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to requiring modules at runtime. Untyped resources cannot have parameters.", "$ref": "#/definitions/resource-parameters" }, "parameters-metadata": { "description": "Additional information about the resource's parameters.", "$ref": "#/definitions/properties-metadata" }, "hooks": { "description": "A list of hooks that will be executed for the resource.", "$ref": "#/definitions/hooks" }, "requires": { "description": "List of names either matching a resource name or a name provided by another resource within the same MTA that are required by this resource.", "$ref": "#/definitions/resource-requires" } } } }, "module-types": { "description": "A list of custom module type definitions that will be used by the MTA application.", "type": "array", "items": { "type": "object", "required": ["name", "extends"], "properties": { "name": { "description": " An MTA internal name of the module type that will be specified in the 'type' element of modules consuming it.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "extends": { "description": "The name of the extended type. Can be another module type defined in this descriptor or one of the default types supported by the deployer.", "type": "string" }, "properties": { "description": "A collection of key-value pairs that will be inherited by all modules of this type.", "type": "object" }, "properties-metadata": { "description": "Additional information about the module type's properties.", "$ref": "#/definitions/properties-metadata" }, "parameters": { "description": "Configuration parameters that will be inherited in all modules of this type.", "type": "object" }, "parameters-metadata": { "description": "Additional information about the module's parameters.", "$ref": "#/definitions/properties-metadata" } } } }, "resource-types": { "description": "A list of custom resource type definitions that will be used by the MTA application.", "type": "array", "items": { "type": "object", "required": ["name", "extends"], "properties": { "name": { "description": " An MTA internal name of the resource type that will be specified in the 'type' element of resources consuming it.", "type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$" }, "extends": { "description": "The name of the extended type. Can be another resource type defined in this descriptor or one of the default types supported by the deployer.", "type": "string" }, "properties": { "description": "A collection of key-value pairs that will be inherited by all resources of this type.", "type": "object" }, "properties-metadata": { "description": "Additional information about the resource type's properties.", "$ref": "#/definitions/properties-metadata" }, "parameters": { "description": "Configuration parameters that will be inherited in all resources of this type.", "type": "object" }, "parameters-metadata": { "description": "Additional information about the resource's parameters.", "$ref": "#/definitions/properties-metadata" } } } } }, "required": ["_schema-version", "ID", "version"], "title": "mtad.yaml v3.3", "type": "object" }

uplugin.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "BuildConfiguration": { "description": "Available build configurations. Mirorred from `UnrealTargetConfiguration`.", "type": "string", "enum": [ "Unknown", "Debug", "DebugGame", "Development", "Shipping", "Test" ] }, "BuildTargetType": { "description": "Enumerates build target types.", "type": "string", "enum": ["Unknown", "Game", "Server", "Client", "Editor", "Program"] }, "ModuleDescriptor": { "description": "Description of a loadable module.", "type": "object", "properties": { "AdditionalDependencies": { "description": "List of additional dependencies for building this module.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "HasExplicitPlatforms": { "description": "When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions", "type": "boolean", "default": false }, "LoadingPhase": { "description": "When should the module be loaded during the startup sequence? This is sort of an advanced setting.", "type": "string", "enum": [ "EarliestPossible", "PostConfigInit", "PostSplashScreen", "PreEarlyLoadingScreen", "PreLoadingScreen", "PreDefault", "Default", "PostDefault", "PostEngineInit", "None", "Max" ] }, "Name": { "description": "Name of this module", "type": "string" }, "PlatformAllowList": { "description": "List of allowed platforms", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "PlatformDenyList": { "description": "List of disallowed platforms", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "ProgramAllowList": { "description": "List of allowed programs", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "ProgramDenyList": { "description": "List of disallowed programs", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "TargetAllowList": { "description": "List of allowed targets", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildTargetType" } }, "TargetConfigurationAllowList": { "description": "List of allowed target configurations", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildConfiguration" } }, "TargetConfigurationDenyList": { "description": "List of disallowed target configurations", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildConfiguration" } }, "TargetDenyList": { "description": "List of disallowed targets", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildTargetType" } }, "Type": { "description": "Usage type of module", "type": "string", "enum": [ "Runtime", "RuntimeNoCommandlet", "RuntimeAndProgram", "CookedOnly", "UncookedOnly", "Developer", "DeveloperTool", "Editor", "EditorNoCommandlet", "EditorAndProgram", "Program", "ServerOnly", "ClientOnly", "ClientOnlyNoCommandlet", "Max" ] } } }, "PluginReferenceDescriptor": { "description": "Descriptor for a plugin reference.", "type": "object", "properties": { "Enabled": { "description": "Whether it should be enabled by default", "type": "boolean", "default": true }, "HasExplicitPlatforms": { "description": "When true, empty `SupportedTargetPlatforms` and `PlatformAllowList` are interpreted as *no platforms* with the expectation that explicit platforms will be added in plugin platform extensions", "type": "boolean", "default": false }, "Optional": { "description": "Whether this plugin is optional, and the game should silently ignore it not being present", "type": "boolean", "default": false }, "Description": { "description": "Description of the plugin for users that do not have it installed.", "type": "string" }, "MarketplaceURL": { "description": "URL for this plugin on the marketplace, if the user doesn't have it installed.", "type": "string" }, "Name": { "description": "Name of the plugin", "type": "string" }, "PlatformAllowList": { "description": "List of allowed platforms", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "PlatformDenyList": { "description": "List of disallowed platforms", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "TargetAllowList": { "description": "List of allowed targets", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildTargetType" } }, "TargetConfigurationAllowList": { "description": "List of allowed target configurations", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildConfiguration" } }, "TargetConfigurationDenyList": { "description": "List of disallowed target configurations", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildConfiguration" } }, "TargetDenyList": { "description": "List of disallowed targets", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/BuildTargetType" } } }, "required": ["Enabled", "Name"] } }, "description": "Descriptor for plugins. Contains all the information contained within a `.uplugin` file.", "id": "https://json.schemastore.org/uplugin.json", "properties": { "CanContainContent": { "description": "Can this plugin contain content?", "type": "boolean", "default": false }, "CanContainVerse": { "description": "Can this plugin contain Verse code?", "type": "boolean", "default": false }, "ExplicitlyLoaded": { "description": "When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically.", "type": "boolean", "default": false }, "HasExplicitPlatforms": { "description": "When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions", "type": "boolean", "default": false }, "Installed": { "description": "Signifies that the plugin was installed on top of the engine", "type": "boolean", "default": false }, "IsBetaVersion": { "description": "Marks the plugin as beta in the UI", "type": "boolean", "default": false }, "IsExperimentalVersion": { "description": "Marks the plugin as experimental in the UI", "type": "boolean", "default": false }, "IsHidden": { "description": "For auto-generated plugins that should not be listed in the plugin browser for users to disable freely.", "type": "boolean", "default": false }, "IsPluginExtension": { "description": "If true, this plugin from a platform extension extending another plugin", "type": "boolean", "default": false }, "RequiresBuildPlatform": { "description": "For plugins that are under a platform folder (eg. /PS4/), determines whether compiling the plugin requires the build platform and/or SDK to be available", "type": "boolean", "default": false }, "Category": { "description": "The name of the category this plugin", "type": "string", "default": "Other" }, "CreatedBy": { "description": "The company or individual who created this plugin.", "type": "string" }, "CreatedByURL": { "description": "Hyperlink URL string for the company or individual who created this plugin. This is optional.", "type": "string" }, "Description": { "description": "Description of the plugin", "type": "string" }, "DocsURL": { "description": "Documentation URL string.", "type": "string" }, "EditorCustomVirtualPath": { "description": "Optional custom virtual path to display in editor to better organize.", "type": "string" }, "EnabledByDefault": { "description": "Whether this plugin should be enabled by default for all projects", "type": "string", "enum": ["Unspecified", "Enabled", "Disabled"] }, "EngineVersion": { "description": "Version of the engine that this plugin is compatible with", "type": "string" }, "FileVersion": { "description": "Descriptor version number.", "type": "number", "default": 3 }, "FriendlyName": { "description": "Friendly name of the plugin", "type": "string" }, "LocalizationTargets": { "description": "List of all localization targets associated with this plugin", "type": "array", "uniqueItems": true, "items": { "type": "object", "required": ["LoadingPolicy", "Name"], "properties": { "LoadingPolicy": { "description": "When should the localization data associated with a target should be loaded?", "type": "string", "enum": [ "Never", "Always", "Editor", "Game", "PropertyNames", "ToolTips", "Max" ] }, "Name": { "description": "Name of this target", "type": "string" } } } }, "MarketplaceURL": { "description": "Marketplace URL for this plugin.", "type": "string" }, "Modules": { "description": "List of all modules associated with this plugin", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/ModuleDescriptor" } }, "ParentPluginName": { "description": "If specified, this is the real plugin that this one is just extending", "type": "string" }, "Plugins": { "description": "Plugins used by this plugin", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/PluginReferenceDescriptor" } }, "PostBuildSteps": { "description": "Post-build steps for each host platform", "type": "object", "$comment": "Define platform as key, command as value." }, "PreBuildSteps": { "description": "Pre-build steps for each host platform", "type": "object", "$comment": "Define platform as key, command as value." }, "SupportedPrograms": { "description": "List of programs that are supported by this plugin.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "SupportedTargetPlatforms": { "description": "Controls a subset of platforms that can use this plugin, and which ones will stage the `.uplugin` file and content files.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "SupportURL": { "description": "Support URL/email for this plugin.", "type": "string" }, "Version": { "description": "Version number for the plugin.", "type": "number", "default": 1 }, "VersionName": { "description": "Name of the version for this plugin.", "type": "string", "default": "1.0" } }, "required": ["FileVersion"], "title": "JSON schema for Unreal Engine uplugin", "type": "object" }

creatomic.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/creatomic.json", "properties": { "tslint.enable": { "type": "boolean", "default": true, "description": "Control whether tslint is enabled for TypeScript files or not." }, "tslint.jsEnable": { "type": "boolean", "default": false, "description": "Control whether tslint is enabled for JavaScript files or not.", "scope": "resource" }, "tslint.rulesDirectory": { "type": ["string", "array"], "items": { "type": "string" }, "description": "An additional rules directory", "default": "", "scope": "resource" }, "tslint.validateWithDefaultConfig": { "type": "boolean", "description": "Validate a file when there is only a default tslint configuration is found", "default": false, "scope": "resource" }, "tslint.configFile": { "type": "string", "description": "The path to the rules configuration file", "default": "", "scope": "resource" }, "tslint.ignoreDefinitionFiles": { "type": "boolean", "default": true, "description": "Control if TypeScript definition files should be ignored", "scope": "resource" }, "tslint.exclude": { "type": ["string", "array"], "items": { "type": "string" }, "description": "Configure glob patterns of file paths to exclude from linting", "scope": "resource" }, "tslint.run": { "type": "string", "enum": ["onSave", "onType"], "default": "onType", "description": "Run the linter on save (onSave) or on type (onType)", "scope": "window" }, "tslint.nodePath": { "type": "string", "default": "", "description": "A path added to NODE_PATH when resolving the tslint module.", "scope": "resource" }, "tslint.autoFixOnSave": { "type": ["boolean", "array"], "items": { "type": "string" }, "default": false, "description": "Turns auto fix on save on or off, or defines which rules (e.g. `no-var-keyword`) to auto fix on save.", "scope": "resource" }, "tslint.alwaysShowRuleFailuresAsWarnings": { "type": "boolean", "default": false, "description": "Always show rule failures as warnings, independent of the tslint configuration.", "scope": "resource" } }, "title": "JSON schema for Creatomic configuration file", "type": "object" }

artifacthub-repo.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "https://json.schemastore.org/artifacthub-repo.json", "properties": { "repositoryID": { "description": "An identifier of the Artifact Hub repository where the packages will be published to", "type": "string", "format": "uuid" }, "owners": { "description": "Repository owners", "type": "array", "uniqueItems": true, "items": { "title": "owner", "description": "A repository owner", "type": "object", "additionalProperties": false, "properties": { "name": { "description": "A repository owner name", "type": "string" }, "email": { "description": "A repository owner email", "type": "string", "format": "email" } } } }, "ignore": { "description": "Packages that should not be indexed by Artifact Hub", "type": "array", "uniqueItems": true, "items": { "title": "package", "description": "A package", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "description": "A package name", "type": "string" }, "version": { "description": "Regular expression", "type": "string" } } } } }, "title": "An Artifact Hub config file", "type": "object" }

fossa-deps.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "fossa-deps", "description": "fossa-deps for dependency specification for FOSSA CLI", "$defs": { "os": { "enum": [ "alpine", "centos", "debian", "redhat", "ubuntu", "oraclelinux", "busybox", "sles", "fedora" ], "description": "Name of the distribution OS." }, "referenced-app-dependency": { "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the dependency. This name will be used to search for dependency in relevant registries." }, "type": { "enum": [ "bower", "cargo", "carthage", "composer", "cpan", "renv", "gem", "git", "go", "hackage", "hex", "maven", "npm", "nuget", "paket", "pub", "pypi", "cocoapods", "swift", "url" ], "description": "Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution." }, "version": { "type": "string", "description": "Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used." } }, "required": [ "name", "type" ], "additionalProperties": false }, "referenced-apk-deb-dependency": { "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the dependency. This name will be used to search for dependency in relevant registries." }, "type": { "enum": [ "apk", "deb" ], "description": "Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution." }, "version": { "type": "string", "description": "Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used." }, "arch": { "type": "string", "minLength": 1, "description": "Architecture associated with this package" }, "os": { "$ref": "#/$defs/os" }, "osVersion": { "type": "string", "minLength": 1, "description": "Version of the distribution OS." } }, "required": [ "name", "type", "arch", "os", "osVersion" ], "additionalProperties": false }, "referenced-rpm-dependency": { "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the dependency. This name will be used to search for dependency in relevant registries." }, "type": { "enum": [ "rpm-generic" ], "description": "Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution." }, "version": { "type": "string", "description": "Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used." }, "arch": { "type": "string", "minLength": 1, "description": "Architecture associated with this package" }, "epoch": { "type": "string", "minLength": 1, "description": "Epoch associated with version (if any)." }, "os": { "$ref": "#/$defs/os" }, "osVersion": { "type": "string", "minLength": 1, "description": "Version of the distribution OS." } }, "required": [ "name", "type", "arch", "os", "osVersion" ], "additionalProperties": false }, "referenced-dependency": { "oneOf": [ { "$ref": "#/$defs/referenced-app-dependency" }, { "$ref": "#/$defs/referenced-apk-deb-dependency" }, { "$ref": "#/$defs/referenced-rpm-dependency" } ] }, "custom-dependency": { "properties": { "name": { "type": "string", "description": "Name of the dependency. This will be the name used in FOSSA's dashboard.", "minLength": 1 }, "version": { "type": "string", "description": "Version of the dependency. This will be the version used in FOSSA's dashboard.", "minLength": 1 }, "license": { "type": "string", "description": "License of the dependency. This string will be used to infer license type.", "minLength": 1 }, "metadata": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the dependency (if any)" }, "homepage": { "type": "string", "description": "Homepage of the dependency. This should be web address." } } } }, "required": [ "name", "version", "license" ], "additionalProperties": false }, "vendored-dependency": { "properties": { "name": { "type": "string", "description": "Name of the dependency. This will be the name associated with this vendored dependency in FOSSA's dashboard", "minLength": 1 }, "path": { "type": "string", "description": "Path to directory, which will be archived and upload to provided endpoint for license scanning.", "minLength": 1 }, "version": { "type": "string", "description": "Version of the dependency. This will be the version associated with this vendored dependency in FOSSA's dashboard" } }, "required": [ "name", "path" ], "additionalProperties": false }, "remote-dependency": { "properties": { "name": { "type": "string", "description": "Name of the dependency. This will be the version used in FOSSA's dashboard.", "minLength": 1 }, "url": { "type": "string", "description": "Url of the dependency's source code. This will be the downloaded by FOSSA for scanning with the analysis.", "minLength": 1 }, "version": { "type": "string", "description": "Version of the dependency." }, "metadata": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the dependency (if any)" }, "homepage": { "type": "string", "description": "Homepage of the dependency. This should be web address." } } } }, "required": [ "name", "url", "version" ], "additionalProperties": false } }, "type": "object", "properties": { "version": { "type": "integer" }, "referenced-dependencies": { "type": "array", "description": "Reference dependency to locate from registry and include it project's dependency and license scanning.", "items": { "$ref": "#/$defs/referenced-dependency" } }, "custom-dependencies": { "type": "array", "description": "Custom dependency and their license for project", "items": { "$ref": "#/$defs/custom-dependency" } }, "vendored-dependencies": { "type": "array", "description": "Local dependencies upload to server for license scanning", "items": { "$ref": "#/$defs/vendored-dependency" } }, "remote-dependencies": { "type": "array", "description": "Remote dependencies to license scanning", "items": { "$ref": "#/$defs/remote-dependency" } } }, "required": [] }

config-schema.json

{ "definitions": { "Cache": { "additionalProperties": true, "type": "object", "title": "Cache", "properties": { "cfwKv": { "$ref": "#/definitions/CFWorkersKVCacheConfig" }, "file": { "$ref": "#/definitions/FileCacheConfig" }, "localforage": { "$ref": "#/definitions/LocalforageConfig" }, "redis": { "$ref": "#/definitions/RedisConfig" } } }, "CFWorkersKVCacheConfig": { "additionalProperties": false, "type": "object", "title": "CFWorkersKVCacheConfig", "properties": { "namespace": { "type": "string", "description": "The name of the Workers KV namespace to use for caching.\n\nMake sure you have configured the following namespace described in [here](https://developers.cloudflare.com/workers/wrangler/cli-wrangler/commands/#kv)." } }, "required": ["namespace"] }, "FileCacheConfig": { "additionalProperties": false, "type": "object", "title": "FileCacheConfig", "properties": { "path": { "type": "string" } } }, "LocalforageConfig": { "additionalProperties": false, "type": "object", "title": "LocalforageConfig", "properties": { "driver": { "type": "array", "items": { "type": "string", "enum": ["WEBSQL", "INDEXEDDB", "LOCALSTORAGE"], "description": "Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE" }, "additionalItems": false, "description": "Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE" }, "name": { "type": "string" }, "version": { "type": "number" }, "size": { "type": "integer" }, "storeName": { "type": "string" }, "description": { "type": "string" } } }, "RedisConfig": { "additionalProperties": false, "type": "object", "title": "RedisConfig", "properties": { "host": { "type": "string" }, "port": { "type": "string" }, "password": { "type": "string" }, "url": { "type": "string" } } }, "ServeConfig": { "additionalProperties": false, "type": "object", "title": "ServeConfig", "properties": { "fork": { "description": "Spawn multiple server instances as node clusters (default: `1`) (Any of: Int, Boolean)", "anyOf": [ { "type": "integer" }, { "type": "boolean" } ] }, "port": { "description": "TCP Port to listen (default: `4000`) (Any of: Int, String)", "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "hostname": { "type": "string", "description": "The binding hostname (default: `localhost`)" }, "cors": { "$ref": "#/definitions/CorsConfig", "description": "Configuration for CORS" }, "staticFiles": { "type": "string", "description": "Path to your static files you want to be served with GraphQL Mesh HTTP Server" }, "playground": { "type": "boolean", "description": "Show GraphiQL Playground" }, "sslCredentials": { "$ref": "#/definitions/HTTPSConfig", "description": "SSL Credentials for HTTPS Server\nIf this is provided, Mesh will be served via HTTPS" }, "endpoint": { "type": "string", "description": "Path to GraphQL Endpoint (default: /graphql)" }, "browser": { "description": "Path to the browser that will be used by `mesh serve` to open a playground window in development mode\nThis feature can be disabled by passing `false` (Any of: String, Boolean)", "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "playgroundTitle": { "type": "string", "description": "Title of GraphiQL Playground" }, "trustProxy": { "type": "string", "description": "Configure Express Proxy Handling\n[Learn more](https://expressjs.com/en/guide/behind-proxies.html)" }, "batchingLimit": { "type": "integer", "description": "Enable and define a limit for [Request Batching](https://github.com/graphql/graphql-over-http/blob/main/rfcs/Batching.md)" } } }, "CorsConfig": { "additionalProperties": false, "type": "object", "title": "CorsConfig", "properties": { "origin": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "allowedHeaders": { "type": "array", "items": { "type": "string" }, "additionalItems": false }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "additionalItems": false }, "credentials": { "type": "boolean" }, "maxAge": { "type": "integer" }, "preflightContinue": { "type": "boolean" }, "optionsSuccessStatus": { "type": "integer" } } }, "HTTPSConfig": { "additionalProperties": false, "type": "object", "title": "HTTPSConfig", "properties": { "key": { "type": "string" }, "cert": { "type": "string" } }, "required": ["key", "cert"] }, "SDKConfig": { "additionalProperties": false, "type": "object", "title": "SDKConfig", "properties": { "generateOperations": { "$ref": "#/definitions/GenerateOperationsConfig", "description": "Use this only if you don't want to use `documents` for SDK,\nand let Mesh generate them for you" } } }, "GenerateOperationsConfig": { "additionalProperties": false, "type": "object", "title": "GenerateOperationsConfig", "properties": { "selectionSetDepth": { "type": "integer" } } }, "Source": { "additionalProperties": false, "type": "object", "title": "Source", "properties": { "name": { "type": "string", "description": "The name you wish to set to your remote API, this will be used for building the GraphQL context" }, "handler": { "$ref": "#/definitions/Handler", "description": "Point to the handler you wish to use, it can either be a predefined handler, or a custom" }, "transforms": { "type": "array", "items": { "$ref": "#/definitions/Transform" }, "additionalItems": false, "description": "List of transforms to apply to the current API source, before unifying it with the rest of the sources" } }, "required": ["name", "handler"] }, "Transform": { "additionalProperties": true, "type": "object", "title": "Transform", "properties": { "cache": { "type": "array", "items": { "$ref": "#/definitions/CacheTransformConfig" }, "additionalItems": false, "description": "Transformer to apply caching for your data sources" }, "encapsulate": { "$ref": "#/definitions/EncapsulateTransformObject", "description": "Transformer to apply encapsulation to the API source, by creating a field for it under the root query" }, "extend": { "$ref": "#/definitions/ExtendTransform" }, "federation": { "$ref": "#/definitions/FederationTransform" }, "filterSchema": { "description": "Transformer to filter (white/black list) GraphQL types, fields and arguments (Any of: FilterSchemaTransform, Any)", "anyOf": [ { "$ref": "#/definitions/FilterSchemaTransform" }, { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] } ] }, "hoistField": { "type": "array", "items": { "$ref": "#/definitions/HoistFieldTransformConfig" }, "additionalItems": false, "description": "Transformer to hoist GraphQL fields" }, "namingConvention": { "$ref": "#/definitions/NamingConventionTransformConfig", "description": "Transformer to apply naming convention to GraphQL Types" }, "prefix": { "$ref": "#/definitions/PrefixTransformConfig", "description": "Prefix transform" }, "prune": { "$ref": "#/definitions/PruneTransformConfig", "description": "Prune transform" }, "rateLimit": { "type": "array", "items": { "$ref": "#/definitions/RateLimitTransformConfig" }, "additionalItems": false, "description": "RateLimit transform" }, "rename": { "description": "Transformer to rename GraphQL types and fields (Any of: RenameTransform, Any)", "anyOf": [ { "$ref": "#/definitions/RenameTransform" }, { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] } ] }, "replaceField": { "$ref": "#/definitions/ReplaceFieldTransformConfig", "description": "Transformer to replace GraphQL field with partial of full config from a different field" }, "resolversComposition": { "description": "Transformer to apply composition to resolvers (Any of: ResolversCompositionTransform, Any)", "anyOf": [ { "$ref": "#/definitions/ResolversCompositionTransform" }, { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] } ] }, "transferSchema": { "$ref": "#/definitions/TransferSchemaTransformConfig", "description": "Transformer to transfer (move or copy) GraphQL parts of GraphQL schema across Types and Fields" }, "typeMerging": { "$ref": "#/definitions/TypeMergingConfig", "description": "[Type Merging](https://www.graphql-tools.com/docs/stitch-type-merging) Configuration" } } }, "Handler": { "additionalProperties": true, "type": "object", "title": "Handler", "properties": { "graphql": { "description": "Handler for remote/local/third-party GraphQL schema (Any of: GraphQLHandlerHTTPConfiguration, GraphQLHandlerCodeFirstConfiguration, GraphQLHandlerMultipleHTTPConfiguration)", "anyOf": [ { "$ref": "#/definitions/GraphQLHandlerHTTPConfiguration" }, { "$ref": "#/definitions/GraphQLHandlerCodeFirstConfiguration" }, { "$ref": "#/definitions/GraphQLHandlerMultipleHTTPConfiguration" } ] }, "grpc": { "$ref": "#/definitions/GrpcHandler", "description": "Handler for gRPC and Protobuf schemas" }, "jsonSchema": { "$ref": "#/definitions/JsonSchemaHandler", "description": "Handler for JSON Schema specification.\nSource could be a local json file, or a url to it." }, "mongoose": { "$ref": "#/definitions/MongooseHandler" }, "mysql": { "$ref": "#/definitions/MySQLHandler" }, "neo4j": { "$ref": "#/definitions/Neo4jHandler", "description": "Handler for Neo4j" }, "odata": { "$ref": "#/definitions/ODataHandler", "description": "Handler for OData" }, "openapi": { "$ref": "#/definitions/OpenapiHandler", "description": "Handler for Swagger / OpenAPI 2/3 specification. Source could be a local json/swagger file, or a url to it." }, "postgraphile": { "$ref": "#/definitions/PostGraphileHandler", "description": "Handler for Postgres database, based on `postgraphile`" }, "raml": { "$ref": "#/definitions/RAMLHandler" }, "soap": { "$ref": "#/definitions/SoapHandler", "description": "Handler for SOAP" }, "supergraph": { "$ref": "#/definitions/SupergraphHandler" }, "thrift": { "$ref": "#/definitions/ThriftHandler", "description": "Handler for OData" }, "tuql": { "$ref": "#/definitions/TuqlHandler", "description": "Handler for SQLite database, based on `tuql`" } } }, "Plugin": { "additionalProperties": true, "type": "object", "title": "Plugin", "properties": { "maskedErrors": { "$ref": "#/definitions/MaskedErrorsPluginConfig" }, "immediateIntrospection": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "deduplicateRequest": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "hive": { "$ref": "#/definitions/HivePlugin" }, "httpCache": { "$ref": "#/definitions/HTTPCachePlugin" }, "httpDetailsExtensions": { "$ref": "#/definitions/HTTPDetailsExtensionsConfig" }, "liveQuery": { "$ref": "#/definitions/LiveQueryConfig" }, "mock": { "$ref": "#/definitions/MockingConfig", "description": "Mock configuration for your source" }, "newrelic": { "$ref": "#/definitions/NewrelicConfig" }, "operationFieldPermissions": { "$ref": "#/definitions/OperationFieldPermissionsConfig" }, "prometheus": { "$ref": "#/definitions/PrometheusConfig" }, "rateLimit": { "$ref": "#/definitions/RateLimitPluginConfig", "description": "RateLimit plugin" }, "responseCache": { "$ref": "#/definitions/ResponseCacheConfig" }, "serializeHeaders": { "$ref": "#/definitions/SerializeHeadersConfig" }, "snapshot": { "$ref": "#/definitions/SnapshotPluginConfig", "description": "Configuration for Snapshot extension" }, "statsd": { "$ref": "#/definitions/StatsdPlugin" } } }, "MaskedErrorsPluginConfig": { "additionalProperties": false, "type": "object", "title": "MaskedErrorsPluginConfig", "properties": { "errorMessage": { "type": "string" } } }, "AdditionalStitchingResolverObject": { "additionalProperties": false, "type": "object", "title": "AdditionalStitchingResolverObject", "properties": { "sourceName": { "type": "string" }, "sourceTypeName": { "type": "string" }, "sourceFieldName": { "type": "string" }, "sourceSelectionSet": { "type": "string" }, "requiredSelectionSet": { "type": "string" }, "sourceArgs": { "type": "object", "properties": {} }, "targetTypeName": { "type": "string" }, "targetFieldName": { "type": "string" }, "result": { "type": "string", "description": "Extract specific property from the result" }, "resultType": { "type": "string", "description": "If return types don't match,\nyou can specify a result type to apply inline fragment" } }, "required": [ "sourceName", "sourceTypeName", "sourceFieldName", "targetTypeName", "targetFieldName" ] }, "AdditionalStitchingBatchResolverObject": { "additionalProperties": false, "type": "object", "title": "AdditionalStitchingBatchResolverObject", "properties": { "sourceName": { "type": "string" }, "sourceTypeName": { "type": "string" }, "sourceFieldName": { "type": "string" }, "sourceSelectionSet": { "type": "string" }, "requiredSelectionSet": { "type": "string" }, "keyField": { "type": "string" }, "keysArg": { "type": "string" }, "additionalArgs": { "type": "object", "properties": {} }, "targetTypeName": { "type": "string" }, "targetFieldName": { "type": "string" }, "result": { "type": "string", "description": "Extract specific property from the result" }, "resultType": { "type": "string", "description": "If return types don't match,\nyou can specify a result type to apply inline fragment" } }, "required": [ "sourceName", "sourceTypeName", "sourceFieldName", "keyField", "keysArg", "targetTypeName", "targetFieldName" ] }, "AdditionalSubscriptionObject": { "additionalProperties": false, "type": "object", "title": "AdditionalSubscriptionObject", "properties": { "targetTypeName": { "type": "string" }, "targetFieldName": { "type": "string" }, "pubsubTopic": { "type": "string" }, "result": { "type": "string" }, "filterBy": { "type": "string" } }, "required": ["targetTypeName", "targetFieldName", "pubsubTopic"] }, "PubSubConfig": { "additionalProperties": false, "type": "object", "title": "PubSubConfig", "properties": { "name": { "type": "string" }, "config": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] } }, "required": ["name"] }, "GraphQLHandlerMultipleHTTPConfiguration": { "additionalProperties": false, "type": "object", "title": "GraphQLHandlerMultipleHTTPConfiguration", "properties": { "sources": { "type": "array", "items": { "$ref": "#/definitions/GraphQLHandlerHTTPConfiguration" }, "additionalItems": false, "description": "HTTP Source Configurations" }, "strategy": { "type": "string", "enum": ["fallback", "race", "highestValue"], "description": "Handling strategy (default: fallback) (Allowed values: fallback, race, highestValue)" }, "strategyConfig": { "$ref": "#/definitions/GraphQLHandlerhighestValueStrategyConfig", "description": "Handling strategy configuration" } }, "required": ["sources"] }, "GraphQLHandlerhighestValueStrategyConfig": { "additionalProperties": false, "type": "object", "title": "GraphQLHandlerhighestValueStrategyConfig", "properties": { "selectionSet": { "type": "string" }, "value": { "type": "string" } }, "required": ["selectionSet", "value"] }, "GraphQLHandlerCodeFirstConfiguration": { "additionalProperties": false, "type": "object", "title": "GraphQLHandlerCodeFirstConfiguration", "properties": { "source": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "A file path to your GraphQL Schema\nIf you provide a path to a code file(js or ts),\nother options will be ignored and the schema exported from the file will be used directly." } }, "required": ["source"] }, "GraphQLHandlerHTTPConfiguration": { "additionalProperties": false, "type": "object", "title": "GraphQLHandlerHTTPConfiguration", "properties": { "endpoint": { "type": "string", "description": "A url or file path to your remote GraphQL endpoint.\nIf you provide a path to a code file(js or ts),\nother options will be ignored and the schema exported from the file will be used directly." }, "schemaHeaders": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "JSON object representing the Headers to add to the runtime of the API calls only for schema introspection" }, "operationHeaders": { "type": "object", "properties": {}, "description": "JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime" }, "useGETForQueries": { "type": "boolean", "description": "Use HTTP GET for Query operations" }, "method": { "type": "string", "enum": ["GET", "POST"], "description": "HTTP method used for GraphQL operations (Allowed values: GET, POST)" }, "credentials": { "type": "string", "enum": ["omit", "include"], "description": "Request Credentials if your environment supports it.\n[See more](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials)\n\n@default \"same-origin\" (Allowed values: omit, include)" }, "webSocketImpl": { "type": "string", "description": "Path to a custom W3 Compatible WebSocket Implementation" }, "source": { "type": "string", "description": "Path to the introspection\nYou can separately give schema introspection or SDL" }, "subscriptionsProtocol": { "type": "string", "enum": ["SSE", "WS", "LEGACY_WS"], "description": "SSE - Server Sent Events\nWS - New graphql-ws\nLEGACY_WS - Legacy subscriptions-transport-ws (Allowed values: SSE, WS, LEGACY_WS)" }, "subscriptionsEndpoint": { "type": "string", "description": "URL to your endpoint serving all subscription queries for this source" }, "retry": { "type": "integer", "description": "Retry attempts if fails" }, "timeout": { "type": "integer", "description": "Timeout in milliseconds" }, "batch": { "type": "boolean", "description": "Enable/Disable automatic query batching" }, "connectionParams": { "type": "object", "properties": {}, "description": "JSON object representing the `connectionParams` from a WebSocket connection to add to the runtime of the API calls only for operation during runtime.\nMore information about the WebSocket `connectionParams`:\n - When using `subscriptionsProtocol=WS` (graphql-ws): https://github.com/enisdenjo/graphql-ws/blob/master/docs/interfaces/client.ClientOptions.md#connectionparams\n - When using `subscriptionsProtocol=LEGACY_WS` (subscriptions-transport-ws): https://github.com/apollographql/subscriptions-transport-ws/blob/51270cc7dbaf09c7b9aa67368f1de58148c7d334/README.md#subscriptionclient" } }, "required": ["endpoint"] }, "GrpcHandler": { "additionalProperties": false, "type": "object", "title": "GrpcHandler", "properties": { "endpoint": { "type": "string", "description": "gRPC Endpoint" }, "source": { "description": "gRPC Proto file that contains your protobuf schema\nOR\nUse a binary-encoded or JSON file descriptor set file (Any of: ProtoFilePath, String)", "anyOf": [ { "$ref": "#/definitions/ProtoFilePath" }, { "type": "string" } ] }, "requestTimeout": { "type": "integer", "description": "Request timeout in milliseconds\nDefault: 200000" }, "credentialsSsl": { "$ref": "#/definitions/GrpcCredentialsSsl", "description": "SSL Credentials" }, "useHTTPS": { "type": "boolean", "description": "Use https instead of http for gRPC connection" }, "metaData": { "type": "object", "properties": {}, "description": "MetaData" }, "prefixQueryMethod": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "prefix to collect Query method default: list, get" }, "schemaHeaders": { "type": "object", "properties": {} } }, "required": ["endpoint"] }, "LoadOptions": { "additionalProperties": false, "type": "object", "title": "LoadOptions", "properties": { "defaults": { "type": "boolean" }, "includeDirs": { "type": "array", "items": { "type": "string" }, "additionalItems": false } } }, "ProtoFilePath": { "additionalProperties": false, "type": "object", "title": "ProtoFilePath", "properties": { "file": { "type": "string" }, "load": { "$ref": "#/definitions/LoadOptions" } }, "required": ["file"] }, "GrpcCredentialsSsl": { "additionalProperties": false, "type": "object", "title": "GrpcCredentialsSsl", "properties": { "rootCA": { "type": "string" }, "certChain": { "type": "string" }, "privateKey": { "type": "string" } } }, "QueryStringOptions": { "additionalProperties": false, "type": "object", "title": "QueryStringOptions", "properties": { "indices": { "type": "boolean", "description": "When arrays are stringified, by default they are not given explicit indices:\n`a=b&a=c&a=d`\nYou may override this by setting the indices option to true:\n`a[0]=b&a[1]=c&a[2]=d`" }, "arrayFormat": { "type": "string", "enum": ["indices", "brackets", "repeat", "comma"], "description": "You can configure how to format arrays in the query strings.\n\nNote: when using arrayFormat set to 'comma', you can also pass the commaRoundTrip option set to true or false, to append [] on single-item arrays, so that they can round trip through a parse. (Allowed values: indices, brackets, repeat, comma)" }, "commaRoundTrip": { "type": "boolean", "description": "Even if there is a single item in an array, this option treats them as arrays\n(default: false)" } } }, "JsonSchemaHandler": { "additionalProperties": false, "type": "object", "title": "JsonSchemaHandler", "properties": { "source": { "type": "string", "description": "Path to the bundle file" }, "endpoint": { "type": "string" }, "operationHeaders": { "type": "object", "properties": {} }, "schemaHeaders": { "type": "object", "properties": {} }, "operations": { "type": "array", "items": { "description": "Any of: JsonSchemaHTTPOperation, JsonSchemaPubSubOperation", "anyOf": [ { "$ref": "#/definitions/JsonSchemaHTTPOperation" }, { "$ref": "#/definitions/JsonSchemaPubSubOperation" } ] }, "additionalItems": false, "description": "Any of: JsonSchemaHTTPOperation, JsonSchemaPubSubOperation" }, "ignoreErrorResponses": { "type": "boolean" }, "queryParams": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "queryStringOptions": { "$ref": "#/definitions/QueryStringOptions" }, "bundlePath": { "type": "string", "description": "Will be removed later" }, "bundleHeaders": { "type": "object", "properties": {}, "description": "Will be removed later" }, "timeout": { "type": "integer", "description": "Timeout for the HTTP request in milliseconds" } } }, "JsonSchemaHTTPOperation": { "additionalProperties": false, "type": "object", "title": "JsonSchemaHTTPOperation", "properties": { "field": { "type": "string", "description": "This Field based on the field name of the URL path.\nExample: \"https://MyAPIURL.com/FieldNameHere/\",\nso we will set the \"field: FieldNameHere\"." }, "description": { "type": "string", "description": "Your chance to describe the operation!\nMake sure the description is clear and concise." }, "type": { "type": "string", "enum": ["Query", "Mutation", "Subscription"], "description": "Type field is set the opertion type: Query, Mutation or Subscription. (Allowed values: Query, Mutation, Subscription)" }, "requestSchema": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Your chance to provide request schema name." }, "requestSample": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "The path definition of the JSON Schema sample.\nExample: \"./jsons/questions.response.json\"." }, "requestTypeName": { "type": "string", "description": "Inset any name for the type of the request body." }, "requestBaseBody": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "This body will be merged with the request body sent with\nthe underlying HTTP request" }, "responseSchema": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Yay! Now you can provide the response schema name." }, "responseSample": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Did you use Sample? Provide the response sample path." }, "responseTypeName": { "type": "string", "description": "Inset any name for the type of the response body." }, "responseByStatusCode": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "You can define your response schemas by status codes;\n```yaml filename=\".meshrc.yaml\"\nresponseByStatusCode:\n 200:\n responseSchema: ./someschema.json#/somepath\n 404:\n responseSample: ./error-sample.json\n responseTypeName: MyError\n```" }, "exposeResponseMetadata": { "type": "boolean", "description": "Expose response details done to the upstream API\nWhen you enable this, you will see a new field in the response type;\n```graphql\ntype MyResponseType {\n myFooField: String\n _response: ResponseMetadata\n}\n\n# And a new type for the response metadata object\ntype ResponseMetadata {\n url: URL\n status: Int\n method: String\n headers: JSON\n body: String\n}\n```" }, "argTypeMap": { "type": "object", "properties": {}, "description": "Mapping the JSON Schema and define the arguments of the operation.\n\n# Example:\nargTypeMap:\n user_id:\n type: string" }, "queryParamArgMap": { "type": "object", "properties": {}, "description": "JSON object representing the mapping of query search parameters (added to the route path) and the matching argument.\n\n# Example:\nqueryParamArgMap:\n id: user_id" }, "path": { "type": "string" }, "method": { "type": "string", "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"], "description": "Allowed values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH" }, "headers": { "type": "object", "properties": {} }, "binary": { "type": "boolean", "description": "If true, this operation cannot have requestSchema or requestSample\nAnd the request body will be passed as binary with its mime type\nunless you define an explicit Content-Type header" } }, "required": ["field", "type", "path"] }, "JsonSchemaPubSubOperation": { "additionalProperties": false, "type": "object", "title": "JsonSchemaPubSubOperation", "properties": { "field": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": ["Query", "Mutation", "Subscription"], "description": "Allowed values: Query, Mutation, Subscription" }, "requestSchema": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "requestSample": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "requestTypeName": { "type": "string" }, "requestBaseBody": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "This body will be merged with the request body sent with\nthe underlying HTTP request" }, "responseSchema": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "responseSample": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "responseTypeName": { "type": "string" }, "argTypeMap": { "type": "object", "properties": {} }, "pubsubTopic": { "type": "string" } }, "required": ["field", "type", "pubsubTopic"] }, "MongooseHandler": { "additionalProperties": false, "type": "object", "title": "MongooseHandler", "properties": { "connectionString": { "type": "string" }, "models": { "type": "array", "items": { "$ref": "#/definitions/MongooseModel" }, "additionalItems": false }, "discriminators": { "type": "array", "items": { "$ref": "#/definitions/MongooseModel" }, "additionalItems": false } } }, "MongooseModel": { "additionalProperties": false, "type": "object", "title": "MongooseModel", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "options": { "$ref": "#/definitions/ComposeWithMongooseOpts" } }, "required": ["name", "path"] }, "ComposeWithMongooseOpts": { "additionalProperties": false, "type": "object", "title": "ComposeWithMongooseOpts", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "fields": { "$ref": "#/definitions/ComposeWithMongooseFieldsOpts" }, "inputType": { "$ref": "#/definitions/ComposeMongooseInputType" }, "resolvers": { "$ref": "#/definitions/TypeConverterResolversOpts" } } }, "ComposeMongooseInputType": { "additionalProperties": false, "type": "object", "title": "ComposeMongooseInputType", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "fields": { "$ref": "#/definitions/ComposeWithMongooseFieldsOpts" }, "resolvers": { "$ref": "#/definitions/TypeConverterResolversOpts" } } }, "ComposeWithMongooseFieldsOpts": { "additionalProperties": false, "type": "object", "title": "ComposeWithMongooseFieldsOpts", "properties": { "only": { "type": "array", "items": { "type": "string" }, "additionalItems": false }, "remove": { "type": "array", "items": { "type": "string" }, "additionalItems": false }, "required": { "type": "array", "items": { "type": "string" }, "additionalItems": false } } }, "TypeConverterResolversOpts": { "additionalProperties": false, "type": "object", "title": "TypeConverterResolversOpts", "properties": { "findById": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "findByIds": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "findOne": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "findMany": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "updateById": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "updateOne": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "updateMany": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "removeById": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "removeOne": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "removeMany": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "createOne": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "createMany": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "count": { "description": "Any of: Boolean, ComposeWithMongooseResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/ComposeWithMongooseResolverOpts" } ] }, "connection": { "description": "Any of: Boolean, JSON", "anyOf": [ { "type": "boolean" }, { "type": "object", "properties": {} } ] }, "pagination": { "description": "Any of: Boolean, PaginationResolverOpts", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/PaginationResolverOpts" } ] } } }, "ComposeWithMongooseResolverOpts": { "additionalProperties": false, "type": "object", "title": "ComposeWithMongooseResolverOpts", "properties": { "filter": { "$ref": "#/definitions/FilterHelperArgsOpts" }, "sort": { "$ref": "#/definitions/SortHelperArgsOpts" }, "limit": { "$ref": "#/definitions/LimitHelperArgsOpts" }, "record": { "$ref": "#/definitions/RecordHelperArgsOpts" }, "skip": { "type": "boolean" } } }, "FilterHelperArgsOpts": { "additionalProperties": false, "type": "object", "title": "FilterHelperArgsOpts", "properties": { "filterTypeName": { "type": "string" }, "isRequired": { "type": "boolean" }, "onlyIndexed": { "type": "boolean" }, "requiredFields": { "type": "array", "items": { "type": "string" }, "additionalItems": false }, "operators": { "description": "Any of: Boolean, JSON", "anyOf": [ { "type": "boolean" }, { "type": "object", "properties": {} } ] }, "removeFields": { "type": "array", "items": { "type": "string" }, "additionalItems": false } } }, "SortHelperArgsOpts": { "additionalProperties": false, "type": "object", "title": "SortHelperArgsOpts", "properties": { "sortTypeName": { "type": "string" } } }, "LimitHelperArgsOpts": { "additionalProperties": false, "type": "object", "title": "LimitHelperArgsOpts", "properties": { "defaultValue": { "type": "integer" } } }, "RecordHelperArgsOpts": { "additionalProperties": false, "type": "object", "title": "RecordHelperArgsOpts", "properties": { "recordTypeName": { "type": "string" }, "isRequired": { "type": "boolean" }, "removeFields": { "type": "array", "items": { "type": "string" }, "additionalItems": false }, "requiredFields": { "type": "array", "items": { "type": "string" }, "additionalItems": false } } }, "PaginationResolverOpts": { "additionalProperties": false, "type": "object", "title": "PaginationResolverOpts", "properties": { "perPage": { "type": "integer" } } }, "MySQLHandler": { "additionalProperties": false, "type": "object", "title": "MySQLHandler", "properties": { "host": { "type": "string", "description": "The hostname of the database you are connecting to. (Default: localhost)" }, "port": { "type": "integer", "description": "The port number to connect to. (Default: 3306)" }, "localAddress": { "type": "string", "description": "The source IP address to use for TCP connection" }, "user": { "type": "string", "description": "The MySQL user to authenticate as" }, "password": { "type": "string", "description": "The password of that MySQL user" }, "database": { "type": "string", "description": "Name of the database to use for this connection" }, "ssl": { "$ref": "#/definitions/MySQLSSLOptions", "description": "SSL Options for your MySQL connection" }, "pool": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Use existing `Pool` instance\nFormat: modulePath#exportName" }, "tables": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Use specific tables for your schema" }, "tableFields": { "type": "array", "items": { "$ref": "#/definitions/TableField" }, "additionalItems": false, "description": "Use specific fields of specific tables" } } }, "TableField": { "additionalProperties": false, "type": "object", "title": "TableField", "properties": { "table": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "additionalItems": false } }, "required": ["table", "fields"] }, "MySQLSSLOptions": { "additionalProperties": false, "type": "object", "title": "MySQLSSLOptions", "properties": { "rejectUnauthorized": { "type": "boolean", "description": "Default: true" }, "ca": { "type": "string", "description": "Path to your CA" } } }, "Neo4jHandler": { "additionalProperties": false, "type": "object", "title": "Neo4jHandler", "properties": { "endpoint": { "type": "string", "description": "URL for the Neo4j Instance e.g. neo4j://localhost" }, "source": { "type": "string", "description": "Provide GraphQL Type Definitions instead of inferring" }, "username": { "type": "string", "description": "Username for basic authentication" }, "password": { "type": "string", "description": "Password for basic authentication" }, "alwaysIncludeRelationships": { "type": "boolean", "description": "Specifies whether relationships should always be included in the type definitions as [relationship](https://grandstack.io/docs/neo4j-graphql-js.html#relationship-types) types, even if the relationships do not have properties." }, "database": { "type": "string", "description": "Specifies database name" } }, "required": ["endpoint", "username", "password"] }, "ODataHandler": { "additionalProperties": false, "type": "object", "title": "ODataHandler", "properties": { "endpoint": { "type": "string", "description": "Base URL for OData API" }, "source": { "type": "string", "description": "Custom $metadata File or URL" }, "schemaHeaders": { "type": "object", "properties": {}, "description": "Headers to be used with the $metadata requests" }, "operationHeaders": { "type": "object", "properties": {}, "description": "Headers to be used with the operation requests" }, "batch": { "type": "string", "enum": ["multipart", "json"], "description": "Enable batching (Allowed values: multipart, json)" }, "expandNavProps": { "type": "boolean", "description": "Use $expand for navigation props instead of seperate HTTP requests (Default: false)" } }, "required": ["endpoint"] }, "OpenapiHandler": { "additionalProperties": false, "type": "object", "title": "OpenapiHandler", "properties": { "source": { "type": "string", "description": "A pointer to your API source (Support both JSON and YAML) - could be a local file, remote file or url endpoint" }, "fallbackFormat": { "type": "string", "enum": ["json", "yaml", "js", "ts"], "description": "Format of the files referenced from the source file, for cases content type isn't detected automatically (Allowed values: json, yaml, js, ts)" }, "endpoint": { "type": "string", "description": "Specifies the URL on which all paths will be based on.\nOverrides the server object in the OAS." }, "schemaHeaders": { "type": "object", "properties": {}, "description": "If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema." }, "operationHeaders": { "type": "object", "properties": {}, "description": "JSON object representing the Headers to add to the runtime of the API calls" }, "ignoreErrorResponses": { "type": "boolean", "description": "Responses are converted to a Union type grouping all possible responses.\nApplying this will ignore all responses with status code other than 2xx, resulting in simpler response types, usualy regular object type instead of union.\nDefault: false" }, "selectQueryOrMutationField": { "type": "array", "items": { "$ref": "#/definitions/OASSelectQueryOrMutationFieldConfig" }, "additionalItems": false, "description": "Allows to explicitly override the default operation (Query or Mutation) for any OAS operation" }, "queryParams": { "type": "object", "properties": {}, "description": "JSON object representing the query search parameters to add to the API calls" }, "timeout": { "type": "integer", "description": "Timeout for the HTTP request in milliseconds" }, "bundle": { "type": "boolean" } }, "required": ["source"] }, "OASSelectQueryOrMutationFieldConfig": { "additionalProperties": false, "type": "object", "title": "OASSelectQueryOrMutationFieldConfig", "properties": { "type": { "type": "string", "enum": ["query", "mutation", "Query", "Mutation"], "description": "Allowed values: query, mutation, Query, Mutation" }, "fieldName": { "type": "string" } }, "required": ["type", "fieldName"] }, "HivePlugin": { "additionalProperties": false, "type": "object", "title": "HivePlugin", "properties": { "enabled": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "If this expression is truthy, mocking would be enabled\nYou can use environment variables expression, for example: `process.env.MOCKING_ENABLED != null`" }, "token": { "type": "string", "description": "Access Token" }, "agent": { "$ref": "#/definitions/HiveAgentOptions", "description": "Agent Options" }, "usage": { "$ref": "#/definitions/HiveUsageOptions", "description": "Collects schema usage based on operations" }, "reporting": { "$ref": "#/definitions/HiveReportingOptions", "description": "Schema reporting" }, "selfHosting": { "$ref": "#/definitions/HiveSelfHostingOptions", "description": "Options for self-hosting\n[See more](https://github.com/kamilkisiela/graphql-hive/tree/main/packages/libraries/client#self-hosting)" } }, "required": ["token"] }, "HiveAgentOptions": { "additionalProperties": false, "type": "object", "title": "HiveAgentOptions", "properties": { "timeout": { "type": "integer", "description": "30s by default" }, "maxRetries": { "type": "integer", "description": "5 by default" }, "minTimeout": { "type": "integer", "description": "200 by default" }, "sendInterval": { "type": "integer", "description": "Send reports in interval (defaults to 10_000ms)" }, "maxSize": { "type": "integer", "description": "Max number of traces to send at once (defaults to 25)" } } }, "HiveUsageOptions": { "additionalProperties": false, "type": "object", "title": "HiveUsageOptions", "properties": { "clientInfo": { "$ref": "#/definitions/HiveClientInfo", "description": "Extract client info from GraphQL Context" }, "max": { "type": "integer", "description": "Hive uses LRU cache to store info about operations.\nThis option represents the maximum size of the cache.\nDefault: 1000" }, "ttl": { "type": "integer", "description": "Hive uses LRU cache to store info about operations.\nThis option represents the maximum age of an unused operation in the cache.\nDefault: no ttl" }, "exclude": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "A list of operations (by name) to be ignored by Hive." }, "sampleRate": { "type": "number", "description": "Sample rate to determine sampling.\n0.0 = 0% chance of being sent\n1.0 = 100% chance of being sent\nDefault: 1.0" }, "processVariables": { "type": "boolean", "description": "(Experimental) Enables collecting Input fields usage based on the variables passed to the operation.\nDefault: false" } } }, "HiveClientInfo": { "additionalProperties": false, "type": "object", "title": "HiveClientInfo", "properties": { "name": { "type": "string", "description": "Extract client name\nExample: `{context.headers['x-client-name']}`" }, "version": { "type": "string", "description": "Extract client version\nExample: `{context.headers['x-client-version']}`" } } }, "HiveReportingOptions": { "additionalProperties": false, "type": "object", "title": "HiveReportingOptions", "properties": { "author": { "type": "string", "description": "Author of current version of the schema" }, "commit": { "type": "string", "description": "Commit SHA hash (or any identifier) related to the schema version" }, "serviceName": { "type": "string" }, "serviceUrl": { "type": "string" } }, "required": ["author", "commit"] }, "HiveSelfHostingOptions": { "additionalProperties": false, "type": "object", "title": "HiveSelfHostingOptions", "properties": { "graphqlEndpoint": { "type": "string", "description": "Point to your own instance of GraphQL Hive API\n\nUsed by schema reporting and token info." }, "applicationUrl": { "type": "string", "description": "Address of your own GraphQL Hive application\n\nUsed by token info to generate a link to the organization, project and target." }, "usageEndpoint": { "type": "string", "description": "Point to your own instance of GraphQL Hive Usage API\n\nUsed by usage reporting." } }, "required": ["graphqlEndpoint", "applicationUrl"] }, "HTTPCachePlugin": { "additionalProperties": false, "type": "object", "title": "HTTPCachePlugin", "properties": { "matches": { "type": "array", "items": { "description": "Any of: String, URLPatternObj", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/URLPatternObj" } ] }, "additionalItems": false, "description": "If the following patterns match the request URL, the response will be cached. (Any of: String, URLPatternObj)" }, "ignores": { "type": "array", "items": { "description": "Any of: String, URLPatternObj", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/URLPatternObj" } ] }, "additionalItems": false, "description": "If the following patterns match the request URL, the response will not be cached. (Any of: String, URLPatternObj)" } } }, "URLPatternObj": { "additionalProperties": false, "type": "object", "title": "URLPatternObj", "properties": { "protocol": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "hostname": { "type": "string" }, "port": { "type": "string" }, "pathname": { "type": "string" }, "search": { "type": "string" }, "hash": { "type": "string" }, "baseURL": { "type": "string" } } }, "HTTPDetailsExtensionsConfig": { "additionalProperties": false, "type": "object", "title": "HTTPDetailsExtensionsConfig", "properties": { "if": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] } } }, "LiveQueryConfig": { "additionalProperties": false, "type": "object", "title": "LiveQueryConfig", "properties": { "invalidations": { "type": "array", "items": { "$ref": "#/definitions/LiveQueryInvalidation" }, "additionalItems": false, "description": "Invalidate a query or queries when a specific operation is done without an error" }, "resourceIdentifier": { "type": "string", "description": "Custom strategy for building resources identifiers\nBy default resource identifiers are built by concatenating the Typename with the id separated by a color (`User:1`).\n\nThis may be useful if you are using a relay compliant schema and the Typename information is not required for building a unique topic.\n\nDefault: \"{typename}:{id}\"" }, "includeIdentifierExtension": { "type": "boolean", "description": "Whether the extensions should include a list of all resource identifiers for the latest operation result.\nAny of those can be used for invalidating and re-scheduling the operation execution.\n\nThis is mainly useful for discovering and learning what kind of topics a given query will subscribe to.\nThe default value is `true` if `DEBUG` environment variable is set" }, "idFieldName": { "type": "string", "description": "Identifier unique field\n\nDefault: \"id\"" }, "indexBy": { "type": "array", "items": { "$ref": "#/definitions/LiveQueryIndexBy" }, "additionalItems": false, "description": "Specify which fields should be indexed for specific invalidations." } } }, "LiveQueryInvalidation": { "additionalProperties": false, "type": "object", "title": "LiveQueryInvalidation", "properties": { "field": { "type": "string", "description": "Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field." }, "invalidate": { "type": "array", "items": { "type": "string" }, "additionalItems": false } }, "required": ["field", "invalidate"] }, "LiveQueryIndexBy": { "additionalProperties": false, "type": "object", "title": "LiveQueryIndexBy", "properties": { "field": { "type": "string" }, "args": { "type": "array", "items": { "type": "string" }, "additionalItems": false } }, "required": ["field", "args"] }, "MockingConfig": { "additionalProperties": false, "type": "object", "title": "MockingConfig", "properties": { "if": { "type": "boolean", "description": "If this expression is truthy, mocking would be enabled\nYou can use environment variables expression, for example: `process.env.MOCKING_ENABLED != null`" }, "preserveResolvers": { "type": "boolean", "description": "Do not mock any other resolvers other than defined in `mocks`.\nFor example, you can enable this if you don't want to mock entire schema but partially." }, "mocks": { "type": "array", "items": { "$ref": "#/definitions/MockingFieldConfig" }, "additionalItems": false, "description": "Mock configurations" }, "initializeStore": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "The path to the code runs before the store is attached to the schema" } } }, "MockingFieldConfig": { "additionalProperties": false, "type": "object", "title": "MockingFieldConfig", "properties": { "apply": { "type": "string", "description": "Resolver path\nExample: User.firstName" }, "if": { "type": "boolean", "description": "If this expression is truthy, mocking would be enabled\nYou can use environment variables expression, for example: `${MOCKING_ENABLED}`" }, "faker": { "type": "string", "description": "Faker.js expression or function\nRead more (https://github.com/marak/Faker.js/#fakerfake)\nExample:\nfaker: `name.firstName`\nfaker: `{{ name.firstName }} {{ name.lastName }}`" }, "custom": { "type": "string", "description": "Custom mocking\nIt can be a module or json file.\nBoth \"moduleName#exportName\" or only \"moduleName\" would work" }, "length": { "type": "integer", "description": "Length of the mock list\nFor the list types `[ObjectType]`, how many `ObjectType` you want to return?\ndefault: 2" }, "store": { "$ref": "#/definitions/GetFromMockStoreConfig", "description": "Get the data from the mock store" }, "updateStore": { "type": "array", "items": { "$ref": "#/definitions/UpdateMockStoreConfig" }, "additionalItems": false, "description": "Update the data on the mock store" } }, "required": ["apply"] }, "GetFromMockStoreConfig": { "additionalProperties": false, "type": "object", "title": "GetFromMockStoreConfig", "properties": { "type": { "type": "string" }, "key": { "type": "string" }, "fieldName": { "type": "string" } } }, "UpdateMockStoreConfig": { "additionalProperties": false, "type": "object", "title": "UpdateMockStoreConfig", "properties": { "type": { "type": "string" }, "key": { "type": "string" }, "fieldName": { "type": "string" }, "value": { "type": "string" } } }, "NewrelicConfig": { "additionalProperties": false, "type": "object", "title": "NewrelicConfig", "properties": { "includeOperationDocument": { "type": "boolean", "description": "default `false`. When set to `true`, includes the GraphQL document defining the operations and fragments" }, "includeExecuteVariables": { "type": "boolean", "description": "default `false`. When set to `true`, includes all the operation variables with their values" }, "includeRawResult": { "type": "boolean", "description": "default: `false`. When set to `true`, includes the execution result of both delegation and execution" }, "trackResolvers": { "type": "boolean", "description": "default `false`. When set to `true`, track resolvers as segments to monitor their performance" }, "includeResolverArgs": { "type": "boolean", "description": "default `false`. When set to `true`, includes all the arguments passed to resolvers and delegation with their values" }, "rootFieldsNaming": { "type": "boolean", "description": "default `false`. When set to `true` append the names of operation root fields to the transaction name" }, "extractOperationName": { "type": "string", "description": "Allows to set a custom operation name to be used as transaction name and attribute\n`extractOperationName: {context.headers['x-operation-name']}`" } } }, "OperationFieldPermissionsConfig": { "additionalProperties": false, "type": "object", "title": "OperationFieldPermissionsConfig", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/definitions/OperationFieldPermission" }, "additionalItems": false } } }, "OperationFieldPermission": { "additionalProperties": false, "type": "object", "title": "OperationFieldPermission", "properties": { "if": { "type": "string" }, "allow": { "type": "array", "items": { "type": "string" }, "additionalItems": false } } }, "PrometheusConfig": { "additionalProperties": false, "type": "object", "title": "PrometheusConfig", "properties": { "requestCount": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "requestTotalDuration": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "requestSummary": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "parse": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "validate": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "contextBuilding": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "execute": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "errors": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "deprecatedFields": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "skipIntrospection": { "type": "boolean" }, "registry": { "type": "string" }, "delegation": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "fetch": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "fetchRequestHeaders": { "type": "boolean" }, "fetchResponseHeaders": { "type": "boolean" }, "http": { "description": "Any of: Boolean, String", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "httpRequestHeaders": { "type": "boolean" }, "httpResponseHeaders": { "type": "boolean" }, "endpoint": { "type": "string", "description": "The path to the metrics endpoint\ndefault: `/metrics`" } } }, "RateLimitPluginConfig": { "additionalProperties": false, "type": "object", "title": "RateLimitPluginConfig", "properties": { "config": { "type": "array", "items": { "$ref": "#/definitions/RateLimitTransformConfig" }, "additionalItems": false } }, "required": ["config"] }, "ResponseCacheConfig": { "additionalProperties": false, "type": "object", "title": "ResponseCacheConfig", "properties": { "ttl": { "type": "number", "description": "Maximum age in ms. Defaults to `Infinity`. Set it to 0 for disabling the global TTL." }, "ttlPerCoordinate": { "type": "array", "items": { "$ref": "#/definitions/ResponseCacheTTLConfig" }, "additionalItems": false, "description": "Overwrite the ttl for query operations whose selection contains a specific schema coordinate (e.g. Query.users).\nUseful if the selection of a specific field should reduce the TTL of the query operation." }, "ignoredTypes": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Skip caching of following the types." }, "idFields": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "List of fields that are used to identify the entity." }, "invalidateViaMutation": { "type": "boolean", "description": "Whether the mutation execution result should be used for invalidating resources.\nDefaults to `true`" }, "includeExtensionMetadata": { "type": "boolean", "description": "Include extension values that provide useful information, such as whether the cache was hit or which resources a mutation invalidated." }, "sessionId": { "type": "string", "description": "Allows to cache responses based on the resolved session id.\nReturn a unique value for each session.\nCreates a global session by default.\nExample;\n```yaml\nsessionId: \"{context.headers.userId}\"\n```" }, "if": { "type": "string", "description": "Specify whether the cache should be used based on the context.\n```yaml\nif: \"context.headers.userId != null\"\n```" }, "cacheKey": { "type": "string", "description": "Customize the behavior how the response cache key is computed from the documentString, variableValues, contextValue and sessionId.\nIf the given string is interpolated as empty, default behavior is used.\nExample;\n```yaml\n# Cache by specific value\ncacheKey: \"{variableValues.userId}\"\n\n# Cache by documentString\ncacheKey: \"{documentString}\"\n\n# Cache by operationName\ncacheKey: \"{operationName}\"\n\n# Cache by some header value\ncacheKey: \"{contextValue.headers.authorization}\"\n\n# Or combine two of each\ncacheKey: \"{contextValue.headers.authorization}-{operationName}\"\n```" }, "shouldCacheResult": { "type": "string", "description": "Checks if the result should be cached.\n```yaml\nshouldCacheResult: \"result.errors.length > 0\"\n```" } } }, "ResponseCacheTTLConfig": { "additionalProperties": false, "type": "object", "title": "ResponseCacheTTLConfig", "properties": { "coordinate": { "type": "string" }, "ttl": { "type": "number" } }, "required": ["coordinate", "ttl"] }, "SerializeHeadersConfig": { "additionalProperties": false, "type": "object", "title": "SerializeHeadersConfig", "properties": { "names": { "type": "array", "items": { "type": "string" }, "additionalItems": false } }, "required": ["names"] }, "SnapshotPluginConfig": { "additionalProperties": false, "type": "object", "title": "SnapshotPluginConfig", "properties": { "if": { "description": "Expression for when to activate this extension.\nValue can be a valid JS expression string or a boolean (Any of: String, Boolean)", "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "apply": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "HTTP URL pattern to be applied\nFor example;\n apply:\n - http://my-remote-api.com/* \\<- * will apply this extension to all paths of remote API" }, "outputDir": { "type": "string", "description": "Path to the directory of the generated snapshot files" } }, "required": ["apply", "outputDir"] }, "StatsdPlugin": { "additionalProperties": false, "type": "object", "title": "StatsdPlugin", "properties": { "skipIntrospection": { "type": "boolean", "description": "If you wish to disable introspection for logging (default: false)" }, "prefix": { "type": "string", "description": "prefix.operations.count (default: graphql)" }, "client": { "$ref": "#/definitions/StatsdClientConfiguration", "description": "Client Configuration" } } }, "StatsdClientConfiguration": { "additionalProperties": false, "type": "object", "title": "StatsdClientConfiguration", "properties": { "bufferFlushInterval": { "type": "integer" }, "bufferHolder": { "$ref": "#/definitions/StatsdClientBufferHolder" }, "cacheDns": { "type": "boolean" }, "cacheDnsTtl": { "type": "integer" }, "globalTags": { "type": "object", "properties": {} }, "globalize": { "type": "boolean" }, "host": { "type": "string" }, "isChild": { "type": "boolean" }, "maxBufferSize": { "type": "integer" }, "mock": { "type": "boolean" }, "path": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string", "enum": ["tcp", "udp", "uds", "stream"], "description": "Allowed values: tcp, udp, uds, stream" }, "sampleRate": { "type": "number" }, "suffix": { "type": "string" }, "telegraf": { "type": "boolean" }, "useDefaultRoute": { "type": "boolean" }, "tagPrefix": { "type": "string" }, "tagSeperator": { "type": "string" }, "tcpGracefulErrorHandling": { "type": "boolean" }, "tcpGracefulRestartRateLimit": { "type": "integer" }, "udsGracefulErrorHandling": { "type": "boolean" }, "udsGracefulRestartRateLimit": { "type": "integer" }, "closingFlushInterval": { "type": "integer" } } }, "StatsdClientBufferHolder": { "additionalProperties": false, "type": "object", "title": "StatsdClientBufferHolder", "properties": { "buffer": { "type": "string" } }, "required": ["buffer"] }, "PostGraphileHandler": { "additionalProperties": false, "type": "object", "title": "PostGraphileHandler", "properties": { "connectionString": { "type": "string", "description": "A connection string to your Postgres database" }, "schemaName": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "An array of strings which specifies the PostgreSQL schemas that PostGraphile will use to create a GraphQL schema. The default schema is the public schema." }, "pool": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Connection Pool instance or settings or you can provide the path of a code file that exports any of those" }, "appendPlugins": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Extra Postgraphile Plugins to append" }, "skipPlugins": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Postgraphile Plugins to skip (e.g. \"graphile-build#NodePlugin\")" }, "options": { "description": "Extra Postgraphile options that will be added to the postgraphile constructor. It can either be an object or a string pointing to the object's path (e.g. \"./my-config#options\"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-library/) for more information. (Any of: JSON, String)", "anyOf": [ { "type": "object", "properties": {} }, { "type": "string" } ] }, "subscriptions": { "type": "boolean", "description": "Enable GraphQL websocket transport support for subscriptions (default: true)" }, "live": { "type": "boolean", "description": "Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)" }, "contextOptions": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "A file that exports a function which takes context as a paramter and returns postgraphile context options (e.g. \"./my-function#pgSettings\"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-schema/) for more information." } } }, "RAMLHandler": { "additionalProperties": false, "type": "object", "title": "RAMLHandler", "properties": { "source": { "type": "string" }, "endpoint": { "type": "string" }, "schemaHeaders": { "type": "object", "properties": {} }, "operationHeaders": { "type": "object", "properties": {} }, "ignoreErrorResponses": { "type": "boolean" }, "selectQueryOrMutationField": { "type": "array", "items": { "$ref": "#/definitions/RAMLSelectQueryOrMutationFieldConfig" }, "additionalItems": false }, "queryParams": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "bundle": { "type": "boolean" }, "timeout": { "type": "integer", "description": "Timeout for the HTTP request in milliseconds" } }, "required": ["source"] }, "RAMLSelectQueryOrMutationFieldConfig": { "additionalProperties": false, "type": "object", "title": "RAMLSelectQueryOrMutationFieldConfig", "properties": { "type": { "type": "string", "enum": ["query", "mutation", "Query", "Mutation"], "description": "Allowed values: query, mutation, Query, Mutation" }, "fieldName": { "type": "string" } }, "required": ["type", "fieldName"] }, "SoapHandler": { "additionalProperties": false, "type": "object", "title": "SoapHandler", "properties": { "source": { "type": "string", "description": "A url to your WSDL or generated SDL with annotations" }, "schemaHeaders": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "JSON object representing the Headers to add to the runtime of the API calls only for schema introspection\nYou can also provide `.js` or `.ts` file path that exports schemaHeaders as an object" }, "operationHeaders": { "type": "object", "properties": {}, "description": "JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime" } }, "required": ["source"] }, "SupergraphHandler": { "additionalProperties": false, "type": "object", "title": "SupergraphHandler", "properties": { "source": { "type": "string", "description": "A file path to your Supergraph Schema\nIf you provide a path to a code file(js or ts),\nother options will be ignored and the schema exported from the file will be used directly." }, "schemaHeaders": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] } }, "required": ["source"] }, "ThriftHandler": { "additionalProperties": false, "type": "object", "title": "ThriftHandler", "properties": { "hostName": { "type": "string", "description": "The name of the host to connect to." }, "port": { "type": "integer", "description": "The port number to attach to on the host." }, "path": { "type": "string", "description": "The path on which the Thrift service is listening. Defaults to '/thrift'." }, "https": { "type": "boolean", "description": "Boolean value indicating whether to use https. Defaults to false." }, "protocol": { "type": "string", "enum": ["binary", "compact", "json"], "description": "Name of the Thrift protocol type to use. Defaults to 'binary'. (Allowed values: binary, compact, json)" }, "serviceName": { "type": "string", "description": "The name of your service. Used for logging." }, "operationHeaders": { "type": "object", "properties": {}, "description": "JSON object representing the Headers to add to the runtime of the API calls" }, "schemaHeaders": { "type": "object", "properties": {}, "description": "If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema." }, "idl": { "type": "string", "description": "Path to IDL file" } }, "required": ["hostName", "port", "serviceName", "idl"] }, "CacheTransformConfig": { "additionalProperties": false, "type": "object", "title": "CacheTransformConfig", "properties": { "field": { "type": "string", "description": "The type and field to apply cache to, you can use wild cards as well, for example: `Query.*`" }, "cacheKey": { "type": "string", "description": "Cache key to use to store your resolvers responses.\nThe default is: `{typeName}-{fieldName}-{argsHash}-{fieldNamesHash}`\n\nAvailable variables:\n - `{args.argName}` - use resolver argument\n - `{typeName}` - use name of the type\n - `{fieldName}` - use name of the field\n - `{argsHash}` - a hash based on the 'args' object\n - `{fieldNamesHash}` - a hash based on the field names selected by the client\n - `{info}` - the GraphQLResolveInfo of the resolver\n\nAvailable interpolations:\n - `{format|date}` - returns the current date with a specific format" }, "invalidate": { "$ref": "#/definitions/CacheInvalidateConfig", "description": "Invalidation rules" } }, "required": ["field"] }, "CacheInvalidateConfig": { "additionalProperties": false, "type": "object", "title": "CacheInvalidateConfig", "properties": { "effectingOperations": { "type": "array", "items": { "$ref": "#/definitions/CacheEffectingOperationConfig" }, "additionalItems": false, "description": "Invalidate the cache when a specific operation is done without an error" }, "ttl": { "type": "integer", "description": "Specified in seconds, the time-to-live (TTL) value limits the lifespan" } } }, "CacheEffectingOperationConfig": { "additionalProperties": false, "type": "object", "title": "CacheEffectingOperationConfig", "properties": { "operation": { "type": "string", "description": "Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field." }, "matchKey": { "type": "string", "description": "Cache key to invalidate on successful resolver (no error), see `cacheKey` for list of available options in this field." } }, "required": ["operation"] }, "EncapsulateTransformObject": { "additionalProperties": false, "type": "object", "title": "EncapsulateTransformObject", "properties": { "name": { "type": "string", "description": "Optional, name to use for grouping under the root types. If not specific, the API name is used." }, "applyTo": { "$ref": "#/definitions/EncapsulateTransformApplyTo", "description": "Allow you to choose which root operations you would like to apply. By default, it's applied to all root types." } } }, "EncapsulateTransformApplyTo": { "additionalProperties": false, "type": "object", "title": "EncapsulateTransformApplyTo", "properties": { "query": { "type": "boolean" }, "mutation": { "type": "boolean" }, "subscription": { "type": "boolean" } } }, "ExtendTransform": { "additionalProperties": false, "type": "object", "title": "ExtendTransform", "properties": { "typeDefs": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "resolvers": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] } } }, "FederationTransform": { "additionalProperties": false, "type": "object", "title": "FederationTransform", "properties": { "types": { "type": "array", "items": { "$ref": "#/definitions/FederationTransformType" }, "additionalItems": false }, "version": { "type": "string", "description": "Version of the federation spec\nDefault: v2.0" } } }, "FederationTransformType": { "additionalProperties": false, "type": "object", "title": "FederationTransformType", "properties": { "name": { "type": "string" }, "config": { "$ref": "#/definitions/FederationObjectConfig" } }, "required": ["name"] }, "FederationObjectConfig": { "additionalProperties": false, "type": "object", "title": "FederationObjectConfig", "properties": { "key": { "type": "array", "items": { "$ref": "#/definitions/FederationObjectKeyConfig" }, "additionalItems": false }, "shareable": { "type": "boolean" }, "extends": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/FederationField" }, "additionalItems": false }, "resolveReference": { "description": "Any of: String, ResolveReferenceObject", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/ResolveReferenceObject" } ] } } }, "FederationObjectKeyConfig": { "additionalProperties": false, "type": "object", "title": "FederationObjectKeyConfig", "properties": { "fields": { "type": "string" } } }, "ResolveReferenceObject": { "additionalProperties": false, "type": "object", "title": "ResolveReferenceObject", "properties": { "queryFieldName": { "type": "string", "description": "Name of root field name that resolves the reference" }, "args": { "type": "object", "properties": {}, "description": "You need configure the arguments for that field;\n```yaml\nargs:\n someArg: \"{root.someKeyValue}\"\n```" } }, "required": ["queryFieldName"] }, "FederationField": { "additionalProperties": false, "type": "object", "title": "FederationField", "properties": { "name": { "type": "string" }, "config": { "$ref": "#/definitions/FederationFieldConfig" } }, "required": ["name", "config"] }, "FederationFieldConfig": { "additionalProperties": false, "type": "object", "title": "FederationFieldConfig", "properties": { "external": { "type": "boolean" }, "provides": { "$ref": "#/definitions/FederationFieldProvidesConfig" }, "requires": { "$ref": "#/definitions/FederationFieldRequiresConfig" }, "tag": { "$ref": "#/definitions/FederationFieldTagConfig" }, "inaccessible": { "type": "boolean" }, "override": { "$ref": "#/definitions/FederationFieldOverrideConfig" } } }, "FederationFieldProvidesConfig": { "additionalProperties": false, "type": "object", "title": "FederationFieldProvidesConfig", "properties": { "fields": { "type": "string" } } }, "FederationFieldRequiresConfig": { "additionalProperties": false, "type": "object", "title": "FederationFieldRequiresConfig", "properties": { "fields": { "type": "string" } } }, "FederationFieldTagConfig": { "additionalProperties": false, "type": "object", "title": "FederationFieldTagConfig", "properties": { "name": { "type": "string" } } }, "FederationFieldOverrideConfig": { "additionalProperties": false, "type": "object", "title": "FederationFieldOverrideConfig", "properties": { "from": { "type": "string" } } }, "FilterSchemaTransform": { "additionalProperties": false, "type": "object", "title": "FilterSchemaTransform", "properties": { "mode": { "type": "string", "enum": ["bare", "wrap"], "description": "Specify to apply filter-schema transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)" }, "filters": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Array of filter rules" } }, "required": ["filters"] }, "HoistFieldTransformConfig": { "additionalProperties": false, "type": "object", "title": "HoistFieldTransformConfig", "properties": { "typeName": { "type": "string", "description": "Type name that defines where field should be hoisted to" }, "pathConfig": { "type": "array", "items": { "description": "Any of: String, HoistFieldTransformFieldPathConfigObject", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/HoistFieldTransformFieldPathConfigObject" } ] }, "additionalItems": false, "description": "Array of fieldsNames to reach the field to be hoisted (Any of: String, HoistFieldTransformFieldPathConfigObject)" }, "newFieldName": { "type": "string", "description": "Name the hoisted field should have when hoisted to the type specified in typeName" }, "alias": { "type": "string" }, "filterArgsInPath": { "type": "boolean", "description": "Defines if args in path are filtered (default = false)" } }, "required": ["typeName", "pathConfig", "newFieldName"] }, "HoistFieldTransformFieldPathConfigObject": { "additionalProperties": false, "type": "object", "title": "HoistFieldTransformFieldPathConfigObject", "properties": { "fieldName": { "type": "string", "description": "Field name" }, "filterArgs": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Match fields based on argument, needs to implement `(arg: GraphQLArgument) => boolean`;" } }, "required": ["fieldName", "filterArgs"] }, "NamingConventionTransformConfig": { "additionalProperties": false, "type": "object", "title": "NamingConventionTransformConfig", "properties": { "mode": { "type": "string", "enum": ["bare", "wrap"], "description": "Specify to apply naming-convention transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)" }, "typeNames": { "type": "string", "enum": [ "camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase" ], "description": "Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase" }, "fieldNames": { "type": "string", "enum": [ "camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase" ], "description": "Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase" }, "enumValues": { "type": "string", "enum": [ "camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase" ], "description": "Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase" }, "fieldArgumentNames": { "type": "string", "enum": [ "camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase" ], "description": "Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase" } } }, "PrefixTransformConfig": { "additionalProperties": false, "type": "object", "title": "PrefixTransformConfig", "properties": { "mode": { "type": "string", "enum": ["bare", "wrap"], "description": "Specify to apply prefix transform to bare schema or by wrapping original schema (Allowed values: bare, wrap)" }, "value": { "type": "string", "description": "The prefix to apply to the schema types. By default it's the API name." }, "ignore": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "List of ignored types" }, "includeRootOperations": { "type": "boolean", "description": "Changes root types and changes the field names (default: false)" }, "includeTypes": { "type": "boolean", "description": "Changes types (default: true)" } } }, "PruneTransformConfig": { "additionalProperties": false, "type": "object", "title": "PruneTransformConfig", "properties": { "skipPruning": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Types to skip pruning" }, "skipEmptyCompositeTypePruning": { "type": "boolean", "description": "Set to `true` to skip pruning object types or interfaces with no fields" }, "skipUnimplementedInterfacesPruning": { "type": "boolean", "description": "Set to `true` to skip pruning interfaces that are not implemented by any other types" }, "skipEmptyUnionPruning": { "type": "boolean", "description": "Set to `true` to skip pruning empty unions" }, "skipUnusedTypesPruning": { "type": "boolean", "description": "Set to `true` to skip pruning unused types" } } }, "RateLimitTransformConfig": { "additionalProperties": false, "type": "object", "title": "RateLimitTransformConfig", "properties": { "type": { "type": "string", "description": "The type name that the following field belongs to" }, "field": { "type": "string", "description": "The field of the type that the rate limit is applied to" }, "max": { "type": "integer", "description": "The maximum number of requests that can be made in a given time period" }, "ttl": { "type": "integer", "description": "The time period in which the rate limit is applied" }, "identifier": { "type": "string", "description": "The identifier expression that determines the identity of the request (e.g. `{context.req.socket.remoteAddress}`)" } }, "required": ["type", "field", "max", "ttl", "identifier"] }, "RenameTransform": { "additionalProperties": false, "type": "object", "title": "RenameTransform", "properties": { "mode": { "type": "string", "enum": ["bare", "wrap"], "description": "Specify to apply rename transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)" }, "renames": { "type": "array", "items": { "$ref": "#/definitions/RenameTransformObject" }, "additionalItems": false, "description": "Array of rename rules" } }, "required": ["renames"] }, "RenameTransformObject": { "additionalProperties": false, "type": "object", "title": "RenameTransformObject", "properties": { "from": { "$ref": "#/definitions/RenameConfig" }, "to": { "$ref": "#/definitions/RenameConfig" }, "useRegExpForTypes": { "type": "boolean", "description": "Use Regular Expression for type names" }, "useRegExpForFields": { "type": "boolean", "description": "Use Regular Expression for field names" }, "useRegExpForArguments": { "type": "boolean", "description": "Use Regular Expression for field names" }, "regExpFlags": { "type": "string", "description": "Flags to use in the Regular Expression" }, "includeDefaults": { "type": "boolean", "description": "Flag to indicate whether certain default types (built-ins, scalars and other types specified an exclusion list) should be renamed or not.\n\n@default: false" } }, "required": ["from", "to"] }, "RenameConfig": { "additionalProperties": false, "type": "object", "title": "RenameConfig", "properties": { "type": { "type": "string" }, "field": { "type": "string" }, "argument": { "type": "string" } } }, "ReplaceFieldTransformConfig": { "additionalProperties": false, "type": "object", "title": "ReplaceFieldTransformConfig", "properties": { "typeDefs": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Additional type definition to used to replace field types" }, "replacements": { "type": "array", "items": { "$ref": "#/definitions/ReplaceFieldTransformObject" }, "additionalItems": false, "description": "Array of rules to replace fields" } }, "required": ["replacements"] }, "ReplaceFieldTransformObject": { "additionalProperties": false, "type": "object", "title": "ReplaceFieldTransformObject", "properties": { "from": { "$ref": "#/definitions/ReplaceFieldConfig" }, "to": { "$ref": "#/definitions/ReplaceFieldConfig" }, "scope": { "type": "string", "enum": ["config", "hoistValue"], "description": "Allowed values: config, hoistValue" }, "composer": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ] }, "name": { "type": "string" } }, "required": ["from", "to"] }, "ReplaceFieldConfig": { "additionalProperties": false, "type": "object", "title": "ReplaceFieldConfig", "properties": { "type": { "type": "string" }, "field": { "type": "string" } }, "required": ["type", "field"] }, "ResolversCompositionTransform": { "additionalProperties": false, "type": "object", "title": "ResolversCompositionTransform", "properties": { "mode": { "type": "string", "enum": ["bare", "wrap"], "description": "Specify to apply resolvers-composition transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)" }, "compositions": { "type": "array", "items": { "$ref": "#/definitions/ResolversCompositionTransformObject" }, "additionalItems": false, "description": "Array of resolver/composer to apply" } }, "required": ["compositions"] }, "ResolversCompositionTransformObject": { "additionalProperties": false, "type": "object", "title": "ResolversCompositionTransformObject", "properties": { "resolver": { "type": "string", "description": "The GraphQL Resolver path\nExample: Query.users" }, "composer": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Path to the composer function\nExample: ./src/auth.js#authComposer" } }, "required": ["resolver", "composer"] }, "TransferSchemaTransformConfig": { "additionalProperties": false, "type": "object", "title": "TransferSchemaTransformConfig", "properties": { "transfers": { "type": "array", "items": { "$ref": "#/definitions/TransferSchemaTransformObject" }, "additionalItems": false, "description": "Array of rules to transfer fields or args" } }, "required": ["transfers"] }, "TransferSchemaTransformObject": { "additionalProperties": false, "type": "object", "title": "TransferSchemaTransformObject", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "action": { "type": "string", "enum": ["move", "copy"], "description": "Allowed values: move, copy" } }, "required": ["from", "to"] }, "TypeMergingConfig": { "additionalProperties": false, "type": "object", "title": "TypeMergingConfig", "properties": { "types": { "type": "array", "items": { "$ref": "#/definitions/MergedTypeConfig" }, "additionalItems": false }, "queryFields": { "type": "array", "items": { "$ref": "#/definitions/MergedRootFieldConfig" }, "additionalItems": false, "description": "Denotes a root field used to query a merged type across services.\nThe marked field's name is analogous\nto the fieldName setting in\n[merged type configuration](https://www.graphql-tools.com/docs/stitch-type-merging#basic-example),\nwhile the field's arguments and return type are used to infer merge configuration.\nDirective arguments tune the merge behavior" }, "additionalConfiguration": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "The path to a code file that has additional type merging configuration" } } }, "MergedRootFieldConfig": { "additionalProperties": false, "type": "object", "title": "MergedRootFieldConfig", "properties": { "queryFieldName": { "type": "string" }, "keyField": { "type": "string", "description": "Specifies the name of a field to pick off origin objects as the key value. When omitted, a `@key` directive must be included on the return type's definition to be built into an object key.\nhttps://www.graphql-tools.com/docs/stitch-directives-sdl#object-keys" }, "keyArg": { "type": "string", "description": "Specifies which field argument receives the merge key. This may be omitted for fields with only one argument where the recipient can be inferred." }, "additionalArgs": { "type": "string", "description": "Specifies a string of additional keys and values to apply to other arguments,\nformatted as `\\\"\\\"\\\" arg1: \"value\", arg2: \"value\" \\\"\\\"\\\"`." }, "key": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Advanced use only; Allows building a custom key just for the argument from the selectionSet included by the `@key` directive." }, "argsExpr": { "type": "string", "description": "Advanced use only; This argument specifies a string expression that allows more customization of the input arguments. Rules for evaluation of this argument are as follows:\n - basic object parsing of the input key: `\"arg1: $key.arg1, arg2: $key.arg2\"`\n - any expression enclosed by double brackets will be evaluated once for each of the requested keys, and then sent as a list: `\"input: { keys: [[$key]] }\"`\n - selections from the key can be referenced by using the $ sign and dot notation: `\"upcs: [[$key.upc]]\"`, so that `$key.upc` refers to the `upc` field of the key." } }, "required": ["queryFieldName"] }, "MergedTypeConfig": { "additionalProperties": false, "type": "object", "title": "MergedTypeConfig", "properties": { "typeName": { "type": "string", "description": "Name of the type (Query by default)" }, "key": { "$ref": "#/definitions/KeyAnnotation", "description": "Specifies a base selection set needed to merge the annotated type across subschemas.\nAnalogous to the `selectionSet` setting specified in [merged type configuration](https://www.graphql-tools.com/docs/stitch-type-merging#basic-example)." }, "canonical": { "type": "boolean", "description": "Specifies types and fields\nthat provide a [canonical definition](https://www.graphql-tools.com/docs/stitch-type-merging#canonical-definitions) to be built into the gateway schema. Useful for selecting preferred characteristics among types and fields that overlap across subschemas. Root fields marked as canonical specify which subschema the field proxies for new queries entering the graph." }, "fields": { "type": "array", "items": { "$ref": "#/definitions/MergedTypeField" }, "additionalItems": false } } }, "KeyAnnotation": { "additionalProperties": false, "type": "object", "title": "KeyAnnotation", "properties": { "selectionSet": { "type": "string" } }, "required": ["selectionSet"] }, "MergedTypeField": { "additionalProperties": false, "type": "object", "title": "MergedTypeField", "properties": { "fieldName": { "type": "string" }, "computed": { "$ref": "#/definitions/ComputedAnnotation", "description": "specifies a selection of fields required from other services to compute the value of this field.\nThese additional fields are only selected when the computed field is requested.\nAnalogous to [computed field](https://www.graphql-tools.com/docs/stitch-type-merging#computed-fields) in merged type configuration.\nComputed field dependencies must be sent into the subservice using an [object key](https://www.graphql-tools.com/docs/stitch-directives-sdl#object-keys)." } }, "required": ["fieldName"] }, "ComputedAnnotation": { "additionalProperties": false, "type": "object", "title": "ComputedAnnotation", "properties": { "selectionSet": { "type": "string" } }, "required": ["selectionSet"] }, "TuqlHandler": { "additionalProperties": false, "type": "object", "title": "TuqlHandler", "properties": { "db": { "type": "string", "description": "Pointer to your SQLite database" }, "infile": { "type": "string", "description": "Path to the SQL Dump file if you want to build a in-memory database" } } } }, "title": "Config", "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "required": ["sources"], "properties": { "serve": { "$ref": "#/definitions/ServeConfig", "description": "Configuration for `mesh start` or `mesh dev` command.\nThose commands won't be available in programmatic usage." }, "sdk": { "$ref": "#/definitions/SDKConfig", "description": "SDK Configuration" }, "codegen": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Codegen Configuration" }, "require": { "type": "array", "items": { "type": "string" }, "additionalItems": false }, "sources": { "type": "array", "items": { "$ref": "#/definitions/Source" }, "additionalItems": false, "description": "Defines the list of your external data sources for your API mesh" }, "transforms": { "type": "array", "items": { "$ref": "#/definitions/Transform" }, "additionalItems": false, "description": "Transform to apply to the unified mesh schema" }, "additionalTypeDefs": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Additional type definitions, or type definitions overrides you wish to add to the schema mesh" }, "additionalResolvers": { "type": "array", "items": { "description": "Any of: String, AdditionalStitchingResolverObject, AdditionalStitchingBatchResolverObject, AdditionalSubscriptionObject", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/AdditionalStitchingResolverObject" }, { "$ref": "#/definitions/AdditionalStitchingBatchResolverObject" }, { "$ref": "#/definitions/AdditionalSubscriptionObject" } ] }, "additionalItems": false, "description": "Additional resolvers, or resolvers overrides you wish to add to the schema mesh (Any of: String, AdditionalStitchingResolverObject, AdditionalStitchingBatchResolverObject, AdditionalSubscriptionObject)" }, "cache": { "$ref": "#/definitions/Cache", "description": "Backend cache" }, "merger": { "type": "string", "description": "Merge method" }, "pubsub": { "description": "PubSub Implementation (Any of: String, PubSubConfig)", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/PubSubConfig" } ] }, "documents": { "type": "array", "items": { "type": "string" }, "additionalItems": false, "description": "Provide a query or queries for GraphQL Playground, validation and SDK Generation\nThe value can be the file path, glob expression for the file paths or the SDL.\n(.js, .jsx, .graphql, .gql, .ts and .tsx files are supported." }, "logger": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Logger instance that matches `Console` interface of NodeJS" }, "customFetch": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" }, { "type": "array", "additionalItems": true } ], "description": "Path to a custom W3 Compatible Fetch Implementation" }, "skipSSLValidation": { "type": "boolean", "description": "Allow connections to an SSL endpoint without certificates" }, "additionalEnvelopPlugins": { "type": "string", "description": "You can provide Envelop plugins" }, "plugins": { "type": "array", "items": { "$ref": "#/definitions/Plugin" }, "additionalItems": false } }, "additionalProperties": false }

proxies.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "proxy-schema": { "type": "object", "properties": { "desc": { "type": "array", "items": { "type": "string" } }, "matchCondition": { "$ref": "#/definitions/match-condition-schema", "description": "Required - an object defining the requests that will trigger the execution of this proxy. It contains two properties shared with HTTP triggers - methods and route" }, "backendUri": { "type": "string", "description": "The URL of the backend resource to which the request should be proxied. This value may be templated. If this property is not included, Azure Functions will respond with an HTTP 200 OK" }, "requestOverrides": { "$ref": "#/definitions/requestOverrides-schema", "description": "The requestOverrides object defines changes made to the request when the backend resource is called. You can make changes to the HTTP method, headers, and query string parameters." }, "responseOverrides": { "$ref": "#/definitions/responseOverrides-schema", "description": "The responseOverrides object defines changes made to the response passed back to the client. You can make changes to the response's status code, reason phrase, headers, and body." }, "debug": { "type": "boolean" }, "disabled": { "type": "boolean" } }, "required": ["matchCondition"], "additionalProperties": false, "default": { "matchCondition": { "route": "" }, "backendUri": "" } }, "match-condition-schema": { "type": "object", "properties": { "route": { "type": "string", "description": "Required - This defines the route template, controlling to which request URLs your proxy will respond. Unlike in HTTP triggers, there is no default value" }, "methods": { "type": "array", "description": "This is an array of the HTTP methods to which the proxy will respond. If not specified, the proxy will respond to all HTTP methods on the route.", "minItems": 1, "items": { "$ref": "#/definitions/http-method-schema" }, "uniqueItems": true } }, "additionalProperties": false, "required": ["route"] }, "requestOverrides-schema": { "type": "object", "properties": { "backend.request.method": { "description": "This is the HTTP method which will be used to call the backend.", "anyOf": [ { "$ref": "#/definitions/http-method-schema" }, { "$ref": "#/definitions/request-overrides-value-expression-schema" } ] }, "backend.request.querystring.<ParameterName>": { "description": "A query string parameter which can be set for the call to the backend. Replace \"<ParameterName>\" with the name of the parameter you wish to set. If the empty string is provided, the parameter will not be included on the backend request", "$ref": "#/definitions/request-overrides-value-expression-schema" }, "backend.request.headers.<HeaderName>": { "description": "A header which can be set for the call to the backend. Replace \"<HeaderName>\" with the name of the header you wish to set. If the empty string is provided, the header will not be included on the backend request.", "$ref": "#/definitions/request-overrides-value-expression-schema" } }, "patternProperties": { "^backend\\.request\\.querystring\\..+$": { "description": "A query string parameter which can be set for the call to the backend. Values can reference application settings and parameters from the original client request. If the empty string is provided, the parameter will not be included on the backend request", "$ref": "#/definitions/request-overrides-value-expression-schema" }, "^backend\\.request\\.headers\\..+$": { "description": "A header which can be set for the call to the backend. Values can reference application settings, parameters from the original client request, and parameters from the backend response. If the empty string is provided, the header will not be included on the backend request.", "$ref": "#/definitions/request-overrides-value-expression-schema" } }, "additionalProperties": false }, "responseOverrides-schema": { "type": "object", "properties": { "response.statusCode": { "description": "The HTTP status code to be returned to the client.", "$ref": "#/definitions/response-overrides-value-expression-schema" }, "response.statusReason": { "description": "The HTTP reason phrase to be returned to the client.", "$ref": "#/definitions/response-overrides-value-expression-schema" }, "response.body": { "description": "The string representation of the body to be returned to the client.", "anyOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "minItems": 1, "items": { "type": "object" } } ] }, "response.headers.<HeaderName>": { "description": "A header which can be set for the response to the client. Replace \"<HeaderName>\" with the name of the header you wish to set. If the empty string is provided, the header will not be included on the response.", "$ref": "#/definitions/response-overrides-value-expression-schema" } }, "patternProperties": { "^response\\.headers\\..+$": { "description": "A header which can be set for the response to the client. Values can reference application settings, parameters from the original client request, and parameters from the backend response. If the empty string is provided, the header will not be included on the response.", "$ref": "#/definitions/response-overrides-value-expression-schema" } }, "additionalProperties": false }, "request-overrides-value-expression-schema": { "type": "string", "defaultSnippets": [ { "label": "Original Request Header", "description": "Read from one of the request headers", "body": "{request.headers.<HeaderName>}" }, { "label": "Original Request Query String Parameter", "description": "Read one of the original request query string parameters", "body": "{request.querystring.<ParameterName>}" }, { "label": "Original Request Method", "description": "Read the request method", "body": "{request.method}" } ] }, "response-overrides-value-expression-schema": { "type": "string", "defaultSnippets": [ { "label": "Backend Response Header", "description": "Read from one of the backend response headers", "body": "{backend.response.headers.<HeaderName>}" }, { "label": "Backend Response Status Code", "description": "Read the backend response status code.", "body": "{backend.response.statusCode}" }, { "label": "Backend Response Status Reason", "description": "Read the backend response status reason.", "body": "{backend.response.statusReason}" }, { "label": "Original Request Header", "description": "Read from one of the original request headers", "body": "{request.headers.<HeaderName>}" }, { "label": "Original Request Query String", "description": "Read one of the original request query string parameters", "body": "{request.querystring.<ParameterName>}" }, { "label": "Original Request Method", "description": "Read the original request method", "body": "{request.method}" }, { "label": "Backend Request Header", "description": "Read from backend request headers", "body": "{backend.request.headers.<HeaderName>}" }, { "label": "Backend Request Query String", "description": "Read one of the backend request query string parameters", "body": "{backend.request.querystring.<ParameterName>}" }, { "label": "Backend Request Method", "description": "Read the backend request method", "body": "{backend.request.method}" } ] }, "http-method-schema": { "enum": [ "GET", "POST", "HEAD", "OPTIONS", "PUT", "TRACE", "DELETE", "PATCH", "CONNECT" ] } }, "id": "https://json.schemastore.org/proxies.json", "properties": { "$schema": { "type": "string" }, "proxies": { "type": "object", "description": "The proxies object defines the proxies that will be used by the function app", "properties": { "<ProxyName>": { "$ref": "#/definitions/proxy-schema", "description": "Default template for a proxy. Replace \"<ProxyName>\" with a friendly name you wish to set." } }, "additionalProperties": { "$ref": "#/definitions/proxy-schema", "description": "A friendly name for the proxy" } } }, "required": ["proxies"], "title": "JSON schema for Azure Functions Proxies proxies.json files", "type": "object" }

samcli.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "AWS SAM CLI samconfig schema", "type": "object", "properties": { "version": { "title": "Config version", "type": "number", "default": 0.1 } }, "required": [ "version" ], "additionalProperties": false, "patternProperties": { "^.+$": { "title": "Environment", "properties": { "init": { "title": "Init command", "description": "Initialize an AWS SAM application.", "properties": { "parameters": { "title": "Parameters for the init command", "description": "Available parameters for the init command:\n* no_interactive:\nDisable interactive prompting for init parameters. (fail if any required values are missing)\n* architecture:\nArchitectures for Lambda functions.\n\nArchitectures: ['arm64', 'x86_64']\n* location:\nTemplate location (git, mercurial, http(s), zip, path).\n* runtime:\nLambda runtime for application.\n\nRuntimes: dotnet6, go1.x, java17, java11, java8.al2, java8, nodejs18.x, nodejs16.x, nodejs14.x, nodejs12.x, provided, provided.al2, python3.9, python3.8, python3.7, python3.11, python3.10, ruby3.2, ruby2.7\n* package_type:\nLambda deployment package type.\n\nPackage Types: Zip, Image\n* base_image:\nLambda base image for deploying IMAGE based package type.\n\nBase images: amazon/dotnet6-base, amazon/go-provided.al2-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java8-base, amazon/java8.al2-base, amazon/nodejs12.x-base, amazon/nodejs14.x-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.7-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby2.7-base, amazon/ruby3.2-base\n* dependency_manager:\nDependency manager for Lambda runtime.\n\nDependency managers: bundler, cli-package, gradle, maven, mod, npm, pip\n* output_dir:\nDirectory to initialize AWS SAM application.\n* name:\nName of AWS SAM Application.\n* app_template:\nIdentifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow.\n* no_input:\nDisable Cookiecutter prompting and accept default values defined in the cookiecutter config.\n* extra_context:\nOverride custom parameters in the template's cookiecutter.json configuration e.g. {\"customParam1\": \"customValue1\", \"customParam2\":\"customValue2\"}\n* tracing:\nEnable AWS X-Ray tracing for application.\n* application_insights:\nEnable CloudWatch Application Insights monitoring for application.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "no_interactive": { "title": "no_interactive", "type": "boolean", "description": "Disable interactive prompting for init parameters. (fail if any required values are missing)" }, "architecture": { "title": "architecture", "type": "string", "description": "Architectures for Lambda functions.\n\nArchitectures: ['arm64', 'x86_64']", "enum": [ "arm64", "x86_64" ] }, "location": { "title": "location", "type": "string", "description": "Template location (git, mercurial, http(s), zip, path)." }, "runtime": { "title": "runtime", "type": "string", "description": "Lambda runtime for application.\n\nRuntimes: dotnet6, go1.x, java17, java11, java8.al2, java8, nodejs18.x, nodejs16.x, nodejs14.x, nodejs12.x, provided, provided.al2, python3.9, python3.8, python3.7, python3.11, python3.10, ruby3.2, ruby2.7", "enum": [ "dotnet6", "go1.x", "java11", "java17", "java8", "java8.al2", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "provided", "provided.al2", "python3.10", "python3.11", "python3.7", "python3.8", "python3.9", "ruby2.7", "ruby3.2" ] }, "package_type": { "title": "package_type", "type": "string", "description": "Lambda deployment package type.\n\nPackage Types: Zip, Image", "enum": [ "Image", "Zip" ] }, "base_image": { "title": "base_image", "type": "string", "description": "Lambda base image for deploying IMAGE based package type.\n\nBase images: amazon/dotnet6-base, amazon/go-provided.al2-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java8-base, amazon/java8.al2-base, amazon/nodejs12.x-base, amazon/nodejs14.x-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.7-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby2.7-base, amazon/ruby3.2-base", "enum": [ "amazon/dotnet6-base", "amazon/go-provided.al2-base", "amazon/go1.x-base", "amazon/java11-base", "amazon/java17-base", "amazon/java8-base", "amazon/java8.al2-base", "amazon/nodejs12.x-base", "amazon/nodejs14.x-base", "amazon/nodejs16.x-base", "amazon/nodejs18.x-base", "amazon/python3.10-base", "amazon/python3.11-base", "amazon/python3.7-base", "amazon/python3.8-base", "amazon/python3.9-base", "amazon/ruby2.7-base", "amazon/ruby3.2-base" ] }, "dependency_manager": { "title": "dependency_manager", "type": "string", "description": "Dependency manager for Lambda runtime.\n\nDependency managers: bundler, cli-package, gradle, maven, mod, npm, pip", "enum": [ "bundler", "cli-package", "gradle", "maven", "mod", "npm", "pip" ] }, "output_dir": { "title": "output_dir", "type": "string", "description": "Directory to initialize AWS SAM application.", "default": "." }, "name": { "title": "name", "type": "string", "description": "Name of AWS SAM Application." }, "app_template": { "title": "app_template", "type": "string", "description": "Identifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow." }, "no_input": { "title": "no_input", "type": "boolean", "description": "Disable Cookiecutter prompting and accept default values defined in the cookiecutter config." }, "extra_context": { "title": "extra_context", "type": "string", "description": "Override custom parameters in the template's cookiecutter.json configuration e.g. {\"customParam1\": \"customValue1\", \"customParam2\":\"customValue2\"}" }, "tracing": { "title": "tracing", "type": "boolean", "description": "Enable AWS X-Ray tracing for application." }, "application_insights": { "title": "application_insights", "type": "boolean", "description": "Enable CloudWatch Application Insights monitoring for application." }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "validate": { "title": "Validate command", "description": "Validate an AWS SAM Template.", "properties": { "parameters": { "title": "Parameters for the validate command", "description": "Available parameters for the validate command:\n* template_file:\nAWS SAM template file.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* lint:\nRun linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint", "type": "object", "properties": { "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template file.", "default": "template.[yaml|yml|json]" }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "lint": { "title": "lint", "type": "boolean", "description": "Run linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint" } } } }, "required": [ "parameters" ] }, "build": { "title": "Build command", "description": "Build AWS serverless function code.", "properties": { "parameters": { "title": "Parameters for the build command", "description": "Available parameters for the build command:\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* use_container:\nBuild functions within an AWS Lambda-like container.\n* container_env_var:\nEnvironment variables to be passed into build containers\nResource format (FuncName.VarName=Value) or Global format (VarName=Value).\n\n Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2\n* container_env_var_file:\nEnvironment variables json file (e.g., env_vars.json) to be passed to build containers.\n* build_image:\nContainer image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used.\n* exclude:\nName of the resource(s) to exclude from AWS SAM CLI build.\n* parallel:\nEnable parallel builds for AWS SAM template's functions and layers.\n* mount_with:\nSpecify mount mode for building functions/layers inside container. If it is mounted with write permissions, some files in source code directory may be changed/added by the build process. By default the source code directory is read only.\n* build_dir:\nDirectory to store build artifacts.Note: This directory will be first removed before starting a build.\n* cache_dir:\nDirectory to store cached artifacts. The default cache directory is .aws-sam/cache\n* base_dir:\nResolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location.\n* manifest:\nPath to a custom dependency manifest. Example: custom-package.json\n* cached:\nEnable cached builds.Reuse build artifacts that have not changed from previous builds. \n\nAWS SAM CLI evaluates if files in your project directory have changed. \n\nNote: AWS SAM CLI does not evaluate changes made to third party modules that the project depends on.Example: Python function includes a requirements.txt file with the following entry requests=1.x and the latest request module version changes from 1.1 to 1.2, AWS SAM CLI will not pull the latest version until a non-cached build is run.\n* template_file:\nAWS SAM template file.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "hook_name": { "title": "hook_name", "type": "string", "description": "Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']" }, "skip_prepare_infra": { "title": "skip_prepare_infra", "type": "boolean", "description": "Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name." }, "use_container": { "title": "use_container", "type": "boolean", "description": "Build functions within an AWS Lambda-like container." }, "container_env_var": { "title": "container_env_var", "type": "string", "description": "Environment variables to be passed into build containers\nResource format (FuncName.VarName=Value) or Global format (VarName=Value).\n\n Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2" }, "container_env_var_file": { "title": "container_env_var_file", "type": "string", "description": "Environment variables json file (e.g., env_vars.json) to be passed to build containers." }, "build_image": { "title": "build_image", "type": "string", "description": "Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used." }, "exclude": { "title": "exclude", "type": "string", "description": "Name of the resource(s) to exclude from AWS SAM CLI build." }, "parallel": { "title": "parallel", "type": "boolean", "description": "Enable parallel builds for AWS SAM template's functions and layers." }, "mount_with": { "title": "mount_with", "type": "string", "description": "Specify mount mode for building functions/layers inside container. If it is mounted with write permissions, some files in source code directory may be changed/added by the build process. By default the source code directory is read only.", "default": "READ", "enum": [ "READ", "WRITE" ] }, "build_dir": { "title": "build_dir", "type": "string", "description": "Directory to store build artifacts.Note: This directory will be first removed before starting a build.", "default": ".aws-sam/build" }, "cache_dir": { "title": "cache_dir", "type": "string", "description": "Directory to store cached artifacts. The default cache directory is .aws-sam/cache", "default": ".aws-sam/cache" }, "base_dir": { "title": "base_dir", "type": "string", "description": "Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location." }, "manifest": { "title": "manifest", "type": "string", "description": "Path to a custom dependency manifest. Example: custom-package.json" }, "cached": { "title": "cached", "type": "boolean", "description": "Enable cached builds.Reuse build artifacts that have not changed from previous builds. \n\nAWS SAM CLI evaluates if files in your project directory have changed. \n\nNote: AWS SAM CLI does not evaluate changes made to third party modules that the project depends on.Example: Python function includes a requirements.txt file with the following entry requests=1.x and the latest request module version changes from 1.1 to 1.2, AWS SAM CLI will not pull the latest version until a non-cached build is run." }, "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template file.", "default": "template.[yaml|yml|json]" }, "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "skip_pull_image": { "title": "skip_pull_image", "type": "boolean", "description": "Skip pulling down the latest Docker image for Lambda runtime." }, "docker_network": { "title": "docker_network", "type": "string", "description": "Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network." }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "local_invoke": { "title": "Local Invoke command", "description": "Invoke AWS serverless functions locally.", "properties": { "parameters": { "title": "Parameters for the local invoke command", "description": "Available parameters for the local invoke command:\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* event:\nJSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin\n* no_event:\nDEPRECATED: By default no event is assumed.\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* env_vars:\nJSON file containing values for Lambda function's environment variables.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* debug_port:\nWhen specified, Lambda function container will start in debug mode and will expose this port on localhost.\n* debugger_path:\nHost path to a debugger that will be mounted into the Lambda container.\n* debug_args:\nAdditional arguments to be passed to the debugger.\n* container_env_vars:\nJSON file containing environment variables to be set within the container environment\n* docker_volume_basedir:\nSpecify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.\n* log_file:\nFile to capture output logs.\n* layer_cache_basedir:\nSpecify the location basedir where the lambda layers used by the template will be downloaded to.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* force_image_build:\nForce rebuilding the image used for invoking functions with layers.\n* shutdown:\nEmulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.\n* container_host:\nHost of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`\n* container_host_interface:\nIP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.\n* invoke_image:\nContainer image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "hook_name": { "title": "hook_name", "type": "string", "description": "Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']" }, "skip_prepare_infra": { "title": "skip_prepare_infra", "type": "boolean", "description": "Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name." }, "event": { "title": "event", "type": "string", "description": "JSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin" }, "no_event": { "title": "no_event", "type": "boolean", "description": "DEPRECATED: By default no event is assumed.", "default": true }, "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template which references built artifacts for resources in the template. (if applicable)", "default": "template.[yaml|yml|json]" }, "env_vars": { "title": "env_vars", "type": "string", "description": "JSON file containing values for Lambda function's environment variables." }, "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "debug_port": { "title": "debug_port", "type": "integer", "description": "When specified, Lambda function container will start in debug mode and will expose this port on localhost." }, "debugger_path": { "title": "debugger_path", "type": "string", "description": "Host path to a debugger that will be mounted into the Lambda container." }, "debug_args": { "title": "debug_args", "type": "string", "description": "Additional arguments to be passed to the debugger." }, "container_env_vars": { "title": "container_env_vars", "type": "string", "description": "JSON file containing environment variables to be set within the container environment" }, "docker_volume_basedir": { "title": "docker_volume_basedir", "type": "string", "description": "Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine." }, "log_file": { "title": "log_file", "type": "string", "description": "File to capture output logs." }, "layer_cache_basedir": { "title": "layer_cache_basedir", "type": "string", "description": "Specify the location basedir where the lambda layers used by the template will be downloaded to." }, "skip_pull_image": { "title": "skip_pull_image", "type": "boolean", "description": "Skip pulling down the latest Docker image for Lambda runtime." }, "docker_network": { "title": "docker_network", "type": "string", "description": "Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network." }, "force_image_build": { "title": "force_image_build", "type": "boolean", "description": "Force rebuilding the image used for invoking functions with layers." }, "shutdown": { "title": "shutdown", "type": "boolean", "description": "Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior." }, "container_host": { "title": "container_host", "type": "string", "description": "Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`", "default": "localhost" }, "container_host_interface": { "title": "container_host_interface", "type": "string", "description": "IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.", "default": "127.0.0.1" }, "invoke_image": { "title": "invoke_image", "type": "string", "description": "Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used." }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "local_start_api": { "title": "Local Start Api command", "description": "Run & test AWS serverless functions locally as a HTTP API.", "properties": { "parameters": { "title": "Parameters for the local start api command", "description": "Available parameters for the local start api command:\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* host:\nLocal hostname or IP address to bind to (default: '127.0.0.1')\n* port:\nLocal port number to listen on (default: '3000')\n* static_dir:\nAny static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* env_vars:\nJSON file containing values for Lambda function's environment variables.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* debug_port:\nWhen specified, Lambda function container will start in debug mode and will expose this port on localhost.\n* debugger_path:\nHost path to a debugger that will be mounted into the Lambda container.\n* debug_args:\nAdditional arguments to be passed to the debugger.\n* container_env_vars:\nJSON file containing environment variables to be set within the container environment\n* docker_volume_basedir:\nSpecify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.\n* log_file:\nFile to capture output logs.\n* layer_cache_basedir:\nSpecify the location basedir where the lambda layers used by the template will be downloaded to.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* force_image_build:\nForce rebuilding the image used for invoking functions with layers.\n* warm_containers:\nOptional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY: Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.\n* debug_function:\nOptional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.\n* shutdown:\nEmulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.\n* container_host:\nHost of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`\n* container_host_interface:\nIP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.\n* invoke_image:\nContainer image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "hook_name": { "title": "hook_name", "type": "string", "description": "Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']" }, "skip_prepare_infra": { "title": "skip_prepare_infra", "type": "boolean", "description": "Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name." }, "host": { "title": "host", "type": "string", "description": "Local hostname or IP address to bind to (default: '127.0.0.1')", "default": "127.0.0.1" }, "port": { "title": "port", "type": "integer", "description": "Local port number to listen on (default: '3000')", "default": 3000 }, "static_dir": { "title": "static_dir", "type": "string", "description": "Any static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /", "default": "public" }, "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template which references built artifacts for resources in the template. (if applicable)", "default": "template.[yaml|yml|json]" }, "env_vars": { "title": "env_vars", "type": "string", "description": "JSON file containing values for Lambda function's environment variables." }, "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "debug_port": { "title": "debug_port", "type": "integer", "description": "When specified, Lambda function container will start in debug mode and will expose this port on localhost." }, "debugger_path": { "title": "debugger_path", "type": "string", "description": "Host path to a debugger that will be mounted into the Lambda container." }, "debug_args": { "title": "debug_args", "type": "string", "description": "Additional arguments to be passed to the debugger." }, "container_env_vars": { "title": "container_env_vars", "type": "string", "description": "JSON file containing environment variables to be set within the container environment" }, "docker_volume_basedir": { "title": "docker_volume_basedir", "type": "string", "description": "Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine." }, "log_file": { "title": "log_file", "type": "string", "description": "File to capture output logs." }, "layer_cache_basedir": { "title": "layer_cache_basedir", "type": "string", "description": "Specify the location basedir where the lambda layers used by the template will be downloaded to." }, "skip_pull_image": { "title": "skip_pull_image", "type": "boolean", "description": "Skip pulling down the latest Docker image for Lambda runtime." }, "docker_network": { "title": "docker_network", "type": "string", "description": "Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network." }, "force_image_build": { "title": "force_image_build", "type": "boolean", "description": "Force rebuilding the image used for invoking functions with layers." }, "warm_containers": { "title": "warm_containers", "type": "string", "description": "Optional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY: Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.", "enum": [ "EAGER", "LAZY" ] }, "debug_function": { "title": "debug_function", "type": "string", "description": "Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args." }, "shutdown": { "title": "shutdown", "type": "boolean", "description": "Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior." }, "container_host": { "title": "container_host", "type": "string", "description": "Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`", "default": "localhost" }, "container_host_interface": { "title": "container_host_interface", "type": "string", "description": "IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.", "default": "127.0.0.1" }, "invoke_image": { "title": "invoke_image", "type": "string", "description": "Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used." }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "local_generate_event": { "title": "Local Generate Event command", "description": "Generate events for Lambda functions.", "properties": { "parameters": { "title": "Parameters for the local generate event command", "description": "Available parameters for the local generate event command:\n* ", "type": "object", "properties": {} } }, "required": [ "parameters" ] }, "local_start_lambda": { "title": "Local Start Lambda command", "description": "Emulate AWS serverless functions locally.", "properties": { "parameters": { "title": "Parameters for the local start lambda command", "description": "Available parameters for the local start lambda command:\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* host:\nLocal hostname or IP address to bind to (default: '127.0.0.1')\n* port:\nLocal port number to listen on (default: '3001')\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* env_vars:\nJSON file containing values for Lambda function's environment variables.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* debug_port:\nWhen specified, Lambda function container will start in debug mode and will expose this port on localhost.\n* debugger_path:\nHost path to a debugger that will be mounted into the Lambda container.\n* debug_args:\nAdditional arguments to be passed to the debugger.\n* container_env_vars:\nJSON file containing environment variables to be set within the container environment\n* docker_volume_basedir:\nSpecify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.\n* log_file:\nFile to capture output logs.\n* layer_cache_basedir:\nSpecify the location basedir where the lambda layers used by the template will be downloaded to.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* force_image_build:\nForce rebuilding the image used for invoking functions with layers.\n* warm_containers:\nOptional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY: Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.\n* debug_function:\nOptional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.\n* shutdown:\nEmulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.\n* container_host:\nHost of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`\n* container_host_interface:\nIP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.\n* invoke_image:\nContainer image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "hook_name": { "title": "hook_name", "type": "string", "description": "Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']" }, "skip_prepare_infra": { "title": "skip_prepare_infra", "type": "boolean", "description": "Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name." }, "host": { "title": "host", "type": "string", "description": "Local hostname or IP address to bind to (default: '127.0.0.1')", "default": "127.0.0.1" }, "port": { "title": "port", "type": "integer", "description": "Local port number to listen on (default: '3001')", "default": 3001 }, "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template which references built artifacts for resources in the template. (if applicable)", "default": "template.[yaml|yml|json]" }, "env_vars": { "title": "env_vars", "type": "string", "description": "JSON file containing values for Lambda function's environment variables." }, "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "debug_port": { "title": "debug_port", "type": "integer", "description": "When specified, Lambda function container will start in debug mode and will expose this port on localhost." }, "debugger_path": { "title": "debugger_path", "type": "string", "description": "Host path to a debugger that will be mounted into the Lambda container." }, "debug_args": { "title": "debug_args", "type": "string", "description": "Additional arguments to be passed to the debugger." }, "container_env_vars": { "title": "container_env_vars", "type": "string", "description": "JSON file containing environment variables to be set within the container environment" }, "docker_volume_basedir": { "title": "docker_volume_basedir", "type": "string", "description": "Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine." }, "log_file": { "title": "log_file", "type": "string", "description": "File to capture output logs." }, "layer_cache_basedir": { "title": "layer_cache_basedir", "type": "string", "description": "Specify the location basedir where the lambda layers used by the template will be downloaded to." }, "skip_pull_image": { "title": "skip_pull_image", "type": "boolean", "description": "Skip pulling down the latest Docker image for Lambda runtime." }, "docker_network": { "title": "docker_network", "type": "string", "description": "Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network." }, "force_image_build": { "title": "force_image_build", "type": "boolean", "description": "Force rebuilding the image used for invoking functions with layers." }, "warm_containers": { "title": "warm_containers", "type": "string", "description": "Optional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY: Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.", "enum": [ "EAGER", "LAZY" ] }, "debug_function": { "title": "debug_function", "type": "string", "description": "Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args." }, "shutdown": { "title": "shutdown", "type": "boolean", "description": "Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior." }, "container_host": { "title": "container_host", "type": "string", "description": "Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`", "default": "localhost" }, "container_host_interface": { "title": "container_host_interface", "type": "string", "description": "IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.", "default": "127.0.0.1" }, "invoke_image": { "title": "invoke_image", "type": "string", "description": "Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used." }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "package": { "title": "Package command", "description": "Package an AWS SAM application.", "properties": { "parameters": { "title": "Parameters for the package command", "description": "Available parameters for the package command:\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* output_template_file:\nThe path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output.\n* s3_bucket:\nAWS S3 bucket where artifacts referenced in the template are uploaded.\n* image_repository:\nAWS ECR repository URI where artifacts referenced in the template are uploaded.\n* image_repositories:\nMapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.\n* s3_prefix:\nPrefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.\n* kms_key_id:\nThe ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.\n* use_json:\nIndicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.\n* force_upload:\nIndicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.\n* resolve_s3:\nAutomatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.\n* metadata:\nMap of metadata to attach to ALL the artifacts that are referenced in the template.\n* signing_profiles:\nA string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName\n* no_progressbar:\nDoes not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template which references built artifacts for resources in the template. (if applicable)", "default": "template.[yaml|yml|json]" }, "output_template_file": { "title": "output_template_file", "type": "string", "description": "The path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output." }, "s3_bucket": { "title": "s3_bucket", "type": "string", "description": "AWS S3 bucket where artifacts referenced in the template are uploaded." }, "image_repository": { "title": "image_repository", "type": "string", "description": "AWS ECR repository URI where artifacts referenced in the template are uploaded." }, "image_repositories": { "title": "image_repositories", "type": "array", "description": "Mapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.", "items": { "type": "string" } }, "s3_prefix": { "title": "s3_prefix", "type": "string", "description": "Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket." }, "kms_key_id": { "title": "kms_key_id", "type": "string", "description": "The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket." }, "use_json": { "title": "use_json", "type": "boolean", "description": "Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default." }, "force_upload": { "title": "force_upload", "type": "boolean", "description": "Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket." }, "resolve_s3": { "title": "resolve_s3", "type": "boolean", "description": "Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option." }, "metadata": { "title": "metadata", "type": "string", "description": "Map of metadata to attach to ALL the artifacts that are referenced in the template." }, "signing_profiles": { "title": "signing_profiles", "type": "string", "description": "A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName" }, "no_progressbar": { "title": "no_progressbar", "type": "boolean", "description": "Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "deploy": { "title": "Deploy command", "description": "The sam deploy command creates a Cloudformation Stack and deploys your resources.", "properties": { "parameters": { "title": "Parameters for the deploy command", "description": "Available parameters for the deploy command:\n* guided:\nSpecify this flag to allow SAM CLI to guide you through the deployment using guided prompts.\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* no_execute_changeset:\nIndicates whether to execute the change set. Specify this flag to view stack changes before executing the change set.\n* fail_on_empty_changeset:\nSpecify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.\n* confirm_changeset:\nPrompt to confirm if the computed changeset is to be deployed by SAM CLI.\n* disable_rollback:\nPreserves the state of previously provisioned resources when an operation fails.\n* on_failure:\nProvide an action to determine what will happen when a stack fails to create. Three actions are available:\n\n- ROLLBACK: This will rollback a stack to a previous known good state.\n\n- DELETE: The stack will rollback to a previous state if one exists, otherwise the stack will be deleted.\n\n- DO_NOTHING: The stack will not rollback or delete, this is the same as disabling rollback.\n\nDefault behaviour is ROLLBACK.\n\n\n\nThis option is mutually exclusive with --disable-rollback/--no-disable-rollback. You can provide\n--on-failure or --disable-rollback/--no-disable-rollback but not both at the same time.\n* stack_name:\nName of the AWS CloudFormation stack.\n* s3_bucket:\nAWS S3 bucket where artifacts referenced in the template are uploaded.\n* image_repository:\nAWS ECR repository URI where artifacts referenced in the template are uploaded.\n* image_repositories:\nMapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.\n* force_upload:\nIndicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.\n* s3_prefix:\nPrefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.\n* kms_key_id:\nThe ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.\n* role_arn:\nARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.\n* use_json:\nIndicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.\n* resolve_s3:\nAutomatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.\n* resolve_image_repos:\nAutomatically create and delete ECR repositories for image-based functions in non-guided deployments. A companion stack containing ECR repos for each function will be deployed along with the template stack. Automatically created image repositories will be deleted if the corresponding functions are removed.\n* metadata:\nMap of metadata to attach to ALL the artifacts that are referenced in the template.\n* notification_arns:\nARNs of SNS topics that AWS Cloudformation associates with the stack.\n* tags:\nList of tags to associate with the stack.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* signing_profiles:\nA string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName\n* no_progressbar:\nDoes not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR\n* capabilities:\nList of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "guided": { "title": "guided", "type": "boolean", "description": "Specify this flag to allow SAM CLI to guide you through the deployment using guided prompts." }, "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template which references built artifacts for resources in the template. (if applicable)", "default": "template.[yaml|yml|json]" }, "no_execute_changeset": { "title": "no_execute_changeset", "type": "boolean", "description": "Indicates whether to execute the change set. Specify this flag to view stack changes before executing the change set." }, "fail_on_empty_changeset": { "title": "fail_on_empty_changeset", "type": "boolean", "description": "Specify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.", "default": true }, "confirm_changeset": { "title": "confirm_changeset", "type": "boolean", "description": "Prompt to confirm if the computed changeset is to be deployed by SAM CLI." }, "disable_rollback": { "title": "disable_rollback", "type": "boolean", "description": "Preserves the state of previously provisioned resources when an operation fails." }, "on_failure": { "title": "on_failure", "type": "string", "description": "Provide an action to determine what will happen when a stack fails to create. Three actions are available:\n\n- ROLLBACK: This will rollback a stack to a previous known good state.\n\n- DELETE: The stack will rollback to a previous state if one exists, otherwise the stack will be deleted.\n\n- DO_NOTHING: The stack will not rollback or delete, this is the same as disabling rollback.\n\nDefault behaviour is ROLLBACK.\n\n\n\nThis option is mutually exclusive with --disable-rollback/--no-disable-rollback. You can provide\n--on-failure or --disable-rollback/--no-disable-rollback but not both at the same time.", "default": "ROLLBACK", "enum": [ "DELETE", "DO_NOTHING", "ROLLBACK" ] }, "stack_name": { "title": "stack_name", "type": "string", "description": "Name of the AWS CloudFormation stack." }, "s3_bucket": { "title": "s3_bucket", "type": "string", "description": "AWS S3 bucket where artifacts referenced in the template are uploaded." }, "image_repository": { "title": "image_repository", "type": "string", "description": "AWS ECR repository URI where artifacts referenced in the template are uploaded." }, "image_repositories": { "title": "image_repositories", "type": "array", "description": "Mapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.", "items": { "type": "string" } }, "force_upload": { "title": "force_upload", "type": "boolean", "description": "Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket." }, "s3_prefix": { "title": "s3_prefix", "type": "string", "description": "Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket." }, "kms_key_id": { "title": "kms_key_id", "type": "string", "description": "The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket." }, "role_arn": { "title": "role_arn", "type": "string", "description": "ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set." }, "use_json": { "title": "use_json", "type": "boolean", "description": "Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default." }, "resolve_s3": { "title": "resolve_s3", "type": "boolean", "description": "Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option." }, "resolve_image_repos": { "title": "resolve_image_repos", "type": "boolean", "description": "Automatically create and delete ECR repositories for image-based functions in non-guided deployments. A companion stack containing ECR repos for each function will be deployed along with the template stack. Automatically created image repositories will be deleted if the corresponding functions are removed." }, "metadata": { "title": "metadata", "type": "string", "description": "Map of metadata to attach to ALL the artifacts that are referenced in the template." }, "notification_arns": { "title": "notification_arns", "type": [ "array", "string" ], "description": "ARNs of SNS topics that AWS Cloudformation associates with the stack.", "items": { "type": "string" } }, "tags": { "title": "tags", "type": "array", "description": "List of tags to associate with the stack.", "items": { "type": "string" } }, "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "signing_profiles": { "title": "signing_profiles", "type": "string", "description": "A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName" }, "no_progressbar": { "title": "no_progressbar", "type": "boolean", "description": "Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR" }, "capabilities": { "title": "capabilities", "type": [ "array", "string" ], "description": "List of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html", "items": { "type": "string" } }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "delete": { "title": "Delete command", "description": "The sam delete command deletes the CloudFormation\nstack and all the artifacts which were created using sam deploy.\n\n\ne.g. sam delete", "properties": { "parameters": { "title": "Parameters for the delete command", "description": "Available parameters for the delete command:\n* stack_name:\nThe name of the AWS CloudFormation stack you want to delete.\n* no_prompts:\nSpecify this flag to allow SAM CLI to skip through the guided prompts.\n* s3_bucket:\nThe S3 bucket path you want to delete.\n* s3_prefix:\nThe S3 prefix you want to delete\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "stack_name": { "title": "stack_name", "type": "string", "description": "The name of the AWS CloudFormation stack you want to delete." }, "no_prompts": { "title": "no_prompts", "type": "boolean", "description": "Specify this flag to allow SAM CLI to skip through the guided prompts." }, "s3_bucket": { "title": "s3_bucket", "type": "string", "description": "The S3 bucket path you want to delete." }, "s3_prefix": { "title": "s3_prefix", "type": "string", "description": "The S3 prefix you want to delete" }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "logs": { "title": "Logs command", "description": "The sam logs commands fetches logs of Lambda Functions/CloudWatch log groups\nwith additional filtering by options.", "properties": { "parameters": { "title": "Parameters for the logs command", "description": "Available parameters for the logs command:\n* name:\nThe name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, this can be the LogicalID of the resource in the CloudFormation/SAM template. Multiple names can be provided by repeating the parameter again. If resource is in a nested stack, name can be prepended by nested stack name to pull logs from that resource (NestedStackLogicalId/ResourceLogicalId). If it is not provided and no --cw-log-group have been given, it will scan given stack and find all supported resources, and start pulling log information from them.\n* stack_name:\nName of the AWS CloudFormation stack that the function is a part of.\n* filter:\nYou can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. \"error\") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\n* tail:\nTail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources\n* include_traces:\nInclude the XRay traces in the log output.\n* cw_log_group:\nAdditional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well\n* output:\nThe formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting\n* end_time:\nFetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'\n* start_time:\nFetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "name": { "title": "name", "type": "string", "description": "The name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, this can be the LogicalID of the resource in the CloudFormation/SAM template. Multiple names can be provided by repeating the parameter again. If resource is in a nested stack, name can be prepended by nested stack name to pull logs from that resource (NestedStackLogicalId/ResourceLogicalId). If it is not provided and no --cw-log-group have been given, it will scan given stack and find all supported resources, and start pulling log information from them." }, "stack_name": { "title": "stack_name", "type": "string", "description": "Name of the AWS CloudFormation stack that the function is a part of." }, "filter": { "title": "filter", "type": "string", "description": "You can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. \"error\") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html" }, "tail": { "title": "tail", "type": "boolean", "description": "Tail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources" }, "include_traces": { "title": "include_traces", "type": "boolean", "description": "Include the XRay traces in the log output." }, "cw_log_group": { "title": "cw_log_group", "type": "string", "description": "Additional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well" }, "output": { "title": "output", "type": "string", "description": "The formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting", "enum": [ "json", "text" ] }, "end_time": { "title": "end_time", "type": "string", "description": "Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'" }, "start_time": { "title": "start_time", "type": "string", "description": "Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.", "default": "10m ago" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "publish": { "title": "Publish command", "description": "Use this command to publish a packaged AWS SAM template to\nthe AWS Serverless Application Repository to share within your team,\nacross your organization, or with the community at large.\n\n\nThis command expects the template's Metadata section to contain an\nAWS::ServerlessRepo::Application section with application metadata\nfor publishing. For more details on this metadata section, see\nhttps://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-publishing-applications.html\n\nExamples\n--------\nTo publish an application\n$ sam publish -t packaged.yaml --region <region>", "properties": { "parameters": { "title": "Parameters for the publish command", "description": "Available parameters for the publish command:\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* semantic_version:\nOptional. The value provided here overrides SemanticVersion in the template metadata.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template which references built artifacts for resources in the template. (if applicable)", "default": "template.[yaml|yml|json]" }, "semantic_version": { "title": "semantic_version", "type": "string", "description": "Optional. The value provided here overrides SemanticVersion in the template metadata." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "traces": { "title": "Traces command", "description": "Use this command to fetch AWS X-Ray traces generated by your stack.\n\n\nRun the following command to fetch X-Ray traces by ID.\n$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2\n\nRun the following command to tail X-Ray traces as they become available.\n$ sam traces --tail", "properties": { "parameters": { "title": "Parameters for the traces command", "description": "Available parameters for the traces command:\n* trace_id:\nFetch specific trace by providing its id\n* tail:\nTail events. This will ignore the end time argument and continue to fetch events as they become available.\n* output:\nThe formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting\n* end_time:\nFetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'\n* start_time:\nFetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "trace_id": { "title": "trace_id", "type": "string", "description": "Fetch specific trace by providing its id" }, "tail": { "title": "tail", "type": "boolean", "description": "Tail events. This will ignore the end time argument and continue to fetch events as they become available." }, "output": { "title": "output", "type": "string", "description": "The formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting", "enum": [ "json", "text" ] }, "end_time": { "title": "end_time", "type": "string", "description": "Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'" }, "start_time": { "title": "start_time", "type": "string", "description": "Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.", "default": "10m ago" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "sync": { "title": "Sync command", "description": "NEW! Sync an AWS SAM Project to AWS.", "properties": { "parameters": { "title": "Parameters for the sync command", "description": "Available parameters for the sync command:\n* template_file:\nAWS SAM template file.\n* code:\nSync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions.\n* watch:\nWatch local files and automatically sync with cloud.\n* resource_id:\nSync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}.\n* resource:\nSync code for all resources of the given resource type. Accepted values are ['AWS::Serverless::Function', 'AWS::Lambda::Function', 'AWS::Serverless::LayerVersion', 'AWS::Lambda::LayerVersion', 'AWS::Serverless::Api', 'AWS::ApiGateway::RestApi', 'AWS::Serverless::HttpApi', 'AWS::ApiGatewayV2::Api', 'AWS::Serverless::StateMachine', 'AWS::StepFunctions::StateMachine']\n* dependency_layer:\nSeparate dependencies of individual function into a Lambda layer for improved performance.\n* skip_deploy_sync:\nThis option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.\n* stack_name:\nName of the AWS CloudFormation stack.\n* base_dir:\nResolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location.\n* use_container:\nBuild functions within an AWS Lambda-like container.\n* build_image:\nContainer image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used.\n* image_repository:\nAWS ECR repository URI where artifacts referenced in the template are uploaded.\n* image_repositories:\nMapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.\n* s3_bucket:\nAWS S3 bucket where artifacts referenced in the template are uploaded.\n* s3_prefix:\nPrefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.\n* kms_key_id:\nThe ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.\n* role_arn:\nARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* metadata:\nMap of metadata to attach to ALL the artifacts that are referenced in the template.\n* notification_arns:\nARNs of SNS topics that AWS Cloudformation associates with the stack.\n* tags:\nList of tags to associate with the stack.\n* capabilities:\nList of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html", "type": "object", "properties": { "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template file.", "default": "template.[yaml|yml|json]" }, "code": { "title": "code", "type": "boolean", "description": "Sync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions." }, "watch": { "title": "watch", "type": "boolean", "description": "Watch local files and automatically sync with cloud." }, "resource_id": { "title": "resource_id", "type": "string", "description": "Sync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}." }, "resource": { "title": "resource", "type": "string", "description": "Sync code for all resources of the given resource type. Accepted values are ['AWS::Serverless::Function', 'AWS::Lambda::Function', 'AWS::Serverless::LayerVersion', 'AWS::Lambda::LayerVersion', 'AWS::Serverless::Api', 'AWS::ApiGateway::RestApi', 'AWS::Serverless::HttpApi', 'AWS::ApiGatewayV2::Api', 'AWS::Serverless::StateMachine', 'AWS::StepFunctions::StateMachine']", "enum": [ "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Api", "AWS::Lambda::Function", "AWS::Lambda::LayerVersion", "AWS::Serverless::Api", "AWS::Serverless::Function", "AWS::Serverless::HttpApi", "AWS::Serverless::LayerVersion", "AWS::Serverless::StateMachine", "AWS::StepFunctions::StateMachine" ] }, "dependency_layer": { "title": "dependency_layer", "type": "boolean", "description": "Separate dependencies of individual function into a Lambda layer for improved performance.", "default": true }, "skip_deploy_sync": { "title": "skip_deploy_sync", "type": "boolean", "description": "This option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.", "default": true }, "stack_name": { "title": "stack_name", "type": "string", "description": "Name of the AWS CloudFormation stack." }, "base_dir": { "title": "base_dir", "type": "string", "description": "Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location." }, "use_container": { "title": "use_container", "type": "boolean", "description": "Build functions within an AWS Lambda-like container." }, "build_image": { "title": "build_image", "type": "string", "description": "Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used." }, "image_repository": { "title": "image_repository", "type": "string", "description": "AWS ECR repository URI where artifacts referenced in the template are uploaded." }, "image_repositories": { "title": "image_repositories", "type": "array", "description": "Mapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.", "items": { "type": "string" } }, "s3_bucket": { "title": "s3_bucket", "type": "string", "description": "AWS S3 bucket where artifacts referenced in the template are uploaded." }, "s3_prefix": { "title": "s3_prefix", "type": "string", "description": "Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket." }, "kms_key_id": { "title": "kms_key_id", "type": "string", "description": "The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket." }, "role_arn": { "title": "role_arn", "type": "string", "description": "ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set." }, "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "metadata": { "title": "metadata", "type": "string", "description": "Map of metadata to attach to ALL the artifacts that are referenced in the template." }, "notification_arns": { "title": "notification_arns", "type": [ "array", "string" ], "description": "ARNs of SNS topics that AWS Cloudformation associates with the stack.", "items": { "type": "string" } }, "tags": { "title": "tags", "type": "array", "description": "List of tags to associate with the stack.", "items": { "type": "string" } }, "capabilities": { "title": "capabilities", "type": [ "array", "string" ], "description": "List of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html", "default": [ "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND" ], "items": { "type": "string" } } } } }, "required": [ "parameters" ] }, "pipeline_bootstrap": { "title": "Pipeline Bootstrap command", "description": "This command generates the required AWS infrastructure resources to connect to your CI/CD system.\nThis step must be run for each deployment stage in your pipeline, prior to running the sam pipeline init command.", "properties": { "parameters": { "title": "Parameters for the pipeline bootstrap command", "description": "Available parameters for the pipeline bootstrap command:\n* interactive:\nDisable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.\n* stage:\nThe name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources.\n* pipeline_user:\nThe Amazon Resource Name (ARN) of the IAM user having its access key ID and secret access key shared with the CI/CD system. It is used to grant this IAM user permission to access the corresponding AWS account. If not provided, the command will create one along with the access key ID and secret access key credentials.\n* pipeline_execution_role:\nThe ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one.\n* cloudformation_execution_role:\nThe ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one.\n* bucket:\nThe ARN of the Amazon S3 bucket to hold the AWS SAM artifacts.\n* create_image_repository:\nIf set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type.\n* image_repository:\nThe ARN of an Amazon ECR image repository to hold the container images of Lambda functions or layers that have a package type of Image. If provided, the --create-image-repository options is ignored. If not provided and --create-image-repository is specified, the command will create one.\n* confirm_changeset:\nPrompt to confirm if the resources are to be deployed.\n* permissions_provider:\nChoose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.\n* oidc_provider_url:\nThe URL of the OIDC provider.\n* oidc_client_id:\nThe client ID configured to use with the OIDC provider.\n* github_org:\nThe GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions\n* github_repo:\nThe name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions\n* deployment_branch:\nThe name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions\n* oidc_provider:\nThe name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket\n* gitlab_group:\nThe GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions\n* gitlab_project:\nThe GitLab project name. Only used if using GitLab OIDC for permissions\n* bitbucket_repo_uuid:\nThe UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect\n* cicd_provider:\nThe CICD platform for the SAM Pipeline\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "interactive": { "title": "interactive", "type": "boolean", "description": "Disable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.", "default": true }, "stage": { "title": "stage", "type": "string", "description": "The name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources." }, "pipeline_user": { "title": "pipeline_user", "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM user having its access key ID and secret access key shared with the CI/CD system. It is used to grant this IAM user permission to access the corresponding AWS account. If not provided, the command will create one along with the access key ID and secret access key credentials." }, "pipeline_execution_role": { "title": "pipeline_execution_role", "type": "string", "description": "The ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one." }, "cloudformation_execution_role": { "title": "cloudformation_execution_role", "type": "string", "description": "The ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one." }, "bucket": { "title": "bucket", "type": "string", "description": "The ARN of the Amazon S3 bucket to hold the AWS SAM artifacts." }, "create_image_repository": { "title": "create_image_repository", "type": "boolean", "description": "If set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type." }, "image_repository": { "title": "image_repository", "type": "string", "description": "The ARN of an Amazon ECR image repository to hold the container images of Lambda functions or layers that have a package type of Image. If provided, the --create-image-repository options is ignored. If not provided and --create-image-repository is specified, the command will create one." }, "confirm_changeset": { "title": "confirm_changeset", "type": "boolean", "description": "Prompt to confirm if the resources are to be deployed.", "default": true }, "permissions_provider": { "title": "permissions_provider", "type": "string", "description": "Choose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.", "default": "iam", "enum": [ "iam", "oidc" ] }, "oidc_provider_url": { "title": "oidc_provider_url", "type": "string", "description": "The URL of the OIDC provider." }, "oidc_client_id": { "title": "oidc_client_id", "type": "string", "description": "The client ID configured to use with the OIDC provider." }, "github_org": { "title": "github_org", "type": "string", "description": "The GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions" }, "github_repo": { "title": "github_repo", "type": "string", "description": "The name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions" }, "deployment_branch": { "title": "deployment_branch", "type": "string", "description": "The name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions" }, "oidc_provider": { "title": "oidc_provider", "type": "string", "description": "The name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket", "enum": [ "bitbucket-pipelines", "github-actions", "gitlab" ] }, "gitlab_group": { "title": "gitlab_group", "type": "string", "description": "The GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions" }, "gitlab_project": { "title": "gitlab_project", "type": "string", "description": "The GitLab project name. Only used if using GitLab OIDC for permissions" }, "bitbucket_repo_uuid": { "title": "bitbucket_repo_uuid", "type": "string", "description": "The UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect" }, "cicd_provider": { "title": "cicd_provider", "type": "string", "description": "The CICD platform for the SAM Pipeline" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] }, "pipeline_init": { "title": "Pipeline Init command", "description": "This command generates a pipeline configuration file that your CI/CD system can use to deploy\nserverless applications using AWS SAM.\n\nBefore using sam pipeline init, you must bootstrap the necessary resources for each stage in your pipeline.\nYou can do this by running sam pipeline init --bootstrap to be guided through the setup and configuration\nfile generation process, or refer to resources you have previously created with the sam pipeline bootstrap command.", "properties": { "parameters": { "title": "Parameters for the pipeline init command", "description": "Available parameters for the pipeline init command:\n* bootstrap:\nEnable interactive mode that walks the user through creating necessary AWS infrastructure resources.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "bootstrap": { "title": "bootstrap", "type": "boolean", "description": "Enable interactive mode that walks the user through creating necessary AWS infrastructure resources." }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "list_resources": { "title": "List Resources command", "description": "Get a list of resources that will be deployed to CloudFormation.\n\nIf a stack name is provided, the corresponding physical IDs of each\nresource will be mapped to the logical ID of each resource.", "properties": { "parameters": { "title": "Parameters for the list resources command", "description": "Available parameters for the list resources command:\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* stack_name:\nName of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)\n* output:\nOutput the results from the command in a given output format (json or table).\n* template_file:\nAWS SAM template file.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "stack_name": { "title": "stack_name", "type": "string", "description": "Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)" }, "output": { "title": "output", "type": "string", "description": "Output the results from the command in a given output format (json or table).", "default": "table", "enum": [ "json", "table" ] }, "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template file.", "default": "template.[yaml|yml|json]" }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "list_stack_outputs": { "title": "List Stack Outputs command", "description": "Get the stack outputs as defined in the SAM/CloudFormation template.", "properties": { "parameters": { "title": "Parameters for the list stack outputs command", "description": "Available parameters for the list stack outputs command:\n* stack_name:\nName of corresponding deployed stack.\n* output:\nOutput the results from the command in a given output format (json or table).\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "stack_name": { "title": "stack_name", "type": "string", "description": "Name of corresponding deployed stack." }, "output": { "title": "output", "type": "string", "description": "Output the results from the command in a given output format (json or table).", "default": "table", "enum": [ "json", "table" ] }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "list_endpoints": { "title": "List Endpoints command", "description": "Get a summary of the cloud endpoints in the stack.\n\nThis command will show both the cloud and local endpoints that can\nbe used with sam local and sam sync. Currently the endpoint resources\nare Lambda functions and API Gateway API resources.", "properties": { "parameters": { "title": "Parameters for the list endpoints command", "description": "Available parameters for the list endpoints command:\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* stack_name:\nName of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)\n* output:\nOutput the results from the command in a given output format (json or table).\n* template_file:\nAWS SAM template file.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.", "type": "object", "properties": { "parameter_overrides": { "title": "parameter_overrides", "type": [ "array", "string" ], "description": "String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.", "items": { "type": "string" } }, "stack_name": { "title": "stack_name", "type": "string", "description": "Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)" }, "output": { "title": "output", "type": "string", "description": "Output the results from the command in a given output format (json or table).", "default": "table", "enum": [ "json", "table" ] }, "template_file": { "title": "template_file", "type": "string", "description": "AWS SAM template file.", "default": "template.[yaml|yml|json]" }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." } } } }, "required": [ "parameters" ] }, "docs": { "title": "Docs command", "description": "NEW! Open the documentation in a browser.", "properties": { "parameters": { "title": "Parameters for the docs command", "description": "Available parameters for the docs command:\n* ", "type": "object", "properties": {} } }, "required": [ "parameters" ] }, "remote_invoke": { "title": "Remote Invoke command", "description": "Invoke or send an event to resources in the cloud.", "properties": { "parameters": { "title": "Parameters for the remote invoke command", "description": "Available parameters for the remote invoke command:\n* stack_name:\nName of the stack to get the resource information from\n* event:\nThe event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string\n* event_file:\nThe file that contains the event that will be sent to the resource.\n* output:\nOutput the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.\n* parameter:\nAdditional parameters that can be passed to invoke the resource.\nThe following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'. The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)", "type": "object", "properties": { "stack_name": { "title": "stack_name", "type": "string", "description": "Name of the stack to get the resource information from" }, "event": { "title": "event", "type": "string", "description": "The event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string" }, "event_file": { "title": "event_file", "type": "string", "description": "The file that contains the event that will be sent to the resource." }, "output": { "title": "output", "type": "string", "description": "Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.", "default": "text", "enum": [ "json", "text" ] }, "parameter": { "title": "parameter", "type": "array", "description": "Additional parameters that can be passed to invoke the resource.\nThe following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'. The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.", "items": { "type": "string" } }, "beta_features": { "title": "beta_features", "type": "boolean", "description": "Enable/Disable beta features." }, "debug": { "title": "debug", "type": "boolean", "description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps." }, "profile": { "title": "profile", "type": "string", "description": "Select a specific profile from your credential file to get AWS credentials." }, "region": { "title": "region", "type": "string", "description": "Set the AWS Region of the service. (e.g. us-east-1)" } } } }, "required": [ "parameters" ] } } } } }

statamic.blueprint.schema.json

{ "title": "A Statamic Blueprint JSON Schema", "$id": "https://arroba-it.de/statamic.blueprint.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "oneOf": [ { "required": [ "tabs" ] }, { "required": [ "sections" ] } ], "properties": { "title": { "type": "string" }, "tabs": { "title": "The Tabs", "description": "At its most basic, a blueprint has tabs. A tab has a handle, a display name, and an array of sections. Since Statamic 4", "type": "object", "additionalProperties": false, "patternProperties": { "^[A-Za-z_]+?$": { "description": "The handle (name) of a section. This one is on you.", "type": "object", "properties": { "display": { "description": "The displayed text.", "type": "string" }, "sections": { "description": "The Sections of the Tab", "type": "array", "items": { "type": "object", "properties": { "display": { "description": "The displayed text.", "type": "string" }, "instructions": { "description": "Some instructions", "type": "string" }, "fields": { "$ref": "#/$defs/fields" } } }, "additionalItems": false } } } } }, "sections": { "title": "The Sections", "description": "At its most basic, a blueprint has sections. A section has a handle, a display name, and an array of fields. Until Statamic 3", "type": "object", "additionalProperties": false, "patternProperties": { "^[A-Za-z]+?$": { "description": "The handle (name) of a section. This one is on you.", "type": "object", "properties": { "display": { "description": "The displayed text.", "type": "string" }, "fields": { "$ref": "#/$defs/fields" } } } } } }, "$defs": { "fields": { "description": "Here you define the fields of this section.", "type": "array", "uniqueItems": true, "uniqueItemProperties": [ "handle" ], "items": { "type": "object", "properties": { "handle": { "type": "string", "description": "The field's template variable." }, "config": { "type": "object", "properties": { "display": { "type": "string" } } }, "import": { "type": "string" }, "prefix": { "type": "string" }, "field": { "description": "The definition of a single field.", "type": [ "object", "string" ], "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/array" }, { "$ref": "#/$defs/assets" }, { "$ref": "#/$defs/bard" }, { "$ref": "#/$defs/button_group" }, { "$ref": "#/$defs/checkboxes" }, { "$ref": "#/$defs/code" }, { "$ref": "#/$defs/collections" }, { "$ref": "#/$defs/color" }, { "$ref": "#/$defs/date" }, { "$ref": "#/$defs/entries" }, { "$ref": "#/$defs/form" }, { "$ref": "#/$defs/grid" }, { "$ref": "#/$defs/hidden" }, { "$ref": "#/$defs/html" }, { "$ref": "#/$defs/integer" }, { "$ref": "#/$defs/link" }, { "$ref": "#/$defs/list" }, { "$ref": "#/$defs/markdown" }, { "$ref": "#/$defs/radio" }, { "$ref": "#/$defs/range" }, { "$ref": "#/$defs/replicator" }, { "$ref": "#/$defs/revealer" }, { "$ref": "#/$defs/section" }, { "$ref": "#/$defs/select" }, { "$ref": "#/$defs/sites" }, { "$ref": "#/$defs/slug" }, { "$ref": "#/$defs/structures" }, { "$ref": "#/$defs/table" }, { "$ref": "#/$defs/taxonomies" }, { "$ref": "#/$defs/taggable" }, { "$ref": "#/$defs/template" }, { "$ref": "#/$defs/terms" }, { "$ref": "#/$defs/text" }, { "$ref": "#/$defs/textarea" }, { "$ref": "#/$defs/time" }, { "$ref": "#/$defs/toggle" }, { "$ref": "#/$defs/user_groups" }, { "$ref": "#/$defs/user_roles" }, { "$ref": "#/$defs/users" }, { "$ref": "#/$defs/video" }, { "$ref": "#/$defs/yaml" } ], "required": [ "type" ] } }, "dependentRequired": { "field": [ "handle" ] } } }, "array": { "description": "This fieldtype is used to manage key: value array data in the right situation.", "type": "object", "properties": { "display": { "$ref": "#/$defs/display" }, "icon": { "$ref": "#/$defs/icon" }, "instructions": { "$ref": "#/$defs/instructions" }, "instructions_position": { "$ref": "#/$defs/instructions_position" }, "listable": { "$ref": "#/$defs/listable" }, "required": { "$ref": "#/$defs/required" }, "localizable": { "$ref": "#/$defs/localizable" }, "validate": { "$ref": "#/$defs/validate" }, "type": { "const": "array" }, "mode": { "type": "string", "enum": [ "dynamic", "keyed" ] }, "keys": { "type": [ "object", "array" ] }, "value_header": { "type": "string" }, "key_header": { "type": "string" } }, "additionalProperties": true }, "assets": { "description": "The assets fieldtype is used to manage and relate files with your entries.", "type": "object", "properties": { "type": { "const": "assets" }, "mode": { "type": "string", "enum": [ "grid", "list" ], "default": "list" }, "container": { "type": "string" }, "folder": { "type": "string" }, "restrict": { "type": "boolean", "default": false }, "allow_uploads": { "type": "boolean", "default": true }, "show_filename": { "type": "boolean", "default": true }, "max_files": { "type": "integer" } }, "additionalProperties": true }, "bard": { "description": "Bard is our recommended fieldtype for creating long form content from the control panel.", "type": "object", "properties": { "type": { "const": "bard" }, "always_show_set_button": { "description": "Enable to always show the \"Add Set\" button.", "type": "boolean", "default": false }, "sets": { "description": "Sets are configurable blocks of fields that can be inserted anywhere in your Bard content.", "type": "object" }, "buttons": { "description": "Choose which buttons to show in the toolbar.", "type": "array", "items": { "type": "string", "uniqueItems": true, "enum": [ "h2", "h3", "bold", "italic", "unorderedlist", "orderedlist", "removeformat", "quote", "anchor", "image", "table" ] } }, "container": { "description": "Choose which asset container to use for this field.", "type": "string" }, "save_html": { "description": "Save HTML instead of structured data. This simplifies but limits control of your template markup.", "type": "boolean", "default": false }, "toolbar_mode": { "description": "Choose which style of toolbar you prefer.", "type": "string", "enum": [ "fixed", "floating" ], "default": "fixed" }, "link_noopener": { "description": "Set rel=\"noopener\" on all links.", "type": "boolean", "default": false }, "link_noreferrer": { "description": "Set rel=\"noreferrer\" on all links.", "type": "boolean", "default": false }, "target_blank": { "description": "Set target=\"_blank\" on all links.", "type": "boolean", "default": false }, "link_collections": { "description": "Entries from these collections will be available in the link selector. Leaving this empty will make all entries available.", "type": "array", "items": { "type": "string" } }, "reading_time": { "description": "Show estimated reading time at the bottom of the field.", "type": "boolean", "default": false }, "fullscreen": { "description": "Enable to toggle into fullscreen mode.", "type": "boolean", "default": true }, "allow_source": { "description": "Allow Source Mode", "type": "boolean", "default": true }, "enable_input_rules": { "description": "Enable Input Rules", "type": "boolean", "default": true }, "enable_paste_rules": { "description": "Enables Markdown-style shortcuts when typing content.", "type": "boolean", "default": true }, "display": { "$ref": "#/$defs/display" }, "instructions": { "$ref": "#/$defs/instructions" }, "instructions_position": { "$ref": "#/$defs/instructions_position" }, "listable": { "$ref": "#/$defs/listable" }, "required": { "$ref": "#/$defs/required" }, "localizable": { "$ref": "#/$defs/localizable" }, "validate": { "$ref": "#/$defs/validate" } }, "additionalProperties": true }, "button_group": { "description": "The button group fieldtype is a multiple choice input where you only get one choice.", "type": "object", "properties": { "type": { "const": "button_group" }, "options": { "description": "Set the array keys and their optional labels.", "type": [ "object", "array" ] }, "default": { "description": "Set the default value.", "type": "string" } }, "additionalProperties": true }, "checkboxes": { "description": "The checkboxes fieldtype is a multiple choice input.", "type": "object", "properties": { "type": { "const": "checkboxes" }, "inline": { "type": "boolean", "default": "false" }, "options": { "type": [ "object", "array" ] }, "default": { "type": "string" } }, "additionalProperties": true }, "code": { "description": "If your content involves code snippets, this is the fieldtype for you.", "type": "object", "properties": { "type": { "const": "code" }, "theme": { "description": "Choose your preferred theme.", "type": "string", "enum": [ "light", "material" ] }, "mode": { "description": "Choose language for syntax highlighting.", "type": "string", "enum": [ "clike", "css", "diff", "go", "haml", "handlebars", "htmlmixed", "less", "markdown", "gfm", "nginx", "text/x-java", "javascript", "jsx", "text/x-objectivec", "php", "python", "ruby", "scss", "shell", "sql", "twig", "vue", "xml", "yaml-frontmatter" ] }, "indent_type": { "description": "Set your preferred type of indentation.", "type": "string", "enum": [ "tabs", "spaces" ] }, "indent_size": { "description": "Set your preferred indentation size (in spaces).", "type": "integer", "default": 4 }, "key_map": { "description": "Choose preferred set of keyboard shortcuts.", "type": "string", "default": "default", "enum": [ "default", "sublime", "vim" ] }, "line_numbers": { "description": "Show Line Numbers", "type": "boolean", "default": true }, "line_wrapping": { "description": "Enable Line Wrapping", "type": "boolean", "default": true } }, "additionalProperties": true }, "collections": { "description": "This fieldtype is used to view and select from a list of Collections.", "type": "object", "properties": { "type": { "const": "collections" }, "max_items": { "description": "Set a maximum number of selectable items.", "type": "integer" }, "mode": { "description": "Choose your preferred UI style.", "$ref": "#/$defs/userSelectModes" } }, "additionalProperties": true }, "color": { "description": "This fieldtype is a highly configurable color picker with simple and advanced UI modes, support for alpha channel, rgba, hsla, hsva, and more.", "type": "object", "properties": { "type": { "const": "color" }, "swatches": { "description": "Pre-define colors that can be selected from a list. Supports all color mode formats.", "type": "array", "uniqueItems": true }, "theme": { "description": "Choose between a classic and a simpler nano (mini) theme. Default: classic.", "type": "string", "enum": [ "classic", "nano" ] }, "lock_opacity": { "description": "Disables the alpha slider, preventing adjustments to opacity.", "type": "boolean", "default": false }, "default_color_mode": { "description": "Set which color mode you wish to be the default. Default: hex.", "type": "string", "default": "HEXA", "enum": [ "HEXA", "RGBA", "HSLA", "HSVA", "CMYK" ] }, "color_modes": { "description": "Choose which color modes you want to enable in the UI. Available choices: hex, rgba, hsla, hsva, and cmyk. Default: hex.", "type": "array", "uniqueItems": true, "default": "hex", "items": { "type": "string", "enum": [ "hex", "rgba", "hsla", "hsva", "cmyk" ] } } }, "additionalProperties": true }, "date": { "description": "Work with dates, times, and ranges with a variety of user interface options that make you really enjoy basically just picking numbers from a table.", "type": "object", "properties": { "columns": { "type": "integer", "description": "Show multiple months at one time, in columns and rows. Default: 1.", "minimum": 1, "default": 1 }, "earliest_date": { "oneOf": [ { "format": "date" }, { "format": "date-time" } ], "type": "string", "default": "1900-01-01", "description": "Set the earliest selectable date in YYYY-MM-DD format." }, "format": { "type": "string", "description": "How the date should be stored, using the PHP date format. Default: 'Y-m-d' or 'Y-m-d H:m'", "default": "'Y-m-d'" }, "full_width": { "type": "boolean", "description": "Enable to stretch the calendar out like Stretch Armstrong, using the maximum amount of available horizontal space. Default: false", "default": false }, "icon": { "type": "string" }, "inline": { "type": "boolean", "description": "Always show the calendar instead of the text input and dropdown UI. Default: false.", "default": false }, "mode": { "type": "string", "description": "Choose between single or range. Range mode disables the time picker. Default: single.", "enum": [ "single", "range" ], "default": "single" }, "rows": { "type": "integer", "description": "Show multiple months at one time, in columns and rows. Default: 1.", "minimum": 1, "default": 1 }, "time_enabled": { "type": "boolean", "description": "Enable/disable the timepicker. Default: false.", "default": false }, "time_required": { "type": "boolean", "description": "Makes the time field visible and non-dismissible. Default: false.", "default": false }, "type": { "type": "string", "const": "date" } }, "additionalProperties": true }, "entries": { "description": "", "type": "object", "properties": { "type": { "const": "entries" }, "max_items": { "$ref": "#/$defs/max_items" }, "mode": { "$ref": "#/$defs/userSelectModes" }, "create": { "type": "boolean", "default": true }, "collections": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "additionalProperties": true }, "form": { "description": "The Form fieldtype is gives your users a way to pick a form to include along with the current entry.", "type": "object", "properties": { "type": { "const": "form" }, "placeholder": { "$ref": "#/$defs/placeholder" }, "max_items": { "type": "integer", "default": 1 } }, "additionalProperties": true }, "grid": { "description": "The grid fieldtype is a meta fieldtype, a fieldtype that serves as a container for more fieldtypes.", "type": "object", "properties": { "type": { "const": "grid" }, "fields": { "description": "A list of fields, each of which create their own column.", "type": "array", "items": { "type": "object" } }, "mode": { "description": "The Grid is displayed as a table by default. If you have a large number of columns it can get pretty crowded. Choose stacked mode to group rows similar to Replicator. When Sneak Peek is enabled, Grids automatically toggle into stacked mode.", "type": "string", "enum": [ "table", "stacked" ] }, "min_rows": { "description": "The minimum number of required rows.", "type": "integer", "minimum": 0 }, "max_rows": { "description": "The maximum number of rows allowed. Once reached the Add Row button will disappear.", "type": "integer", "minimum": 1 }, "add_row": { "description": "The Add Row button's label.", "type": "string", "minimum": 1 }, "reorderable": { "description": "The minimum number of required rows.", "type": "boolean", "default": true } }, "additionalProperties": true }, "hidden": { "description": "The hidden field is perfect for setting default data when creating new entries.", "type": "object", "properties": { "type": { "const": "hidden" }, "default": { "type": "string" } }, "additionalProperties": true }, "html": { "description": "If you've ever wanted to add a little HTML to your blueprint, this is the way to do it.", "type": "object", "properties": { "type": { "const": "html" }, "html": { "description": "Store whatever HTML you want — it's up to you.", "type": [ "string" ] } }, "additionalProperties": true }, "import": { "description": "Importing Fieldsets. They serve to create reusable sets of fields, just like v2.", "type": "string" }, "integer": { "description": "The integer fieldtype is a text-style input that only accepts integers (numbers) and has increment and decrement controls.", "type": "object", "properties": { "type": { "const": "integer" }, "default": { "type": [ "string", "integer" ] } }, "additionalProperties": true }, "link": { "description": "For when you want to create a link to a URL or entry, this fieldtype is here for you.", "type": "object", "properties": { "type": { "const": "link" }, "collections": { "type": "array" } }, "additionalProperties": true }, "list": { "description": "For when you want to manage a simple YAML list, this fieldtype is here for you.", "type": "object", "properties": { "type": { "const": "list" }, "default": { "type": "array" } }, "additionalProperties": true }, "markdown": { "description": "Write Markdown with the help of formatting buttons, assets integration, fullscreen mode, a Markdown cheatsheet, and HTML preview mode.", "type": "object", "properties": { "type": { "const": "markdown" }, "container": { "description": "Set the name of an asset container to enable browsing, uploading, and inserting assets.", "type": "string" }, "restrict": { "description": "If true, navigation within the asset browser will be disabled. Your users will be restricted to specified the container and folder. Default: false.", "type": "boolean", "default": false }, "automatic_line_breaks": { "description": "Automatically convert line breaks to <br> tags. Default: true.", "type": "boolean", "default": true }, "automatic_links": { "description": "Automatically links any URLs in the text. Default: false.", "type": "boolean", "default": false }, "escape_markup": { "description": "Escapes inline HTML markup. For example, <div> will be replaced with &lt;div&gt;. Default: true.", "type": "boolean", "default": false }, "smartypants": { "description": "Automatically convert straight quotes into curly quotes, dashes into en/em-dashes, and other similar text transformations. Default: false.", "type": "boolean", "default": false }, "antlers": { "$ref": "#/$defs/antlers" }, "default": { "description": "Set the default value.", "type": "string" } }, "additionalProperties": true }, "radio": { "description": "The radio fieldtype is a multiple choice input where you only get one choice.", "type": "object", "properties": { "type": { "const": "radio" }, "options": { "description": "Sets of key/value pairs define the values and labels of the radio options.", "type": [ "object", "array" ] }, "inline": { "description": "Show the radio buttons next to each other in a row instead of stacked vertically. Default: false", "type": "boolean", "default": false }, "cast_booleans": { "type": "boolean", "default": false } }, "additionalProperties": true }, "range": { "description": "Range fields let the user choose a numeric value which must be no less than a given value, and no more than another.", "type": "object", "properties": { "type": { "const": "range" }, "step": { "description": "The minimum size between values.", "type": "integer", "minimum": 1, "default": 1 }, "min": { "description": "The minimum, left-most value.", "type": "integer", "minimum": 0, "default": 0 }, "max": { "description": "The maximum, right-most value.", "type": "integer", "default": 100 }, "default": { "description": "Set the default value.", "type": "integer" } }, "additionalProperties": true }, "replicator": { "description": "The Replicator is a meta fieldtype giving you the ability to define sets of fields that you can dynamically piece together in whatever order and arrangement you imagine.", "type": "object", "properties": { "type": { "const": "replicator" } }, "additionalProperties": true }, "revealer": { "description": "The revealer is a simple button that reveals conditional fields without saving any additional data.", "type": "object", "properties": { "type": { "const": "revealer" } }, "additionalProperties": true }, "section": { "description": "", "type": "object", "properties": { "type": { "const": "section" } }, "additionalProperties": true }, "select": { "description": "Give your users a list of options to choose from.", "type": "object", "properties": { "type": { "const": "select" }, "clearable": { "description": "Allow deselecting any chosen option and making null a possible value. Default: false.", "type": "boolean", "default": false }, "options": { "description": "A set of key/value pairs that define the values and labels. If you don't define the keys, the value and label will be the same.\n\n", "type": [ "array", "object" ] }, "placeholder": { "description": "Set the non-selectable placeholder text. Default: none.", "$ref": "#/$defs/placeholder" }, "default": { "description": "Set the default option key. Default: none.", "type": "string" }, "multiple": { "description": "Allow multiple selections. Default: false.", "type": "boolean", "default": false }, "searchable": { "description": "Enable search with suggestions by typing in the select box. Default: true.", "type": "boolean", "default": true }, "taggable": { "description": "Use a \"tag\" style UI when selecting multiples. Default: false.", "type": "boolean", "default": false }, "push_tags": { "description": "Add newly created options to the list. Default: false.", "type": "boolean", "default": false } }, "additionalProperties": true, "required": [ "options" ] }, "sites": { "description": "", "type": "object", "properties": { "type": { "const": "sites" }, "max_items": { "$ref": "#/$defs/max_items" }, "mode": { "$ref": "#/$defs/userSelectModes" } }, "additionalProperties": true }, "slug": { "description": "", "type": "object", "properties": { "type": { "const": "slug" }, "generate": { "type": "boolean", "default": true } }, "additionalProperties": true }, "structures": { "description": "Use this fieldtype to create a one-way relationship with one or more structures in your site.", "type": "object", "properties": { "type": { "const": "structures" }, "max_items": { "$ref": "#/$defs/max_items" }, "mode": { "$ref": "#/$defs/userSelectModes" } }, "additionalProperties": true }, "table": { "description": "This fieldtype gives you a way to create flexible tabular data.", "type": "object", "properties": { "type": { "const": "table" } }, "additionalProperties": true }, "taggable": { "description": "Users can enter “taggable” values, which are formatted automatically into a YAML list format.", "type": "object", "properties": { "type": { "const": "taggable" }, "placeholder": { "$ref": "#/$defs/placeholder" } }, "additionalProperties": true }, "taxonomies": { "description": "", "type": "object", "properties": { "type": { "const": "taxonomies" }, "max_items": { "$ref": "#/$defs/max_items" }, "mode": { "$ref": "#/$defs/userSelectModes" } }, "additionalProperties": true }, "template": { "description": "This is generally used as a \"system\" field to control an entry's template.", "type": "object", "properties": { "type": { "const": "template" }, "hide_partials": { "type": "boolean", "default": true } }, "additionalProperties": true }, "terms": { "description": "Taxonomies are usually relationships established on the collection-configuration level.", "type": "object", "properties": { "type": { "const": "terms" }, "max_items": { "$ref": "#/$defs/max_items" }, "mode": { "$ref": "#/$defs/userSelectModes" }, "create": { "type": "boolean" }, "taxonomies": { "type": "array" } }, "additionalProperties": true }, "text": { "description": "A text field that has the ability to morph into an intergalactic dragon and devour entire planets!", "type": "object", "properties": { "type": { "const": "text" }, "placeholder": { "$ref": "#/$defs/placeholder" }, "input_type": { "type": "string", "default": "text", "enum": [ "color", "date", "email", "hidden", "month", "number", "password", "tel", "text", "time", "url", "week" ] }, "character_limit": { "type": [ "integer" ] }, "antlers": { "$ref": "#/$defs/antlers" }, "default": { "type": "string" }, "append": { "type": "string" }, "prepend": { "type": "string" } }, "additionalProperties": true }, "textarea": { "description": "A long textarea field that functions like a swimming pool for letters and numbers on a hot day.", "type": "object", "properties": { "type": { "const": "textarea" }, "placeholder": { "$ref": "#/$defs/placeholder" }, "character_limit": { "type": [ "integer", "string" ] }, "antlers": { "$ref": "#/$defs/antlers" }, "default": { "type": "string" } }, "additionalProperties": true }, "time": { "description": "The original time field from the set of Kiefer Sutherland's hit drama \"24\".", "type": "object", "properties": { "type": { "const": "time" }, "default": { "type": "string", "pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" } }, "additionalProperties": true }, "toggle": { "description": "A nice little toggle switch generally used to manage settings-type variables.", "type": "object", "properties": { "type": { "const": "toggle" }, "default": { "type": "boolean", "default": false } }, "additionalProperties": true }, "user_groups": { "description": "The User Group fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.", "type": "object", "properties": { "type": { "const": "user_groups" }, "max_items": { "type": [ "integer", "null" ], "minimum": 1, "default": null }, "mode": { "$ref": "#/$defs/userSelectModes" } }, "additionalProperties": true }, "user_roles": { "description": "The User Role fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.", "type": "object", "properties": { "type": { "const": "user_roles" }, "max_items": { "type": [ "integer", "null" ], "minimum": 1, "default": null }, "mode": { "$ref": "#/$defs/userSelectModes" } }, "additionalProperties": true }, "users": { "description": "The most common use for the Users fieldtype is to set the \"author\" for entries, but it's not the only use.", "type": "object", "properties": { "type": { "const": "users" }, "max_items": { "type": [ "integer", "null" ], "minimum": 1, "default": null }, "mode": { "$ref": "#/$defs/userSelectModes" }, "default": { "type": "string", "const": "current" } }, "additionalProperties": true }, "video": { "description": "", "type": "object", "properties": { "type": { "const": "video" }, "placeholder": { "$ref": "#/$defs/placeholder" }, "default": { "type": "string", "format": "url" } }, "additionalProperties": true }, "yaml": { "description": "This field is a code fieldtype that gets saved as YAML instead of a string.", "type": "object", "properties": { "type": { "const": "yaml" }, "default": { "type": [ "object", "string" ] } }, "additionalProperties": true }, "display": { "description": "The label shown above the field.", "type": "string" }, "icon": { "description": "The icon", "type": "string" }, "instructions": { "description": "Shown under the field's display label, like this very text. Markdown is supported.", "type": "string" }, "instructions_position": { "description": "Where the instructions should be positioned relative to the field. Options: Above or Below.", "type": "string", "enum": [ "above", "below" ] }, "listable": { "description": "Controls whether the field should be shown in control panel listings.", "oneOf": [ { "type": "boolean" }, { "type": "string", "pattern": "hidden" } ] }, "required": { "description": "Control whether or not this field is required.\n\n", "type": "boolean" }, "localizable": { "description": "", "type": "boolean" }, "validate": { "description": "The validation rules for that field", "type": "array", "items": { "anyOf": [ { "$ref": "#/$defs/ruleMin" }, { "$ref": "#/$defs/validationRules" } ], "minItems": 1, "uniqueItems": true } }, "ruleMin": { "type": "string", "pattern": "^((accepted|declined|exclude)_if:\\S+,\\S+|(after|before):[\\w\\d_-]+|(after|before)_or_equal:[\\w\\d_-]+|between:\\d+,\\d+|date_equals:[\\w\\d_-]+|date_format:[\\w\\d_-]+|different:\\S+|digits:\\d+|digits_between:\\d+,\\d+|ends_with:\\S+,\\S+|exclude_unless:\\S+,\\S+|exclude_without:\\S+|exists:\\S+,\\S+|[lg]t(e)?:\\S+|in:\\S+,\\S+|in_array:\\S+|(min|max):\\d+|mimetypes:\\S+|mimes:\\S+|multiple_of:\\d+|not_in:\\S+,\\S+|(not_)?regex:\\S+|prohibited_(if|unless):[\\S_]+,\\S+|prohibits:(\\S)+,(\\S)+|required_(if|unless):\\S+,\\d+|required_(with|with_all|without|without_all):\\S+,\\S+|same:\\S+|size:\\d+|starts_with:\\S+,\\S+|unique:\\S+,\\S+|unique_user_value:[\\{(collection|id|site)\\}]+)$" }, "validationRules": { "type": "string", "enum": [ "accepted", "active_url", "required", "alpha", "alpha_dash", "alpha_num", "array", "bail", "boolean", "confirmed", "current_password", "date", "declined", "dimensions", "distinct", "email", "enum", "exclude", "file", "filled", "image", "integer", "ip", "ipv4", "ipv6", "json", "nullable", "numeric", "password", "present", "prohibited", "string", "timezone", "url", "uuid" ] }, "userSelectModes": { "type": "string", "enum": [ "default", "select", "typeahead" ] }, "placeholder": { "type": "string" }, "antlers": { "description": "Enable Antlers parsing in this field's content.", "type": "boolean", "default": false }, "max_items": { "type": "integer", "minimum": 1 } } }

sarif-external-property-file-2.1.0-rtm.5.json

{ "$id": "https://json.schemastore.org/sarif-external-property-file-2.1.0-rtm.5.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "$schema": { "description": "The URI of the JSON schema corresponding to the version of the external property file format.", "type": "string", "format": "uri" }, "version": { "description": "The SARIF format version of this external properties object.", "enum": ["2.1.0"] }, "guid": { "description": "A stable, unique identifier for this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "runGuid": { "description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "conversion": { "description": "A conversion object that will be merged with an external run.", "$ref": "sarif-2.1.0-rtm.5.json#/definitions/conversion" }, "graphs": { "description": "An array of graph objects that will be merged with an external run.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/graph" } }, "externalizedProperties": { "description": "Key/value pairs that provide additional information that will be merged with an external run.", "$ref": "sarif-2.1.0-rtm.5.json#/definitions/propertyBag" }, "artifacts": { "description": "An array of artifact objects that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/artifact" } }, "invocations": { "description": "Describes the invocation of the analysis tool that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/invocation" } }, "logicalLocations": { "description": "An array of logical locations such as namespaces, types or functions that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/logicalLocation" } }, "threadFlowLocations": { "description": "An array of threadFlowLocation objects that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/threadFlowLocation" } }, "results": { "description": "An array of result objects that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/result" } }, "taxonomies": { "description": "Tool taxonomies that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/toolComponent" } }, "driver": { "description": "The analysis tool object that will be merged with an external run.", "$ref": "sarif-2.1.0-rtm.5.json#/definitions/toolComponent" }, "extensions": { "description": "Tool extensions that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/toolComponent" } }, "policies": { "description": "Tool policies that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/toolComponent" } }, "translations": { "description": "Tool translations that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/toolComponent" } }, "addresses": { "description": "Addresses that will be merged with with an external run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/address" } }, "webRequests": { "description": "Requests that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/webRequest" } }, "webResponses": { "description": "Responses that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.5.json#/definitions/webResponse" } }, "properties": { "description": "Key/value pairs that provide additional information about the external properties.", "$ref": "sarif-2.1.0-rtm.5.json#/definitions/propertyBag" } }, "required": ["version"], "title": "SARIF External Property File Schema Version 2.1.0-rtm.5 JSON Schema", "type": "object" }

vsconfig.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/vsconfig.json", "properties": { "version": { "description": "The version of the component configuration file format.", "type": "string", "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+\\.)?(\\d+)$" }, "components": { "type": "array", "description": "An array of Visual Studio component names", "items": { "type": "string", "minLength": 1 } } }, "required": ["components"], "title": "JSON schema for Visual Studio component configuration files", "type": "object" }

bxci.schema-2.x.json

{ "$id": "https://json.schemastore.org/bxci.schema-2.x.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "branchPattern": { "description": "Regular expression for validating branch names", "type": "string" }, "timeout": { "description": "Timeout in seconds", "type": "integer" }, "credentials": { "description": "Jenkins credentials ID", "type": "string" }, "binaryRepository": { "type": "object", "description": "Binary repository details", "properties": { "address": { "type": "string", "format": "uri", "description": "Repository URL" }, "credentials": { "$ref": "#/definitions/credentials", "description": "Jenkins credentials ID for connecting to this repository" } }, "additionalProperties": false, "required": ["address", "credentials"] }, "checkmarx": { "type": "object", "title": "CheckMarx", "properties": { "enabled": { "type": "boolean", "default": false, "description": "Sets whether the scan should be run" }, "branch_pattern": { "$ref": "#/definitions/branchPattern", "description": "Specifies in which branches this stage will be executed", "default": "^master$|^release/.*$" }, "groupId": { "type": "string", "default": "55", "description": "Fully qualified team name for the project" }, "preset": { "type": "string", "default": "36", "description": "Scan preset for the project" }, "sourceEncoding": { "type": "string", "default": "5", "description": "Language encoding ID associated to the source code character encoding (5: Multi-Language Scan)" }, "serverUrl": { "type": "string", "default": "http://cxpbgmgmtserver/", "description": "Checkmarx Server URL or IP address" }, "credentialsId": { "type": "string", "default": "BB-Checkmarx", "description": "Jenkins credentials ID" }, "isProxy": { "type": "boolean", "default": false }, "useOwnServerCredentials": { "type": "boolean", "default": true, "description": "Enables the use of the default server credentials or disables and provides server and credentials that override the defaults" }, "projectName": { "type": "string", "description": "Unique project name. Will be inferred from the repository name if not provided" }, "exclusionsSetting": { "enum": ["job", "global"], "default": "job", "description": "Specifies which exclusions settings to use: global (Jenkins global settings) or job (current pipeline)" }, "excludeFolders": { "type": "string", "description": "Comma separated list of folders to be excluded from the CxSAST scan", "examples": ["folder-1, folder-2, folder-3"] }, "filterPattern": { "type": "string", "description": "Defines the include/exclude wildcard patterns. Does not have effect when \"exclusionsSetting\" is set to \"global\"", "examples": [ "\"!**/_cvs/**/*, !**/.svn/**/*, !**/.hg/**/*, !**/.git/**/*\"" ] }, "hideDebugLogs": { "type": "boolean", "default": true, "description": "Sets whether debug logs are visible in the job output" }, "waitForResultsEnabled": { "type": "boolean", "default": true, "description": "Sets whether the scan should be executed synchronously (default). The Synchronous mode allows viewing scan results in Jenkins" }, "vulnerabilityThresholdEnabled": { "type": "boolean", "default": true, "description": "Sets whether the scan should fail if the number of vulnerabilities is above the configured thresholds. This option is only available if the waitForResultsEnabled parameter is enabled" }, "highThreshold": { "type": "integer", "default": 0, "description": "Sets the maximum number of High vulnerabilities allowed" }, "mediumThreshold": { "type": "integer", "default": 10, "description": "Sets the maximum number of Medium vulnerabilities allowed" }, "lowThreshold": { "type": "integer", "default": null, "description": "Sets the maximum number of Low vulnerabilities allowed" } }, "additionalProperties": false }, "sonar": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "breaks_build": { "type": "boolean", "description": "Waits for analysis result and breaks the build when the project fails for some quality gates", "default": false }, "branch_analysis": { "type": "boolean", "description": "Indicates whether sonnar server supports branch analysis, to provide dedicated parameters.", "default": true }, "branch_pattern": { "type": "string", "description": "Indicates what branches static analysis will be performed.", "examples": ["^master$|^release/.+$", "master"] }, "image": { "type": "string", "description": "Prebuilt Docker image for running scan into it. If not specified, it will use the same image used for main build.", "examples": ["myrepo:port/my-awesome-image:1.2.3"] }, "timeout": { "$ref": "#/definitions/timeout", "description": "Seconds to wait for the result of the quality gate. Only applies when breaks_build is set to true", "default": 120 }, "exclusions": { "type": "string", "description": "Comma separated list of wildcard patterns defining files to be excluded from the SonarQube scan", "examples": ["**/excluded-folder/**, **/example/*.html"] } }, "additionalProperties": false }, "when": { "type": "object", "title": "When", "description": "Condition that should be met to run this step", "properties": { "branch": { "title": "Branch", "$ref": "#/definitions/branchPattern" } } }, "steps": { "type": "array", "description": "List of steps to run", "title": "Steps" }, "singleStage": { "type": "object", "title": "Stage", "properties": { "steps": { "$ref": "#/definitions/steps" }, "when": { "$ref": "#/definitions/when" } }, "required": ["steps"], "additionalProperties": false }, "failFast": { "type": "boolean", "title": "Fail Fast", "default": false, "description": "Forces parallel stages to all be aborted when one of them fails" }, "parallelStage": { "type": "object", "title": "Parallel Stage", "properties": { "when": { "$ref": "#/definitions/when" }, "fail_fast": { "$ref": "#/definitions/failFast" }, "parallel": { "type": "object", "description": "List of stages to be executed in parallel", "patternProperties": { "^\\w+( \\w+)*$": { "$ref": "#/definitions/singleStage", "description": "Stage name in the Jenkins pipeline" } } } }, "required": ["parallel"], "additionalProperties": false }, "stage": { "type": "object", "properties": { "when": { "$ref": "#/definitions/when" }, "steps": { "$ref": "#/definitions/steps" }, "fail_fast": { "$ref": "#/definitions/failFast" }, "parallel": { "title": "Parallel", "patternProperties": { "^\\w+( \\w+)*$": { "$ref": "#/definitions/singleStage" } } } }, "anyOf": [ { "$ref": "#/definitions/singleStage" }, { "$ref": "#/definitions/parallelStage" } ], "additionalProperties": false }, "releaseChannel": { "type": "string", "description": "Release channel name" }, "releaseChannelBranch": { "$ref": "#/definitions/branchPattern", "description": "Indicates on which branches the artifact will be published" }, "dockerfile": { "description": "Dockerfile path", "type": "string" }, "outputDocker": { "type": "object", "properties": { "dockerfile": { "$ref": "#/definitions/dockerfile", "description": "Path to Dockerfile used to generate the docker image" }, "image_name": { "type": "string", "description": "Image name for the generated docker image. Cannot include tag. Tag will be automatically generated based on project version." }, "publish": { "$ref": "#/definitions/outputDockerPublish", "description": "Docker publishing information. If not present, no images will be published" }, "vulnerability_scan": { "type": "object", "description": "Configuration for running vulnerability scans on published Docker images", "title": "Vulnerability scan", "properties": { "enabled": { "type": "boolean", "default": true, "description": "Whether the vulnerability scan step should be run" } }, "additionalProperties": false }, "args": { "type": "array", "description": "List of build args (--build-arg) to pass in docker build", "title": "Docker build args", "items": { "$ref": "#/definitions/outputDockerBuildArgs" } } }, "required": ["dockerfile", "image_name"], "additionalProperties": false }, "outputDockerPublish": { "type": "array", "items": { "$ref": "#/definitions/dockerReleaseChannel" } }, "outputDockerBuildArgs": { "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string", "description": "ARG name" }, "env": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "description": "Environment variable whose value will be used to set the ARG" }, "value": { "type": "string", "description": "Value of the ARG" } }, "required": ["key"], "oneOf": [ { "required": ["env"], "not": { "required": ["value"] } }, { "required": ["value"], "not": { "required": ["env"] } } ] }, "dockerReleaseChannel": { "type": "object", "properties": { "channel": { "$ref": "#/definitions/releaseChannel" }, "branch": { "$ref": "#/definitions/releaseChannelBranch" }, "registry": { "type": "string", "description": "Docker registry. Must include protocol (http|https) and port", "format": "uri" }, "credentials": { "$ref": "#/definitions/credentials", "description": "Jenkins credentials ID for publishing into the specified Docker registry" } }, "required": ["channel", "branch", "registry", "credentials"], "additionalProperties": false }, "outputHelm": { "type": "object", "properties": { "path": { "type": "string", "description": "Path to the folder with all required chart config files" }, "updates": { "type": "array", "description": "Updates that must be done before packing Helm chart. It's a list of objects that specifies which updates must be done on which files", "items": { "$ref": "#/definitions/outputHelmUpdates" } }, "publish": { "$ref": "#/definitions/outputHelmPublish", "description": "Helm chart publishing configuration. If not present, no charts will be published" } }, "required": ["path", "publish", "updates"], "additionalProperties": false }, "outputHelmUpdates": { "type": "object", "additionalProperties": false, "properties": { "file": { "type": "string", "description": "Name (including path from Helm object path) of the file to be updated. Only supports yaml files" }, "properties": { "type": "array", "description": "A list of properties to update. It can be updated with a fixed value or environment variable", "items": { "$ref": "#/definitions/outputHelmUpdatesProperties" } } }, "required": ["file", "properties"] }, "outputHelmUpdatesProperties": { "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string", "description": "Yaml property (full path) to be updated" }, "env": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "description": "Environment variable whose value will be used to update the property" }, "value": { "type": "string", "description": "Value to update the given property" } }, "required": ["key"], "oneOf": [ { "required": ["env"], "not": { "required": ["value"] } }, { "required": ["value"], "not": { "required": ["env"] } } ] }, "outputHelmPublish": { "type": "array", "items": { "$ref": "#/definitions/helmReleaseChannel" } }, "helmReleaseChannel": { "type": "object", "properties": { "channel": { "$ref": "#/definitions/releaseChannel" }, "branch": { "$ref": "#/definitions/releaseChannelBranch" }, "repository": { "type": "string", "format": "uri", "description": "Helm chart repository. Must include protocol, host, port (if needed) and path" }, "credentials": { "$ref": "#/definitions/credentials", "description": "Jenkins credentials Id for this repository for uploading the chart" } }, "required": ["channel", "branch", "repository", "credentials"], "additionalProperties": false }, "outputPackage": { "type": "object", "properties": { "publish": { "$ref": "#/definitions/outputPackagePublish", "description": "Package publish configuration." } }, "required": ["publish"], "additionalProperties": false }, "outputPackagePublish": { "type": "array", "items": { "$ref": "#/definitions/packagePublishChannel" } }, "packagePublishChannel": { "type": "object", "properties": { "channel": { "$ref": "#/definitions/releaseChannel" }, "branch": { "$ref": "#/definitions/releaseChannelBranch" }, "registry": { "type": "string", "description": "NPM registry (env variable or registry URL)", "examples": [ "NPM_PUBLISH_REGISTRY", "NPM_SNAPSHOT_REGISTRY", "https://registry.npmjs.org" ] }, "credentials": { "$ref": "#/definitions/credentials", "description": "Jenkins credentials ID for publishing into the specified Docker registry" }, "maven_releases_repo": { "type": "string", "description": "Maven repository for deploying releases" }, "maven_snapshots_repo": { "type": "string", "description": "Maven repository for deploying snapshots" }, "params": { "type": "string", "description": "Optional params for npm publish or mvn deploy command.", "examples": ["--tag latest", "-Dmaven.test.skip=true"] } }, "required": ["channel", "branch"], "additionalProperties": false }, "cacheItem": { "type": "object", "properties": { "type": { "enum": ["maven", "npm", "local"], "description": "Cache type", "default": "maven" }, "enabled": { "type": "boolean", "description": "Sets whether this cache type is enabled", "default": false }, "source": { "type": "string", "description": "Location of the cache in the Jenkins workspace", "default": ".ci-cache/<type>" }, "target": { "type": "string", "description": "Location of the cache directory inside the Docker container", "default": "/container-path/directory" } }, "additionalProperties": false, "required": ["type", "enabled"] } }, "description": "CI configuration for Amdocs Bill Experience projects", "properties": { "project": { "description": "Project properties", "type": "object", "properties": { "name": { "description": "Project's name (used by Jenkins, Docker and Sonar)", "type": "string" }, "type": { "description": "Project type", "enum": ["npm", "maven", "mvn"], "default": "mvn" }, "settings": { "description": "ID of a managed maven or npm Jenkins file", "type": "string", "examples": ["bx-maven-settings", "bx-npm-settings"] } }, "additionalProperties": false }, "config": { "type": "object", "properties": { "jenkins_runtime": { "type": "object", "properties": { "docker": { "type": "object", "description": "Specifies how to build the Docker container (from an existing image or from a local Dockerfile)", "properties": { "image": { "description": "Prebuilt Docker image (has precedence over dockerfile)", "type": "string", "examples": ["remote-host.com/image-name:tag"] }, "dockerfile": { "description": "Path to a local Dockerfile", "$ref": "#/definitions/dockerfile", "examples": [".ci/Dockerfile"] } }, "additionalProperties": false } }, "additionalProperties": false, "required": ["docker"] }, "branch": { "type": "object", "description": "Describes on which branch names a build will be run", "properties": { "branch_pattern": { "$ref": "#/definitions/branchPattern" }, "disable_validation": { "description": "Disables branch name validation", "type": "boolean", "default": false } }, "additionalProperties": false }, "build": { "type": "object", "properties": { "clean_workspace_after_run": { "type": "boolean", "description": "Whether Jenkins workspace should be cleaned after the build", "default": true }, "commit_time_threshold": { "oneOf": [ { "type": "integer", "const": 0 }, { "type": "string", "pattern": "^\\d+[mhd]$" } ], "description": "Commit age threshold. Disables automated builds older than this parameter. When 0, this feature is disabled", "default": false, "examples": [0, "2m", "30m", "1d", "30m", "10d"] }, "checkmarx": { "$ref": "#/definitions/checkmarx", "description": "Adds a Static Analysis stage for CheckMarx. See https://www.jenkins.io/doc/pipeline/steps/checkmarx/ for all the configuration options." }, "static_analysis": { "$ref": "#/definitions/sonar", "description": "Adds a Static Analysis stage for Sonar." } }, "additionalProperties": false }, "cache": { "type": "object", "description": "Cache configuration for projects built inside Docker containers", "properties": { "repository": { "$ref": "#/definitions/binaryRepository" }, "items": { "type": "array", "description": "List of cache types", "items": { "$ref": "#/definitions/cacheItem" } } }, "additionalProperties": false } }, "additionalProperties": false }, "services": { "type": "array", "description": "Additional services required by the project or application.", "items": { "enum": [ "Postgres", "Postgis", "Redis", "Mssql", "Mysql", "Mongodb", "Elasticsearch" ] }, "uniqueItems": true }, "environment": { "type": "object", "description": "Custom environment variables to be added to the pipeline", "propertyNames": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" } }, "jenkinsEnvironment": { "type": "array", "description": "Jenkins environment variables that are passed to the Docker container", "uniqueItems": true, "items": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "type": "string" } }, "stages": { "type": "object", "title": "Stages", "description": "Defines the stages and steps required to build the project.", "patternProperties": { "^\\w+( \\w+)*$": { "$ref": "#/definitions/stage", "description": "Stage name in the Jenkins pipeline" } } }, "output": { "type": "object", "description": "Describes artifacts generated after all the stages have been run", "properties": { "package": { "$ref": "#/definitions/outputPackage", "description": "Configuration for publishing NPM or Maven packages" }, "docker": { "$ref": "#/definitions/outputDocker", "description": "Configuration for generating a Docker image" }, "helm": { "$ref": "#/definitions/outputHelm", "description": "Configuration for generating a Helm chart" } }, "additionalProperties": false }, "archive": { "type": "array", "description": "List of artifacts to archive (wildcards allowed). Check out https://www.jenkins.io/doc/pipeline/steps/core/#archiveartifacts-archive-the-artifacts", "examples": ["target/*.jar", "**/*.jar", "target/out.txt"] }, "timeout": { "$ref": "#/definitions/timeout", "description": "Build timeout in seconds", "default": 600 } }, "required": ["project", "stages"], "type": "object" }

samt.json

{ "$id": "https://json.schemastore.org/samt.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "source": { "description": "Path to the source directory, defaults to ./src", "type": "string", "format": "uri-reference" }, "repositories": { "description": "The default repositories to use if no repository is specified for a plugin", "type": "object", "properties": { "maven": { "description": "The url to the maven repository to use, defaults to https://repo.maven.apache.org/maven2", "type": "string", "format": "uri" } }, "additionalProperties": false }, "plugins": { "type": "array", "items": { "oneOf": [ { "description": "A local plugin, should most likely not be used in production", "type": "object", "required": ["type", "path"], "properties": { "type": { "const": "local" }, "path": { "type": "string", "format": "uri-reference" } }, "additionalProperties": false }, { "description": "A maven plugin in POM-like notation, will be downloaded from the provided repository", "type": "object", "required": ["type", "groupId", "artifactId", "version"], "properties": { "type": { "const": "maven" }, "groupId": { "type": "string" }, "artifactId": { "type": "string" }, "version": { "type": "string" }, "repository": { "type": "string", "format": "uri" } }, "additionalProperties": false }, { "description": "A maven plugin in gradle-like notation, will be downloaded from the provided repository", "type": "object", "required": ["type", "dependency"], "properties": { "type": { "const": "gradle" }, "dependency": { "type": "string" }, "repository": { "type": "string", "format": "uri" } }, "additionalProperties": false } ] } }, "generators": { "description": "Which SAMT generators to use", "type": "array", "items": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string" }, "output": { "type": "string", "format": "uri-reference" }, "options": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } } }, "type": "object" }

meta.schema.json

{ "$defs": { "AliasPredicateEnum": { "description": "permissible values for the relationship between an element and an alias", "enum": [ "EXACT_SYNONYM", "RELATED_SYNONYM", "BROAD_SYNONYM", "NARROW_SYNONYM" ], "title": "AliasPredicateEnum", "type": "string" }, "AltDescription": { "additionalProperties": false, "description": "an attributed description", "properties": { "description": { "description": "text of an attributed description", "type": "string" }, "source": { "description": "the source of an attributed description", "type": "string" } }, "required": [ "source", "description" ], "title": "AltDescription", "type": "object" }, "AltDescription__identifier_optional": { "additionalProperties": false, "description": "an attributed description", "properties": { "description": { "description": "text of an attributed description", "type": "string" }, "source": { "description": "the source of an attributed description", "type": "string" } }, "required": [ "description" ], "title": "AltDescription", "type": "object" }, "Annotation": { "additionalProperties": false, "description": "a tag/value pair with the semantics of OWL Annotation", "properties": { "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "tag": { "description": "a tag associated with an extension", "type": "string" }, "value": { "description": "the actual annotation", "type": "string" } }, "required": [ "tag", "value" ], "title": "Annotation", "type": "object" }, "Annotation__identifier_optional": { "additionalProperties": false, "description": "a tag/value pair with the semantics of OWL Annotation", "properties": { "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "tag": { "description": "a tag associated with an extension", "type": "string" }, "value": { "description": "the actual annotation", "type": "string" } }, "required": [ "value" ], "title": "Annotation", "type": "object" }, "AnonymousClassExpression": { "additionalProperties": false, "description": "", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "is_a": { "description": "A primary parent class or slot from which inheritable metaslots are propagated from. While multiple inheritance is not allowed, mixins can be provided effectively providing the same thing. The semantics are the same when translated to formalisms that allow MI (e.g. RDFS/OWL). When translating to a SI framework (e.g. java classes, python classes) then is a is used. When translating a framework without polymorphism (e.g. json-schema, solr document schema) then is a and mixins are recursively unfolded", "type": "string" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "slot_conditions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "expresses constraints on a group of slots for a class expression", "type": "object" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" } }, "title": "AnonymousClassExpression", "type": "object" }, "AnonymousEnumExpression": { "additionalProperties": false, "description": "An enum_expression that is not named", "properties": { "code_set": { "description": "the identifier of an enumeration code set.", "type": "string" }, "code_set_tag": { "description": "the version tag of the enumeration code set", "type": "string" }, "code_set_version": { "description": "the version identifier of the enumeration code set", "type": "string" }, "concepts": { "description": "A list of identifiers that are used to construct a set of permissible values", "items": { "type": "string" }, "type": "array" }, "include": { "description": "An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "inherits": { "description": "An enum definition that is used as the basis to create a new enum", "items": { "type": "string" }, "type": "array" }, "matches": { "$ref": "#/$defs/MatchQuery", "description": "Specifies a match query that is used to calculate the list of permissible values" }, "minus": { "description": "An enum expression that yields a list of permissible values that are to be subtracted from the enum", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "permissible_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/PermissibleValue__identifier_optional" }, { "type": "null" } ] }, "description": "A list of possible values for a slot range", "type": "object" }, "pv_formula": { "$ref": "#/$defs/PvFormulaOptions", "description": "Defines the specific formula to be used to generate the permissible values." }, "reachable_from": { "$ref": "#/$defs/ReachabilityQuery", "description": "Specifies a query for obtaining a list of permissible values based on graph reachability" } }, "title": "AnonymousEnumExpression", "type": "object" }, "AnonymousSlotExpression": { "additionalProperties": false, "description": "", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_members": { "$ref": "#/$defs/AnonymousSlotExpression", "description": "the value of the slot is multivalued with all members satisfying the condition" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "enum_range": { "$ref": "#/$defs/EnumExpression", "description": "An inlined enumeration" }, "equals_expression": { "description": "the value of the slot must equal the value of the evaluated expression", "type": "string" }, "equals_number": { "description": "the slot must have range of a number and the value of the slot must equal the specified value", "type": "integer" }, "equals_string": { "description": "the slot must have range string and the value of the slot must equal the specified value", "type": "string" }, "equals_string_in": { "description": "the slot must have range string and the value of the slot must equal one of the specified values", "items": { "type": "string" }, "type": "array" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "has_member": { "$ref": "#/$defs/AnonymousSlotExpression", "description": "the value of the slot is multivalued with at least one member satisfying the condition" }, "implicit_prefix": { "description": "Causes the slot value to be interpreted as a uriorcurie after prefixing with this string", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "inlined": { "description": "True means that keyed or identified slot appears in an outer structure by value. False means that only the key or identifier for the slot appears within the domain, referencing a structure that appears elsewhere.", "type": "boolean" }, "inlined_as_list": { "description": "True means that an inlined slot is represented as a list of range instances. False means that an inlined slot is represented as a dictionary, whose key is the slot key or identifier and whose value is the range instance.", "type": "boolean" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "maximum_cardinality": { "description": "the maximum number of entries for a multivalued slot", "type": "integer" }, "maximum_value": { "description": "for slots with ranges of type number, the value must be equal to or lowe than this", "type": "integer" }, "minimum_cardinality": { "description": "the minimum number of entries for a multivalued slot", "type": "integer" }, "minimum_value": { "description": "for slots with ranges of type number, the value must be equal to or higher than this", "type": "integer" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "pattern": { "description": "the string value of the slot must conform to this regular expression expressed in the string", "type": "string" }, "range": { "description": "defines the type of the object of the slot. Given the following slot definition\n S1:\n domain: C1\n range: C2\nthe declaration\n X:\n S1: Y\n\nimplicitly asserts Y is an instance of C2\n", "type": "string" }, "range_expression": { "$ref": "#/$defs/AnonymousClassExpression", "description": "A range that is described as a boolean expression combining existing ranges" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "recommended": { "description": "true means that the slot should be present in instances of the class definition, but this is not required", "type": "boolean" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "required": { "description": "true means that the slot must be present in instances of the class definition", "type": "boolean" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "structured_pattern": { "$ref": "#/$defs/PatternExpression", "description": "the string value of the slot must conform to the regular expression in the pattern expression" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" }, "value_presence": { "$ref": "#/$defs/PresenceEnum", "description": "if true then a value must be present (for lists there must be at least one value). If false then a value must be absent (for lists, must be empty)" } }, "title": "AnonymousSlotExpression", "type": "object" }, "AnonymousTypeExpression": { "additionalProperties": false, "description": "A type expression that is not a top-level named type definition. Used for nesting.", "properties": { "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "equals_number": { "description": "the slot must have range of a number and the value of the slot must equal the specified value", "type": "integer" }, "equals_string": { "description": "the slot must have range string and the value of the slot must equal the specified value", "type": "string" }, "equals_string_in": { "description": "the slot must have range string and the value of the slot must equal one of the specified values", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "implicit_prefix": { "description": "Causes the slot value to be interpreted as a uriorcurie after prefixing with this string", "type": "string" }, "maximum_value": { "description": "for slots with ranges of type number, the value must be equal to or lowe than this", "type": "integer" }, "minimum_value": { "description": "for slots with ranges of type number, the value must be equal to or higher than this", "type": "integer" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "pattern": { "description": "the string value of the slot must conform to this regular expression expressed in the string", "type": "string" }, "structured_pattern": { "$ref": "#/$defs/PatternExpression", "description": "the string value of the slot must conform to the regular expression in the pattern expression" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" } }, "title": "AnonymousTypeExpression", "type": "object" }, "Anything": { "additionalProperties": true, "description": "", "title": "Anything", "type": "object" }, "ClassDefinition": { "additionalProperties": false, "description": "an element whose instances are complex objects that may have slot-value assignments", "properties": { "abstract": { "description": "Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.", "type": "boolean" }, "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "apply_to": { "description": "Used to extend class or slot definitions. For example, if we have a core schema where a gene has two slots for identifier and symbol, and we have a specialized schema for my_organism where we wish to add a slot systematic_name, we can avoid subclassing by defining a class gene_my_organism, adding the slot to this class, and then adding an apply_to pointing to the gene class. The new slot will be 'injected into' the gene class.", "items": { "type": "string" }, "type": "array" }, "attributes": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "Inline definition of slots", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "children_are_mutually_disjoint": { "description": "If true then all direct is_a children are mutually disjoint and share no instances in common", "type": "boolean" }, "class_uri": { "description": "URI of the class that provides a semantic interpretation of the element in a linked data context. The URI may come from any namespace and may be shared between schemas", "type": "string" }, "classification_rules": { "description": "The collection of classification rules that apply to all members of this class. Classification rules allow for automatically assigning the instantiated type of an instance.", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "defining_slots": { "description": "The combination of is a plus defining slots form a genus-differentia definition, or the set of necessary and sufficient conditions that can be transformed into an OWL equivalence axiom", "items": { "type": "string" }, "type": "array" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "disjoint_with": { "description": "Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances", "items": { "type": "string" }, "type": "array" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "is_a": { "description": "A primary parent class from which inheritable metaslots are propagated", "type": "string" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "mixin": { "description": "Indicates the class or slot is intended to be inherited from without being an is_a parent. mixins should not be inherited from using is_a, except by other mixins.", "type": "boolean" }, "mixins": { "description": "A collection of secondary parent mixin classes from which inheritable metaslots are propagated", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "represents_relationship": { "description": "true if this class represents a relationship rather than an entity", "type": "boolean" }, "rules": { "description": "the collection of rules that apply to all members of this class", "items": { "$ref": "#/$defs/ClassRule" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "slot_conditions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "expresses constraints on a group of slots for a class expression", "type": "object" }, "slot_names_unique": { "description": "if true then induced/mangled slot names are not created for class_usage and attributes", "type": "boolean" }, "slot_usage": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "the refinement of a slot in the context of the containing class definition.", "type": "object" }, "slots": { "description": "collection of slot names that are applicable to a class", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "string_serialization": { "description": "Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots.\nWe call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion.\nImplementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects\nFor example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "subclass_of": { "description": "DEPRECATED -- rdfs:subClassOf to be emitted in OWL generation", "type": "string" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "tree_root": { "description": "Indicates that this is the Container class which forms the root of the serialized document structure in tree serializations", "type": "boolean" }, "union_of": { "description": "indicates that the domain element consists exactly of the members of the element in the range.", "items": { "type": "string" }, "type": "array" }, "unique_keys": { "additionalProperties": { "$ref": "#/$defs/UniqueKey__identifier_optional" }, "description": "A collection of named unique keys for this class. Unique keys may be singular or compound.", "type": "object" }, "values_from": { "description": "The identifier of a \"value set\" -- a set of identifiers that form the possible values for the range of a slot. Note: this is different than 'subproperty_of' in that 'subproperty_of' is intended to be a single ontology term while 'values_from' is the identifier of an entire value set. Additionally, this is different than an enumeration in that in an enumeration, the values of the enumeration are listed directly in the model itself. Setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "items": { "type": "string" }, "type": "array" } }, "required": [ "name" ], "title": "ClassDefinition", "type": "object" }, "ClassDefinition__identifier_optional": { "additionalProperties": false, "description": "an element whose instances are complex objects that may have slot-value assignments", "properties": { "abstract": { "description": "Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.", "type": "boolean" }, "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "apply_to": { "description": "Used to extend class or slot definitions. For example, if we have a core schema where a gene has two slots for identifier and symbol, and we have a specialized schema for my_organism where we wish to add a slot systematic_name, we can avoid subclassing by defining a class gene_my_organism, adding the slot to this class, and then adding an apply_to pointing to the gene class. The new slot will be 'injected into' the gene class.", "items": { "type": "string" }, "type": "array" }, "attributes": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "Inline definition of slots", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "children_are_mutually_disjoint": { "description": "If true then all direct is_a children are mutually disjoint and share no instances in common", "type": "boolean" }, "class_uri": { "description": "URI of the class that provides a semantic interpretation of the element in a linked data context. The URI may come from any namespace and may be shared between schemas", "type": "string" }, "classification_rules": { "description": "The collection of classification rules that apply to all members of this class. Classification rules allow for automatically assigning the instantiated type of an instance.", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "defining_slots": { "description": "The combination of is a plus defining slots form a genus-differentia definition, or the set of necessary and sufficient conditions that can be transformed into an OWL equivalence axiom", "items": { "type": "string" }, "type": "array" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "disjoint_with": { "description": "Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances", "items": { "type": "string" }, "type": "array" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "is_a": { "description": "A primary parent class from which inheritable metaslots are propagated", "type": "string" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "mixin": { "description": "Indicates the class or slot is intended to be inherited from without being an is_a parent. mixins should not be inherited from using is_a, except by other mixins.", "type": "boolean" }, "mixins": { "description": "A collection of secondary parent mixin classes from which inheritable metaslots are propagated", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousClassExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "represents_relationship": { "description": "true if this class represents a relationship rather than an entity", "type": "boolean" }, "rules": { "description": "the collection of rules that apply to all members of this class", "items": { "$ref": "#/$defs/ClassRule" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "slot_conditions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "expresses constraints on a group of slots for a class expression", "type": "object" }, "slot_names_unique": { "description": "if true then induced/mangled slot names are not created for class_usage and attributes", "type": "boolean" }, "slot_usage": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "the refinement of a slot in the context of the containing class definition.", "type": "object" }, "slots": { "description": "collection of slot names that are applicable to a class", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "string_serialization": { "description": "Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots.\nWe call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion.\nImplementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects\nFor example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "subclass_of": { "description": "DEPRECATED -- rdfs:subClassOf to be emitted in OWL generation", "type": "string" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "tree_root": { "description": "Indicates that this is the Container class which forms the root of the serialized document structure in tree serializations", "type": "boolean" }, "union_of": { "description": "indicates that the domain element consists exactly of the members of the element in the range.", "items": { "type": "string" }, "type": "array" }, "unique_keys": { "additionalProperties": { "$ref": "#/$defs/UniqueKey__identifier_optional" }, "description": "A collection of named unique keys for this class. Unique keys may be singular or compound.", "type": "object" }, "values_from": { "description": "The identifier of a \"value set\" -- a set of identifiers that form the possible values for the range of a slot. Note: this is different than 'subproperty_of' in that 'subproperty_of' is intended to be a single ontology term while 'values_from' is the identifier of an entire value set. Additionally, this is different than an enumeration in that in an enumeration, the values of the enumeration are listed directly in the model itself. Setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "items": { "type": "string" }, "type": "array" } }, "required": [], "title": "ClassDefinition", "type": "object" }, "ClassRule": { "additionalProperties": false, "description": "A rule that applies to instances of a class", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "bidirectional": { "description": "in addition to preconditions entailing postconditions, the postconditions entail the preconditions", "type": "boolean" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deactivated": { "description": "a deactivated rule is not executed by the rules engine", "type": "boolean" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "elseconditions": { "$ref": "#/$defs/AnonymousClassExpression", "description": "an expression that must hold for an instance of the class, if the preconditions no not hold" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "open_world": { "description": "if true, the the postconditions may be omitted in instance data, but it is valid for an inference engine to add these", "type": "boolean" }, "postconditions": { "$ref": "#/$defs/AnonymousClassExpression", "description": "an expression that must hold for an instance of the class, if the preconditions hold" }, "preconditions": { "$ref": "#/$defs/AnonymousClassExpression", "description": "an expression that must hold in order for the rule to be applicable to an instance" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" } }, "title": "ClassRule", "type": "object" }, "EnumDefinition": { "additionalProperties": false, "description": "an element whose instances must be drawn from a specified set of permissible values", "properties": { "abstract": { "description": "Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.", "type": "boolean" }, "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "apply_to": { "description": "Used to extend class or slot definitions. For example, if we have a core schema where a gene has two slots for identifier and symbol, and we have a specialized schema for my_organism where we wish to add a slot systematic_name, we can avoid subclassing by defining a class gene_my_organism, adding the slot to this class, and then adding an apply_to pointing to the gene class. The new slot will be 'injected into' the gene class.", "items": { "type": "string" }, "type": "array" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "code_set": { "description": "the identifier of an enumeration code set.", "type": "string" }, "code_set_tag": { "description": "the version tag of the enumeration code set", "type": "string" }, "code_set_version": { "description": "the version identifier of the enumeration code set", "type": "string" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "concepts": { "description": "A list of identifiers that are used to construct a set of permissible values", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "enum_uri": { "description": "URI of the enum that provides a semantic interpretation of the element in a linked data context. The URI may come from any namespace and may be shared between schemas", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "include": { "description": "An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "inherits": { "description": "An enum definition that is used as the basis to create a new enum", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "is_a": { "description": "A primary parent class or slot from which inheritable metaslots are propagated from. While multiple inheritance is not allowed, mixins can be provided effectively providing the same thing. The semantics are the same when translated to formalisms that allow MI (e.g. RDFS/OWL). When translating to a SI framework (e.g. java classes, python classes) then is a is used. When translating a framework without polymorphism (e.g. json-schema, solr document schema) then is a and mixins are recursively unfolded", "type": "string" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "matches": { "$ref": "#/$defs/MatchQuery", "description": "Specifies a match query that is used to calculate the list of permissible values" }, "minus": { "description": "An enum expression that yields a list of permissible values that are to be subtracted from the enum", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "mixin": { "description": "Indicates the class or slot is intended to be inherited from without being an is_a parent. mixins should not be inherited from using is_a, except by other mixins.", "type": "boolean" }, "mixins": { "description": "A collection of secondary parent classes or slots from which inheritable metaslots are propagated from.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "permissible_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/PermissibleValue__identifier_optional" }, { "type": "null" } ] }, "description": "A list of possible values for a slot range", "type": "object" }, "pv_formula": { "$ref": "#/$defs/PvFormulaOptions", "description": "Defines the specific formula to be used to generate the permissible values." }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "reachable_from": { "$ref": "#/$defs/ReachabilityQuery", "description": "Specifies a query for obtaining a list of permissible values based on graph reachability" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "string_serialization": { "description": "Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots.\nWe call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion.\nImplementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects\nFor example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "values_from": { "description": "The identifier of a \"value set\" -- a set of identifiers that form the possible values for the range of a slot. Note: this is different than 'subproperty_of' in that 'subproperty_of' is intended to be a single ontology term while 'values_from' is the identifier of an entire value set. Additionally, this is different than an enumeration in that in an enumeration, the values of the enumeration are listed directly in the model itself. Setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "items": { "type": "string" }, "type": "array" } }, "required": [ "name" ], "title": "EnumDefinition", "type": "object" }, "EnumDefinition__identifier_optional": { "additionalProperties": false, "description": "an element whose instances must be drawn from a specified set of permissible values", "properties": { "abstract": { "description": "Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.", "type": "boolean" }, "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "apply_to": { "description": "Used to extend class or slot definitions. For example, if we have a core schema where a gene has two slots for identifier and symbol, and we have a specialized schema for my_organism where we wish to add a slot systematic_name, we can avoid subclassing by defining a class gene_my_organism, adding the slot to this class, and then adding an apply_to pointing to the gene class. The new slot will be 'injected into' the gene class.", "items": { "type": "string" }, "type": "array" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "code_set": { "description": "the identifier of an enumeration code set.", "type": "string" }, "code_set_tag": { "description": "the version tag of the enumeration code set", "type": "string" }, "code_set_version": { "description": "the version identifier of the enumeration code set", "type": "string" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "concepts": { "description": "A list of identifiers that are used to construct a set of permissible values", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "enum_uri": { "description": "URI of the enum that provides a semantic interpretation of the element in a linked data context. The URI may come from any namespace and may be shared between schemas", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "include": { "description": "An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "inherits": { "description": "An enum definition that is used as the basis to create a new enum", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "is_a": { "description": "A primary parent class or slot from which inheritable metaslots are propagated from. While multiple inheritance is not allowed, mixins can be provided effectively providing the same thing. The semantics are the same when translated to formalisms that allow MI (e.g. RDFS/OWL). When translating to a SI framework (e.g. java classes, python classes) then is a is used. When translating a framework without polymorphism (e.g. json-schema, solr document schema) then is a and mixins are recursively unfolded", "type": "string" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "matches": { "$ref": "#/$defs/MatchQuery", "description": "Specifies a match query that is used to calculate the list of permissible values" }, "minus": { "description": "An enum expression that yields a list of permissible values that are to be subtracted from the enum", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "mixin": { "description": "Indicates the class or slot is intended to be inherited from without being an is_a parent. mixins should not be inherited from using is_a, except by other mixins.", "type": "boolean" }, "mixins": { "description": "A collection of secondary parent classes or slots from which inheritable metaslots are propagated from.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "permissible_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/PermissibleValue__identifier_optional" }, { "type": "null" } ] }, "description": "A list of possible values for a slot range", "type": "object" }, "pv_formula": { "$ref": "#/$defs/PvFormulaOptions", "description": "Defines the specific formula to be used to generate the permissible values." }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "reachable_from": { "$ref": "#/$defs/ReachabilityQuery", "description": "Specifies a query for obtaining a list of permissible values based on graph reachability" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "string_serialization": { "description": "Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots.\nWe call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion.\nImplementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects\nFor example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "values_from": { "description": "The identifier of a \"value set\" -- a set of identifiers that form the possible values for the range of a slot. Note: this is different than 'subproperty_of' in that 'subproperty_of' is intended to be a single ontology term while 'values_from' is the identifier of an entire value set. Additionally, this is different than an enumeration in that in an enumeration, the values of the enumeration are listed directly in the model itself. Setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "items": { "type": "string" }, "type": "array" } }, "required": [], "title": "EnumDefinition", "type": "object" }, "EnumExpression": { "additionalProperties": false, "description": "An expression that constrains the range of a slot", "properties": { "code_set": { "description": "the identifier of an enumeration code set.", "type": "string" }, "code_set_tag": { "description": "the version tag of the enumeration code set", "type": "string" }, "code_set_version": { "description": "the version identifier of the enumeration code set", "type": "string" }, "concepts": { "description": "A list of identifiers that are used to construct a set of permissible values", "items": { "type": "string" }, "type": "array" }, "include": { "description": "An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "inherits": { "description": "An enum definition that is used as the basis to create a new enum", "items": { "type": "string" }, "type": "array" }, "matches": { "$ref": "#/$defs/MatchQuery", "description": "Specifies a match query that is used to calculate the list of permissible values" }, "minus": { "description": "An enum expression that yields a list of permissible values that are to be subtracted from the enum", "items": { "$ref": "#/$defs/AnonymousEnumExpression" }, "type": "array" }, "permissible_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/PermissibleValue__identifier_optional" }, { "type": "null" } ] }, "description": "A list of possible values for a slot range", "type": "object" }, "pv_formula": { "$ref": "#/$defs/PvFormulaOptions", "description": "Defines the specific formula to be used to generate the permissible values." }, "reachable_from": { "$ref": "#/$defs/ReachabilityQuery", "description": "Specifies a query for obtaining a list of permissible values based on graph reachability" } }, "title": "EnumExpression", "type": "object" }, "Example": { "additionalProperties": false, "description": "usage example and description", "properties": { "description": { "description": "description of what the value is doing", "type": "string" }, "object": { "$ref": "#/$defs/Anything", "description": "direct object representation of the example" }, "value": { "description": "example value", "type": "string" } }, "title": "Example", "type": "object" }, "Extension": { "additionalProperties": false, "description": "a tag/value pair used to add non-model information to an entry", "properties": { "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "tag": { "description": "a tag associated with an extension", "type": "string" }, "value": { "description": "the actual annotation", "type": "string" } }, "required": [ "tag", "value" ], "title": "Extension", "type": "object" }, "Extension__identifier_optional": { "additionalProperties": false, "description": "a tag/value pair used to add non-model information to an entry", "properties": { "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "tag": { "description": "a tag associated with an extension", "type": "string" }, "value": { "description": "the actual annotation", "type": "string" } }, "required": [ "value" ], "title": "Extension", "type": "object" }, "ImportExpression": { "additionalProperties": false, "description": "an expression describing an import", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "import_as": { "type": "string" }, "import_from": { "type": "string" }, "import_map": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/Setting__identifier_optional" }, { "description": "The value assigned for a setting", "type": "string" } ] }, "type": "object" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" } }, "required": [ "import_from" ], "title": "ImportExpression", "type": "object" }, "LocalName": { "additionalProperties": false, "description": "an attributed label", "properties": { "local_name_source": { "description": "the ncname of the source of the name", "type": "string" }, "local_name_value": { "description": "a name assigned to an element in a given ontology", "type": "string" } }, "required": [ "local_name_source", "local_name_value" ], "title": "LocalName", "type": "object" }, "LocalName__identifier_optional": { "additionalProperties": false, "description": "an attributed label", "properties": { "local_name_source": { "description": "the ncname of the source of the name", "type": "string" }, "local_name_value": { "description": "a name assigned to an element in a given ontology", "type": "string" } }, "required": [ "local_name_value" ], "title": "LocalName", "type": "object" }, "MatchQuery": { "additionalProperties": false, "description": "A query that is used on an enum expression to dynamically obtain a set of permissivle values via a query that matches on properties of the external concepts", "properties": { "identifier_pattern": { "description": "A regular expression that is used to obtain a set of identifiers from a source_ontology to construct a set of permissible values", "type": "string" }, "source_ontology": { "description": "An ontology or vocabulary or terminology that is used in a query to obtain a set of permissible values", "type": "string" } }, "title": "MatchQuery", "type": "object" }, "PathExpression": { "additionalProperties": false, "description": "An expression that describes an abstract path from an object to another through a sequence of slot lookups", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/PathExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/PathExpression" }, "type": "array" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/PathExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "followed_by": { "$ref": "#/$defs/PathExpression", "description": "in a sequential list, this indicates the next member" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/PathExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "range_expression": { "$ref": "#/$defs/AnonymousClassExpression", "description": "A range that is described as a boolean expression combining existing ranges" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "reversed": { "description": "true if the slot is to be inversed", "type": "boolean" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "traverse": { "description": "the slot to traverse", "type": "string" } }, "title": "PathExpression", "type": "object" }, "PatternExpression": { "additionalProperties": false, "description": "a regular expression pattern used to evaluate conformance of a string", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "interpolated": { "description": "if true then the pattern is first string interpolated", "type": "boolean" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "partial_match": { "description": "if true then the pattern must match the whole string, as if enclosed in ^...$", "type": "boolean" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "syntax": { "description": "the string value of the slot must conform to this regular expression expressed in the string. May be interpolated.", "type": "string" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" } }, "title": "PatternExpression", "type": "object" }, "PermissibleValue": { "additionalProperties": false, "description": "a permissible value, accompanied by intended text and an optional mapping to a concept URI", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "meaning": { "description": "the value meaning of a permissible value", "type": "string" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "text": { "description": "The actual permissible value itself", "type": "string" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" } }, "required": [ "text" ], "title": "PermissibleValue", "type": "object" }, "PermissibleValue__identifier_optional": { "additionalProperties": false, "description": "a permissible value, accompanied by intended text and an optional mapping to a concept URI", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "meaning": { "description": "the value meaning of a permissible value", "type": "string" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "text": { "description": "The actual permissible value itself", "type": "string" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" } }, "required": [], "title": "PermissibleValue", "type": "object" }, "Prefix": { "additionalProperties": false, "description": "prefix URI tuple", "properties": { "prefix_prefix": { "description": "The prefix components of a prefix expansions. This is the part that appears before the colon in a CURIE.", "type": "string" }, "prefix_reference": { "description": "The namespace to which a prefix expands to.", "type": "string" } }, "required": [ "prefix_prefix", "prefix_reference" ], "title": "Prefix", "type": "object" }, "Prefix__identifier_optional": { "additionalProperties": false, "description": "prefix URI tuple", "properties": { "prefix_prefix": { "description": "The prefix components of a prefix expansions. This is the part that appears before the colon in a CURIE.", "type": "string" }, "prefix_reference": { "description": "The namespace to which a prefix expands to.", "type": "string" } }, "required": [ "prefix_reference" ], "title": "Prefix", "type": "object" }, "PresenceEnum": { "description": "enumeration of conditions by which a slot value should be set", "enum": [ "UNCOMMITTED", "PRESENT", "ABSENT" ], "title": "PresenceEnum", "type": "string" }, "PvFormulaOptions": { "description": "The formula used to generate the set of permissible values from the code_set values", "enum": [ "CODE", "CURIE", "URI", "FHIR_CODING" ], "title": "PvFormulaOptions", "type": "string" }, "ReachabilityQuery": { "additionalProperties": false, "description": "A query that is used on an enum expression to dynamically obtain a set of permissible values via walking from a set of source nodes to a set of descendants or ancestors over a set of relationship types", "properties": { "include_self": { "description": "True if the query is reflexive", "type": "boolean" }, "is_direct": { "description": "True if the reachability query should only include directly related nodes, if False then include also transitively connected", "type": "boolean" }, "relationship_types": { "description": "A list of relationship types (properties) that are used in a reachability query", "items": { "type": "string" }, "type": "array" }, "source_nodes": { "description": "A list of nodes that are used in the reachability query", "items": { "type": "string" }, "type": "array" }, "source_ontology": { "description": "An ontology or vocabulary or terminology that is used in a query to obtain a set of permissible values", "type": "string" }, "traverse_up": { "description": "True if the direction of the reachability query is reversed and ancestors are retrieved", "type": "boolean" } }, "title": "ReachabilityQuery", "type": "object" }, "RelationalRoleEnum": { "description": "enumeration of roles a slot on a relationship class can play", "enum": [ "SUBJECT", "OBJECT", "PREDICATE", "NODE", "OTHER_ROLE" ], "title": "RelationalRoleEnum", "type": "string" }, "SchemaDefinition": { "additionalProperties": false, "description": "A collection of definitions that make up a schema or a data model.", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "classes": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/ClassDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all class definitions in the schema", "type": "object" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "default_curi_maps": { "description": "ordered list of prefixcommon biocontexts to be fetched to resolve id prefixes and inline prefix variables", "items": { "type": "string" }, "type": "array" }, "default_prefix": { "description": "The prefix that is used for all elements within a schema", "type": "string" }, "default_range": { "description": "default slot range to be used if range element is omitted from a slot definition", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "emit_prefixes": { "description": "a list of Curie prefixes that are used in the representation of instances of the model. All prefixes in this list are added to the prefix sections of the target models.", "items": { "type": "string" }, "type": "array" }, "enums": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/EnumDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all enum definitions in the schema", "type": "object" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "generation_date": { "description": "date and time that the schema was loaded/generated", "format": "date-time", "type": "string" }, "id": { "description": "The official schema URI", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "imports": { "description": "A list of schemas that are to be included in this schema", "items": { "type": "string" }, "type": "array" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "license": { "description": "license for the schema", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "metamodel_version": { "description": "Version of the metamodel used to load the schema", "type": "string" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "a unique name for the schema that is both human-readable and consists of only characters from the NCName set", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "prefixes": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/Prefix__identifier_optional" }, { "description": "The namespace to which a prefix expands to.", "type": "string" } ] }, "description": "A collection of prefix expansions that specify how CURIEs can be expanded to URIs", "type": "object" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "settings": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/Setting__identifier_optional" }, { "description": "The value assigned for a setting", "type": "string" } ] }, "description": "A collection of global variable settings", "type": "object" }, "slot_names_unique": { "description": "if true then induced/mangled slot names are not created for class_usage and attributes", "type": "boolean" }, "slots": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all slot definitions in the schema", "type": "object" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "source_file": { "description": "name, uri or description of the source of the schema", "type": "string" }, "source_file_date": { "description": "modification date of the source of the schema", "format": "date-time", "type": "string" }, "source_file_size": { "description": "size in bytes of the source of the schema", "type": "integer" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "subsets": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SubsetDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all subset definitions in the schema", "type": "object" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "types": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/TypeDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all type definitions in the schema", "type": "object" }, "version": { "description": "particular version of schema", "type": "string" } }, "required": [ "id", "name" ], "title": "SchemaDefinition", "type": "object" }, "Setting": { "additionalProperties": false, "description": "assignment of a key to a value", "properties": { "setting_key": { "description": "the variable name for a setting", "type": "string" }, "setting_value": { "description": "The value assigned for a setting", "type": "string" } }, "required": [ "setting_key", "setting_value" ], "title": "Setting", "type": "object" }, "Setting__identifier_optional": { "additionalProperties": false, "description": "assignment of a key to a value", "properties": { "setting_key": { "description": "the variable name for a setting", "type": "string" }, "setting_value": { "description": "The value assigned for a setting", "type": "string" } }, "required": [ "setting_value" ], "title": "Setting", "type": "object" }, "SlotDefinition": { "additionalProperties": false, "description": "an element that describes how instances are related to other instances", "properties": { "abstract": { "description": "Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.", "type": "boolean" }, "alias": { "description": "the name used for a slot in the context of its owning class. If present, this is used instead of the actual slot name.", "type": "string" }, "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_members": { "$ref": "#/$defs/AnonymousSlotExpression", "description": "the value of the slot is multivalued with all members satisfying the condition" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "apply_to": { "description": "Used to extend class or slot definitions. For example, if we have a core schema where a gene has two slots for identifier and symbol, and we have a specialized schema for my_organism where we wish to add a slot systematic_name, we can avoid subclassing by defining a class gene_my_organism, adding the slot to this class, and then adding an apply_to pointing to the gene class. The new slot will be 'injected into' the gene class.", "items": { "type": "string" }, "type": "array" }, "asymmetric": { "description": "If s is antisymmetric, and i.s=v where i is different from v, v.s cannot have value i", "type": "boolean" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "children_are_mutually_disjoint": { "description": "If true then all direct is_a children are mutually disjoint and share no instances in common", "type": "boolean" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "designates_type": { "description": "True means that the key slot(s) is used to determine the instantiation (types) relation between objects and a ClassDefinition", "type": "boolean" }, "disjoint_with": { "description": "Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances", "items": { "type": "string" }, "type": "array" }, "domain": { "description": "defines the type of the subject of the slot. Given the following slot definition\n S1:\n domain: C1\n range: C2\nthe declaration\n X:\n S1: Y\n\nimplicitly asserts that X is an instance of C1\n", "type": "string" }, "domain_of": { "description": "the class(es) that reference the slot in a \"slots\" or \"slot_usage\" context", "items": { "type": "string" }, "type": "array" }, "enum_range": { "$ref": "#/$defs/EnumExpression", "description": "An inlined enumeration" }, "equals_expression": { "description": "the value of the slot must equal the value of the evaluated expression", "type": "string" }, "equals_number": { "description": "the slot must have range of a number and the value of the slot must equal the specified value", "type": "integer" }, "equals_string": { "description": "the slot must have range string and the value of the slot must equal the specified value", "type": "string" }, "equals_string_in": { "description": "the slot must have range string and the value of the slot must equal one of the specified values", "items": { "type": "string" }, "type": "array" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "has_member": { "$ref": "#/$defs/AnonymousSlotExpression", "description": "the value of the slot is multivalued with at least one member satisfying the condition" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "identifier": { "description": "True means that the key slot(s) uniquely identifies the elements. There can be at most one identifier or key per container", "type": "boolean" }, "ifabsent": { "description": "function that provides a default value for the slot. Possible values for this slot are defined in\nlinkml.utils.ifabsent_functions.default_library:\n * [Tt]rue -- boolean True\n * [Ff]alse -- boolean False\n * bnode -- blank node identifier\n * class_curie -- CURIE for the containing class\n * class_uri -- URI for the containing class\n * default_ns -- schema default namespace\n * default_range -- schema default range\n * int(value) -- integer value\n * slot_uri -- URI for the slot\n * slot_curie -- CURIE for the slot\n * string(value) -- string value", "type": "string" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "implicit_prefix": { "description": "Causes the slot value to be interpreted as a uriorcurie after prefixing with this string", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "inherited": { "description": "true means that the *value* of a slot is inherited by subclasses", "type": "boolean" }, "inlined": { "description": "True means that keyed or identified slot appears in an outer structure by value. False means that only the key or identifier for the slot appears within the domain, referencing a structure that appears elsewhere.", "type": "boolean" }, "inlined_as_list": { "description": "True means that an inlined slot is represented as a list of range instances. False means that an inlined slot is represented as a dictionary, whose key is the slot key or identifier and whose value is the range instance.", "type": "boolean" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "inverse": { "description": "indicates that any instance of d s r implies that there is also an instance of r s' d", "type": "string" }, "irreflexive": { "description": "If s is irreflexive, then there exists no i such i.s=i", "type": "boolean" }, "is_a": { "description": "A primary parent slot from which inheritable metaslots are propagated", "type": "string" }, "is_class_field": { "description": "indicates that for any instance, i, the domain of this slot will include an assertion of i s range", "type": "boolean" }, "is_grouping_slot": { "description": "true if this slot is a grouping slot", "type": "boolean" }, "is_usage_slot": { "description": "True means that this slot was defined in a slot_usage situation", "type": "boolean" }, "key": { "description": "True means that the key slot(s) uniquely identify the elements within a single container", "type": "boolean" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "list_elements_ordered": { "description": "If True, then the order of elements of a multivalued slot is guaranteed to be preserved. If False, the order may still be preserved but this is not guaranteed", "type": "boolean" }, "list_elements_unique": { "description": "If True, then there must be no duplicates in the elements of a multivalued slot", "type": "boolean" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "locally_reflexive": { "description": "If s is locally_reflexive, then i.s=i for all instances i where s is a class slot for the type of i", "type": "boolean" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "maximum_cardinality": { "description": "the maximum number of entries for a multivalued slot", "type": "integer" }, "maximum_value": { "description": "for slots with ranges of type number, the value must be equal to or lowe than this", "type": "integer" }, "minimum_cardinality": { "description": "the minimum number of entries for a multivalued slot", "type": "integer" }, "minimum_value": { "description": "for slots with ranges of type number, the value must be equal to or higher than this", "type": "integer" }, "mixin": { "description": "Indicates the class or slot is intended to be inherited from without being an is_a parent. mixins should not be inherited from using is_a, except by other mixins.", "type": "boolean" }, "mixins": { "description": "A collection of secondary parent mixin slots from which inheritable metaslots are propagated", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "multivalued": { "description": "true means that slot can have more than one value and should be represented using a list or collection structure.", "type": "boolean" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "owner": { "description": "the \"owner\" of the slot. It is the class if it appears in the slots list, otherwise the declaring slot", "type": "string" }, "path_rule": { "$ref": "#/$defs/PathExpression", "description": "a rule for inferring a slot assignment based on evaluating a path through a sequence of slot assignments" }, "pattern": { "description": "the string value of the slot must conform to this regular expression expressed in the string", "type": "string" }, "range": { "description": "defines the type of the object of the slot. Given the following slot definition\n S1:\n domain: C1\n range: C2\nthe declaration\n X:\n S1: Y\n\nimplicitly asserts Y is an instance of C2\n", "type": "string" }, "range_expression": { "$ref": "#/$defs/AnonymousClassExpression", "description": "A range that is described as a boolean expression combining existing ranges" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "readonly": { "description": "If present, slot is read only. Text explains why", "type": "string" }, "recommended": { "description": "true means that the slot should be present in instances of the class definition, but this is not required", "type": "boolean" }, "reflexive": { "description": "If s is reflexive, then i.s=i for all instances i", "type": "boolean" }, "reflexive_transitive_form_of": { "description": "transitive_form_of including the reflexive case", "type": "string" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "relational_role": { "$ref": "#/$defs/RelationalRoleEnum", "description": "the role a slot on a relationship class plays, for example, the subject, object or predicate roles" }, "required": { "description": "true means that the slot must be present in instances of the class definition", "type": "boolean" }, "role": { "description": "a textual descriptor that indicates the role played by the slot range", "type": "string" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "shared": { "description": "If True, then the relationship between the slot domain and range is many to one or many to many", "type": "boolean" }, "singular_name": { "description": "a name that is used in the singular form", "type": "string" }, "slot_group": { "description": "allows for grouping of related slots into a grouping slot that serves the role of a group", "type": "string" }, "slot_uri": { "description": "URI of the class that provides a semantic interpretation of the slot in a linked data context. The URI may come from any namespace and may be shared between schemas.", "type": "string" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "string_serialization": { "description": "Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots.\nWe call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion.\nImplementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects\nFor example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "structured_pattern": { "$ref": "#/$defs/PatternExpression", "description": "the string value of the slot must conform to the regular expression in the pattern expression" }, "subproperty_of": { "description": "Ontology property which this slot is a subproperty of. Note: setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "type": "string" }, "symmetric": { "description": "If s is symmetric, and i.s=v, then v.s=i", "type": "boolean" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "transitive": { "description": "If s is transitive, and i.s=z, and s.s=j, then i.s=j", "type": "boolean" }, "transitive_form_of": { "description": "If s transitive_form_of d, then (1) s holds whenever d holds (2) s is transitive (3) d holds whenever s holds and there are no intermediates, and s is not reflexive", "type": "string" }, "union_of": { "description": "indicates that the domain element consists exactly of the members of the element in the range.", "items": { "type": "string" }, "type": "array" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" }, "usage_slot_name": { "description": "The name of the slot referenced in the slot_usage", "type": "string" }, "value_presence": { "$ref": "#/$defs/PresenceEnum", "description": "if true then a value must be present (for lists there must be at least one value). If false then a value must be absent (for lists, must be empty)" }, "values_from": { "description": "The identifier of a \"value set\" -- a set of identifiers that form the possible values for the range of a slot. Note: this is different than 'subproperty_of' in that 'subproperty_of' is intended to be a single ontology term while 'values_from' is the identifier of an entire value set. Additionally, this is different than an enumeration in that in an enumeration, the values of the enumeration are listed directly in the model itself. Setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "items": { "type": "string" }, "type": "array" } }, "required": [ "name" ], "title": "SlotDefinition", "type": "object" }, "SlotDefinition__identifier_optional": { "additionalProperties": false, "description": "an element that describes how instances are related to other instances", "properties": { "abstract": { "description": "Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.", "type": "boolean" }, "alias": { "description": "the name used for a slot in the context of its owning class. If present, this is used instead of the actual slot name.", "type": "string" }, "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_members": { "$ref": "#/$defs/AnonymousSlotExpression", "description": "the value of the slot is multivalued with all members satisfying the condition" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "apply_to": { "description": "Used to extend class or slot definitions. For example, if we have a core schema where a gene has two slots for identifier and symbol, and we have a specialized schema for my_organism where we wish to add a slot systematic_name, we can avoid subclassing by defining a class gene_my_organism, adding the slot to this class, and then adding an apply_to pointing to the gene class. The new slot will be 'injected into' the gene class.", "items": { "type": "string" }, "type": "array" }, "asymmetric": { "description": "If s is antisymmetric, and i.s=v where i is different from v, v.s cannot have value i", "type": "boolean" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "children_are_mutually_disjoint": { "description": "If true then all direct is_a children are mutually disjoint and share no instances in common", "type": "boolean" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "designates_type": { "description": "True means that the key slot(s) is used to determine the instantiation (types) relation between objects and a ClassDefinition", "type": "boolean" }, "disjoint_with": { "description": "Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances", "items": { "type": "string" }, "type": "array" }, "domain": { "description": "defines the type of the subject of the slot. Given the following slot definition\n S1:\n domain: C1\n range: C2\nthe declaration\n X:\n S1: Y\n\nimplicitly asserts that X is an instance of C1\n", "type": "string" }, "domain_of": { "description": "the class(es) that reference the slot in a \"slots\" or \"slot_usage\" context", "items": { "type": "string" }, "type": "array" }, "enum_range": { "$ref": "#/$defs/EnumExpression", "description": "An inlined enumeration" }, "equals_expression": { "description": "the value of the slot must equal the value of the evaluated expression", "type": "string" }, "equals_number": { "description": "the slot must have range of a number and the value of the slot must equal the specified value", "type": "integer" }, "equals_string": { "description": "the slot must have range string and the value of the slot must equal the specified value", "type": "string" }, "equals_string_in": { "description": "the slot must have range string and the value of the slot must equal one of the specified values", "items": { "type": "string" }, "type": "array" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "has_member": { "$ref": "#/$defs/AnonymousSlotExpression", "description": "the value of the slot is multivalued with at least one member satisfying the condition" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "identifier": { "description": "True means that the key slot(s) uniquely identifies the elements. There can be at most one identifier or key per container", "type": "boolean" }, "ifabsent": { "description": "function that provides a default value for the slot. Possible values for this slot are defined in\nlinkml.utils.ifabsent_functions.default_library:\n * [Tt]rue -- boolean True\n * [Ff]alse -- boolean False\n * bnode -- blank node identifier\n * class_curie -- CURIE for the containing class\n * class_uri -- URI for the containing class\n * default_ns -- schema default namespace\n * default_range -- schema default range\n * int(value) -- integer value\n * slot_uri -- URI for the slot\n * slot_curie -- CURIE for the slot\n * string(value) -- string value", "type": "string" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "implicit_prefix": { "description": "Causes the slot value to be interpreted as a uriorcurie after prefixing with this string", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "inherited": { "description": "true means that the *value* of a slot is inherited by subclasses", "type": "boolean" }, "inlined": { "description": "True means that keyed or identified slot appears in an outer structure by value. False means that only the key or identifier for the slot appears within the domain, referencing a structure that appears elsewhere.", "type": "boolean" }, "inlined_as_list": { "description": "True means that an inlined slot is represented as a list of range instances. False means that an inlined slot is represented as a dictionary, whose key is the slot key or identifier and whose value is the range instance.", "type": "boolean" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "inverse": { "description": "indicates that any instance of d s r implies that there is also an instance of r s' d", "type": "string" }, "irreflexive": { "description": "If s is irreflexive, then there exists no i such i.s=i", "type": "boolean" }, "is_a": { "description": "A primary parent slot from which inheritable metaslots are propagated", "type": "string" }, "is_class_field": { "description": "indicates that for any instance, i, the domain of this slot will include an assertion of i s range", "type": "boolean" }, "is_grouping_slot": { "description": "true if this slot is a grouping slot", "type": "boolean" }, "is_usage_slot": { "description": "True means that this slot was defined in a slot_usage situation", "type": "boolean" }, "key": { "description": "True means that the key slot(s) uniquely identify the elements within a single container", "type": "boolean" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "list_elements_ordered": { "description": "If True, then the order of elements of a multivalued slot is guaranteed to be preserved. If False, the order may still be preserved but this is not guaranteed", "type": "boolean" }, "list_elements_unique": { "description": "If True, then there must be no duplicates in the elements of a multivalued slot", "type": "boolean" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "locally_reflexive": { "description": "If s is locally_reflexive, then i.s=i for all instances i where s is a class slot for the type of i", "type": "boolean" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "maximum_cardinality": { "description": "the maximum number of entries for a multivalued slot", "type": "integer" }, "maximum_value": { "description": "for slots with ranges of type number, the value must be equal to or lowe than this", "type": "integer" }, "minimum_cardinality": { "description": "the minimum number of entries for a multivalued slot", "type": "integer" }, "minimum_value": { "description": "for slots with ranges of type number, the value must be equal to or higher than this", "type": "integer" }, "mixin": { "description": "Indicates the class or slot is intended to be inherited from without being an is_a parent. mixins should not be inherited from using is_a, except by other mixins.", "type": "boolean" }, "mixins": { "description": "A collection of secondary parent mixin slots from which inheritable metaslots are propagated", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "multivalued": { "description": "true means that slot can have more than one value and should be represented using a list or collection structure.", "type": "boolean" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousSlotExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "owner": { "description": "the \"owner\" of the slot. It is the class if it appears in the slots list, otherwise the declaring slot", "type": "string" }, "path_rule": { "$ref": "#/$defs/PathExpression", "description": "a rule for inferring a slot assignment based on evaluating a path through a sequence of slot assignments" }, "pattern": { "description": "the string value of the slot must conform to this regular expression expressed in the string", "type": "string" }, "range": { "description": "defines the type of the object of the slot. Given the following slot definition\n S1:\n domain: C1\n range: C2\nthe declaration\n X:\n S1: Y\n\nimplicitly asserts Y is an instance of C2\n", "type": "string" }, "range_expression": { "$ref": "#/$defs/AnonymousClassExpression", "description": "A range that is described as a boolean expression combining existing ranges" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "readonly": { "description": "If present, slot is read only. Text explains why", "type": "string" }, "recommended": { "description": "true means that the slot should be present in instances of the class definition, but this is not required", "type": "boolean" }, "reflexive": { "description": "If s is reflexive, then i.s=i for all instances i", "type": "boolean" }, "reflexive_transitive_form_of": { "description": "transitive_form_of including the reflexive case", "type": "string" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "relational_role": { "$ref": "#/$defs/RelationalRoleEnum", "description": "the role a slot on a relationship class plays, for example, the subject, object or predicate roles" }, "required": { "description": "true means that the slot must be present in instances of the class definition", "type": "boolean" }, "role": { "description": "a textual descriptor that indicates the role played by the slot range", "type": "string" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "shared": { "description": "If True, then the relationship between the slot domain and range is many to one or many to many", "type": "boolean" }, "singular_name": { "description": "a name that is used in the singular form", "type": "string" }, "slot_group": { "description": "allows for grouping of related slots into a grouping slot that serves the role of a group", "type": "string" }, "slot_uri": { "description": "URI of the class that provides a semantic interpretation of the slot in a linked data context. The URI may come from any namespace and may be shared between schemas.", "type": "string" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "string_serialization": { "description": "Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots.\nWe call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion.\nImplementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects\nFor example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "structured_pattern": { "$ref": "#/$defs/PatternExpression", "description": "the string value of the slot must conform to the regular expression in the pattern expression" }, "subproperty_of": { "description": "Ontology property which this slot is a subproperty of. Note: setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "type": "string" }, "symmetric": { "description": "If s is symmetric, and i.s=v, then v.s=i", "type": "boolean" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "transitive": { "description": "If s is transitive, and i.s=z, and s.s=j, then i.s=j", "type": "boolean" }, "transitive_form_of": { "description": "If s transitive_form_of d, then (1) s holds whenever d holds (2) s is transitive (3) d holds whenever s holds and there are no intermediates, and s is not reflexive", "type": "string" }, "union_of": { "description": "indicates that the domain element consists exactly of the members of the element in the range.", "items": { "type": "string" }, "type": "array" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" }, "usage_slot_name": { "description": "The name of the slot referenced in the slot_usage", "type": "string" }, "value_presence": { "$ref": "#/$defs/PresenceEnum", "description": "if true then a value must be present (for lists there must be at least one value). If false then a value must be absent (for lists, must be empty)" }, "values_from": { "description": "The identifier of a \"value set\" -- a set of identifiers that form the possible values for the range of a slot. Note: this is different than 'subproperty_of' in that 'subproperty_of' is intended to be a single ontology term while 'values_from' is the identifier of an entire value set. Additionally, this is different than an enumeration in that in an enumeration, the values of the enumeration are listed directly in the model itself. Setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.", "items": { "type": "string" }, "type": "array" } }, "required": [], "title": "SlotDefinition", "type": "object" }, "StructuredAlias": { "additionalProperties": false, "description": "object that contains meta data about a synonym or alias including where it came from (source) and its scope (narrow, broad, etc.)", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "The category or categories of an alias. This can be drawn from any relevant vocabulary", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "literal_form": { "description": "The literal lexical form of a structured alias; i.e the actual alias value.", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "predicate": { "$ref": "#/$defs/AliasPredicateEnum", "description": "The relationship between an element and its alias." }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" } }, "required": [ "literal_form" ], "title": "StructuredAlias", "type": "object" }, "SubsetDefinition": { "additionalProperties": false, "description": "an element that can be used to group other metamodel elements", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" } }, "required": [ "name" ], "title": "SubsetDefinition", "type": "object" }, "SubsetDefinition__identifier_optional": { "additionalProperties": false, "description": "an element that can be used to group other metamodel elements", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" } }, "required": [], "title": "SubsetDefinition", "type": "object" }, "TypeDefinition": { "additionalProperties": false, "description": "an element that whose instances are atomic scalar values that can be mapped to primitive types", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "base": { "description": "python base type in the LinkML runtime that implements this type definition", "type": "string" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "equals_number": { "description": "the slot must have range of a number and the value of the slot must equal the specified value", "type": "integer" }, "equals_string": { "description": "the slot must have range string and the value of the slot must equal the specified value", "type": "string" }, "equals_string_in": { "description": "the slot must have range string and the value of the slot must equal one of the specified values", "items": { "type": "string" }, "type": "array" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "implicit_prefix": { "description": "Causes the slot value to be interpreted as a uriorcurie after prefixing with this string", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "maximum_value": { "description": "for slots with ranges of type number, the value must be equal to or lowe than this", "type": "integer" }, "minimum_value": { "description": "for slots with ranges of type number, the value must be equal to or higher than this", "type": "integer" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "pattern": { "description": "the string value of the slot must conform to this regular expression expressed in the string", "type": "string" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "repr": { "description": "the name of the python object that implements this type definition", "type": "string" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "structured_pattern": { "$ref": "#/$defs/PatternExpression", "description": "the string value of the slot must conform to the regular expression in the pattern expression" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "typeof": { "description": "A parent type from which type properties are inherited", "type": "string" }, "union_of": { "description": "indicates that the domain element consists exactly of the members of the element in the range.", "items": { "type": "string" }, "type": "array" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" }, "uri": { "description": "The uri that defines the possible values for the type definition", "type": "string" } }, "required": [ "name" ], "title": "TypeDefinition", "type": "object" }, "TypeDefinition__identifier_optional": { "additionalProperties": false, "description": "an element that whose instances are atomic scalar values that can be mapped to primitive types", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "all_of": { "description": "holds if all of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "any_of": { "description": "holds if at least one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "base": { "description": "python base type in the LinkML runtime that implements this type definition", "type": "string" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "equals_number": { "description": "the slot must have range of a number and the value of the slot must equal the specified value", "type": "integer" }, "equals_string": { "description": "the slot must have range string and the value of the slot must equal the specified value", "type": "string" }, "equals_string_in": { "description": "the slot must have range string and the value of the slot must equal one of the specified values", "items": { "type": "string" }, "type": "array" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "exactly_one_of": { "description": "holds if only one of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "implicit_prefix": { "description": "Causes the slot value to be interpreted as a uriorcurie after prefixing with this string", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "maximum_value": { "description": "for slots with ranges of type number, the value must be equal to or lowe than this", "type": "integer" }, "minimum_value": { "description": "for slots with ranges of type number, the value must be equal to or higher than this", "type": "integer" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "the unique name of the element within the context of the schema. Name is combined with the default prefix to form the globally unique subject of the target class.", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "none_of": { "description": "holds if none of the expressions hold", "items": { "$ref": "#/$defs/AnonymousTypeExpression" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "pattern": { "description": "the string value of the slot must conform to this regular expression expressed in the string", "type": "string" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "repr": { "description": "the name of the python object that implements this type definition", "type": "string" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "structured_pattern": { "$ref": "#/$defs/PatternExpression", "description": "the string value of the slot must conform to the regular expression in the pattern expression" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "typeof": { "description": "A parent type from which type properties are inherited", "type": "string" }, "union_of": { "description": "indicates that the domain element consists exactly of the members of the element in the range.", "items": { "type": "string" }, "type": "array" }, "unit": { "$ref": "#/$defs/UnitOfMeasure", "description": "an encoding of a unit" }, "uri": { "description": "The uri that defines the possible values for the type definition", "type": "string" } }, "required": [], "title": "TypeDefinition", "type": "object" }, "UniqueKey": { "additionalProperties": false, "description": "a collection of slots whose values uniquely identify an instance of a class", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "consider_nulls_inequal": { "description": "By default, None values are considered equal for the purposes of comparisons in determining uniqueness. Set this to true to treat missing values as per ANSI-SQL NULLs, i.e NULL=NULL is always False.", "type": "boolean" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "unique_key_name": { "description": "name of the unique key", "type": "string" }, "unique_key_slots": { "description": "list of slot names that form a key. The tuple formed from the values of all these slots should be unique.", "items": { "type": "string" }, "type": "array" } }, "required": [ "unique_key_name", "unique_key_slots" ], "title": "UniqueKey", "type": "object" }, "UniqueKey__identifier_optional": { "additionalProperties": false, "description": "a collection of slots whose values uniquely identify an instance of a class", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "consider_nulls_inequal": { "description": "By default, None values are considered equal for the purposes of comparisons in determining uniqueness. Set this to true to treat missing values as per ANSI-SQL NULLs, i.e NULL=NULL is always False.", "type": "boolean" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "unique_key_name": { "description": "name of the unique key", "type": "string" }, "unique_key_slots": { "description": "list of slot names that form a key. The tuple formed from the values of all these slots should be unique.", "items": { "type": "string" }, "type": "array" } }, "required": [ "unique_key_slots" ], "title": "UniqueKey", "type": "object" }, "UnitOfMeasure": { "additionalProperties": false, "description": "A unit of measure, or unit, is a particular quantity value that has been chosen as a scale for measuring other quantities the same kind (more generally of equivalent dimension).", "properties": { "abbreviation": { "description": "An abbreviation for a unit is a short ASCII string that is used in place of the full name for the unit in contexts where non-ASCII characters would be problematic, or where using the abbreviation will enhance readability. When a power of a base unit needs to be expressed, such as squares this can be done using abbreviations rather than symbols (source: qudt)", "type": "string" }, "derivation": { "description": "Expression for deriving this unit from other units", "type": "string" }, "descriptive_name": { "description": "the spelled out name of the unit, for example, meter", "type": "string" }, "exact_mappings": { "description": "Used to link a unit to equivalent concepts in ontologies such as UO, SNOMED, OEM, OBOE, NCIT", "items": { "type": "string" }, "type": "array" }, "has_quantity_kind": { "description": "Concept in a vocabulary or ontology that denotes the kind of quanity being measured, e.g. length", "type": "string" }, "iec61360code": { "type": "string" }, "symbol": { "description": "name of the unit encoded as a symbol", "type": "string" }, "ucum_code": { "description": "associates a QUDT unit with its UCUM code (case-sensitive).", "type": "string" } }, "title": "UnitOfMeasure", "type": "object" } }, "$id": "https://w3id.org/linkml/meta", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "description": "A collection of definitions that make up a schema or a data model.", "metamodel_version": "1.7.0", "properties": { "aliases": { "description": "Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.", "items": { "type": "string" }, "type": "array" }, "alt_descriptions": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/AltDescription__identifier_optional" }, { "description": "text of an attributed description", "type": "string" } ] }, "description": "A sourced alternative description for an element", "type": "object" }, "annotations": { "additionalProperties": { "$ref": "#/$defs/Annotation__identifier_optional" }, "description": "a collection of tag/text tuples with the semantics of OWL Annotation", "type": "object" }, "broad_mappings": { "description": "A list of terms from different schemas or terminology systems that have broader meaning.", "items": { "type": "string" }, "type": "array" }, "categories": { "description": "Controlled terms used to categorize an element.", "items": { "type": "string" }, "type": "array" }, "classes": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/ClassDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all class definitions in the schema", "type": "object" }, "close_mappings": { "description": "A list of terms from different schemas or terminology systems that have close meaning.", "items": { "type": "string" }, "type": "array" }, "comments": { "description": "notes and comments about an element intended primarily for external consumption", "items": { "type": "string" }, "type": "array" }, "conforms_to": { "description": "An established standard to which the element conforms.", "type": "string" }, "contributors": { "description": "agent that contributed to the element", "items": { "type": "string" }, "type": "array" }, "created_by": { "description": "agent that created the element", "type": "string" }, "created_on": { "description": "time at which the element was created", "format": "date-time", "type": "string" }, "default_curi_maps": { "description": "ordered list of prefixcommon biocontexts to be fetched to resolve id prefixes and inline prefix variables", "items": { "type": "string" }, "type": "array" }, "default_prefix": { "description": "The prefix that is used for all elements within a schema", "type": "string" }, "default_range": { "description": "default slot range to be used if range element is omitted from a slot definition", "type": "string" }, "definition_uri": { "description": "The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri", "type": "string" }, "deprecated": { "description": "Description of why and when this element will no longer be used", "type": "string" }, "deprecated_element_has_exact_replacement": { "description": "When an element is deprecated, it can be automatically replaced by this uri or curie", "type": "string" }, "deprecated_element_has_possible_replacement": { "description": "When an element is deprecated, it can be potentially replaced by this uri or curie", "type": "string" }, "description": { "description": "a textual description of the element's purpose and use", "type": "string" }, "emit_prefixes": { "description": "a list of Curie prefixes that are used in the representation of instances of the model. All prefixes in this list are added to the prefix sections of the target models.", "items": { "type": "string" }, "type": "array" }, "enums": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/EnumDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all enum definitions in the schema", "type": "object" }, "exact_mappings": { "description": "A list of terms from different schemas or terminology systems that have identical meaning.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "example usages of an element", "items": { "$ref": "#/$defs/Example" }, "type": "array" }, "extensions": { "additionalProperties": { "$ref": "#/$defs/Extension__identifier_optional" }, "description": "a tag/text tuple attached to an arbitrary element", "type": "object" }, "from_schema": { "description": "id of the schema that defined the element", "type": "string" }, "generation_date": { "description": "date and time that the schema was loaded/generated", "format": "date-time", "type": "string" }, "id": { "description": "The official schema URI", "type": "string" }, "id_prefixes": { "description": "An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix", "items": { "type": "string" }, "type": "array" }, "implements": { "description": "An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.", "items": { "type": "string" }, "type": "array" }, "imported_from": { "description": "the imports entry that this element was derived from. Empty means primary source", "type": "string" }, "imports": { "description": "A list of schemas that are to be included in this schema", "items": { "type": "string" }, "type": "array" }, "in_language": { "description": "the primary language used in the sources", "type": "string" }, "in_subset": { "description": "used to indicate membership of a term in a defined subset of terms used for a particular domain or application.", "items": { "type": "string" }, "type": "array" }, "instantiates": { "description": "An element in another schema which this element instantiates.", "items": { "type": "string" }, "type": "array" }, "keywords": { "description": "Keywords or tags used to describe the element", "items": { "type": "string" }, "type": "array" }, "last_updated_on": { "description": "time at which the element was last updated", "format": "date-time", "type": "string" }, "license": { "description": "license for the schema", "type": "string" }, "local_names": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/LocalName__identifier_optional" }, { "description": "a name assigned to an element in a given ontology", "type": "string" } ] }, "type": "object" }, "mappings": { "description": "A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.", "items": { "type": "string" }, "type": "array" }, "metamodel_version": { "description": "Version of the metamodel used to load the schema", "type": "string" }, "modified_by": { "description": "agent that modified the element", "type": "string" }, "name": { "description": "a unique name for the schema that is both human-readable and consists of only characters from the NCName set", "type": "string" }, "narrow_mappings": { "description": "A list of terms from different schemas or terminology systems that have narrower meaning.", "items": { "type": "string" }, "type": "array" }, "notes": { "description": "editorial notes about an element intended primarily for internal consumption", "items": { "type": "string" }, "type": "array" }, "prefixes": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/Prefix__identifier_optional" }, { "description": "The namespace to which a prefix expands to.", "type": "string" } ] }, "description": "A collection of prefix expansions that specify how CURIEs can be expanded to URIs", "type": "object" }, "rank": { "description": "the relative order in which the element occurs, lower values are given precedence", "type": "integer" }, "related_mappings": { "description": "A list of terms from different schemas or terminology systems that have related meaning.", "items": { "type": "string" }, "type": "array" }, "see_also": { "description": "A list of related entities or URLs that may be of relevance", "items": { "type": "string" }, "type": "array" }, "settings": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/Setting__identifier_optional" }, { "description": "The value assigned for a setting", "type": "string" } ] }, "description": "A collection of global variable settings", "type": "object" }, "slot_names_unique": { "description": "if true then induced/mangled slot names are not created for class_usage and attributes", "type": "boolean" }, "slots": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SlotDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all slot definitions in the schema", "type": "object" }, "source": { "description": "A related resource from which the element is derived.", "type": "string" }, "source_file": { "description": "name, uri or description of the source of the schema", "type": "string" }, "source_file_date": { "description": "modification date of the source of the schema", "format": "date-time", "type": "string" }, "source_file_size": { "description": "size in bytes of the source of the schema", "type": "integer" }, "status": { "description": "status of the element", "type": "string" }, "structured_aliases": { "description": "A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.", "items": { "$ref": "#/$defs/StructuredAlias" }, "type": "array" }, "subsets": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/SubsetDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all subset definitions in the schema", "type": "object" }, "title": { "description": "A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.", "type": "string" }, "todos": { "description": "Outstanding issues that needs resolution", "items": { "type": "string" }, "type": "array" }, "types": { "additionalProperties": { "anyOf": [ { "$ref": "#/$defs/TypeDefinition__identifier_optional" }, { "type": "null" } ] }, "description": "An index to the collection of all type definitions in the schema", "type": "object" }, "version": { "description": "particular version of schema", "type": "string" } }, "required": [ "id", "name" ], "title": "meta", "type": "object", "version": "2.0.0" }

ssh-agent-config.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "AgentConfig", "description": "Defines *user* configuration for the SSH agent, and allows the user to configure which accounts, vaults, and items should be considered for use by the SSH agent.", "type": "object", "required": ["ssh-keys"], "properties": { "ssh-keys": { "description": "The list of rules to decide which accounts, vaults, and items to add to the SSH agent.", "type": "array", "items": { "$ref": "#/definitions/AgentConfigRule" } } }, "definitions": { "AgentConfigRule": { "description": "A single rule defined in the SSH agent config for which keys to include in the SSH agent. Each field may be the UUID or another identifier, which varies per field.", "type": "object", "anyOf": [ { "required": ["account"] }, { "required": ["item"] }, { "required": ["vault"] } ], "properties": { "account": { "description": "Can be either an account UUID or signin address or account name", "type": "string" }, "item": { "description": "Can be either an item UUID or name", "type": "string" }, "vault": { "description": "Can be either a vault UUID or name", "type": "string" } }, "additionalProperties": false } } }

grunt-task.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": { "anyOf": [ { "$ref": "#/definitions/fileFormat" }, { "$ref": "#/definitions/dynamic" } ] }, "definitions": { "dynamic": { "type": "object", "required": ["src"], "properties": { "expand": { "description": "Must be set to true to use properties other than 'src' and 'dest'", "type": "boolean", "default": false }, "cwd": { "description": "All 'src' matches are relative to (but don't include) this path", "type": "string" }, "dest": { "description": "Destination path prefix.", "type": "string" }, "ext": { "description": "Replace any existing extension with this value in generated 'dest' paths.", "type": "string" }, "extDot": { "description": "Used to indicate where the period indicating the extension is located.", "enum": ["first", "last"], "default": "first" }, "filter": { "description": "The 'filter' property can help you target files with a greater level of detail", "enum": [ "isFile", "isDirectory", "isBlockDevice", "isCharacterDevice", "isSymbolicLink", "isFIFO", "isSocket" ] }, "flatten": { "description": "Remove all path parts from generated 'dest' paths", "type": "boolean", "default": false }, "matchBase": { "description": "If set, patterns without slashes will be matched against the basename of the path if it contains slashes. For example, 'a?b' would match the path '/xyz/123/acb', but not '/xyz/acb/123'.", "type": "boolean", "default": false }, "nonull": { "description": "If set to 'true' then the operation will include non-matching patterns. Combined with grunt's '--verbose' flag, this option can help debug file path issues.", "type": "boolean", "default": false }, "rename": { "description": "This function is called for each matched 'src' file, (after extension renaming and flattening). ", "type": "string" }, "src": { "description": "Pattern(s) to match, relative to the 'cwd'.", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } } } }, "fileFormat": { "properties": { "files": { "oneOf": [ { "type": "object", "additionalProperties": { "type": ["array", "string"], "uniqueItems": true, "minItems": 1, "items": { "type": "string" } } }, { "type": "array", "items": { "$ref": "#/definitions/dynamic" } } ] } } } }, "id": "https://json.schemastore.org/grunt-task", "properties": { "options": { "type": "object" } }, "title": "JSON schema for any Grunt task", "type": "object" }

debugsettings.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "profile": { "type": "object", "required": ["name"], "allOf": [ { "$ref": "#/definitions/content" } ], "anyOf": [ { "properties": { "executablePath": { "type": "string", "description": "An absolute path to the to the executable.", "default": "", "minLength": 1 } }, "not": { "required": ["commandName"] } }, { "properties": { "commandName": { "type": "string", "description": "The name of the command to call.", "default": "", "minLength": 1 } }, "not": { "required": ["executablePath"] } } ] }, "content": { "properties": { "name": { "type": "string", "description": "The name of the debug profile", "minLength": 1 }, "commandLineArgs": { "type": "string", "description": "The arguments to pass to the command.", "default": "" }, "workingDirectory": { "type": "string", "description": "Sets the working directory of the command." }, "launchBrowser": { "type": "boolean", "description": "Set to true if the browser should be launched.", "default": false }, "launchUrl": { "type": "string", "description": "The relative URL to launch in the browser.", "format": "uri" }, "environmentVariables": { "type": "object", "description": "Set the environment variables as key/value pairs.", "additionalProperties": { "type": "string" } }, "sdkVersion": { "type": "string", "description": "Sets the version of the SDK." } } } }, "id": "https://json.schemastore.org/debugsettings.json", "properties": { "profiles": { "type": "array", "description": "A list of debug profiles", "items": { "$ref": "#/definitions/profile" } } }, "title": "JSON schema for the ASP.NET DebugSettings.json files.", "type": "object" }

schema-org-thing.json

{ "$comment": "Version 1.1", "$schema": "http://json-schema.org/draft-04/schema#", "anyOf": [ { "$ref": "https://json.schemastore.org/jsonld.json" } ], "description": "This is a JSON schema representation of the schema.org Thing schema: https://schema.org/Thing", "id": "https://json.schemastore.org/schema-org-thing.json", "properties": { "@context": { "type": "string", "format": "regex", "pattern": "http://schema.org", "description": "override the @context property to ensure the schema.org URI is used" }, "additionalType": { "type": "string", "format": "uri", "description": "An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally." }, "alternateName": { "type": "string", "description": "An alias for the item." }, "description": { "type": "string", "description": "A description of the item." }, "disambiguatingDescription": { "type": "string", "description": "A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation." }, "image": { "description": "An image of the item. This can be a URL or a fully described ImageObject.", "oneOf": [ { "type": "string", "format": "uri" }, { "type": "object" } ] }, "mainEntityOfPage": { "description": "Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property mainEntity.", "oneOf": [ { "type": "string", "format": "uri" }, { "type": "object" } ] }, "name": { "type": "string", "description": "The name of the item." }, "potentialAction": { "type": "object", "description": "Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role." }, "sameAs": { "type": "string", "format": "uri", "description": "URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website." }, "url": { "type": "string", "format": "uri", "description": "URL of the item." } }, "required": ["@type"], "title": "JSON schema for schema.org / Thing", "type": "object" }

journey-map.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "Config": { "description": "图表配置", "properties": { "color": { "description": "旅程图主色风格", "type": "string" }, "height": { "$ref": "#/definitions/Partial<Record<SectionType,number>>", "description": "每个部分的高度" }, "sections": { "description": "待显示的区块\n默认为: ['stage', 'action', 'emotion','thought']", "items": { "enum": ["action", "chance", "emotion", "painPoint", "stage", "thought"], "type": "string" }, "type": "array" }, "title": { "description": "显示旅程图标题", "type": "boolean" } }, "type": "object" }, "Partial<Record<SectionType,number>>": { "properties": { "action": { "type": "number" }, "chance": { "type": "number" }, "emotion": { "type": "number" }, "painPoint": { "type": "number" }, "stage": { "type": "number" }, "thought": { "type": "number" } }, "type": "object" }, "UserAction": { "description": "用户行为类型", "properties": { "color": { "description": "展示颜色", "type": "string" }, "description": { "description": "说明", "type": "string" }, "emotion": { "description": "情绪得分", "maximum": 2, "minimum": -2, "type": "integer" }, "name": { "description": "行为名称", "type": "string" }, "painPoints": { "description": "痛点", "items": { "type": "string" }, "type": "array" }, "thoughts": { "description": "想法", "items": { "type": "string" }, "type": "array" } }, "required": ["name"], "type": "object" }, "YMLStage": { "description": "YML 的阶段类型", "properties": { "actions": { "description": "该阶段所有用户行为", "items": { "$ref": "#/definitions/UserAction" }, "type": "array" }, "color": { "description": "展示颜色", "type": "string" }, "name": { "description": "阶段名称", "type": "string" }, "painPoints": { "description": "痛点", "items": { "type": "string" }, "type": "array" }, "thoughts": { "description": "想法", "items": { "type": "string" }, "type": "array" } }, "required": ["actions", "name"], "type": "object" } }, "description": "解析后的 YML 数据", "properties": { "config": { "$ref": "#/definitions/Config", "description": "配置参数" }, "stages": { "description": "步骤", "items": { "$ref": "#/definitions/YMLStage" }, "type": "array" }, "title": { "description": "标题名", "type": "string" } }, "required": ["stages"], "type": "object" }

zuul.json

{ "$id": "https://json.schemastore.org/zuul.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "JobEntry": { "additionalProperties": false, "properties": { "job": { "$ref": "#/definitions/JobModel" } }, "required": ["job"], "title": "JobEntry", "type": "object" }, "JobModel": { "additionalProperties": false, "properties": { "abstract": { "default": false, "title": "Abstract", "type": "boolean" }, "allowed-projects": { "title": "Allowed-Projects", "type": "string" }, "ansible-version": { "anyOf": [ { "type": "number" }, { "enum": ["2.7", "2.8", "2.9", "2.10", "2.11"], "type": "string" } ], "title": "Ansible-Version" }, "attempts": { "title": "Attempts", "type": "integer" }, "branches": { "title": "Branches", "type": "string" }, "description": { "title": "Description", "type": "string" }, "dependencies": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "items": { "$ref": "#/definitions/JobDependencyModel" }, "type": "array" } ], "title": "Files" }, "failure-url": { "title": "Failure-Url", "type": "string" }, "files": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Files" }, "final": { "default": false, "title": "Final", "type": "boolean" }, "host-vars": { "additionalProperties": { "type": "object" }, "title": "Host-Vars", "type": "object" }, "irrelevant-files": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Irrelevant-Files" }, "name": { "title": "Name", "type": "string" }, "nodeset": { "title": "Nodeset" }, "override-checkout": { "title": "Override-Checkout", "type": "string" }, "parent": { "title": "Parent", "type": "string" }, "post-run": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Post-Run" }, "post-timeout": { "title": "Post-Timeout", "type": "integer" }, "pre-run": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Pre-Run" }, "provides": { "items": { "type": "string" }, "title": "Provides", "type": "array" }, "required-projects": { "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/RequiredProjectModel" } ] }, "title": "Required-Projects", "type": "array" }, "requires": { "items": { "type": "string" }, "title": "Requires", "type": "array" }, "roles": { "items": { "$ref": "#/definitions/ZuulRoleModel" }, "title": "Roles", "type": "array" }, "run": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Run" }, "secrets": { "anyOf": [ { "$ref": "#/definitions/JobSecretModel" }, { "items": { "anyOf": [ { "$ref": "#/definitions/JobSecretModel" }, { "type": "string" } ] }, "type": "array" } ], "title": "Secrets" }, "success-url": { "title": "Success-Url", "type": "string" }, "tags": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Tags" }, "timeout": { "title": "Timeout", "type": "integer" }, "vars": { "title": "Vars", "type": "object" }, "voting": { "default": true, "title": "Voting", "type": "boolean" }, "workspace-scheme": { "title": "Workspace Scheme", "enum": ["flat", "golang", "unique"], "type": "string" } }, "required": ["name"], "title": "JobModel", "type": "object" }, "JobDependencyModel": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "soft": { "default": false, "title": "Soft", "type": "boolean" } }, "required": ["name"], "title": "JobDependencyModel", "type": "object" }, "JobSecretModel": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "pass-to-parent": { "default": false, "title": "Pass-To-Parent", "type": "boolean" }, "secret": { "title": "Secret", "type": "string" } }, "required": ["name", "secret"], "title": "JobSecretModel", "type": "object" }, "PipelineModel": { "additionalProperties": false, "properties": { "jobs": { "items": {}, "title": "Jobs", "type": "array" }, "queue": { "title": "Queue", "type": "string" } }, "title": "PipelineModel", "type": "object" }, "ProjectEntry": { "additionalProperties": false, "properties": { "project": { "$ref": "#/definitions/ProjectModel" } }, "required": ["project"], "title": "ProjectEntry", "type": "object" }, "ProjectModel": { "additionalProperties": false, "properties": { "check": { "$ref": "#/definitions/PipelineModel" }, "default-branch": { "title": "Default-Branch", "type": "string" }, "description": { "title": "Description", "type": "string" }, "gate": { "$ref": "#/definitions/PipelineModel" }, "name": { "title": "Name", "type": "string" }, "periodic-weekly": { "$ref": "#/definitions/PipelineModel" }, "post": { "$ref": "#/definitions/PipelineModel" }, "promote": { "$ref": "#/definitions/PipelineModel" }, "queue": { "title": "Queue", "type": "string" }, "release": { "$ref": "#/definitions/PipelineModel" }, "templates": { "items": { "type": "string" }, "title": "Templates", "type": "array" }, "third-party-check": { "$ref": "#/definitions/PipelineModel" }, "vars": { "title": "Vars", "type": "object" } }, "title": "ProjectModel", "type": "object" }, "ProjectTemplateEntry": { "additionalProperties": false, "properties": { "project-template": { "$ref": "#/definitions/ProjectTemplateModel" } }, "required": ["project-template"], "title": "ProjectTemplateEntry", "type": "object" }, "ProjectTemplateModel": { "additionalProperties": false, "properties": { "check": { "$ref": "#/definitions/PipelineModel" }, "default-branch": { "title": "Default-Branch", "type": "string" }, "description": { "title": "Description", "type": "string" }, "gate": { "$ref": "#/definitions/PipelineModel" }, "name": { "title": "Name", "type": "string" }, "periodic-weekly": { "$ref": "#/definitions/PipelineModel" }, "post": { "$ref": "#/definitions/PipelineModel" }, "promote": { "$ref": "#/definitions/PipelineModel" }, "queue": { "title": "Queue", "type": "string" }, "release": { "$ref": "#/definitions/PipelineModel" }, "third-party-check": { "$ref": "#/definitions/PipelineModel" }, "vars": { "title": "Vars", "type": "object" } }, "required": ["name"], "title": "ProjectTemplateModel", "type": "object" }, "RequiredProjectModel": { "properties": { "name": { "title": "Name", "type": "string" }, "override-checkout": { "title": "Override-Checkout", "type": "string" } }, "required": ["name"], "title": "RequiredProjectModel", "type": "object" }, "SecretEntry": { "additionalProperties": false, "properties": { "secret": { "$ref": "#/definitions/SecretModel" } }, "required": ["secret"], "title": "SecretEntry", "type": "object" }, "SecretModel": { "additionalProperties": false, "properties": { "data": { "title": "Data", "type": "object" }, "name": { "title": "Name", "type": "string" } }, "required": ["name", "data"], "title": "SecretModel", "type": "object" }, "ZuulRoleModel": { "additionalProperties": false, "properties": { "zuul": { "title": "Zuul", "type": "string" } }, "required": ["zuul"], "title": "ZuulRoleModel", "type": "object" } }, "examples": ["zuul.d/*.yaml", "zuul-tests.d/*.yaml", ".zuul.yaml"], "items": { "anyOf": [ { "$ref": "#/definitions/JobEntry" }, { "$ref": "#/definitions/ProjectEntry" }, { "$ref": "#/definitions/ProjectTemplateEntry" }, { "$ref": "#/definitions/SecretEntry" } ] }, "title": "Zuul Config Schema", "type": "array" }

all-contributors.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {}, "description": "The configuration file used by the All Contributors CLI and GitHub bot.\nhttps://allcontributors.org/docs/en/bot/configuration", "id": "https://json.schemastore.org/base-04.json", "properties": { "projectName": { "title": "Name of the project", "type": "string", "minLength": 0 }, "projectOwner": { "title": "Name of the user the project is hosted by", "type": "string", "minLength": 0 }, "repoType": { "title": "Type of repository", "enum": ["github", "gitlab"], "default": "github" }, "repoHost": { "title": "Points to the repository hostname", "description": "Change it if you use a self-hosted repository.\nDefault: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab", "type": "string", "minLength": 0 }, "files": { "title": "Array of files to update", "type": "array", "items": { "type": "string", "minLength": 0 }, "default": ["README.md"] }, "imageSize": { "title": "Size (in px) of the user's avatar", "type": "number", "minimum": 0, "default": 100 }, "commit": { "title": "Auto-commit badge when adding contributors", "type": "boolean", "default": false }, "commitConvention": { "title": "Commit convention", "enum": [ "angular", "atom", "ember", "eslint", "jshint", "gitmoji", "none" ], "default": "angular" }, "contributorsPerLine": { "title": "Maximum number of columns for the contributors table", "type": "number", "minimum": 0, "default": 7 }, "contributorsSortAlphabetically": { "title": "true: Sort alphabetically. false: Display in order of addition.", "type": "boolean", "default": false }, "badgeTemplate": { "title": "Your own lodash template to generate the badge", "type": "string", "minLength": 0 }, "contributorTemplate": { "title": "Your own lodash template to generate the contributor", "type": "string", "minLength": 0 }, "types": { "title": "Custom symbols or link templates for contribution types (can override the documented types)", "type": "object", "additionalProperties": { "type": "object", "properties": { "symbol": { "title": "Symbol to use for the contribution type", "type": "string", "minLength": 0 }, "description": { "title": "Description of the contribution type", "type": "string", "minLength": 0 }, "link": { "title": "Link to use for the contribution type", "type": "string", "minLength": 0 } } } }, "linkToUsage": { "title": "Adds a footer with link to usage", "type": "boolean", "default": true }, "skipCi": { "title": "Makes the CI ignore the commit", "type": "boolean", "default": true }, "contributors": { "title": "List of contributors for this project", "type": "array", "items": { "type": "object", "properties": { "login": { "title": "Username of the contributor", "type": "string", "minLength": 0 }, "name": { "title": "Name of the contributor", "type": "string", "minLength": 0 }, "avatar_url": { "title": "URL of the contributor's avatar", "type": "string", "minLength": 0 }, "profile": { "title": "URL of the contributor's profile", "type": "string", "minLength": 0 }, "contributions": { "title": "Array of contributions made by the contributor", "type": "array", "items": { "type": "string", "minLength": 0 }, "minItems": 1 } } } } }, "required": ["projectName", "projectOwner"], "title": "All Contributors configuration file", "type": "object" }

package.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "JSON schema for NPM package.json files", "definitions": { "person": { "description": "A person who has been involved in creating or maintaining this package.", "type": [ "object", "string" ], "required": [ "name" ], "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "email": { "type": "string", "format": "email" } } }, "dependency": { "description": "Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.", "type": "object", "additionalProperties": { "type": "string" } }, "license": { "anyOf": [ { "type": "string" }, { "enum": [ "Apache-2.0", "MIT", "ISC", "BSD-3-Clause", "BSD-2-Clause", "CC0-1.0", "CDDL-1.1", "LGPL-2.1-only", "LGPL-2.1-or-later", "LGPL-3.0-only", "LGPL-3.0-or-later", "EPL-1.0", "EPL-2.0", "MS-PL", "UNLICENSED" ] } ] }, "scriptsInstallAfter": { "description": "Run AFTER the package is installed.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "scriptsPublishAfter": { "description": "Run AFTER the package is published.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "scriptsRestart": { "description": "Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "scriptsStart": { "description": "Run by the 'npm start' command.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "scriptsStop": { "description": "Run by the 'npm stop' command.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "scriptsTest": { "description": "Run by the 'npm test' command.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "scriptsUninstallBefore": { "description": "Run BEFORE the package is uninstalled.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "scriptsVersionBefore": { "description": "Run BEFORE bump the package version.", "type": "string", "x-intellij-language-injection": "Shell Script" }, "packageExportsEntryPath": { "type": [ "string", "null" ], "description": "The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.", "pattern": "^\\./" }, "packageExportsEntryObject": { "type": "object", "description": "Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.", "properties": { "require": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path that is resolved when this specifier is imported as a CommonJS module using the `require(...)` function." }, "import": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path that is resolved when this specifier is imported as an ECMAScript module using an `import` declaration or the dynamic `import(...)` function." }, "node": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path that is resolved when this environment is Node.js." }, "default": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path that is resolved when no other export type matches." }, "types": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path that is resolved for TypeScript types when this specifier is imported. Should be listed before other conditions." } }, "patternProperties": { "^(?![\\.0-9]).": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path that is resolved when this environment matches the property name." } }, "additionalProperties": false }, "packageExportsEntry": { "oneOf": [ { "$ref": "#/definitions/packageExportsEntryPath" }, { "$ref": "#/definitions/packageExportsEntryObject" } ] }, "packageExportsFallback": { "type": "array", "description": "Used to allow fallbacks in case this environment doesn't support the preceding entries.", "items": { "$ref": "#/definitions/packageExportsEntry" } }, "packageExportsEntryOrFallback": { "oneOf": [ { "$ref": "#/definitions/packageExportsEntry" }, { "$ref": "#/definitions/packageExportsFallback" } ] }, "fundingUrl": { "type": "string", "format": "uri", "description": "URL to a website with details about how to fund the package." }, "fundingWay": { "type": "object", "description": "Used to inform about ways to help fund development of the package.", "properties": { "url": { "$ref": "#/definitions/fundingUrl" }, "type": { "type": "string", "description": "The type of funding or the platform through which funding can be provided, e.g. patreon, opencollective, tidelift or github." } }, "additionalProperties": false, "required": [ "url" ] } }, "type": "object", "patternProperties": { "^_": { "description": "Any property starting with _ is valid.", "tsType": "any" } }, "properties": { "name": { "description": "The name of the package.", "type": "string", "maxLength": 214, "minLength": 1, "pattern": "^(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)?/)?[a-z0-9-~][a-z0-9-._~]*$" }, "version": { "description": "Version must be parseable by node-semver, which is bundled with npm as a dependency.", "type": "string" }, "description": { "description": "This helps people discover your package, as it's listed in 'npm search'.", "type": "string" }, "keywords": { "description": "This helps people discover your package as it's listed in 'npm search'.", "type": "array", "items": { "type": "string" } }, "homepage": { "description": "The url to the project homepage.", "type": "string" }, "bugs": { "description": "The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.", "type": [ "object", "string" ], "properties": { "url": { "type": "string", "description": "The url to your project's issue tracker.", "format": "uri" }, "email": { "type": "string", "description": "The email address to which issues should be reported.", "format": "email" } } }, "license": { "$ref": "#/definitions/license", "description": "You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it." }, "licenses": { "description": "DEPRECATED: Instead, use SPDX expressions, like this: { \"license\": \"ISC\" } or { \"license\": \"(MIT OR Apache-2.0)\" } see: 'https://docs.npmjs.com/files/package.json#license'.", "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/definitions/license" }, "url": { "type": "string", "format": "uri" } } } }, "author": { "$ref": "#/definitions/person" }, "contributors": { "description": "A list of people who contributed to this package.", "type": "array", "items": { "$ref": "#/definitions/person" } }, "maintainers": { "description": "A list of people who maintains this package.", "type": "array", "items": { "$ref": "#/definitions/person" } }, "files": { "description": "The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.", "type": "array", "items": { "type": "string" } }, "main": { "description": "The main field is a module ID that is the primary entry point to your program.", "type": "string" }, "exports": { "description": "The \"exports\" field is used to restrict external access to non-exported module files, also enables a module to import itself using \"name\".", "oneOf": [ { "$ref": "#/definitions/packageExportsEntryPath", "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field." }, { "type": "object", "properties": { ".": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field." } }, "patternProperties": { "^\\./.+": { "$ref": "#/definitions/packageExportsEntryOrFallback", "description": "The module path prefix that is resolved when the module specifier starts with \"name/\", set to \"./*\" to allow external modules to import any subpath." } }, "additionalProperties": false }, { "$ref": "#/definitions/packageExportsEntryObject", "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field." }, { "$ref": "#/definitions/packageExportsFallback", "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field." } ] }, "bin": { "type": [ "string", "object" ], "additionalProperties": { "type": "string" } }, "type": { "description": "When set to \"module\", the type field allows a package to specify all .js files within are ES modules. If the \"type\" field is omitted or set to \"commonjs\", all .js files are treated as CommonJS.", "type": "string", "enum": [ "commonjs", "module" ], "default": "commonjs" }, "types": { "description": "Set the types property to point to your bundled declaration file.", "type": "string" }, "typings": { "description": "Note that the \"typings\" field is synonymous with \"types\", and could be used as well.", "type": "string" }, "typesVersions": { "description": "The \"typesVersions\" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.", "type": "object", "additionalProperties": { "description": "Contains overrides for the TypeScript version that matches the version range matching the property key.", "type": "object", "properties": { "*": { "description": "Maps all file paths to the file paths specified in the array.", "type": "array", "items": { "type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$" } } }, "patternProperties": { "^[^*]+$": { "description": "Maps the file path matching the property key to the file paths specified in the array.", "type": "array", "items": { "type": "string" } }, "^[^*]*\\*[^*]*$": { "description": "Maps file paths matching the pattern specified in property key to file paths specified in the array.", "type": "array", "items": { "type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$" } } }, "additionalProperties": false } }, "man": { "type": [ "array", "string" ], "description": "Specify either a single file or an array of filenames to put in place for the man program to find.", "items": { "type": "string" } }, "directories": { "type": "object", "properties": { "bin": { "description": "If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.", "type": "string" }, "doc": { "description": "Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.", "type": "string" }, "example": { "description": "Put example scripts in here. Someday, it might be exposed in some clever way.", "type": "string" }, "lib": { "description": "Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.", "type": "string" }, "man": { "description": "A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.", "type": "string" }, "test": { "type": "string" } } }, "repository": { "description": "Specify the place where your code lives. This is helpful for people who want to contribute.", "type": [ "object", "string" ], "properties": { "type": { "type": "string" }, "url": { "type": "string" }, "directory": { "type": "string" } } }, "funding": { "oneOf": [ { "$ref": "#/definitions/fundingUrl" }, { "$ref": "#/definitions/fundingWay" }, { "type": "array", "items": { "oneOf": [ { "$ref": "#/definitions/fundingUrl" }, { "$ref": "#/definitions/fundingWay" } ] }, "minItems": 1, "uniqueItems": true } ] }, "scripts": { "description": "The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.", "type": "object", "properties": { "lint": { "type": "string", "description": "Run code quality tools, e.g. ESLint, TSLint, etc." }, "prepublish": { "type": "string", "description": "Run BEFORE the package is published (Also run on local npm install without any arguments)." }, "prepare": { "type": "string", "description": "Run both BEFORE the package is packed and published, and on local npm install without any arguments. This is run AFTER prepublish, but BEFORE prepublishOnly." }, "prepublishOnly": { "type": "string", "description": "Run BEFORE the package is prepared and packed, ONLY on npm publish." }, "prepack": { "type": "string", "description": "run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies)." }, "postpack": { "type": "string", "description": "Run AFTER the tarball has been generated and moved to its final destination." }, "publish": { "type": "string", "description": "Publishes a package to the registry so that it can be installed by name. See https://docs.npmjs.com/cli/v8/commands/npm-publish" }, "postpublish": { "$ref": "#/definitions/scriptsPublishAfter" }, "preinstall": { "type": "string", "description": "Run BEFORE the package is installed." }, "install": { "$ref": "#/definitions/scriptsInstallAfter" }, "postinstall": { "$ref": "#/definitions/scriptsInstallAfter" }, "preuninstall": { "$ref": "#/definitions/scriptsUninstallBefore" }, "uninstall": { "$ref": "#/definitions/scriptsUninstallBefore" }, "postuninstall": { "type": "string", "description": "Run AFTER the package is uninstalled." }, "preversion": { "$ref": "#/definitions/scriptsVersionBefore" }, "version": { "$ref": "#/definitions/scriptsVersionBefore" }, "postversion": { "type": "string", "description": "Run AFTER bump the package version." }, "pretest": { "$ref": "#/definitions/scriptsTest" }, "test": { "$ref": "#/definitions/scriptsTest" }, "posttest": { "$ref": "#/definitions/scriptsTest" }, "prestop": { "$ref": "#/definitions/scriptsStop" }, "stop": { "$ref": "#/definitions/scriptsStop" }, "poststop": { "$ref": "#/definitions/scriptsStop" }, "prestart": { "$ref": "#/definitions/scriptsStart" }, "start": { "$ref": "#/definitions/scriptsStart" }, "poststart": { "$ref": "#/definitions/scriptsStart" }, "prerestart": { "$ref": "#/definitions/scriptsRestart" }, "restart": { "$ref": "#/definitions/scriptsRestart" }, "postrestart": { "$ref": "#/definitions/scriptsRestart" }, "serve": { "type": "string", "description": "Start dev server to serve application files" } }, "additionalProperties": { "type": "string", "tsType": "string | undefined", "x-intellij-language-injection": "Shell Script" } }, "config": { "description": "A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.", "type": "object", "additionalProperties": true }, "dependencies": { "$ref": "#/definitions/dependency" }, "devDependencies": { "$ref": "#/definitions/dependency" }, "optionalDependencies": { "$ref": "#/definitions/dependency" }, "peerDependencies": { "$ref": "#/definitions/dependency" }, "peerDependenciesMeta": { "description": "When a user installs your package, warnings are emitted if packages specified in \"peerDependencies\" are not already installed. The \"peerDependenciesMeta\" field serves to provide more information on how your peer dependencies are utilized. Most commonly, it allows peer dependencies to be marked as optional. Metadata for this field is specified with a simple hash of the package name to a metadata object.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true, "properties": { "optional": { "description": "Specifies that this peer dependency is optional and should not be installed automatically.", "type": "boolean" } } } }, "bundledDependencies": { "description": "Array of package names that will be bundled when publishing the package.", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "boolean" } ] }, "bundleDependencies": { "description": "DEPRECATED: This field is honored, but \"bundledDependencies\" is the correct field name.", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "boolean" } ] }, "resolutions": { "description": "Resolutions is used to support selective version resolutions using yarn, which lets you define custom package versions or ranges inside your dependencies. For npm, use overrides instead. See: https://classic.yarnpkg.com/en/docs/selective-version-resolutions", "type": "object" }, "overrides": { "description": "Overrides is used to support selective version overrides using npm, which lets you define custom package versions or ranges inside your dependencies. For yarn, use resolutions instead. See: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides", "type": "object" }, "packageManager": { "description": "Defines which package manager is expected to be used when working on the current project. This field is currently experimental and needs to be opted-in; see https://nodejs.org/api/corepack.html", "type": "string", "pattern": "(npm|pnpm|yarn)@\\d+\\.\\d+\\.\\d+(-.+)?" }, "engines": { "type": "object", "properties": { "node": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "engineStrict": { "type": "boolean" }, "os": { "description": "Specify which operating systems your module will run on.", "type": "array", "items": { "type": "string" } }, "cpu": { "description": "Specify that your code only runs on certain cpu architectures.", "type": "array", "items": { "type": "string" } }, "preferGlobal": { "type": "boolean", "description": "DEPRECATED: This option used to trigger an npm warning, but it will no longer warn. It is purely there for informational purposes. It is now recommended that you install any binaries as local devDependencies wherever possible." }, "private": { "description": "If set to true, then npm will refuse to publish it.", "oneOf": [ { "type": "boolean" }, { "enum": [ "false", "true" ] } ] }, "publishConfig": { "type": "object", "properties": { "access": { "type": "string", "enum": [ "public", "restricted" ] }, "tag": { "type": "string" }, "registry": { "type": "string", "format": "uri" } }, "additionalProperties": true }, "dist": { "type": "object", "properties": { "shasum": { "type": "string" }, "tarball": { "type": "string" } } }, "readme": { "type": "string" }, "module": { "description": "An ECMAScript module ID that is the primary entry point to your program.", "type": "string" }, "esnext": { "description": "A module ID with untranspiled code that is the primary entry point to your program.", "type": [ "string", "object" ], "properties": { "main": { "type": "string" }, "browser": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "workspaces": { "description": "Allows packages within a directory to depend on one another using direct linking of local files. Additionally, dependencies within a workspace are hoisted to the workspace root when possible to reduce duplication. Note: It's also a good idea to set \"private\" to true when using this feature.", "anyOf": [ { "type": "array", "description": "Workspace package paths. Glob patterns are supported.", "items": { "type": "string" } }, { "type": "object", "properties": { "packages": { "type": "array", "description": "Workspace package paths. Glob patterns are supported.", "items": { "type": "string" } }, "nohoist": { "type": "array", "description": "Packages to block from hoisting to the workspace root. Currently only supported in Yarn only.", "items": { "type": "string" } } } } ] }, "jspm": { "$ref": "#" }, "eslintConfig": { "$ref": "https://json.schemastore.org/eslintrc.json" }, "prettier": { "$ref": "https://json.schemastore.org/prettierrc.json" }, "stylelint": { "$ref": "https://json.schemastore.org/stylelintrc.json" }, "ava": { "$ref": "https://json.schemastore.org/ava.json" }, "release": { "$ref": "https://json.schemastore.org/semantic-release.json" }, "jscpd": { "$ref": "https://json.schemastore.org/jscpd.json" } }, "anyOf": [ { "type": "object", "not": { "required": [ "bundledDependencies", "bundleDependencies" ] } }, { "type": "object", "not": { "required": [ "bundleDependencies" ] }, "required": [ "bundledDependencies" ] }, { "type": "object", "not": { "required": [ "bundledDependencies" ] }, "required": [ "bundleDependencies" ] } ], "id": "https://json.schemastore.org/package.json" }

minecraft-pack-mcmeta.json

{ "$comment": "https://minecraft.fandom.com/wiki/Data_Pack", "$id": "https://json.schemastore.org/minecraft-pack-mcmeta.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "A pack metadata\nhttps://minecraft.fandom.com/wiki/Data_pack", "properties": { "pack": { "title": "pack options", "description": "Options for the current pack\nhttps://minecraft.fandom.com/wiki/Data_pack#Contents", "type": "object", "properties": { "description": { "title": "description", "description": "A description for the current pack\nhttps://minecraft.fandom.com/wiki/Data_pack#Contents" }, "pack_format": { "description": "A version for the current pack\nhttps://minecraft.fandom.com/wiki/Data_pack#Contents", "type": "integer", "minimum": 4, "maximum": 15, "default": 4 } }, "additionalProperties": false }, "filter": { "title": "filter options", "description": "Filter options for the current pack\nhttps://minecraft.fandom.com/wiki/Data_pack", "type": "object", "additionalProperties": { "title": "pattern", "description": "A pattern for the current pack\nhttps://minecraft.fandom.com/wiki/Data_pack", "type": "object", "properties": { "namespace": { "description": "A namespace regular expression for the current pack\nhttps://minecraft.fandom.com/wiki/Data_pack", "type": "string" }, "path": { "description": "A path regular expression for the current pack\nhttps://minecraft.fandom.com/wiki/Data_pack", "type": "string" } }, "additionalProperties": false } } }, "title": "pack metadata", "type": "object" }

linkinator-config.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/linkinator-config.json", "properties": { "concurrency": { "description": "The number of connections to make simultaneously.", "type": "number", "default": 100 }, "config": { "description": "The config file path.", "type": "string" }, "recurse": { "description": "By default, all scans are shallow. Only the top level links on the requested page will be scanned. By setting recurse to true, the crawler will follow all links on the page, and continue scanning links on the same domain for as long as it can go. Results are cached, so no worries about loops.", "type": "boolean", "default": true }, "skip": { "description": "List of urls in regexy form to not include in the check.", "type": "string", "default": "www.googleapis.com" }, "format": { "description": "Return the data in CSV or JSON format.", "type": "string", "default": "json", "enum": ["json", "text", "csv"] }, "silent": { "description": "If true, does not show links", "type": "boolean", "default": false }, "verbosity": { "description": "The output verbosity", "type": "string", "default": "error" }, "timeout": { "description": "By default, requests made by linkinator do not time out (or follow the settings of the OS). This option (in milliseconds) will fail requests after the configured amount of time.", "type": "number", "default": "5000" }, "markdown": { "description": "Automatically parse and scan markdown if scanning from a location on disk.", "type": "boolean", "default": false }, "serverRoot": { "description": "When scanning a locally directory, customize the location on disk where the server is started. Defaults to the path passed in path.", "type": "string", "default": "./" }, "directoryListing": { "description": "Automatically serve a static file listing page when serving a directory. Defaults to false.", "type": "boolean", "default": false }, "retry": { "description": "Automatically retry requests that respond with an HTTP 429, and include a retry-after header. The RetryConfig option is a placeholder for fine-grained controls to be implemented at a later time, and is only included here to signal forward-compatibility.", "oneOf": [ { "type": "boolean" }, { "type": "object" } ] }, "retryErrors": { "description": "Automatically retry requests that return 5xx or unknown response.", "type": "boolean" }, "retryErrorsCount": { "description": "How many times should an error be retried?", "type": "number" }, "retryErrorsJitter": { "description": "Random jitter applied to error retry.", "type": "number" }, "urlRewriteExpressions": { "description": "Collection of objects that contain a search pattern, and replacement.", "type": "array" } }, "title": "JSON schema for Linkinator", "type": "object" }

cicstags.json

{ "$id": "http://www.ibm.com/xmlns/prod/cics/cicstags", "$schema": "http://json-schema.org/draft-07/schema#", "title": "CICS region tagging file JSON Schema.", "description": "Super-schema that describes all versions of 'CICS region tagging file JSON Schema.'", "allOf": [ { "title": "CICS region tagging file JSON Schema.", "description": "Schema that describes the contents of a CICS region tagging file.", "if": { "properties": { "schemaVersion": { "const": "regionTagging/1.0.0" } } }, "then": { "$ref": "cicstags/cicstags-1.0.0.json" } } ] }

browser.i18n.json

{ "$id": "https://json.schemastore.org/browser.i18n.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "translationEntry": { "description": "Translation key", "type": "object", "properties": { "message": { "type": "string", "description": "Translation string" }, "description": { "type": "string", "description": "(optional): Description of this string for the translator team" }, "placeholders": { "$ref": "#/definitions/placeholders" } }, "required": ["message"], "additionalProperties": false }, "placeholders": { "type": "object", "description": "(optional): List of placeholders that can be used in the message.", "additionalProperties": false, "patternProperties": { "^(?!@@)[@a-zA-Z0-9_-]+$": { "$ref": "#/definitions/placeholder" } } }, "placeholder": { "description": "Placeholder key", "type": "object", "properties": { "content": { "type": "string", "description": "Value to insert. It can contain a variable $1" }, "example": { "type": "string", "description": "(optional) example of this placeholder" } }, "required": ["content"], "additionalProperties": false } }, "patternProperties": { "^(?!@@)[@a-zA-Z0-9_-]+$": { "$ref": "#/definitions/translationEntry" } }, "title": "browser.i18n messages.json translation file", "type": "object" }

unist.json

{ "$id": "https://json.schemastore.org/unist.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "definitions": { "Point": { "description": "A point represents one place in a source file. The value of the point field implements the Point interface.", "markdownDescription": "A point represents one place in a source file. The value of the point field implements the [Point](https://github.com/syntax-tree/unist#point) interface.", "type": "object", "properties": { "column": { "description": "The column field (1-indexed integer) represents a column in a source file.", "type": "integer", "minimum": 1 }, "line": { "description": "The line field (1-indexed integer) represents a line in a source file.", "type": "integer", "minimum": 1 }, "offset": { "description": "The offset field (0-indexed integer) represents a character in a source file.", "type": "integer", "minimum": 0 } }, "required": ["column", "line"], "additionalProperties": false }, "Position": { "description": "A position represents the location of a node in a source file. The value of the position field implements the Position interface. The position field must not be present if a node is generated.", "markdownDescription": "A position represents the location of a node in a source file. The value of the position field implements the [Position](https://github.com/syntax-tree/unist#position) interface. The position field must not be present if a node is generated.", "type": "object", "properties": { "end": { "description": "The end field of Position represents the place of the first character after the parsed source region, whether it exists or not.", "$ref": "#/definitions/Point" }, "start": { "description": "The start field of Position represents the place of the first character of the parsed source region.", "$ref": "#/definitions/Point" } }, "required": ["end", "start"], "additionalProperties": false } }, "description": "Syntactic units in unist syntax trees are called nodes, and implement the Node interface.", "properties": { "type": { "description": "The type field is a non-empty string representing the variant of a node. This field can be used to determine the type a node implements.", "markdownDescription": "The [type](https://github.com/syntax-tree/unist#type) field is a non-empty string representing the variant of a node. This field can be used to determine the type a node implements.", "type": "string" }, "position": { "$ref": "#/definitions/Position" }, "children": { "description": "The children field is a list representing the children of a node.", "type": "array", "items": { "$ref": "#" } }, "data": { "description": "The data field represents information from the ecosystem. The value of the data field implements the Data interface.", "markdownDescription": "The data field represents information from the ecosystem. The value of the data field implements the [Data](https://github.com/syntax-tree/unist#data) interface.", "type": "object", "additionalProperties": true }, "value": { "description": "The value field can contain any value." } }, "required": ["type"], "title": "JSON schema for unist syntax trees", "type": "object" }

tmlanguage.json

{ "$id": "https://json.schemastore.org/tmlanguage.json", "$ref": "#/definitions/root", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "root": { "allOf": [ { "$ref": "#/definitions/grammar" }, { "type": "object", "properties": { "name": { "type": "string" }, "scopeName": { "description": "this should be a unique name for the grammar, following the convention of being a dot-separated name where each new (left-most) part specializes the name. Normally it would be a two-part name where the first is either text or source and the second is the name of the language or document type. But if you are specializing an existing type, you probably want to derive the name from the type you are specializing. For example Markdown is text.html.markdown and Ruby on Rails (rhtml files) is text.html.rails. The advantage of deriving it from (in this case) text.html is that everything which works in the text.html scope will also work in the text.html.«something» scope (but with a lower precedence than something specifically targeting text.html.«something»).", "type": "string", "pattern": "^(text|source)(\\.[\\w0-9-]+)+$" }, "foldingStartMarker": { "description": "regular expressions that lines (in the document) are matched against. If a line matches one of the patterns (but not both), it becomes a folding marker (see the foldings section for more info).", "type": "string" }, "foldingStopMarker": { "description": "regular expressions that lines (in the document) are matched against. If a line matches one of the patterns (but not both), it becomes a folding marker (see the foldings section for more info).", "type": "string" }, "fileTypes": { "description": "this is an array of file type extensions that the grammar should (by default) be used with. This is referenced when TextMate does not know what grammar to use for a file the user opens. If however the user selects a grammar from the language pop-up in the status bar, TextMate will remember that choice.", "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" }, "firstLineMatch": { "type": "string" } }, "required": ["scopeName"] } ] }, "grammar": { "type": "object", "properties": { "patterns": { "type": "array", "items": { "$ref": "#/definitions/pattern" }, "default": [] }, "repository": { "description": "a dictionary (i.e. key/value pairs) of rules which can be included from other places in the grammar. The key is the name of the rule and the value is the actual rule. Further explanation (and example) follow with the description of the include rule key.", "type": "object", "additionalProperties": { "$ref": "#/definitions/pattern" } } }, "required": ["patterns"] }, "captures": { "type": "object", "patternProperties": { "^[0-9]+$": { "type": "object", "properties": { "name": { "$ref": "#/definitions/name" }, "patterns": { "type": "array", "items": { "$ref": "#/definitions/pattern" }, "default": [] } }, "additionalProperties": false } }, "additionalProperties": false }, "pattern": { "type": "object", "properties": { "comment": { "type": "string" }, "disabled": { "type": "integer", "minimum": 0, "maximum": 1, "description": "set this property to 1 to disable the current pattern" }, "include": { "description": "this allows you to reference a different language, recursively reference the grammar itself or a rule declared in this file's repository.", "type": "string" }, "match": { "description": "a regular expression which is used to identify the portion of text to which the name should be assigned. Example: '\\b(true|false)\\b'.", "type": "string" }, "name": { "description": "the name which gets assigned to the portion matched. This is used for styling and scope-specific settings and actions, which means it should generally be derived from one of the standard names.", "$ref": "#/definitions/name" }, "contentName": { "description": "this key is similar to the name key but only assigns the name to the text between what is matched by the begin/end patterns.", "$ref": "#/definitions/name" }, "begin": { "description": "these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and end is the pattern which ends the block. Captures from the begin pattern can be referenced in the end pattern by using normal regular expression back-references. This is often used with here-docs. A begin/end rule can have nested patterns using the patterns key.", "type": "string" }, "end": { "description": "these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and end is the pattern which ends the block. Captures from the begin pattern can be referenced in the end pattern by using normal regular expression back-references. This is often used with here-docs. A begin/end rule can have nested patterns using the patterns key.", "type": "string" }, "while": { "description": "these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and while continues it.", "type": "string" }, "captures": { "description": "allows you to assign attributes to the captures of the match pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.", "$ref": "#/definitions/captures" }, "beginCaptures": { "description": "allows you to assign attributes to the captures of the begin pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.", "$ref": "#/definitions/captures" }, "endCaptures": { "description": "allows you to assign attributes to the captures of the end pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.", "$ref": "#/definitions/captures" }, "whileCaptures": { "description": "allows you to assign attributes to the captures of the while pattern. Using the captures key for a begin/while rule is short-hand for giving both beginCaptures and whileCaptures with same values.", "$ref": "#/definitions/captures" }, "patterns": { "description": "applies to the region between the begin and end matches", "type": "array", "items": { "$ref": "#/definitions/pattern" }, "default": [] }, "applyEndPatternLast": { "type": "integer", "minimum": 0, "maximum": 1 } }, "dependencies": { "begin": { "anyOf": [ { "required": ["end"] }, { "required": ["while"] } ] }, "end": ["begin"], "while": ["begin"], "contentName": { "anyOf": [ { "required": ["begin", "end"] }, { "required": ["begin", "while"] } ] }, "beginCaptures": { "anyOf": [ { "required": ["begin", "end"] }, { "required": ["begin", "while"] } ] }, "whileCaptures": ["begin", "while"], "endCaptures": ["begin", "end"], "applyEndPatternLast": ["end"] } }, "name": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "comment", "comment.block", "comment.block.documentation", "comment.line", "comment.line.double-dash", "comment.line.double-slash", "comment.line.number-sign", "comment.line.percentage", "constant", "constant.character", "constant.character.escape", "constant.language", "constant.numeric", "constant.other", "constant.regexp", "constant.rgb-value", "constant.sha.git-rebase", "emphasis", "entity", "entity.name", "entity.name.class", "entity.name.function", "entity.name.method", "entity.name.section", "entity.name.selector", "entity.name.tag", "entity.name.type", "entity.other", "entity.other.attribute-name", "entity.other.inherited-class", "header", "invalid", "invalid.deprecated", "invalid.illegal", "keyword", "keyword.control", "keyword.control.less", "keyword.operator", "keyword.operator.new", "keyword.other", "keyword.other.unit", "markup", "markup.bold", "markup.changed", "markup.deleted", "markup.heading", "markup.inline.raw", "markup.inserted", "markup.italic", "markup.list", "markup.list.numbered", "markup.list.unnumbered", "markup.other", "markup.punctuation.list.beginning", "markup.punctuation.quote.beginning", "markup.quote", "markup.raw", "markup.underline", "markup.underline.link", "meta", "meta.cast", "meta.parameter.type.variable", "meta.preprocessor", "meta.preprocessor.numeric", "meta.preprocessor.string", "meta.return-type", "meta.selector", "meta.structure.dictionary.key.python", "meta.tag", "meta.type.annotation", "meta.type.name", "metatag.php", "storage", "storage.modifier", "storage.modifier.import.java", "storage.modifier.package.java", "storage.type", "storage.type.cs", "storage.type.java", "string", "string.html", "string.interpolated", "string.jade", "string.other", "string.quoted", "string.quoted.double", "string.quoted.other", "string.quoted.single", "string.quoted.triple", "string.regexp", "string.unquoted", "string.xml", "string.yaml", "strong", "support", "support.class", "support.constant", "support.function", "support.function.git-rebase", "support.other", "support.property-value", "support.type", "support.type.property-name", "support.type.property-name.css", "support.type.property-name.less", "support.type.property-name.scss", "support.variable", "variable", "variable.language", "variable.name", "variable.other", "variable.parameter" ] } ] } } }

drupal-config.json

{ "$id": "https://json.schemastore.org/drupal-config.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": { "title": "Configuration item", "$ref": "#/definitions/configItem" }, "definitions": { "configItem": { "type": "object", "properties": { "type": { "title": "The type of the value", "type": "string", "examples": [ "boolean", "integer", "float", "string", "uri", "email", "mapping", "sequence", "label", "text", "config_object", "config_entity" ] }, "label": { "title": "User interface label for the value", "type": "string" }, "translatable": { "title": "Whether the defined type is translatable", "type": "boolean" }, "translation context": { "title": "The translation context the source string belongs to", "type": "string" }, "nullable": { "title": "Whether the value can be empty", "type": "boolean" }, "class": { "title": "The class implementing parsing", "type": "string" }, "definition_class": { "title": "The definition class", "type": "string" }, "orderby": { "title": "Determines how the sequence should be sorted", "type": "string" }, "constraints": { "title": "Validation constrains", "type": "object" }, "sequence": { "$ref": "#/definitions/configItem" }, "mapping": { "type": "object", "additionalProperties": { "$ref": "#/definitions/configItem" } } }, "additionalProperties": false } }, "title": "JSON schema for Drupal configuration schema file", "type": "object" }

arc-schema.json

{ "definitions": { "strictName": { "type": "string", "pattern": "^[a-z][a-z0-9\\-]+$" }, "looseName": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9\\-_]+$" }, "macros": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9\\-_/.]+$" }, "region": { "type": "string", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "eu-west-3", "eu-north-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1", "us-gov-west-1", "us-gov-east-1" ] }, "table": { "type": "object", "title": "DynamoDB table", "propertyNames": { "pattern": "^[a-z][a-z|0-9|\\-]+$" }, "minProperties": 1, "maxProperties": 1 } }, "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://arc.codes/schema.json", "type": "object", "title": "OpenJS Architect JSON Schema", "required": [ "app" ], "additionalProperties": { "type": [ "array", "object" ], "items": { "type": [ "string", "number", "boolean", "array", "object" ] } }, "properties": { "app": { "$id": "#/properties/app", "title": "@app", "description": "Application namespace", "type": [ "string", "array" ], "maxItems": 1, "items": { "$ref": "#/definitions/looseName" } }, "aws": { "$id": "#/properties/aws", "title": "@aws", "description": "AWS specific configuration", "type": [ "array", "object" ], "maxItems": 12, "uniqueItems": true, "items": { "type": [ "array", "object" ], "maxItems": 2, "items": [ { "type": "string", "enum": [ "apigateway", "bucket", "concurrency", "layer", "layers", "memory", "policy", "policies", "profile", "region", "runtime", "timeout" ] }, { "type": [ "string", "number" ] } ] }, "properties": { "apigateway": { "type": "string" }, "bucket": { "type": "string" }, "concurrency": { "type": "number" }, "layer": { "type": [ "string", "object", "array" ] }, "layers": { "type": [ "string", "object", "array" ] }, "memory": { "type": "number" }, "policy": { "type": [ "string", "object", "array" ] }, "policies": { "type": [ "string", "object", "array" ] }, "profile": { "type": "string" }, "region": { "type": "string" }, "runtime": { "type": "string" }, "timeout": { "type": "number" } } }, "static": { "$id": "#/properties/static", "title": "@static", "description": "Static asset & S3 configuration", "uniqueItems": true, "type": "array", "maxItems": 6, "items": { "type": ["array", "object"], "items": [ { "type": "string", "enum": [ "fingerprint", "folder", "ignore", "prefix", "production", "prune", "spa", "staging" ] }, { "type": [ "string", "boolean", "array", "object" ] } ], "properties": { "fingerprint": { "type": [ "boolean", "string" ] }, "folder": { "type": "string" }, "ignore": { "type": [ "string", "object", "array" ] }, "prefix": { "type": "string" }, "production": { "type": "string" }, "prune": { "type": "boolean" }, "spa": { "type": "boolean" }, "staging": { "type": "string" } } } }, "ws": { "$id": "#/properties/ws", "type": "array", "title": "@ws", "description": "API Gateway WebSocket configuration", "uniqueItems": true, "items": { "$ref": "#/definitions/strictName" } }, "http": { "$id": "#/properties/http", "title": "@http", "description": "API Gateway configuration", "type": "array", "uniqueItems": true, "items": { "type": [ "array", "object" ], "maxItems": 2, "maxProperties": 1, "properties": { "any": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" }, "get": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" }, "post": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" }, "put": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" }, "patch": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" }, "delete": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" }, "head": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" }, "options": { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" } }, "items": [ { "type": "string", "enum": [ "any", "get", "post", "put", "patch", "delete", "head", "options" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$" } ] } }, "proxy": { "$id": "#/properties/http", "title": "@proxy", "description": "Proxy", "type": "array", "uniqueItems": true, "items": { "type": [ "array", "object" ], "maxItems": 3, "maxProperties": 1, "properties": { "testing": { "type": "string", "pattern": "^https?:\\/\\/.+$" }, "staging": { "type": "string", "pattern": "^https?:\\/\\/.+$" }, "production": { "type": "string", "pattern": "^https?:\\/\\/.+$" } }, "items": [ { "type": "string", "enum": [ "testing", "staging", "production" ] }, { "type": "string", "pattern": "^https?:\\/\\/.+$" } ] } }, "events": { "$id": "#/properties/events", "type": "array", "title": "@events", "description": "Events configuration", "uniqueItems": true, "items": { "$ref": "#/definitions/strictName" } }, "queues": { "$id": "#/properties/queues", "type": "array", "title": "@queues", "description": "Queues configuration", "uniqueItems": true, "items": { "$ref": "#/definitions/strictName" } }, "macros": { "$id": "#/properties/macros", "type": "array", "title": "@macros", "description": "Deployment macros configuration", "uniqueItems": true, "items": { "$ref": "#/definitions/macros" } }, "scheduled": { "$id": "#/properties/scheduled", "type": [ "array", "object" ], "title": "@scheduled", "description": "Scheduled event configuration", "uniqueItems": true, "items": { "$id": "#/properties/scheduled/items", "type": [ "array", "object" ], "title": "scheduled handlers", "items": [ { "type": "string", "pattern": "^[a-z][a-z|\\-|0-9]+$" }, { "type": "string", "pattern": "^(rate|cron)" } ] } }, "tables": { "$id": "#/properties/tables", "type": "array", "title": "@tables", "description": "DynamoDB database tables configuration", "uniqueItems": true, "items": { "$ref": "#/definitions/table" } }, "indexes": { "$id": "#/properties/indexes", "type": "array", "title": "@indexes", "description": "DynamoDB global secondary indexes configuration", "uniqueItems": true, "items": { "$ref": "#/definitions/table" } } } }

pyrightconfig.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "description": "Pyright Configuration Schema", "allowComments": true, "allowTrailingCommas": true, "type": "object", "definitions": { "diagnostic": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "none", "information", "warning", "error" ] } ] } }, "properties": { "include": { "$id": "#/properties/include", "type": "array", "title": "Files and directories included in type analysis", "items": { "$id": "#/properties/include/items", "type": "string", "title": "File or directory to include in type analysis", "pattern": "^(.*)$" } }, "exclude": { "$id": "#/properties/exclude", "type": "array", "title": "Files and directories excluded from type analysis", "items": { "$id": "#/properties/exclude/items", "type": "string", "title": "File or directory to exclude from type analysis", "pattern": "^(.*)$" } }, "ignore": { "$id": "#/properties/ignore", "type": "array", "title": "Files and directories whose diagnostics are suppressed", "items": { "$id": "#/properties/ignore/items", "type": "string", "title": "File or directory where diagnostics should be suppressed", "pattern": "^(.*)$" } }, "strict": { "$id": "#/properties/strict", "type": "array", "title": "Files and directories that should use 'strict' type checking rules", "items": { "$id": "#/properties/strict/items", "type": "string", "title": "File or directory that should use 'strict' type checking rules", "pattern": "^(.*)$" } }, "defineConstant": { "$id": "#/properties/defineConstant", "type": "object", "title": "Identifiers that should be treated as constants", "properties": { }, "additionalProperties": { "type": ["string", "boolean"], "title": "Value of constant (boolean or string)" } }, "typeCheckingMode": { "$id": "#/properties/typeCheckingMode", "type": "string", "enum": [ "off", "basic", "strict" ], "title": "Specifies the default rule set to use for type checking", "default": "basic" }, "useLibraryCodeForTypes": { "$id": "#/properties/useLibraryCodeForTypes", "type": "boolean", "title": "Use library implementations to extract type information when type stub is not present", "default": true }, "typeshedPath": { "$id": "#/properties/typeshedPath", "type": "string", "title": "Path to directory containing typeshed type stub files", "default": "", "pattern": "^(.*)$" }, "stubPath": { "$id": "#/properties/stubPath", "type": "string", "title": "Path to directory containing custom type stub files", "default": "", "examples": [ "src/typestubs" ], "pattern": "^(.*)$" }, "strictListInference": { "$id": "#/properties/strictListInference", "type": "boolean", "title": "Infer strict types for list expressions", "default": false }, "strictSetInference": { "$id": "#/properties/strictSetInference", "type": "boolean", "title": "Infer strict types for set expressions", "default": false }, "strictDictionaryInference": { "$id": "#/properties/strictDictionaryInference", "type": "boolean", "title": "Infer strict types for dictionary expressions", "default": false }, "analyzeUnannotatedFunctions": { "$id": "#/properties/analyzeUnannotatedFunctions", "type": "boolean", "title": "Analyze and report diagnostics for functions that have no annotations", "default": true }, "strictParameterNoneValue": { "$id": "#/properties/strictParameterNoneValue", "type": "boolean", "title": "Allow implicit Optional when default parameter value is None", "default": true }, "enableExperimentalFeatures": { "$id": "#/properties/enableExperimentalFeatures", "type": "boolean", "title": "Enable the use of experimental features that are not part of the Python typing spec", "default": true }, "enableTypeIgnoreComments": { "$id": "#/properties/enableTypeIgnoreComments", "type": "boolean", "title": "Allow \"# type: ignore\" comments", "default": true }, "reportGeneralTypeIssues": { "$id": "#/properties/reportGeneralTypeIssues", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of general type issues", "default": "error" }, "reportPropertyTypeMismatch": { "$id": "#/properties/reportPropertyTypeMismatch", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of property getter/setter type mismatches", "default": "none" }, "reportFunctionMemberAccess": { "$id": "#/properties/reportFunctionMemberAccess", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of member accesses on function objects", "default": "none" }, "reportMissingImports": { "$id": "#/properties/reportMissingImports", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of imports that cannot be resolved", "default": "error" }, "reportMissingModuleSource": { "$id": "#/properties/reportMissingModuleSource", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of imports that cannot be resolved to source files", "default": "warning" }, "reportMissingTypeStubs": { "$id": "#/properties/reportMissingTypeStubs", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of imports that cannot be resolved to type stub files", "default": "none" }, "reportImportCycles": { "$id": "#/properties/reportImportCycles", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of module imports that create cycles in import graph", "default": "none" }, "reportUnusedImport": { "$id": "#/properties/reportUnusedImport", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of imported symbols that are not referenced within the source file", "default": "none" }, "reportUnusedClass": { "$id": "#/properties/reportUnusedClass", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of private classes that are not accessed", "default": "none" }, "reportUnusedFunction": { "$id": "#/properties/reportUnusedFunction", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of private functions or methods that are not accessed", "default": "none" }, "reportUnusedVariable": { "$id": "#/properties/reportUnusedVariable", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of local variables that are not accessed", "default": "none" }, "reportDuplicateImport": { "$id": "#/properties/reportDuplicateImport", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of symbols or modules that are imported more than once", "default": "none" }, "reportWildcardImportFromLibrary": { "$id": "#/properties/reportWildcardImportFromLibrary", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of wlidcard import from external library", "default": "none" }, "reportOptionalSubscript": { "$id": "#/properties/reportOptionalSubscript", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to subscript (index) a variable with Optional type", "default": "error" }, "reportOptionalMemberAccess": { "$id": "#/properties/reportOptionalMemberAccess", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to access a member of a variable with Optional type", "default": "error" }, "reportOptionalCall": { "$id": "#/properties/reportOptionalCall", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to call a variable with Optional type", "default": "error" }, "reportOptionalIterable": { "$id": "#/properties/reportOptionalIterable", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to use an Optional type as an iterable value", "default": "error" }, "reportOptionalContextManager": { "$id": "#/properties/reportOptionalContextManager", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to use an Optional type as a parameter to a with statement", "default": "error" }, "reportOptionalOperand": { "$id": "#/properties/reportOptionalOperand", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to use an Optional type as an operand for a binary or unary operator", "default": "error" }, "reportTypedDictNotRequiredAccess": { "$id": "#/properties/reportTypedDictNotRequiredAccess", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to access a non-required key in a TypedDict without a check for its presence", "default": "error" }, "reportUntypedFunctionDecorator": { "$id": "#/properties/reportUntypedFunctionDecorator", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of function decorators without type annotations, which obscure function types", "default": "none" }, "reportUntypedClassDecorator": { "$id": "#/properties/reportUntypedClassDecorator", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of class decorators without type annotations, which obscure class types", "default": "none" }, "reportUntypedBaseClass": { "$id": "#/properties/reportUntypedBaseClass", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of a base class of an unknown type, which obscures most type checking for the class", "default": "none" }, "reportUntypedNamedTuple": { "$id": "#/properties/reportUntypedNamedTuple", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of a named tuple definition that does not contain type information", "default": "none" }, "reportPrivateUsage": { "$id": "#/properties/reportPrivateUsage", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of private variables and functions used outside of the owning class or module and usage of protected members outside of subclasses", "default": "none" }, "reportTypeCommentUsage": { "$id": "#/properties/reportTypeCommentUsage", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of deprecated type comment usage", "default": "none" }, "reportPrivateImportUsage": { "$id": "#/properties/reportPrivateImportUsage", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of improper usage of symbol imported from a \"py.typed\" module that is not re-exported from that module", "default": "error" }, "reportConstantRedefinition": { "$id": "#/properties/reportConstantRedefinition", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to redefine variables that are in all-caps", "default": "none" }, "reportDeprecated": { "$id": "#/properties/reportDeprecated", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of use of deprecated class or function", "default": "none" }, "reportIncompatibleMethodOverride": { "$id": "#/properties/reportIncompatibleMethodOverride", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of method overrides in subclasses that redefine the method in an incompatible way", "default": "none" }, "reportIncompatibleVariableOverride": { "$id": "#/properties/reportIncompatibleVariableOverride", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of overrides in subclasses that redefine a variable in an incompatible way", "default": "none" }, "reportInconsistentConstructor": { "$id": "#/properties/reportInconsistentConstructor", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of __init__ and __new__ methods whose signatures are inconsistent", "default": "none" }, "reportOverlappingOverload": { "$id": "#/properties/reportOverlappingOverload", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of function overloads that overlap in signature and obscure each other or do not agree on return type", "default": "none" }, "reportMissingSuperCall": { "$id": "#/properties/reportMissingSuperCall", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of missing call to parent class for inherited `__init__` methods", "default": "none" }, "reportUninitializedInstanceVariable": { "$id": "#/properties/reportUninitializedInstanceVariable", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of instance variables that are not initialized in the constructor", "default": "none" }, "reportInvalidStringEscapeSequence": { "$id": "#/properties/reportInvalidStringEscapeSequence", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of invalid escape sequences used within string literals", "default": "warning" }, "reportUnknownParameterType": { "$id": "#/properties/reportUnknownParameterType", "$ref": "#/definitions/diagnostic", "title": "Controls reporting input and return parameters whose types are unknown", "default": "none" }, "reportUnknownArgumentType": { "$id": "#/properties/reportUnknownArgumentType", "$ref": "#/definitions/diagnostic", "title": "Controls reporting argument expressions whose types are unknown", "default": "none" }, "reportUnknownLambdaType": { "$id": "#/properties/reportUnknownLambdaType", "$ref": "#/definitions/diagnostic", "title": "Controls reporting input and return parameters for lambdas whose types are unknown", "default": "none" }, "reportUnknownVariableType": { "$id": "#/properties/reportUnknownVariableType", "$ref": "#/definitions/diagnostic", "title": "Controls reporting local variables whose types are unknown", "default": "none" }, "reportUnknownMemberType": { "$id": "#/properties/reportUnknownMemberType", "$ref": "#/definitions/diagnostic", "title": "Controls reporting class and instance variables whose types are unknown", "default": "none" }, "reportMissingParameterType": { "$id": "#/properties/reportMissingParameterType", "$ref": "#/definitions/diagnostic", "title": "Controls reporting input parameters that are missing a type annotation", "default": "none" }, "reportMissingTypeArgument": { "$id": "#/properties/reportMissingTypeArgument", "$ref": "#/definitions/diagnostic", "title": "Controls reporting generic class reference with missing type arguments", "default": "none" }, "reportInvalidTypeVarUse": { "$id": "#/properties/reportInvalidTypeVarUse", "$ref": "#/definitions/diagnostic", "title": "Controls reporting improper use of type variables within function signatures", "default": "warning" }, "reportCallInDefaultInitializer": { "$id": "#/properties/reportCallInDefaultInitializer", "$ref": "#/definitions/diagnostic", "title": "Controls reporting usage of function calls within a default value initializer expression", "default": "none" }, "reportUnnecessaryIsInstance": { "$id": "#/properties/reportUnnecessaryIsInstance", "$ref": "#/definitions/diagnostic", "title": "Controls reporting calls to 'isinstance' or 'issubclass' where the result is statically determined to be always true", "default": "none" }, "reportUnnecessaryCast": { "$id": "#/properties/reportUnnecessaryCast", "$ref": "#/definitions/diagnostic", "title": "Controls reporting calls to 'cast' that are unnecessary", "default": "none" }, "reportUnnecessaryComparison": { "$id": "#/properties/reportUnnecessaryComparison", "$ref": "#/definitions/diagnostic", "title": "Controls reporting the use of '==' or '!=' comparisons that are unnecessary", "default": "none" }, "reportUnnecessaryContains": { "$id": "#/properties/reportUnnecessaryContains", "$ref": "#/definitions/diagnostic", "title": "Controls reporting the use of 'in' operations that are unnecessary", "default": "none" }, "reportAssertAlwaysTrue": { "$id": "#/properties/reportAssertAlwaysTrue", "$ref": "#/definitions/diagnostic", "title": "Controls reporting assert expressions that will always evaluate to true", "default": "warning" }, "reportSelfClsParameterName": { "$id": "#/properties/reportSelfClsParameterName", "$ref": "#/definitions/diagnostic", "title": "Controls reporting assert expressions that will always evaluate to true", "default": "warning" }, "reportImplicitStringConcatenation": { "$id": "#/properties/reportImplicitStringConcatenation", "$ref": "#/definitions/diagnostic", "title": "Controls reporting usage of implicit concatenation of string literals", "default": "warning" }, "reportUnboundVariable": { "$id": "#/properties/reportUnboundVariable", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to use an unbound or possibly unbound variable", "default": "error" }, "reportUndefinedVariable": { "$id": "#/properties/reportUndefinedVariable", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of attempts to use an undefined variable", "default": "error" }, "reportInvalidStubStatement": { "$id": "#/properties/reportInvalidStubStatement", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of type stub statements that do not conform to PEP 484", "default": "none" }, "reportIncompleteStub": { "$id": "#/properties/reportIncompleteStub", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of incomplete type stubs that declare a module-level __getattr__ function", "default": "none" }, "reportUnsupportedDunderAll": { "$id": "#/properties/reportUnsupportedDunderAll", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of unsupported operations performed on __all__", "default": "warning" }, "reportUnusedCallResult": { "$id": "#/properties/reportUnusedCallResult", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of call expressions whose results are not consumed", "default": "none" }, "reportUnusedCoroutine": { "$id": "#/properties/reportUnusedCoroutine", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of call expressions that returns Coroutine whose results are not consumed", "default": "error" }, "reportUnusedExpression": { "$id": "#/properties/reportUnusedExpression", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of simple expressions whose value is not used in any way", "default": "warning" }, "reportUnnecessaryTypeIgnoreComment": { "$id": "#/properties/reportUnnecessaryTypeIgnoreComment", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of '# type: ignore' comments that have no effect'", "default": "none" }, "reportMatchNotExhaustive": { "$id": "#/properties/reportMatchNotExhaustive", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of 'match' statements that do not exhaustively match all possible values", "default": "none" }, "reportShadowedImports": { "$id": "#/properties/reportShadowedImports", "$ref": "#/definitions/diagnostic", "title": "Controls reporting of shadowed imports of stdlib modules", "default": "none" }, "reportImplicitOverride": { "$id": "#/properties/reportImplicitOverride", "$ref": "#/definitions/diagnostic", "title": "Controls reporting overridden methods that are missing an `@override` decorator", "default": "none" }, "extraPaths": { "$id": "#/properties/extraPaths", "type": "array", "title": "Additional import search resolution paths", "items": { "$id": "#/properties/extraPaths/items", "type": "string", "title": "Additional import search resolution path", "default": "", "pattern": "^(.*)$" } }, "pythonVersion": { "$id": "#/properties/pythonVersion", "type": "string", "title": "Python version to assume during type analysis", "default": "", "examples": [ "3.7" ], "pattern": "^3\\.[0-9]+$" }, "pythonPlatform": { "$id": "#/properties/pythonPlatform", "type": "string", "title": "Python platform to assume during type analysis", "default": "", "examples": [ "Linux" ], "pattern": "^(Linux|Windows|Darwin|All)$" }, "venvPath": { "$id": "#/properties/venvPath", "type": "string", "title": "Path to directory containing a folder of virtual environments", "default": "", "pattern": "^(.*)$" }, "venv": { "$id": "#/properties/venv", "type": "string", "title": "Name of virtual environment subdirectory within venvPath", "default": "", "examples": [ "python37" ], "pattern": "^(.*)$" }, "verboseOutput": { "$id": "#/properties/verboseOutput", "type": "boolean", "title": "Output verbose logging", "default": false }, "executionEnvironments": { "$id": "#/properties/executionEnvironments", "type": "array", "title": "Analysis settings to use for specified subdirectories of code", "items": { "$id": "#/properties/executionEnvironments/items", "type": "object", "title": "Analysis settings to use for specified subdirectories of code", "required": [ "root" ], "properties": { "root": { "$id": "#/properties/executionEnvironments/items/properties/root", "type": "string", "title": "Path to code subdirectory to which these settings apply", "default": "", "pattern": "^(.*)$" }, "extraPaths": { "$id": "#/properties/executionEnvironments/items/properties/extraPaths", "type": "array", "title": "Additional import search resolution paths", "items": { "$id": "#/properties/executionEnvironments/items/properties/extraPaths/items", "type": "string", "title": "Additional import search resolution path", "default": "", "pattern": "^(.*)$" } }, "pythonVersion": { "$id": "#/properties/executionEnvironments/items/properties/pythonVersion", "type": "string", "title": "Python version to assume during type analysis", "default": "", "examples": [ "3.7" ], "pattern": "^3\\.[0-9]+$" }, "pythonPlatform": { "$id": "#/properties/executionEnvironments/items/properties/pythonPlatform", "type": "string", "title": "Python platform to assume during type analysis", "default": "", "examples": [ "Linux" ], "pattern": "^(Linux|Windows|Darwin|All)$" } } } } } }

lintstagedrc.schema.json

{ "$id": "https://json.schemastore.org/lintstagedrc.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [ { "$ref": "#/definitions/advancedConfig" }, { "$ref": "#/definitions/basicConfig" } ], "definitions": { "$schemaProperty": { "type": "string" }, "linter": { "type": ["string", "array"] }, "lintersMap": { "description": "keys (String) are glob patterns, values (Array<String> | String) are commands to execute.", "type": "object", "additionalProperties": { "$ref": "#/definitions/linter" } }, "globOptions": { "description": "micromatch options to customize how glob patterns match files.", "type": "object", "properties": { "matchBase": { "type": "boolean", "default": true }, "dot": { "type": "boolean", "default": true } }, "additionalProperties": false }, "advancedConfig": { "properties": { "$schema": { "$ref": "#/definitions/$schemaProperty" }, "concurrent": { "description": "Controls if linters are run simultaneously for each glob pattern.", "type": "boolean", "default": true }, "chunkSize": { "description": "Max allowed chunk size based on number of files for glob pattern. This option is only applicable on Windows based systems to avoid command length limitations", "type": "number", "minimum": 1 }, "globOptions": { "description": "micromatch options to customize how glob patterns match files.", "$ref": "#/definitions/globOptions" }, "linters": { "description": "keys (String) are glob patterns, values (Array<String> | String) are commands to execute.", "$ref": "#/definitions/lintersMap" }, "ignore": { "description": "array of glob patterns to entirely ignore from any task.", "type": "array", "items": { "type": "string" }, "default": "['**/docs/**/*.js']" }, "subTaskConcurrency": { "description": "Controls concurrency for processing chunks generated for each linter. This option is only applicable on Windows. Execution is not concurrent by default.", "type": "integer", "minimum": 1, "default": 1 }, "renderer": { "enum": ["update", "verbose"], "default": "update" }, "relative": { "description": "If true it will give the relative path from your package.json directory to your linter arguments.", "type": "boolean", "default": false } }, "additionalProperties": false }, "basicConfig": { "properties": { "$schema": { "$ref": "#/definitions/$schemaProperty" } }, "propertyNames": { "not": { "enum": [ "concurrent", "chunkSize", "globOptions", "linters", "ignore", "subTaskConcurrency", "renderer", "relative" ] } }, "additionalProperties": { "$ref": "#/definitions/linter" } } } }

omnisharp.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/omnisharp.json", "properties": { "FormattingOptions": { "type": "object", "description": "Used to control C# formatting", "properties": { "EnableEditorConfigSupport": { "type": "boolean", "default": false }, "NewLine": { "type": "string", "default": "\n" }, "UseTabs": { "type": "boolean", "default": false }, "TabSize": { "type": "integer", "default": 4 }, "IndentationSize": { "type": "integer", "default": 4 }, "SpacingAfterMethodDeclarationName": { "type": "boolean", "default": false }, "SpaceWithinMethodDeclarationParenthesis": { "type": "boolean", "default": false }, "SpaceBetweenEmptyMethodDeclarationParentheses": { "type": "boolean", "default": false }, "SpaceAfterMethodCallName": { "type": "boolean", "default": false }, "SpaceWithinMethodCallParentheses": { "type": "boolean", "default": false }, "SpaceBetweenEmptyMethodCallParentheses": { "type": "boolean", "default": false }, "SpaceAfterControlFlowStatementKeyword": { "type": "boolean", "default": true }, "SpaceWithinExpressionParentheses": { "type": "boolean", "default": false }, "SpaceWithinCastParentheses": { "type": "boolean", "default": false }, "SpaceWithinOtherParentheses": { "type": "boolean", "default": false }, "SpaceAfterCast": { "type": "boolean", "default": false }, "SpacesIgnoreAroundVariableDeclaration": { "type": "boolean", "default": false }, "SpaceBeforeOpenSquareBracket": { "type": "boolean", "default": false }, "SpaceBetweenEmptySquareBrackets": { "type": "boolean", "default": false }, "SpaceWithinSquareBrackets": { "type": "boolean", "default": false }, "SpaceAfterColonInBaseTypeDeclaration": { "type": "boolean", "default": true }, "SpaceAfterComma": { "type": "boolean", "default": true }, "SpaceAfterDot": { "type": "boolean", "default": false }, "SpaceAfterSemicolonsInForStatement": { "type": "boolean", "default": true }, "SpaceBeforeColonInBaseTypeDeclaration": { "type": "boolean", "default": true }, "SpaceBeforeComma": { "type": "boolean", "default": false }, "SpaceBeforeDot": { "type": "boolean", "default": false }, "SpaceBeforeSemicolonsInForStatement": { "type": "boolean", "default": false }, "SpacingAroundBinaryOperator": { "type": "string", "default": "single" }, "IndentBraces": { "type": "boolean", "default": false }, "IndentBlock": { "type": "boolean", "default": true }, "IndentSwitchSection": { "type": "boolean", "default": true }, "IndentSwitchCaseSection": { "type": "boolean", "default": true }, "IndentSwitchCaseSectionWhenBlock": { "type": "boolean", "default": true }, "LabelPositioning": { "type": "string", "default": "oneLess" }, "WrappingPreserveSingleLine": { "type": "boolean", "default": true }, "WrappingKeepStatementsOnSingleLine": { "type": "boolean", "default": true }, "NewLinesForBracesInTypes": { "type": "boolean", "default": true }, "NewLinesForBracesInMethods": { "type": "boolean", "default": true }, "NewLinesForBracesInProperties": { "type": "boolean", "default": true }, "NewLinesForBracesInAccessors": { "type": "boolean", "default": true }, "NewLinesForBracesInAnonymousMethods": { "type": "boolean", "default": true }, "NewLinesForBracesInControlBlocks": { "type": "boolean", "default": true }, "NewLinesForBracesInAnonymousTypes": { "type": "boolean", "default": true }, "NewLinesForBracesInObjectCollectionArrayInitializers": { "type": "boolean", "default": true }, "NewLinesForBracesInLambdaExpressionBody": { "type": "boolean", "default": true }, "NewLineForElse": { "type": "boolean", "default": true }, "NewLineForCatch": { "type": "boolean", "default": true }, "NewLineForFinally": { "type": "boolean", "default": true }, "NewLineForMembersInObjectInit": { "type": "boolean", "default": true }, "NewLineForMembersInAnonymousTypes": { "type": "boolean", "default": true }, "NewLineForClausesInQuery": { "type": "boolean", "default": true } } }, "RoslynExtensionsOptions": { "type": "object", "description": "Used to define refactorings, code actions and analyzer locations that OmniSharp should use (i.e. Roslynator)", "properties": { "EnableDecompilationSupport": { "type": "boolean", "default": false }, "EnableAnalyzersSupport": { "type": "boolean", "description": "If set to false, only refactorings are available", "default": false }, "DocumentAnalysisTimeoutMs": { "type": "integer", "default": 10000 }, "LocationPaths": { "type": "array", "items": { "type": "string" }, "default": null } } }, "FileOptions": { "type": "object", "description": "Used to define which directories and files should be included in OmniSharp's project file / solution file discovery process. Not individual .cs files.", "properties": { "SystemExcludeSearchPatterns": { "type": "array", "description": "Recommended for manual editing", "items": { "type": "string" }, "default": [ "**/node_modules/**/*", "**/bin/**/*", "**/obj/**/*", "**/.git/**/*" ] }, "ExcludeSearchPatterns": { "type": "array", "description": "Can be used by tools such as VS Code to automatically share its exclusion settings with OmniSharp", "items": { "type": "string" }, "default": [] } } }, "RenameOptions": { "type": "object", "properties": { "RenameOverloads": { "type": "boolean", "default": false }, "RenameInStrings": { "type": "boolean", "default": false }, "RenameInComments": { "type": "boolean", "default": false } } }, "ImplementTypeOptions": { "type": "object", "properties": { "InsertionBehavior": { "type": "string", "enum": ["WithOtherMembersOfTheSameKind", "AtTheEnd"], "default": "WithOtherMembersOfTheSameKind" }, "PropertyGenerationBehavior": { "type": "string", "enum": ["PreferThrowingProperties", "PreferAutoProperties"], "default": "PreferThrowingProperties" } } }, "Plugins": { "type": "object", "properties": { "LocationPaths": { "type": "array", "items": { "type": "string" }, "default": [] } } }, "msbuild": { "type": "object", "description": "Used to configure MSBuild solutions and projects", "properties": { "enabled": { "type": "boolean", "default": true }, "ToolsVersion": { "type": "string", "default": null, "description": "Value of ToolsVersion to use when building projects passed to this task", "anyOf": [ { "enum": ["Current", "2.0", "3.5", "4.0", "15.0"] }, { "type": "string" } ] }, "VisualStudioVersion": { "type": "string", "default": null }, "Configuration": { "default": null, "description": "Build configuration used for project evaluation", "anyOf": [ { "enum": ["Debug", "Release"] }, { "type": "string" } ] }, "Platform": { "default": "AnyCPU", "description": "Specifies which version of the Common Language Runtime (CLR) use for project evaluation", "anyOf": [ { "enum": ["AnyCPU", "x86", "x64", "ARM", "ARM64", "Itanium"] }, { "type": "string" } ] }, "EnablePackageAutoRestore": { "type": "boolean", "default": false }, "MSBuildExtensionsPath": { "type": "string", "description": "MSBuild extensions path. On Standalone this defaults to the MSBuild folder. In VisualStudio mode this folder will be %VSINSTALLDIR%\\MSBuild", "default": null }, "TargetFrameworkRootPath": { "type": "string", "description": "Root directory where the target framework will be looked for. Uses default path if this is null", "default": null }, "MSBuildSDKsPath": { "type": "string", "description": "Path to the Sdks folder for this MSBuild instance", "default": null }, "RoslynTargetsPath": { "type": "string", "default": null }, "CscToolPath": { "type": "string", "description": "Local Roslyn path (e.g. <MSBuildPath>/Current/Bin/Roslyn)", "default": null }, "CscToolExe": { "type": "string", "description": "FileName of C# compiler", "default": "csc.exe" }, "loadProjectsOnDemand": { "type": "boolean", "description": "If true, MSBuild project system will only be loading projects for files that were opened in the editor as well as referenced projects, recursively", "default": false } } }, "script": { "type": "object", "description": "Used to configure C# scripting (CSX files)", "properties": { "enabled": { "type": "boolean", "default": true }, "defaultTargetFramework": { "type": "string", "default": "net461", "anyOf": [ { "enum": [ "netstandard1.0", "netstandard1.1", "netstandard1.2", "netstandard1.3", "netstandard1.4", "netstandard1.5", "netstandard1.6", "netstandard2.0", "netstandard2.1", "netcoreapp1.0", "netcoreapp1.1", "netcoreapp2.0", "netcoreapp2.1", "netcoreapp2.2", "netcoreapp3.0", "netcoreapp3.1", "net11", "net20", "net35", "net40", "net403", "net45", "net451", "net452", "net46", "net461", "net462", "net47", "net471", "net472", "net48" ] }, { "type": "string" } ] }, "enableScriptNuGetReferences": { "type": "boolean", "default": false }, "rspFilePath": { "type": "string", "default": "", "description": "A response file (.rsp) is used to provide the command line arguments that are used to run the roslyn script compiler process. You can use this to override the default namespace includes among other things." } } }, "cake": { "type": "object", "description": "Used to configure Cake (cake files)", "properties": { "enabled": { "type": "boolean", "default": true }, "bakeryPath": { "type": "string", "default": null } } } }, "type": "object" }

cosmos-config.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "https://json.schemastore.org/cosmos-config.json", "properties": { "$schema": { "type": "string" }, "rootDir": { "description": "The root directory that all others paths in this config are relative to. Usually the root of your repo. If omitted, rootDir is equal to the directory containing your Cosmos config. When you don't use a Cosmos config, rootDir defaults to the current working directory.", "type": "string", "minLength": 1 }, "exportPath": { "description": "Where to generate static exports on disk. [default: \"cosmos-export\"]", "type": "string", "minLength": 1 }, "detectLocalPlugins": { "description": "Automatically detect and load local plugins", "type": "boolean" }, "disablePlugins": { "description": "Disable plugins", "type": "boolean" }, "staticPath": { "description": "Dir path to serve static assets from.", "type": "string", "minLength": 1 }, "plugins": { "description": "Module IDs of Cosmos plugins (eg. \"react-cosmos-plugin-open-fixture\" or \"../path/to/my-plugin\").", "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true }, "publicUrl": { "description": "Base URL for static assets. [default: \"/\"]", "type": "string" }, "fixturesDir": { "description": "Name for directories that contain fixtures (eg. __fixtures__/example.jsx). [default: \"__fixtures__\"]", "type": "string", "minLength": 1 }, "fixtureFileSuffix": { "description": "Suffix for fixture files (eg. example.fixture.jsx). [default: \"fixture\"]", "type": "string", "minLength": 1 }, "ignore": { "description": "Patterns for ignoring fixture and decorator files (eg. [\"**/dist/**\"]]).", "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true }, "watchDirs": { "description": "Directories where the Cosmos server watches for fixture files changes while running. [default: [\".\"]]", "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true }, "lazy": { "description": "Dynamically import fixture and decorator modules as they are loaded. When false all fixture and decorator modules are imported statically and bundled together. [default: false]", "type": "boolean" }, "exposeImports": { "description": "Expose user imports and config required for the Cosmos renderer. Used with React Native and in custom integrations. When a path is specified it requires a file extension (eg. \"src/cosmos.imports.ts\"). [default: false]", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "boolean" } ] }, "hostname": { "description": "Dev server hostname. Set to null to accept connections with any hostname. [default: null]", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "port": { "description": "Dev server port. [default: 5000]", "type": "number" }, "portRetries": { "description": "Max number of port retries. [default: 10]", "type": "number" }, "https": { "description": "Server will be served over HTTPS.", "type": "boolean" }, "httpsOptions": { "description": "Additional options for HTTPS server.", "type": "object", "additionalProperties": false, "properties": { "certPath": { "description": "Path of a certificate file", "type": "string" }, "keyPath": { "description": "Path of a certificate's key file", "type": "string" } } }, "httpProxy": { "description": "Proxy some URLs to a different HTTP server (eg. an API backend dev server). Similar to devServer.proxy in webpack config.", "type": "object", "additionalProperties": true, "patternProperties": { ".*": { "anyOf": [ { "type": "string" }, { "type": "object", "description": "Advanced HTTP proxy config.", "additionalProperties": true, "required": ["target"], "properties": { "target": { "type": "string" }, "secure": { "type": "boolean" }, "pathRewrite": { "type": "object", "patternProperties": { ".*": { "type": "string" } } }, "logLevel": { "type": "string", "enum": ["error", "debug", "info", "warn", "silent"] } } } ] } } }, "globalImports": { "description": "Modules to be imported before loading components. Stuff like reset.css, polyfills, etc.", "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true }, "rendererUrl": { "description": "Required when renderer doesn't run on the same port (or host) as the Playground. Useful for integrations with build tools. [default: null]", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "dom": { "description": "DOM-related options", "type": "object", "properties": { "containerQuerySelector": { "description": "Document selector for existing element to use as component parent (eg. #root). A blank container element is created from scratch if no selector is provided. [default: null]", "type": ["string", "null"], "minLength": 1 } } }, "vite": { "description": "Vite-related options", "type": "object", "additionalProperties": false, "properties": { "configPath": { "description": "Path to Vite config. Set to false to disable reading it from the default path. [default: \"vite.config.js\"]", "anyOf": [ { "type": "string", "minLength": 1 }, { "enum": [false] } ] }, "indexPath": { "description": "Path to index module (eg. \"src/my-index.tsx\"). [default: matches common index/main module paths]", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "port": { "description": "Vite renderer port. [default: 5050]", "type": "number" } } }, "webpack": { "description": "Webpack-related options", "type": "object", "additionalProperties": false, "properties": { "configPath": { "description": "Path to an existing webpack config, which Cosmos will reuse to build your code. Set to null to disable this behavior. [default: \"webpack.config.js\"]", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "overridePath": { "description": "Path to a user module that customizes the webpack config used by Cosmos. Set to null to disable this behavior. [default: \"webpack.override.js\"]", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "includeHashInOutputFilename": { "description": "Changes output filename from \"[name].js\" to \"[name].[contenthash].js\". [default: false]", "type": "boolean" }, "hotReload": { "description": "Enable webpack's Hot Module Replacement. [default: true]", "type": "boolean" }, "reloadOnFail": { "description": "When using webpack's Hot Module Replacement, enable automatic location reload after webpack fails to update modules. [default: false]", "type": "boolean" } } }, "ui": { "description": "UI plugin options", "type": "object", "additionalProperties": true, "properties": { "responsivePreview": { "type": "object", "additionalProperties": false, "properties": { "devices": { "description": "List of device viewports", "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["label", "width", "height"], "properties": { "label": { "type": "string", "minLength": 1 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } } } } } } } } }, "title": "JSON schema for React Cosmos configs", "type": "object" }

venvironment-schema.json

{ "$id": "https://json.schemastore.org/venvironment-schema.json", "$ref": "#/definitions/24768/full", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "24768": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "venvironment schema", "type": "object", "required": ["version"], "oneOf": [ { "allOf": [ { "properties": { "version": { "const": "2.1.0" } } }, { "$ref": "#/definitions/db5bc/full" } ] }, { "allOf": [ { "properties": { "version": { "const": "2.0.0" } } }, { "$ref": "#/definitions/26679/full" } ] }, { "allOf": [ { "properties": { "version": { "const": "1.1.1" } } }, { "$ref": "#/definitions/91f16/full" } ] }, { "allOf": [ { "properties": { "version": { "const": "1.1.0" } } }, { "$ref": "#/definitions/ed3cd/full" } ] }, { "allOf": [ { "properties": { "version": { "const": "1.0.0" } } }, { "$ref": "#/definitions/b4889/full" } ] } ] } }, "db5bc": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "venvironment schema", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/716b3/full" }, "includes": { "$ref": "#/definitions/85495/full" }, "scenarios": { "$ref": "#/definitions/bf151/full" }, "variables": { "$ref": "#/definitions/57928/full" }, "defines": { "$ref": "#/definitions/405a8/full" }, "global-settings": { "$ref": "#/definitions/0fa26/full" }, "system-variables": { "$ref": "#/definitions/3eaba/full" }, "databases": { "$ref": "#/definitions/7f50f/full" }, "can-networks": { "$ref": "#/definitions/63c85/full" }, "canfd-networks": { "$ref": "#/definitions/5bc6c/full" }, "ethernet-networks": { "$ref": "#/definitions/db003/full" }, "flexray-clusters": { "$ref": "#/definitions/6f43a/full" }, "lin-networks": { "$ref": "#/definitions/962c1/full" }, "simulation-nodes": { "$ref": "#/definitions/64979/full" }, "datasources": { "$ref": "#/definitions/5cec7/full" }, "application-models": { "$ref": "#/definitions/6939d/full" }, "programming-modules": { "$ref": "#/definitions/be294/full" }, "user-files": { "$ref": "#/definitions/22ddc/full" }, "xcp-configuration-files": { "$ref": "#/definitions/bdaa7/full" }, "fdx": { "$ref": "#/definitions/e4b54/full" }, "functional-mockup-units": { "$ref": "#/definitions/bbc08/full" }, "sil-kit": { "$ref": "#/definitions/8984d/full" }, "logging": { "$ref": "#/definitions/8d971/full" }, "can-replay-blocks": { "$ref": "#/definitions/23778/full" }, "ethernet-replay-blocks": { "$ref": "#/definitions/9b94b/full" }, "lin-replay-blocks": { "$ref": "#/definitions/67ea2/full" } } } }, "26679": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "venvironment schema", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/cb919/full" }, "global-settings": { "$ref": "#/definitions/b3abd/full" }, "includes": { "$ref": "#/definitions/85495/full" }, "variables": { "$ref": "#/definitions/57928/full" }, "application-models": { "$ref": "#/definitions/6939d/full" }, "datasources": { "$ref": "#/definitions/5cec7/full" }, "functional-mockup-units": { "$ref": "#/definitions/bbc08/full" }, "sil-kit": { "$ref": "#/definitions/8984d/full" }, "fdx": { "$ref": "#/definitions/e4b54/full" }, "defines": { "$ref": "#/definitions/405a8/full" }, "system-variables": { "$ref": "#/definitions/3eaba/full" }, "xcp-configuration-files": { "$ref": "#/definitions/bdaa7/full" }, "logging": { "$ref": "#/definitions/8d971/full" }, "simulation-nodes": { "$ref": "#/definitions/6101e/full" }, "databases": { "$ref": "#/definitions/7f50f/full" }, "can-networks": { "$ref": "#/definitions/46542/full" }, "canfd-networks": { "$ref": "#/definitions/fe291/full" }, "ethernet-networks": { "$ref": "#/definitions/0fc9e/full" }, "lin-networks": { "$ref": "#/definitions/d240d/full" }, "can-replay-blocks": { "$ref": "#/definitions/23778/full" }, "ethernet-replay-blocks": { "$ref": "#/definitions/9b94b/full" }, "scenarios": { "$ref": "#/definitions/bf151/full" } } } }, "91f16": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "venvironment schema", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/29b8a/full" }, "global-settings": { "$ref": "#/definitions/f5db4/full" }, "includes": { "$ref": "#/definitions/85495/full" }, "variables": { "$ref": "#/definitions/f9fcb/full" }, "application-models": { "$ref": "#/definitions/90d4b/full" }, "datasources": { "$ref": "#/definitions/015cb/full" }, "functional-mockup-units": { "$ref": "#/definitions/f276a/full" }, "sil-kit": { "$ref": "#/definitions/37df6/full" }, "fdx": { "$ref": "#/definitions/e4b54/full" }, "defines": { "$ref": "#/definitions/405a8/full" }, "system-variables": { "$ref": "#/definitions/3eaba/full" }, "xcp-configuration-files": { "$ref": "#/definitions/05c88/full" }, "logging": { "$ref": "#/definitions/e94dc/full" }, "simulation-nodes": { "$ref": "#/definitions/8ab30/full" }, "databases": { "$ref": "#/definitions/13e53/full" }, "can-networks": { "$ref": "#/definitions/828be/full" }, "canfd-networks": { "$ref": "#/definitions/9dce0/full" }, "ethernet-networks": { "$ref": "#/definitions/bf025/full" }, "can-replay-blocks": { "$ref": "#/definitions/55701/full" }, "ethernet-replay-blocks": { "$ref": "#/definitions/a5fab/full" }, "scenarios": { "$ref": "#/definitions/d1a67/full" } } } }, "ed3cd": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "venvironment schema", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/dad40/full" }, "global-settings": { "$ref": "#/definitions/f5db4/full" }, "includes": { "$ref": "#/definitions/85495/full" }, "variables": { "$ref": "#/definitions/f9fcb/full" }, "application-models": { "$ref": "#/definitions/90d4b/full" }, "datasources": { "$ref": "#/definitions/015cb/full" }, "functional-mockup-units": { "$ref": "#/definitions/f276a/full" }, "sil-kit": { "$ref": "#/definitions/37df6/full" }, "defines": { "$ref": "#/definitions/405a8/full" }, "system-variables": { "$ref": "#/definitions/3eaba/full" }, "xcp-configuration-files": { "$ref": "#/definitions/05c88/full" }, "logging": { "$ref": "#/definitions/e94dc/full" }, "simulation-nodes": { "$ref": "#/definitions/8ab30/full" }, "databases": { "$ref": "#/definitions/13e53/full" }, "can-networks": { "$ref": "#/definitions/828be/full" }, "canfd-networks": { "$ref": "#/definitions/9dce0/full" }, "ethernet-networks": { "$ref": "#/definitions/bf025/full" }, "can-replay-blocks": { "$ref": "#/definitions/55701/full" }, "ethernet-replay-blocks": { "$ref": "#/definitions/a5fab/full" }, "scenarios": { "$ref": "#/definitions/d1a67/full" } } } }, "b4889": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "venvironment schema", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/0e921/full" }, "includes": { "$ref": "#/definitions/6c391/full" }, "variables": { "$ref": "#/definitions/f9fcb/full" }, "application-models": { "$ref": "#/definitions/497d3/full" }, "datasources": { "$ref": "#/definitions/015cb/full" }, "defines": { "$ref": "#/definitions/16f14/full" }, "system-variables": { "$ref": "#/definitions/3eaba/full" }, "simulation-nodes": { "$ref": "#/definitions/c706a/full" }, "databases": { "$ref": "#/definitions/13e53/full" }, "can-networks": { "$ref": "#/definitions/79d04/full" }, "canfd-networks": { "$ref": "#/definitions/252f0/full" }, "scenarios": { "$ref": "#/definitions/79a89/full" } } } }, "716b3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.", "const": "2.1.0", "type": "string", "examples": ["2.1.0"] } }, "85495": { "local": { "one": { "type": "string", "pattern": "\\.([Yy][Aa]?[Mm][Ll]|[Jj][Ss][Oo][Nn])$" } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Include files", "description": "Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.", "oneOf": [ { "$ref": "#/definitions/85495/local/one" }, { "type": "array", "items": { "$ref": "#/definitions/85495/local/one" } } ], "examples": [ "my_include.yaml", ["my_include.yml", "my_other_include.json"] ] } }, "bf151": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Scenarios", "description": "List of scenarios with the option to define / override variables or defines.", "type": "array", "items": { "$ref": "#/definitions/9b42a/full" }, "examples": [ [ { "name": "my_scenario_name" } ], [ { "name": "my_scenario_name" }, { "name": "override_variables", "variables": [ { "name": "three", "value": 3 } ] }, { "name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"] } ] ] } }, "57928": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Variables", "description": "List of variables to be used in this configuration file.", "type": "array", "items": { "$ref": "#/definitions/ce2b5/full" }, "examples": [ [ { "name": "var", "value": -42 } ], [ { "name": "my_string", "value": "implicit-type" }, { "name": "var", "value": 422200000000.0, "type": "float" }, { "name": "path_var", "value": "path/to/somewhere", "type": "path" }, { "name": "uint_enum", "value": 43, "type": "uint", "options": [1, 43, 127] } ] ] } }, "405a8": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Defines", "description": "List of defines to be passed to capl / vcdl. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/9d23c/full" }, "examples": [ [ { "define": "mydefine1" } ], [ { "define": ["mydefine1", "mydefine2"] }, { "define": ["mydefine1", "mydefine2"], "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "define": [ "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] } ] ] } }, "0fa26": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global Settings", "description": "Global settings for all scenarios.", "type": "object", "additionalProperties": false, "properties": { "ethernet": { "$ref": "#/definitions/cdf60/full" }, "flexray": { "$ref": "#/definitions/70a7b/full" }, "database": { "$ref": "#/definitions/3dd98/full" }, "database-dotnet-namespace-generation": { "description": "User defined settings for namespace generation in the .Net typelib. Default complies with the setting \"Automatic Qualification\". With this setting the namespaces for signals are automatically generated so that each class is unique. For each frame a class is generated in the namespace \"NetworkDB.Frames\".", "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "string", "enum": [ "use-network", "use-database", "use-frame", "use-node" ] }, { "$ref": "#/definitions/779cd/full" } ] }, "examples": [ ["use-network", "use-database", "use-frame", "use-node"] ] }, "time-scaling-factor": { "description": "'number': The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10. \n'as-fast-as-possible': Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation.", "oneOf": [ { "type": "number", "exclusiveMinimum": 0, "maximum": 1e37 }, { "const": "as-fast-as-possible" }, { "$ref": "#/definitions/779cd/full" } ], "default": "as-fast-as-possible" }, "time-source": { "description": "Time source for the simulation. Operate without hardware and simulate all buses completely. \n'internal-realtime': The time response of the measurement (time basis) is controlled internally. \n'external-software': The time response of the measurement (time basis) is controlled by an external program. \n'internal-scaled': The simulation speed is provided through the property time-scaling-factor.", "default": "internal-realtime", "anyOf": [ { "enum": [ "internal-realtime", "external-software", "internal-scaled" ] }, { "$ref": "#/definitions/779cd/full" } ], "examples": [ "internal-realtime", "internal-scaled", "external-software" ] } }, "allOf": [ { "if": { "required": ["time-source"], "properties": { "time-source": { "const": "internal-scaled" } } }, "then": { "required": ["time-scaling-factor"], "properties": { "time-scaling-factor": true } } }, { "if": { "required": ["time-source"], "properties": { "time-source": { "anyOf": [ { "const": "internal-realtime" }, { "const": "external-software" } ] } } }, "then": { "properties": { "time-scaling-factor": false } } } ], "examples": [ { "ethernet": { "access-mode": "network-based" } }, { "ethernet": { "access-mode": "channel-based", "signal-updates": "always" } }, { "time-source": "internal-realtime" }, { "time-source": "internal-scaled", "time-scaling-factor": "as-fast-as-possible" }, { "time-source": "internal-scaled", "time-scaling-factor": 0.01 }, { "time-source": "internal-scaled", "time-scaling-factor": 0.5 }, { "time-source": "internal-scaled", "time-scaling-factor": 1 }, { "time-source": "internal-scaled", "time-scaling-factor": 6 }, { "time-source": "internal-scaled", "time-scaling-factor": 10 }, { "time-source": "internal-scaled", "time-scaling-factor": 500 }, { "database-dotnet-namespace-generation": [ "use-network", "${someVariable}" ] } ] } }, "3eaba": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "System Variables", "description": "A lists of system variables to be used by the simulation. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/21f87/full" }, "examples": [ [ { "file-path": "path/to/my.vsysvar" } ], [ { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my.vsysvar", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "7f50f": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Databases", "description": "List of databases. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/8d374/full" }, "examples": [ [ { "name": "mydbname", "file-path": "path/to/some.dbc" } ], [ { "name": "mydbname", "file-path": "path/to/some.dbc" }, { "name": "mydbname", "file-path": "path/to/some.arxml", "network-name": "network_in_db" }, { "name": "mydbname", "file-path": "path/to/some.dbc", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "63c85": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Networks", "description": "List of CAN networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/ce8a4/full" }, "examples": [ [ { "name": "my_can_network" } ], [ { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "database": "DB_1", "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator", "when": "SCENARIO_NAME == \"another_scenario\"" } ] ] } }, "5bc6c": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD Networks", "description": "List of CANFD networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/f1384/full" }, "examples": [ [ { "name": "my_canfd_network" } ], [ { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "database": "DB_1", "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator" } ] ] } }, "db003": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Networks", "description": "List of Ethernet networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/f146b/full" }, "examples": [ [ { "name": "my_eth_network" } ], [ { "name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "tcp-ip-stack-adapter": { "mac-address": "02:84:cf:3b:be:01" }, "mapping": "external-sil-kit" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": { "mtu": 1500, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.1", "subnet-mask": "255.255.0.0" } ] }, "ipv6-settings": { "address-configuration": "dhcp" }, "vlans": [ { "id": 42, "priority": 0 } ] } } ] ] } }, "6f43a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "FlexRay Clusters", "description": "List of FlexRay clusters. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/d89e9/full" } } }, "962c1": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "LIN Networks", "description": "List of LIN networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/3a966/full" } } }, "64979": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Nodes", "description": "A list of simulation nodes used in a simulation. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/a6ab3/full" }, "examples": [ [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ] } ], [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name1\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": true, "network-assignments": [ { "network": "my_can_network_1" } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": [ "modeling/lib/1.vmodule", "${path_in_var}" ], "when": "SCENARIO_NAME == \"my_scenario_name2\"" } ] ] } }, "5cec7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Datasources", "description": "The definition of datasources used by application models. Input files can be deactivated with when.", "type": "object", "additionalProperties": false, "properties": { "input-files": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/b88a6/full" }, "defines": { "$ref": "#/definitions/f52d1/full" } } } } }, "examples": [ { "input-files": [ { "file-path": "path/to/my.vcdl" } ] }, { "input-files": [ { "file-path": [ "path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}" ] } ] }, { "input-files": [ { "file-path": "path/to/my.vcdl", "defines": ["A", "B=42"], "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } ] } }, "6939d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Application Models", "description": "List of application models representing some program. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/4b905/full" }, "examples": [ [ { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"] } ] ] } }, "be294": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Programming Modules", "description": "Lists of programming modules to be used by the simulation. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/c3b11/full" }, "examples": [ [ { "capl-library-path": "path/to/my.vmodule" } ], [ { "c-library-path": [ "${path_in_variable}", "path/${name_in_variable}" ] } ], [ { "capl-library-path": "path/to/my.vmodule", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "c-library-path": "path/to/my.vmodule", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "22ddc": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "User Files", "description": "List of user files. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/4aae7/full" }, "examples": [ [ { "file-path": "path/to/my.txt" } ], [ { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my_file.txt", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "bdaa7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "XCP files", "description": "List of XCP configuration files (entries can be deactivated with when)", "type": "array", "items": { "$ref": "#/definitions/375dd/full" }, "examples": [ [ { "file-path": "path/to/my.xcpcfg" } ], [ { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my.yaml", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "e4b54": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "FDX", "description": "FDX settings. Entry can be deactivated with when.", "type": "object", "additionalProperties": false, "required": ["transport-layer", "port"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "transport-layer": { "description": "Protocol to be used as transport layer for the FDX protocol", "default": "udp/ipv4", "anyOf": [ { "type": "string", "enum": ["udp/ipv4", "udp/ipv6", "tcp/ipv4", "tcp/ipv6"] }, { "$ref": "#/definitions/779cd/full" } ] }, "port": { "description": "Number of the UDP or TCP port to be used for the FDX protocol", "default": 2809, "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 65535 }, { "$ref": "#/definitions/779cd/full" } ] }, "description-files": { "description": "List of XML files that describe which signals or variables are to be exchanged and the manner in which this is to occur (e.g., with regard to grouping). Each entry can be deactivated with when.", "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/42d39/full" } } } } }, "examples": [ { "transport-layer": "udp/ipv4", "port": 2809 }, { "transport-layer": "tcp/ipv6", "port": 5555, "description-files": [ { "file-path": "path/to/first.xml" }, { "file-path": "path/to/second.xml" } ] } ] } }, "bbc08": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Functional mockup units", "description": "List of functional mockup units. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/dfa5a/full" }, "examples": [ [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001 } ], [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": true } ], [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "active-model-variables": ["Variable1", "Variable2"] } ], [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "inactive-model-variables": ["Variable3"] } ] ] } }, "8984d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "SIL Kit", "description": "SIL Kit settings. Entry can be deactivated with when.", "type": "object", "additionalProperties": false, "required": ["participant-name"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "registry-uri": { "description": "The URI of the registry.", "type": "string", "anyOf": [ { "pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?", "default": "silkit://localhost:8500" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["silkit://localhost:8500"] }, "participant-name": { "description": "Name used by the simulation tool to join a simulation as a participant at the start of a measurement.", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["CANoe4SW-SE"] }, "config-file-path": { "$ref": "#/definitions/c9f2a/full" }, "simulation-step-in-micro-sec": { "description": "Time length of a single simulation step. Valid only for the time-source \"external-software\".", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775, "default": 100 }, { "$ref": "#/definitions/779cd/full" } ] }, "life-cycle-event-timeout-in-sec": { "description": "Maximum waiting time for the other simulation participants. Valid only for the time-source \"external-software\".", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036, "default": 30 }, { "$ref": "#/definitions/779cd/full" } ] } }, "examples": [ { "participant-name": "CANoe4SW-SE" }, { "registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW-SE", "config-file-path": "path/to/config-file.json" }, { "registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW-SE", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150 }, { "registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW-SE", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150, "life-cycle-event-timeout-in-sec": 30 } ] } }, "8d971": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Logging Block", "description": "Configuration of the logging for the environment.", "type": "object", "additionalProperties": false, "required": ["file-name"], "properties": { "file-name": { "$ref": "#/definitions/799e1/full" }, "logging-events": { "type": "array", "default": [ "application-layer", "bus", "diagnostic", "internal", "statistic", "system-variable", "test" ], "items": { "anyOf": [ { "type": "string", "enum": [ "application-layer", "bus", "diagnostic", "internal", "statistic", "system-variable", "test" ] }, { "$ref": "#/definitions/779cd/full" } ] } }, "advanced": { "$ref": "#/definitions/a53a3/full" } }, "examples": [ { "file-name": "file-name.blf", "logging-events": [ "bus", "diagnostic", "internal", "${someVariable}" ], "advanced": { "warn-overwritten-log-file": true, "show-error-on-data-loss": false } } ] } }, "23778": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Replay Blocks", "description": "List of CAN replay blocks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/1934a/full" }, "examples": [ [ { "name": "my_can_replay_block", "file-path": "my_logging_file.blf" } ], [ { "name": "my_can_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\"" } ] ] } }, "9b94b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Ethernet Replay Blocks", "description": "List of ethernet replay blocks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/5f17a/full" }, "examples": [ [ { "name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf" } ], [ { "name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_ethernet_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\"" } ] ] } }, "67ea2": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "LIN Replay Blocks", "description": "List of LIN replay blocks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/aebb7/full" }, "examples": [ [ { "name": "my_lin_replay_block", "file-path": "my_logging_file.blf" } ], [ { "name": "my_lin_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_lin_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\"" } ] ] } }, "cb919": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.", "const": "2.0.0", "type": "string", "examples": ["2.0.0"] } }, "b3abd": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global Settings", "description": "Global settings for all scenarios.", "type": "object", "additionalProperties": false, "properties": { "ethernet": { "$ref": "#/definitions/cdf60/full" }, "database": { "$ref": "#/definitions/c18ab/full" }, "database-dotnet-namespace-generation": { "description": "User defined settings for namespace generation in the .Net typelib. Default complies with the setting \"Automatic Qualification\"", "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "string", "enum": [ "use-network", "use-database", "use-frame", "use-node" ] }, { "$ref": "#/definitions/779cd/full" } ] }, "examples": [ ["use-network", "use-database", "use-frame", "use-node"] ] }, "time-scaling-factor": true, "time-source": { "description": "Time source for the simulation. Operate without hardware and simulate all buses completely. \n'internal-realtime': The time response of the measurement (time basis) is controlled internally. \n'external-software': The time response of the measurement (time basis) is controlled by an external program. \n'internal-scaled': The simulation speed is provided through the property time-scaling-factor.", "default": "internal-realtime", "anyOf": [ { "type": "string", "enum": [ "internal-realtime", "external-software", "internal-scaled" ] }, { "$ref": "#/definitions/779cd/full" } ], "examples": [ "internal-realtime", "internal-scaled", "external-software" ] } }, "allOf": [ { "if": { "required": ["time-source"], "properties": { "time-source": { "const": "internal-scaled" } } }, "then": { "properties": { "time-scaling-factor": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0, "maximum": 1e37, "description": "The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10." }, { "const": "as-fast-as-possible", "description": "Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation." }, { "$ref": "#/definitions/779cd/full" } ], "default": "as-fast-as-possible", "examples": [ "as-fast-as-possible", "0.01", "0.05", "0.1", "0.5", "1", "5", "10", "50", "100", "500" ] } } } } ], "examples": [ { "ethernet": { "access-mode": "network-based" } }, { "ethernet": { "access-mode": "channel-based", "signal-updates": "always" } }, { "time-source": "internal-realtime" }, { "time-source": "internal-scaled", "time-scaling-factor": 6 }, { "database-dotnet-namespace-generation": [ "use-network", "${someVariable}" ] } ] } }, "6101e": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Nodes", "description": "A list of simulation nodes used in a simulation. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/00f15/full" }, "examples": [ [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ] } ], [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name1\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": true, "network-assignments": [ { "network": "my_can_network_1" } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": [ "modeling/lib/1.vmodule", "${path_in_var}" ], "when": "SCENARIO_NAME == \"my_scenario_name2\"" } ] ] } }, "46542": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Networks", "description": "List of CAN networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/fe737/full" }, "examples": [ [ { "name": "my_can_network" } ], [ { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "database": "DB_1", "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator", "when": "SCENARIO_NAME == \"another_scenario\"" } ] ] } }, "fe291": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD Networks", "description": "List of CANFD networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/077d5/full" }, "examples": [ [ { "name": "my_canfd_network" } ], [ { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "database": "DB_1", "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator" } ] ] } }, "0fc9e": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Networks", "description": "List of Ethernet networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/fb03e/full" }, "examples": [ [ { "name": "my_eth_network" } ], [ { "name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "tcp-ip-stack-adapter": { "mac-address": "02:84:cf:3b:be:01" }, "mapping": "external-sil-kit" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": { "mtu": 1500, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.1", "subnet-mask": "255.255.0.0" } ] }, "ipv6-settings": { "address-configuration": "dhcp" }, "vlans": [ { "id": 42, "priority": 0 } ] } } ] ] } }, "d240d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "LIN Networks", "description": "List of LIN networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/974c5/full" } } }, "29b8a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.", "const": "1.1.1", "type": "string", "examples": ["1.1.1"] } }, "f5db4": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global Settings", "description": "Global settings for all scenarios.", "type": "object", "additionalProperties": false, "properties": { "ethernet-settings": { "$ref": "#/definitions/843bf/full" }, "time-scaling-factor": true, "time-source": { "description": "Time source for the simulation.", "default": "internal-realtime", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "const": "internal-realtime", "description": "Operate without hardware and simulate all buses completely. The time response of the measurement (time basis) is controlled internally." }, { "const": "external-software", "description": "Operate without hardware and simulate all buses completely. The time response of the measurement (time basis) is controlled by an external program." }, { "const": "internal-scaled", "description": "Operate without hardware and simulate all buses completely. The simulation speed is provided through the property time-scaling-factor." } ], "examples": [ "internal-realtime", "internal-scaled", "external-software" ] } }, "allOf": [ { "if": { "required": ["time-source"], "properties": { "time-source": { "const": "internal-scaled" } } }, "then": { "properties": { "time-scaling-factor": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0, "maximum": 1.7976931348623157e308, "description": "The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10." }, { "const": "as-fast-as-possible", "description": "Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation." }, { "$ref": "#/definitions/779cd/full" } ], "default": "as-fast-as-possible", "examples": [ "as-fast-as-possible", "0.01", "0.05", "0.1", "0.5", "1", "5", "10", "50", "100", "500" ] } } } } ], "examples": [ { "ethernet-settings": { "access-mode": "network-based" } }, { "ethernet-settings": { "access-mode": "channel-based", "signal-updates": "always" } }, { "time-source": "internal-realtime" }, { "time-source": "internal-scaled", "time-scaling-factor": 6 } ] } }, "f9fcb": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Variables", "description": "List of variables to be used in this configuration file.", "type": "array", "items": { "$ref": "#/definitions/03ea7/full" }, "examples": [ [ { "name": "var", "value": -42 } ], [ { "name": "my_string", "value": "implicit-type" }, { "name": "var", "value": 422200000000.0, "type": "float" }, { "name": "path_var", "value": "path/to/somewhere", "type": "path" }, { "name": "uint_enum", "value": 43, "type": "uint", "options": [1, 43, 127] } ] ] } }, "90d4b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Application Models", "description": "List of application models representing some program. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/8e790/full" }, "examples": [ [ { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"] } ] ] } }, "015cb": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Datasources", "description": "The definition of datasources used by application models. Input files can be deactivated with when.", "type": "object", "additionalProperties": false, "properties": { "input-files": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/b88a6/full" } } } } }, "examples": [ { "input-files": [ { "file-path": "path/to/my.vcdl" } ] }, { "input-files": [ { "file-path": [ "path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}" ] } ] }, { "input-files": [ { "file-path": "path/to/my.vcdl", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } ] } }, "f276a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Functional mockup units", "description": "List of functional mockup units. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/37850/full" }, "examples": [ [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001 } ], [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": true } ], [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "active-model-variables": ["Variable1", "Variable2"] } ], [ { "file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "inactive-model-variables": ["Variable3"] } ] ] } }, "37df6": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "SIL Kit", "description": "SIL Kit settings. Entry can be deactivated with when.", "type": "object", "additionalProperties": false, "required": ["participant-name"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "registry-uri": { "description": "registry URI", "type": "string", "anyOf": [ { "pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["silkit://localhost:8500"] }, "participant-name": { "description": "Name used by CANoe4SW to join a simulation as a participant at the start of a measurement.", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["CANoe4SW"] }, "config-file-path": { "$ref": "#/definitions/c9f2a/full" }, "simulation-step-in-micro-sec": { "description": "Time length of a single simulation step. Valid only for the time-source \"external-software\". Default: 100 us.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 100 }, { "$ref": "#/definitions/779cd/full" } ] }, "life-cycle-event-timeout-in-sec": { "description": "Maximum waiting time for the other simulation participants. Valid only for the time-source \"external-software\". Default: 30s.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 30 }, { "$ref": "#/definitions/779cd/full" } ] } }, "examples": [ { "registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW", "config-file-path": "path/to/config-file.json" }, { "registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150 }, { "registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150, "life-cycle-event-timeout-in-sec": 30 } ] } }, "05c88": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "XCP files", "description": "List of XCP configuration files (entries can be deactivated with when)", "type": "array", "items": { "$ref": "#/definitions/31be0/full" }, "examples": [ [ { "file-path": "path/to/my.xcpcfg" } ], [ { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my.xcpcfg", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "e94dc": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Logging Block", "description": "Configuration of the standalone logging block.", "type": "object", "additionalProperties": false, "required": ["file-name"], "properties": { "file-name": { "$ref": "#/definitions/799e1/full" }, "logging-events": { "type": "array", "default": [ "bus", "diagnostic", "internal", "statistic", "system-variable", "test" ], "items": { "anyOf": [ { "type": "string", "enum": [ "bus", "diagnostic", "internal", "statistic", "system-variable", "test" ] }, { "$ref": "#/definitions/779cd/full" } ] } }, "advanced": { "$ref": "#/definitions/c55d3/full" } }, "examples": [ { "file-name": "file-name.blf", "logging-events": [ "bus", "diagnostic", "internal", "${someVariable}" ], "advanced": { "warn-overwritten-log-file": true, "show-error-on-data-loss": false } } ] } }, "8ab30": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Nodes", "description": "A list of simulation nodes used in a simulation. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/796db/full" }, "examples": [ [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ] } ], [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name1\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "network-assignments": [ { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" } } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": [ "modeling/lib/1.vmodule", "${path_in_var}" ], "when": "SCENARIO_NAME == \"my_scenario_name2\"" } ] ] } }, "13e53": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Databases", "description": "List of databases. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/3071b/full" }, "examples": [ [ { "name": "mydbname", "file-path": "path/to/some.dbc" } ], [ { "name": "mydbname", "file-path": "path/to/some.dbc" }, { "name": "mydbname", "file-path": "path/to/some.arxml", "network-name": "network_in_db" }, { "name": "mydbname", "file-path": "path/to/some.dbc", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "828be": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Networks", "description": "List of CAN networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/fe7b6/full" }, "examples": [ [ { "name": "my_can_network" } ], [ { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator", "when": "SCENARIO_NAME == \"another_scenario\"" } ] ] } }, "9dce0": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD Networks", "description": "List of CANFD networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/d92db/full" }, "examples": [ [ { "name": "my_canfd_network" } ], [ { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator" } ] ] } }, "bf025": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Networks", "description": "List of Ethernet networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/69b41/full" }, "examples": [ [ { "name": "my_eth_network" } ], [ { "name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_eth_network", "databases": ["DB_1", "DB_2"], "application-channel": 12, "tcp-ip-stack-adapter": { "mac-address": "02:84:cf:3b:be:01" }, "mapping": "external-sil-kit" }, { "name": "my_eth_network", "databases": ["DB_1", "DB_2"], "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": { "mtu": 1500, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.1", "subnet-mask": "255.255.0.0" } ] }, "ipv6-settings": { "address-configuration": "dhcp" }, "vlans": [ { "id": 42, "priority": 0 } ] } } ] ] } }, "55701": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Replay Blocks", "description": "List of CAN replay blocks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/77df9/full" }, "examples": [ [ { "name": "my_can_replay_block", "file-path": "my_logging_file.blf" } ], [ { "name": "my_can_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\"" } ] ] } }, "a5fab": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Ethernet Replay Blocks", "description": "List of ethernet replay blocks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/3cca7/full" }, "examples": [ [ { "name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf" } ], [ { "name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_ethernet_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\"" } ] ] } }, "d1a67": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Scenarios", "description": "List of scenarios with the option to define / override variables or defines.", "type": "array", "items": { "$ref": "#/definitions/4909e/full" }, "examples": [ [ { "name": "my_scenario_name" } ], [ { "name": "my_scenario_name" }, { "name": "override_variables", "variables": [ { "name": "three", "value": 3 } ] }, { "name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"] } ] ] } }, "dad40": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.", "const": "1.1.0", "type": "string", "examples": ["1.1.0"] } }, "0e921": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.", "const": "1.0.0", "type": "string", "examples": ["1.0.0"] } }, "6c391": { "local": { "one": { "type": "string", "pattern": "\\.([Yy][Aa][Mm][Ll]|[Jj][Ss][Oo][Nn])$" } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Include files", "description": "Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.", "oneOf": [ { "$ref": "#/definitions/6c391/local/one" }, { "type": "array", "items": { "$ref": "#/definitions/6c391/local/one" } } ], "examples": [ "my_include.yaml", ["my_include.yaml", "my_other_include.json"] ] } }, "497d3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Application Models", "description": "List of application models representing some program. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/51b90/full" }, "examples": [ [ { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"] } ] ] } }, "16f14": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Defines", "description": "List of defines to be passed to capl / vcdl. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/cd5c2/full" }, "examples": [ [ { "define": "mydefine1" } ], [ { "define": ["mydefine1", "mydefine2"] }, { "define": ["mydefine1", "mydefine2"], "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "define": [ "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] } ] ] } }, "c706a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Nodes", "description": "A list of simulation nodes used in a simulation. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/86b88/full" }, "examples": [ [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ] } ], [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "network-assignments": [ { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" }, "modeling-libraries": ["modeling/lib/2.dll"] } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.dll", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] ] } }, "79d04": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN Networks", "description": "List of CAN networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/00571/full" }, "examples": [ [ { "name": "my_can_network" } ], [ { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "baudrate": 500000 } ] ] } }, "252f0": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD Networks", "description": "List of CANFD networks. Entries can be deactivated with when.", "type": "array", "items": { "$ref": "#/definitions/b0b65/full" }, "examples": [ [ { "name": "my_canfd_network" } ], [ { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000 } ] ] } }, "79a89": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Scenarios", "description": "List of scenarios with the option to define / override variables or defines.", "type": "array", "items": { "$ref": "#/definitions/d12ef/full" }, "examples": [ [ { "name": "my_scenario_name" } ], [ { "name": "my_scenario_name" }, { "name": "override_variables", "variables": [ { "name": "three", "value": 3 } ] }, { "name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"] } ] ] } }, "9b42a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Scenario", "description": "A scenario with the option to define / override variables or defines.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "not": { "const": "Default" } }, "variables": { "$ref": "#/definitions/57928/full" }, "defines": { "$ref": "#/definitions/f52d1/full" } }, "examples": [ { "name": "my_scenario_name" }, { "name": "override_variables", "variables": [ { "name": "three", "value": 3 } ] }, { "name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"] } ] } }, "ce2b5": { "local": { "name": { "type": "string", "description": "A C-identifier for this variable (case sensitive).", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "allOf": [ { "not": { "pattern": "^[cC][aA][nN][oO][eE]_.*$" } }, { "not": { "pattern": "^[aA][nN][dD]$" } }, { "not": { "pattern": "^[aA][sS]$" } }, { "not": { "pattern": "^[aA][sS][sS][eE][rR][tT]$" } }, { "not": { "pattern": "^[bB][oO][oO][lL]$" } }, { "not": { "pattern": "^[bB][rR][eE][aA][kK]$" } }, { "not": { "pattern": "^[cC][aA][sS][eE]$" } }, { "not": { "pattern": "^[cC][aA][tT][cC][hH]$" } }, { "not": { "pattern": "^[cC][lL][aA][sS][sS]$" } }, { "not": { "pattern": "^[cC][oO][nN][tT][iI][nN][uU][eE]$" } }, { "not": { "pattern": "^[dD][eE][fF]$" } }, { "not": { "pattern": "^[dD][eE][lL][eE][tT][eE]$" } }, { "not": { "pattern": "^[eE][lL][iI][fF]$" } }, { "not": { "pattern": "^[eE][lL][sS][eE]$" } }, { "not": { "pattern": "^[eE][xX][cC][eE][pP][tT]$" } }, { "not": { "pattern": "^[fF][aA][lL][sS][eE]$" } }, { "not": { "pattern": "^[fF][iI][nN][aA][lL][lL][yY]$" } }, { "not": { "pattern": "^[fF][lL][oO][aA][tT]$" } }, { "not": { "pattern": "^[fF][oO][rR]$" } }, { "not": { "pattern": "^[fF][rR][oO][mM]$" } }, { "not": { "pattern": "^[gG][lL][oO][bB][aA][lL]$" } }, { "not": { "pattern": "^[iI][fF]$" } }, { "not": { "pattern": "^[iI][mM][pP][oO][rR][tT]$" } }, { "not": { "pattern": "^[iI][nN]$" } }, { "not": { "pattern": "^[iI][nN][tT]$" } }, { "not": { "pattern": "^[iI][nN][tT][eE][gG][eE][rR]$" } }, { "not": { "pattern": "^[iI][sS]$" } }, { "not": { "pattern": "^[lL][oO][nN][gG]$" } }, { "not": { "pattern": "^[nN][oO][nN][eE]$" } }, { "not": { "pattern": "^[nN][oO][tT]$" } }, { "not": { "pattern": "^[oO][rR]$" } }, { "not": { "pattern": "^[pP][aA][sS][sS]$" } }, { "not": { "pattern": "^[rR][aA][iI][sS][eE]$" } }, { "not": { "pattern": "^[rR][eE][tT][uU][rR][nN]$" } }, { "not": { "pattern": "^[sS][cC][eE][nN][aA][rR][iI][oO]_[nN][aA][mM][eE]$" } }, { "not": { "pattern": "^[sS][eE][lL][fF]$" } }, { "not": { "pattern": "^[sS][tT][rR][uU][cC][tT]$" } }, { "not": { "pattern": "^[sS][wW][iI][tT][cC][hH]$" } }, { "not": { "pattern": "^[tT][hH][iI][sS]$" } }, { "not": { "pattern": "^[tT][rR][uU][eE]$" } }, { "not": { "pattern": "^[tT][rR][yY]$" } }, { "not": { "pattern": "^[uU][iI][nN][tT]$" } }, { "not": { "pattern": "^[uU][nN][sS][iI][gG][nN][eE][dD]$" } }, { "not": { "pattern": "^[vV][oO][iI][dD]$" } }, { "not": { "pattern": "^[wW][hH][iI][lL][eE]$" } }, { "not": { "pattern": "^[wW][iI][tT][hH]$" } }, { "not": { "pattern": "^[xX][oO][rR]$" } }, { "not": { "pattern": "^[yY][iI][eE][lL][dD]$" } } ], "examples": ["my_var"] }, "from-environment": { "type": "boolean", "description": "Take the value from a system environment variable.", "default": false } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Variable", "description": "This variable can be used in any other node and overwritten by a scenario.", "type": "object", "$comment": "has to be split, since the type determines the valid values", "oneOf": [ { "$comment": "type implicit", "additionalProperties": false, "required": ["value", "name"], "description": "Variable of type implicit type (string, number or bool).", "properties": { "name": { "$ref": "#/definitions/ce2b5/local/name" }, "from-environment": { "$ref": "#/definitions/ce2b5/local/from-environment" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number", "$comment": "disable-check:no-missing-number-limits" }, { "type": "boolean" } ] } } }, { "$comment": "type int", "additionalProperties": false, "required": ["type", "name"], "description": "Variable of type integer.", "properties": { "name": { "$ref": "#/definitions/ce2b5/local/name" }, "from-environment": { "$ref": "#/definitions/ce2b5/local/from-environment" }, "value": { "$ref": "#/definitions/c49a5/full" }, "type": { "const": "int" }, "options": { "type": "array", "items": { "$ref": "#/definitions/c49a5/full" } } } }, { "$comment": "type uint", "additionalProperties": false, "required": ["type", "name"], "description": "Variable of type unsigned integer.", "properties": { "name": { "$ref": "#/definitions/ce2b5/local/name" }, "from-environment": { "$ref": "#/definitions/ce2b5/local/from-environment" }, "value": { "$ref": "#/definitions/39ed5/full" }, "type": { "const": "uint" }, "options": { "type": "array", "items": { "$ref": "#/definitions/39ed5/full" } } } }, { "$comment": "type string / path", "additionalProperties": false, "required": ["type", "name"], "description": "Variable of type string or path.", "properties": { "name": { "$ref": "#/definitions/ce2b5/local/name" }, "from-environment": { "$ref": "#/definitions/ce2b5/local/from-environment" }, "value": { "type": "string" }, "type": { "enum": ["string", "path"] }, "options": { "type": "array", "items": { "type": "string" } } } }, { "$comment": "type boolean", "additionalProperties": false, "required": ["type", "name"], "description": "Variable of type bool.", "properties": { "name": { "$ref": "#/definitions/ce2b5/local/name" }, "from-environment": { "$ref": "#/definitions/ce2b5/local/from-environment" }, "value": { "type": "boolean" }, "type": { "const": "bool" }, "options": { "type": "array", "items": { "type": "boolean" } } } }, { "$comment": "type float", "additionalProperties": false, "required": ["type", "name"], "description": "Variable of type float.", "properties": { "name": { "$ref": "#/definitions/ce2b5/local/name" }, "from-environment": { "$ref": "#/definitions/ce2b5/local/from-environment" }, "value": { "$ref": "#/definitions/f26f2/full" }, "type": { "const": "float" }, "options": { "type": "array", "items": { "$ref": "#/definitions/f26f2/full" } } } } ], "examples": [ { "name": "var", "value": -42 }, { "name": "my_string", "value": "implicit-type" }, { "name": "var", "value": 422200000000.0, "type": "float" }, { "name": "path_var", "value": "path/to/somewhere", "type": "path" }, { "name": "uint_enum", "value": 43, "type": "uint", "options": [1, 43, 127] } ] } }, "9d23c": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Define", "description": "Defines to be passed to capl / vcdl.", "type": "object", "additionalProperties": false, "required": ["define"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "define": { "anyOf": [ { "$ref": "#/definitions/d6fe8/full" }, { "$ref": "#/definitions/f52d1/full" } ] } }, "examples": [ { "define": "mydefine1" }, { "define": ["mydefine1", "mydefine2"] }, { "define": ["mydefine1", "mydefine2"], "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "define": [ "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] } ] } }, "cdf60": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global settings for Ethernet", "type": "object", "properties": { "access-mode": { "description": "Mode of the underlying Ethernet bus. Classic approach is the 'Channel-based' setup. More recent and recommended mode is the switched 'Network-based' mode (port based).", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "string", "enum": ["network-based", "channel-based"], "default": "network-based" } ], "examples": ["network-based", "channel-based"] }, "signal-updates": { "description": "Specifies how signals are updated on Network-based access. Will be ignored on Channel-based setups. Always: Events of all ports are used to update a signal without qualified ethernet port. rx-only: Only packets received by the interface are used, which leads to less duplicated updates. never: Signals without qualified ethernet ports are not updated.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "const": "always", "description": "Events of all ports are used to update a signal without qualified ethernet port." }, { "const": "rx-only", "description": "Only packets received by the interface are used, which leads to less duplicated updates." }, { "const": "never", "description": "Signals without qualified ethernet ports are not updated." } ], "examples": ["always", "rx-only", "never"] }, "tcp-ip-stack": { "$ref": "#/definitions/56b2f/full" } }, "additionalProperties": false, "examples": [ { "access-mode": "network-based" }, { "access-mode": "channel-based", "signal-updates": "always" }, { "signal-updates": "rx-only" }, { "signal-updates": "never" } ] } }, "70a7b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global settings for FlexRay", "description": "These settings control the interpretation of frames and PDUs of FlexRay configurations with channels A and B.", "type": "object", "additionalProperties": false, "properties": { "enable-dual-channel-support": { "description": "If active, PDUs on both channels will be configured with channel mask 'AB' and channel postfixes (e.g. xy_Ch_A, xy_Ch_B) will be created for ambiguous objects.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "boolean" } ], "default": true }, "postfixes-for-ambiguous-pdus-on-channel": { "description": "Definition of postfix settings if dual channel support is not activated.", "oneOf": [ { "enum": ["A", "B", "A&B", "no-postfixes"] }, { "$ref": "#/definitions/779cd/full" } ], "default": "A&B" } }, "allOf": [ { "if": { "required": ["enable-dual-channel-support"], "properties": { "enable-dual-channel-support": { "const": true } } }, "then": { "properties": { "postfixes-for-ambiguous-pdus-on-channel": false } } }, { "if": { "required": ["enable-dual-channel-support"], "properties": { "enable-dual-channel-support": { "const": false } } }, "then": { "required": ["postfixes-for-ambiguous-pdus-on-channel"], "properties": { "postfixes-for-ambiguous-pdus-on-channel": true } } } ], "examples": [ { "enable-dual-channel-support": true }, { "enable-dual-channel-support": false, "postfixes-for-ambiguous-pdus-on-channel": "no-postfixes" } ] } }, "3dd98": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global settings for database", "type": "object", "additionalProperties": false, "properties": { "autosar-pdu-layer": { "default": "from-autosar-4.2", "description": "Configure the PDU layer in relation to AUTOSAR databases.\n'no-pdus' : Creation of frames only \n'from-autosar-4.0' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.0 \n'from-autosar-4.2' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.2 ", "anyOf": [ { "type": "string", "enum": ["no-pdus", "from-autosar-4.0", "from-autosar-4.2"], "examples": ["no-pdus", "from-autosar-4.0", "from-autosar-4.2"] }, { "$ref": "#/definitions/779cd/full" } ] }, "autosar-text-table-entries": { "description": "Control naming of text table entries and influence signal qualification. Use text from COMPU-CONST nodes or SHORT-LABEL nodes.", "default": "compu-const", "anyOf": [ { "type": "string", "enum": ["compu-const", "short-label"], "examples": ["compu-const", "short-label"] }, { "$ref": "#/definitions/779cd/full" } ] }, "some-ip-pdus-without-service-context": { "description": "Control the generation of services for SOME/IP PDUs without service context.", "default": "ignore", "oneOf": [ { "type": "string", "enum": ["ignore", "generate-service"], "examples": ["ignore", "generate-service"] }, { "$ref": "#/definitions/779cd/full" } ] } }, "examples": [ { "autosar-pdu-layer": "no-pdus" }, { "autosar-text-table-entries": "compu-const" }, { "some-ip-pdus-without-service-context": "generate-service" }, { "autosar-pdu-layer": "no-pdus", "autosar-text-table-entries": "short-label", "some-ip-pdus-without-service-context": "generate-service" } ] } }, "779cd": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "pattern": "\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}", "examples": ["${myvarname}"] } }, "21f87": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "System variables", "description": "Absolute or relative path to an external file containing system variables. Relative path specifications are resolved relative to the defining configuration file.", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "anyOf": [ { "$ref": "#/definitions/dc7e6/full" }, { "type": "array", "items": { "$ref": "#/definitions/dc7e6/full" } } ] } }, "examples": [ { "file-path": "path/to/my.vsysvar" }, { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my.vsysvar", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "8d374": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Database", "description": "Absolute or relative path to an external database file (.dbc / .ldf / ...). Relative path specifications are resolved relative to the defining configuration file.", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "network-name": { "type": "string", "description": "Select a network from the database (cluster name if .arxml). If selected, 'name' must match 'network-name'." }, "file-path": { "$ref": "#/definitions/5349d/full" } }, "examples": [ { "name": "mydbname", "file-path": "path/to/some.dbc" }, { "name": "mydbname", "file-path": "path/to/some.arxml", "network-name": "network_in_db" }, { "name": "mydbname", "file-path": "path/to/some.dbc", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "ce8a4": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN network", "description": "A Network using the CAN protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "baudrate": { "description": "Baudrate of this CAN bus. \n If this value is set, it has priority. \n If this value is not set, the baudrate is read from the database. If the baudrate is missing from the database, the default value is used.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2000000, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the application channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the application channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/ad271/full" } }, "examples": [ { "name": "my_can_network" }, { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "database": "DB_1", "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator" } ] } }, "f1384": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD network", "description": "A Network using the CANFD protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "mode": { "description": "Operation Mode setting (iso or non-iso Mode).", "anyOf": [ { "type": "string", "enum": ["iso", "non-iso"], "default": "iso" }, { "$ref": "#/definitions/779cd/full" } ] }, "arbitration-baudrate": { "description": "Baudrate for the arbitration phase of CAN FD in Baud. \n If this value is set, it has priority. \n If this value is not set, the baudrate is read from the database. If the baudrate is missing from the database, the default value is used.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2000000, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "data-baudrate": { "description": "Baudrate for the data phase of CAN FD. \n If this value is set, it has priority. \n If this value is not set, the baudrate is read from the database. If the baudrate is missing from the database, the default value is used.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 10000000, "default": 1000000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the application channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the application channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/ad271/full" } }, "oneOf": [ { "required": ["arbitration-baudrate", "data-baudrate"], "properties": { "arbitration-baudrate": true, "data-baudrate": true } }, { "properties": { "arbitration-baudrate": false, "data-baudrate": false } } ], "examples": [ { "name": "my_canfd_network" }, { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "database": "DB_2", "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator" } ] } }, "f146b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Ethernet network", "description": "A Network using the Ethernet protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "tcp-ip-stack-adapter": { "$ref": "#/definitions/bd6e5/full" }, "mapping": { "$ref": "#/definitions/ad271/full" }, "application-channel": { "description": "Index of the application channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "integer", "minimum": 1, "maximum": 32 } ] } }, "examples": [ { "name": "my_eth_network" }, { "name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "tcp-ip-stack-adapter": { "mac-address": "02:84:cf:3b:be:01" }, "mapping": "external-sil-kit" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": { "mtu": 1500, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.1", "subnet-mask": "255.255.0.0" } ] }, "ipv6-settings": { "address-configuration": "dhcp" }, "vlans": [ { "id": 42, "priority": 0 } ] } } ] } }, "d89e9": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "FlexRay cluster", "description": "A cluster using the FlexRay protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name", "database"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "application-channel": { "description": "Index of the Application Channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 32, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/ad271/full" }, "key-slot-configuration": { "$ref": "#/definitions/801ff/full" } }, "examples": [ { "name": "my_flexray_cluster", "database": "DB_1" }, { "name": "my_flexray_cluster", "when": "SCENARIO_NAME == \"my_scenario_name\"", "database": "FR_DB" }, { "name": "my_flexray_cluster", "database": "DB_1", "application-channel": 12, "mapping": "internal-simulator", "key-slot-configuration": { "slot-1": { "mode": "manual", "usage": "startup", "mask": "A", "slot": 1, "leading-cold-start": true }, "slot-2": { "mode": "automatic" } } } ] } }, "3a966": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "LIN network", "description": "A network using the LIN protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "application-channel": { "description": "Index of the application channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 64. Value '0' is not allowed.", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/ad271/full" }, "mode": { "description": "Working mode of the LIN interface.", "anyOf": [ { "const": "commander", "description": "The LIN network interface is able to output message headers on the network." }, { "const": "responder", "description": "The LIN network interface responds to received LIN headers if a response to the LIN ID contained within the header has been configured." }, { "$ref": "#/definitions/779cd/full" } ], "default": "commander", "examples": ["commander", "responder"] } }, "examples": [ { "name": "my_lin_network" }, { "name": "my_lin_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_lin_network", "database": "DB_1", "application-channel": 42, "mapping": "internal-simulator", "mode": "responder" } ] } }, "a6ab3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Node", "description": "Represents a simulation node used in a simulation", "type": "object", "additionalProperties": false, "required": ["name", "network-assignments"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/a19ff/full" }, "network-assignments": { "$ref": "#/definitions/d0551/full" }, "defines": { "$ref": "#/definitions/f52d1/full" }, "database-node": { "description": "Use to assign explicitely a database node to a simulation node. If not set, the simulation-node name will be used as database-node. To deactivate automatic assignement, it should be set to false.", "anyOf": [ { "type": "boolean", "default": true }, { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": [false, true, "aDatabaseNodeName", "${var_with_path}"] }, "modeling-libraries": { "type": "array", "items": { "$ref": "#/definitions/172e4/full" }, "description": "For assignment of modeling libraries to this simulation node." }, "tcp-ip-stack": { "$ref": "#/definitions/6a522/full" } }, "examples": [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": true, "network-assignments": [ { "network": "my_can_network_1" } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.vmodule", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": false, "network-assignments": [ { "network": "my_can_network_1" } ] }, { "name": "otherNameThanInDb", "file-path": "path/to/my_dotnet.cs", "database-node": "nameFromDB", "network-assignments": [ { "network": "my_can_network_1" } ] } ] } }, "09e40": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Declares when to add this node.", "anyOf": [ { "type": "string", "$comment": "impossible to express this grammar as a regex" }, { "type": "boolean" } ], "examples": [ "SCENARIO_NAME == \"my_scenario_name\"", "some_variable == \"somevalue\"", "some_int_variable > 42 && some_other_int_variable <= 42", true ] } }, "b88a6": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [ { "$ref": "#/definitions/4de3d/full" }, { "type": "array", "items": { "$ref": "#/definitions/4de3d/full" }, "examples": [ ["path/to/my.vcdl"], ["path/to/my.vcodm"], [ "path/to/my.vcdl", "path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}" ] ] } ], "examples": [ "path/to/my.vcdl", ["path/to/my.vcodm"], [ "path/to/my.vcdl", "path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}" ] ] } }, "f52d1": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "List of defines to be passed to capl / vcdl.", "type": "array", "items": { "$ref": "#/definitions/d6fe8/full" }, "examples": [ ["mydefine1", "mydefine2"], [ "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] ] } }, "4b905": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Application Model", "description": "Represents an application used in a scenario", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/b8a7b/full" }, "defines": { "$ref": "#/definitions/f52d1/full" } }, "examples": [ { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"] }, { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"], "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "c3b11": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Programming modules", "description": "Programming modules file paths (capl-library or c-library). Entry can be deactivated with when.", "type": "object", "additionalProperties": false, "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "capl-library-path": { "anyOf": [ { "$ref": "#/definitions/81bab/full" }, { "type": "array", "items": { "$ref": "#/definitions/81bab/full" } } ] }, "c-library-path": { "anyOf": [ { "$ref": "#/definitions/81bab/full" }, { "type": "array", "items": { "$ref": "#/definitions/81bab/full" } } ] } } } }, "4aae7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "User files", "description": "Absolute or relative path to user files that can be read/written by CAPL/.NET Scripts. Relative path specifications are resolved relative to the defining configuration file.", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "anyOf": [ { "type": "string", "examples": [ "path/to/my.txt", "${path_in_variable}", "path/${name_in_variable}" ] }, { "type": "array", "items": { "type": "string" }, "examples": [ ["path/to/my.txt"], ["${path_in_variable}", "path/${name_in_variable}"] ] } ] } }, "examples": [ { "file-path": "path/to/my.txt" }, { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my_file.ini", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "375dd": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "XCP files", "description": "Absolute or relative path to an external xcpcfg file. Relative path specifications are resolved relative to the defining configuration file.", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "anyOf": [ { "anyOf": [ { "$ref": "#/definitions/568cc/full" }, { "$ref": "#/definitions/a220f/full" } ] }, { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/568cc/full" }, { "$ref": "#/definitions/a220f/full" } ] } } ] } }, "examples": [ { "file-path": "path/to/my.xcpcfg" }, { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my.xcpcfg", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "42d39": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a FDX description file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[xX][mM][lL]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/myDescriptionFile.xml", "${path_in_variable}", "path/${name_in_variable}" ] } }, "dfa5a": { "local": { "stepsize-in-sec": { "description": "Step size in seconds.", "anyOf": [ { "type": "number", "minimum": 0, "maximum": 10000 }, { "$ref": "#/definitions/779cd/full" } ], "examples": [0, 0.0005, 10000, "${var_with_path}"] }, "debug-output": { "description": "Is the debug output active.", "anyOf": [ { "type": "boolean", "default": false }, { "$ref": "#/definitions/779cd/full" } ], "examples": [false, true, "${var_with_path}"] }, "active-model-variables": { "description": "List of the FMU variables which should be exported", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["Variable1", "${var_with_path}"] } }, "inactive-model-variables": { "description": "List of the FMU variables which should be excluded from the export", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["Variable1", "${var_with_path}"] } } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Functional mockup unit", "description": "Represents a functional mockup unit used in a scenario.", "type": "object", "anyOf": [ { "additionalProperties": false, "required": ["file-path", "stepsize-in-sec"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/8af01/full" }, "stepsize-in-sec": { "$ref": "#/definitions/dfa5a/local/stepsize-in-sec" }, "debug-output": { "$ref": "#/definitions/dfa5a/local/debug-output" } } }, { "additionalProperties": false, "required": [ "file-path", "stepsize-in-sec", "active-model-variables" ], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/8af01/full" }, "stepsize-in-sec": { "$ref": "#/definitions/dfa5a/local/stepsize-in-sec" }, "debug-output": { "$ref": "#/definitions/dfa5a/local/debug-output" }, "active-model-variables": { "$ref": "#/definitions/dfa5a/local/active-model-variables" } } }, { "additionalProperties": false, "required": [ "file-path", "stepsize-in-sec", "inactive-model-variables" ], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/8af01/full" }, "stepsize-in-sec": { "$ref": "#/definitions/dfa5a/local/stepsize-in-sec" }, "debug-output": { "$ref": "#/definitions/dfa5a/local/debug-output" }, "inactive-model-variables": { "$ref": "#/definitions/dfa5a/local/inactive-model-variables" } } } ] } }, "c9f2a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a SIL Kit config file (.yaml or .json). Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[yY][aA][mM][lL]$" }, { "pattern": "^.*\\.[jJ][sS][oO][nN]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/myConfigFile.json", "path/to/myConfigFile.yaml", "${path_in_variable}", "path/${name_in_variable}" ] } }, "799e1": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Name of a blf file, supporting the field codes: {ComputerName}, {LocalTime}, {MeasurementIndex}, {MeasurementStart}, {IncSize|001|100MB} and {IncTime|001|01h00m}.", "type": "string", "anyOf": [ { "pattern": "^(?!.*(\\{TriggerCondition\\}|\\{LoggingBlock\\}|\\{IncMeasurement\\}|\\{ConfigName\\}|\\{IncTrigger\\|[0-9]*\\}|[\"<>*?:/\\\\])).*\\.[bB][lL][fF]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "$comment": "|<|>", "examples": [ "fileName.blf", "file_${SCENARIO_NAME}.blf", "${name_in_variable}", "log_{ComputerName}.blf", "log_{LocalTime}.blf", "log_{MeasurementIndex}.blf", "log_{MeasurementStart}.blf" ] } }, "a53a3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Advanced logging configurations.", "type": "object", "additionalProperties": false, "properties": { "warn-overwritten-log-file": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/779cd/full" } ], "default": true }, "show-error-on-data-loss": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/779cd/full" } ], "default": true } }, "examples": [ { "warn-overwritten-log-file": false, "show-error-on-data-loss": true }, { "warn-overwritten-log-file": true } ] } }, "1934a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN replay block", "description": "A replay block for the CAN protocol.", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/79394/full" }, "replay-on-measurement-start": { "description": "Replay starts with measurement start.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "send-system-variables": { "description": "Send system variable values.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "start-timing-condition": { "$ref": "#/definitions/0a52d/full" }, "channel-mapping": { "$ref": "#/definitions/8451c/full" }, "send-tx-messages": { "description": "Replay the tx messages.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "send-rx-messages": { "description": "Replay the rx messages.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] } }, "examples": [ { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "when": "SCENARIO_NAME == \"MyScenario\"" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "replay-on-measurement-start": true, "send-system-variables": false, "send-tx-messages": true, "send-rx-messages": false, "start-timing-condition": { "condition": "immediately" }, "channel-mapping": { "default-mapping": "as-in-original" } } ] } }, "5f17a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Ethernet replay block", "description": "A replay block for the ethernet protocol.", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/79394/full" }, "replay-on-measurement-start": { "description": "Replay starts with measurement start", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "send-system-variables": { "description": "Send system variable values.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "start-timing-condition": { "$ref": "#/definitions/0a52d/full" }, "channel-mapping": { "$ref": "#/definitions/8451c/full" } }, "examples": [ { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "when": "SCENARIO_NAME == \"MyScenario\"" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "replay-on-measurement-start": true, "send-system-variables": false, "start-timing-condition": { "condition": "immediately" }, "channel-mapping": { "default-mapping": "as-in-original" } } ] } }, "aebb7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "LIN replay block", "description": "A replay block for the LIN protocol.", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/79394/full" }, "replay-on-measurement-start": { "description": "Replay starts with measurement start", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "send-system-variables": { "description": "Send system variable values.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "start-timing-condition": { "$ref": "#/definitions/0a52d/full" }, "channel-mapping": { "$ref": "#/definitions/8451c/full" }, "replay-mode": { "description": "Select events to be replayed. \n'all-responses': replay all the responses.\n'master-responses-only': replay the responses only for frames published by the Master node.\n'master-requests-only': replay only 0x3c responses.\n'no-headers': disable replay of the LIN frame headers.", "default": "all-responses", "anyOf": [ { "type": "string", "enum": [ "all-responses", "master-responses-only", "master-requests-only", "no-headers" ] }, { "$ref": "#/definitions/779cd/full" } ] }, "send-events": { "description": "Select which events from rx-responses, tx-responses and wakeup-signals are replayed. If not set, the default value depends on the value of replay-mode.\n For 'all-responses' or 'master-responses-only': all events are sent.\n For 'master-requests-only': only wakeup-events are sent.\n For 'no-headers': none of the events are sent.", "default": ["tx-responses", "rx-responses", "wakeup-signals"], "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": ["tx-responses", "rx-responses", "wakeup-signals"] }, { "$ref": "#/definitions/779cd/full" } ] } } ] } }, "examples": [ { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "when": "SCENARIO_NAME == \"MyScenario\"" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "replay-on-measurement-start": true, "send-system-variables": false, "start-timing-condition": { "condition": "immediately" }, "channel-mapping": { "default-mapping": "as-in-original" }, "replay-mode": "master-responses-only", "send-events": ["tx-responses", "rx-responses", "wakeup-signals"] } ] } }, "c18ab": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global settings for database", "type": "object", "properties": { "additionalProperties": false, "autosar-pdu-layer": { "default": "from-autosar-4.2", "description": "Configure the PDU layer in relation to AUTOSAR databases.\n'no-pdus' : Creation of frames only \n'from-autosar-4.0' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.0 \n'from-autosar-4.2' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.2 ", "anyOf": [ { "type": "string", "enum": ["no-pdus", "from-autosar-4.0", "from-autosar-4.2"], "examples": ["no-pdus", "from-autosar-4.0", "from-autosar-4.2"] }, { "$ref": "#/definitions/779cd/full" } ] }, "autosar-text-table-entries": { "description": "Control naming of text table entries and influence signal qualification. Use text from COMPU-CONST nodes or SHORT-LABEL nodes.", "default": "compu-const", "anyOf": [ { "type": "string", "enum": ["compu-const", "short-label"], "examples": ["compu-const", "short-label"] }, { "$ref": "#/definitions/779cd/full" } ] } }, "examples": [ { "autosar-pdu-layer": "no-pdus" }, { "autosar-text-table-entries": "compu-const" }, { "autosar-pdu-layer": "no-pdus", "autosar-text-table-entries": "short-label" } ] } }, "00f15": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Node", "description": "Represents a simulation node used in a simulation", "type": "object", "additionalProperties": false, "required": ["name", "network-assignments"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/a19ff/full" }, "network-assignments": { "$ref": "#/definitions/d0551/full" }, "defines": { "$ref": "#/definitions/f52d1/full" }, "database-node": { "description": "Use to assign explicitely a database node to a simulation node. If not set, the simulation-node name will be used as database-node. To deactivate automatic assignement, it should be set to false.", "anyOf": [ { "type": "boolean", "default": true }, { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": [false, true, "aDatabaseNodeName", "${var_with_path}"] }, "modeling-libraries": { "type": "array", "items": { "$ref": "#/definitions/b1f6d/full" }, "description": "For assignment of modeling libraries to this simulation node." }, "tcp-ip-stack": { "$ref": "#/definitions/6a522/full" } }, "examples": [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": true, "network-assignments": [ { "network": "my_can_network_1" } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.vmodule", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": false, "network-assignments": [ { "network": "my_can_network_1" } ] }, { "name": "otherNameThanInDb", "file-path": "path/to/my_dotnet.cs", "database-node": "nameFromDB", "network-assignments": [ { "network": "my_can_network_1" } ] } ] } }, "fe737": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN network", "description": "A Network using the CAN protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "baudrate": { "description": "Baudrate of this CAN bus.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2000000, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/ad271/full" } }, "examples": [ { "name": "my_can_network" }, { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "database": "DB_1", "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator" } ] } }, "077d5": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD network", "description": "A Network using the CANFD protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "mode": { "description": "Operation Mode setting (iso or non-iso Mode).", "anyOf": [ { "type": "string", "enum": ["iso", "non-iso"], "default": "iso" }, { "$ref": "#/definitions/779cd/full" } ] }, "arbitration-baudrate": { "description": "Baudrate for the arbitration phase of CAN FD in Baud.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2000000, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "data-baudrate": { "description": "Baudrate for the data phase of CAN FD.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 10000000, "default": 1000000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/ad271/full" } }, "examples": [ { "name": "my_canfd_network" }, { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "database": "DB_2", "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator" } ] } }, "fb03e": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Ethernet network", "description": "A Network using the Ethernet protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "tcp-ip-stack-adapter": { "$ref": "#/definitions/bd6e5/full" }, "mapping": { "$ref": "#/definitions/ad271/full" }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "integer", "minimum": 1, "maximum": 32 } ] } }, "examples": [ { "name": "my_eth_network" }, { "name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "tcp-ip-stack-adapter": { "mac-address": "02:84:cf:3b:be:01" }, "mapping": "external-sil-kit" }, { "name": "my_eth_network", "database": "DB", "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": { "mtu": 1500, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.1", "subnet-mask": "255.255.0.0" } ] }, "ipv6-settings": { "address-configuration": "dhcp" }, "vlans": [ { "id": 42, "priority": 0 } ] } } ] } }, "974c5": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "LIN network", "description": "A network using the LIN protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "database": { "$ref": "#/definitions/17e6a/full" }, "application-channel": { "description": "Index of the Application Channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 64. Value '0' is not allowed.", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/ad271/full" }, "mode": { "description": "Working mode of the LIN interface.", "anyOf": [ { "const": "commander", "description": "The LIN network interface is able to output message headers on the network." }, { "const": "responder", "description": "The LIN network interface responds to received LIN headers if a response to the LIN ID contained within the header has been configured." }, { "$ref": "#/definitions/779cd/full" } ], "default": "commander", "examples": ["commander", "responder"] } }, "examples": [ { "name": "my_lin_network" }, { "name": "my_lin_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_lin_network", "database": "DB_1", "application-channel": 42, "mapping": "internal-simulator", "mode": "responder" } ] } }, "843bf": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Global settings for Ethernet", "type": "object", "properties": { "access-mode": { "description": "Mode of the underlying Ethernet bus. Classic approach is the 'Channel-based' setup. More recent and recommended mode is the switched 'Network-based' mode (port based).", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "string", "enum": ["network-based", "channel-based"], "default": "network-based" } ] }, "signal-updates": { "description": "Specifies how signals are updated on Network-based access. Will be ignored on Channel-based setups. Always: Events of all ports are used to update a signal without qualified ethernet port. rx-only: Only packets received by the interface are used, which leads to less duplicated updates. never: Signals without qualified ethernet ports are not updated.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "const": "always", "description": "Events of all ports are used to update a signal without qualified ethernet port." }, { "const": "rx-only", "description": "Only packets received by the interface are used, which leads to less duplicated updates." }, { "const": "never", "description": "Signals without qualified ethernet ports are not updated." } ] }, "tcp-ip-stack": { "$ref": "#/definitions/b73a4/full" } }, "additionalProperties": false, "examples": [ { "access-mode": "network-based" }, { "access-mode": "channel-based", "signal-updates": "always" }, { "signal-updates": "rx-only" }, { "signal-updates": "never" } ] } }, "03ea7": { "local": { "name": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "allOf": [ { "not": { "pattern": "^[cC][aA][nN][oO][eE]_.*$" } }, { "not": { "pattern": "^[aA][nN][dD]$" } }, { "not": { "pattern": "^[aA][sS]$" } }, { "not": { "pattern": "^[aA][sS][sS][eE][rR][tT]$" } }, { "not": { "pattern": "^[bB][oO][oO][lL]$" } }, { "not": { "pattern": "^[bB][rR][eE][aA][kK]$" } }, { "not": { "pattern": "^[cC][aA][sS][eE]$" } }, { "not": { "pattern": "^[cC][aA][tT][cC][hH]$" } }, { "not": { "pattern": "^[cC][lL][aA][sS][sS]$" } }, { "not": { "pattern": "^[cC][oO][nN][tT][iI][nN][uU][eE]$" } }, { "not": { "pattern": "^[dD][eE][fF]$" } }, { "not": { "pattern": "^[dD][eE][lL][eE][tT][eE]$" } }, { "not": { "pattern": "^[eE][lL][iI][fF]$" } }, { "not": { "pattern": "^[eE][lL][sS][eE]$" } }, { "not": { "pattern": "^[eE][xX][cC][eE][pP][tT]$" } }, { "not": { "pattern": "^[fF][aA][lL][sS][eE]$" } }, { "not": { "pattern": "^[fF][iI][nN][aA][lL][lL][yY]$" } }, { "not": { "pattern": "^[fF][lL][oO][aA][tT]$" } }, { "not": { "pattern": "^[fF][oO][rR]$" } }, { "not": { "pattern": "^[fF][rR][oO][mM]$" } }, { "not": { "pattern": "^[gG][lL][oO][bB][aA][lL]$" } }, { "not": { "pattern": "^[iI][fF]$" } }, { "not": { "pattern": "^[iI][mM][pP][oO][rR][tT]$" } }, { "not": { "pattern": "^[iI][nN]$" } }, { "not": { "pattern": "^[iI][nN][tT]$" } }, { "not": { "pattern": "^[iI][nN][tT][eE][gG][eE][rR]$" } }, { "not": { "pattern": "^[iI][sS]$" } }, { "not": { "pattern": "^[lL][oO][nN][gG]$" } }, { "not": { "pattern": "^[nN][oO][nN][eE]$" } }, { "not": { "pattern": "^[nN][oO][tT]$" } }, { "not": { "pattern": "^[oO][rR]$" } }, { "not": { "pattern": "^[pP][aA][sS][sS]$" } }, { "not": { "pattern": "^[rR][aA][iI][sS][eE]$" } }, { "not": { "pattern": "^[rR][eE][tT][uU][rR][nN]$" } }, { "not": { "pattern": "^[sS][cC][eE][nN][aA][rR][iI][oO]_[nN][aA][mM][eE]$" } }, { "not": { "pattern": "^[sS][eE][lL][fF]$" } }, { "not": { "pattern": "^[sS][tT][rR][uU][cC][tT]$" } }, { "not": { "pattern": "^[sS][wW][iI][tT][cC][hH]$" } }, { "not": { "pattern": "^[tT][hH][iI][sS]$" } }, { "not": { "pattern": "^[tT][rR][uU][eE]$" } }, { "not": { "pattern": "^[tT][rR][yY]$" } }, { "not": { "pattern": "^[uU][iI][nN][tT]$" } }, { "not": { "pattern": "^[uU][nN][sS][iI][gG][nN][eE][dD]$" } }, { "not": { "pattern": "^[vV][oO][iI][dD]$" } }, { "not": { "pattern": "^[wW][hH][iI][lL][eE]$" } }, { "not": { "pattern": "^[wW][iI][tT][hH]$" } }, { "not": { "pattern": "^[xX][oO][rR]$" } }, { "not": { "pattern": "^[yY][iI][eE][lL][dD]$" } } ], "examples": ["my_var"] }, "from-environment": { "type": "boolean", "default": false } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Variable", "description": "This variable can be used in any other node and overwritten by a scenario.", "type": "object", "required": ["name"], "$comment": "has to be split, since the type determines the valid values", "oneOf": [ { "$comment": "type implicit", "additionalProperties": false, "required": ["value"], "properties": { "name": { "$ref": "#/definitions/03ea7/local/name" }, "from-environment": { "$ref": "#/definitions/03ea7/local/from-environment" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, { "$comment": "type int", "additionalProperties": false, "required": ["type"], "properties": { "name": { "$ref": "#/definitions/03ea7/local/name" }, "from-environment": { "$ref": "#/definitions/03ea7/local/from-environment" }, "value": { "type": "integer", "minimum": -9223372036854775808, "maximum": 9223372036854775807 }, "type": { "const": "int" }, "options": { "type": "array", "items": { "type": "integer", "minimum": -9223372036854775808, "maximum": 9223372036854775807 } } } }, { "$comment": "type uint", "additionalProperties": false, "required": ["type"], "properties": { "name": { "$ref": "#/definitions/03ea7/local/name" }, "from-environment": { "$ref": "#/definitions/03ea7/local/from-environment" }, "value": { "type": "integer", "minimum": 0, "maximum": 18446744073709551616 }, "type": { "const": "uint" }, "options": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 18446744073709551616 } } } }, { "$comment": "type string / path", "additionalProperties": false, "required": ["type"], "properties": { "name": { "$ref": "#/definitions/03ea7/local/name" }, "from-environment": { "$ref": "#/definitions/03ea7/local/from-environment" }, "value": { "type": "string" }, "type": { "enum": ["string", "path"] }, "options": { "type": "array", "items": { "type": "string" } } } }, { "$comment": "type boolean", "additionalProperties": false, "required": ["type"], "properties": { "name": { "$ref": "#/definitions/03ea7/local/name" }, "from-environment": { "$ref": "#/definitions/03ea7/local/from-environment" }, "value": { "type": "boolean" }, "type": { "const": "bool" }, "options": { "type": "array", "items": { "type": "boolean" } } } }, { "$comment": "type float", "additionalProperties": false, "required": ["type"], "properties": { "name": { "$ref": "#/definitions/03ea7/local/name" }, "from-environment": { "$ref": "#/definitions/03ea7/local/from-environment" }, "value": { "type": "number", "minimum": -1.79769e308, "maximum": 1.79769e308 }, "type": { "const": "float" }, "options": { "type": "array", "items": { "type": "number", "minimum": -1.79769e308, "maximum": 1.79769e308 } } } } ], "examples": [ { "name": "var", "value": -42 }, { "name": "my_string", "value": "implicit-type" }, { "name": "var", "value": 422200000000.0, "type": "float" }, { "name": "path_var", "value": "path/to/somewhere", "type": "path" }, { "name": "uint_enum", "value": 43, "type": "uint", "options": [1, 43, 127] } ] } }, "8e790": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Application Model", "description": "Represents an application used in a scenario", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/619f7/full" }, "defines": { "$ref": "#/definitions/f52d1/full" } }, "examples": [ { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"] }, { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"], "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "37850": { "local": { "stepsize-in-sec": { "description": "step size in seconds", "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1.79769e308 }, { "$ref": "#/definitions/779cd/full" } ], "examples": [0, 0.0005, 1568714585, "${var_with_path}"] }, "debug-output": { "description": "Are the debug outputs on", "anyOf": [ { "type": "boolean", "default": false }, { "$ref": "#/definitions/779cd/full" } ], "examples": [false, true, "${var_with_path}"] }, "active-model-variables": { "description": "List of the FMU variables which should be exported", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["Variable1", "${var_with_path}"] } }, "inactive-model-variables": { "description": "List of the FMU variables which should be excluded from the export", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["Variable1", "${var_with_path}"] } } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Functional mockup unit", "description": "Represents a functional mockup unit used in a scenario", "type": "object", "anyOf": [ { "additionalProperties": false, "required": ["file-path", "stepsize-in-sec"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/8af01/full" }, "stepsize-in-sec": { "$ref": "#/definitions/37850/local/stepsize-in-sec" }, "debug-output": { "$ref": "#/definitions/37850/local/debug-output" } } }, { "additionalProperties": false, "required": [ "file-path", "stepsize-in-sec", "active-model-variables" ], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/8af01/full" }, "stepsize-in-sec": { "$ref": "#/definitions/37850/local/stepsize-in-sec" }, "debug-output": { "$ref": "#/definitions/37850/local/debug-output" }, "active-model-variables": { "$ref": "#/definitions/37850/local/active-model-variables" } } }, { "additionalProperties": false, "required": [ "file-path", "stepsize-in-sec", "inactive-model-variables" ], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/8af01/full" }, "stepsize-in-sec": { "$ref": "#/definitions/37850/local/stepsize-in-sec" }, "debug-output": { "$ref": "#/definitions/37850/local/debug-output" }, "inactive-model-variables": { "$ref": "#/definitions/37850/local/inactive-model-variables" } } } ] } }, "31be0": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "XCP files", "description": "Absolute or relative path to an external xcpcfg file. Relative path specifications are resolved relative to the defining configuration file.", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "anyOf": [ { "$ref": "#/definitions/568cc/full" }, { "type": "array", "items": { "$ref": "#/definitions/568cc/full" } } ] } }, "examples": [ { "file-path": "path/to/my.xcpcfg" }, { "file-path": ["${path_in_variable}", "path/${name_in_variable}"] }, { "file-path": "path/to/my.xcpcfg", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "c55d3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Advanced logging configurations", "type": "object", "additionalProperties": false, "properties": { "warn-overwritten-log-file": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/779cd/full" } ], "default": true }, "show-error-on-data-loss": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/779cd/full" } ], "default": true } }, "examples": [ { "warn-overwritten-log-file": false, "show-error-on-data-loss": true }, { "warn-overwritten-log-file": true } ] } }, "796db": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Node", "description": "Represents a simulation node used in a simulation", "type": "object", "additionalProperties": false, "required": ["name", "network-assignments"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/a10be/full" }, "network-assignments": { "$ref": "#/definitions/f6782/full" }, "defines": { "$ref": "#/definitions/f52d1/full" }, "modeling-libraries": { "type": "array", "items": { "$ref": "#/definitions/b1f6d/full" }, "description": "For assignment of modeling libraries to this simulation node" }, "tcp-ip-stack": { "$ref": "#/definitions/dfa4a/full" } }, "examples": [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "network-assignments": [ { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" } } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.vmodule", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "3071b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Database", "description": "Absolute or relative path to an external database file (.dbc / .ldf / ...). Relative path specifications are resolved relative to the defining configuration file.", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "network-name": { "type": "string" }, "file-path": { "type": "string", "anyOf": [ { "pattern": "^.*\\.[Aa][Rr][Xx][Mm][Ll]$" }, { "pattern": "^.*\\.[Xx][Mm][Ll]$" }, { "pattern": "^.*\\.[Dd][Bb][Cc]$" }, { "pattern": "^.*\\.[Ll][Dd][Ff]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/some.dbc", "path/to/some.arxml", "path/to/some.xml", "path/to/some.ldf", "path/${var_with_name}", "${var_with_path}" ] } }, "examples": [ { "name": "mydbname", "file-path": "path/to/some.dbc" }, { "name": "mydbname", "file-path": "path/to/some.arxml", "network-name": "network_in_db" }, { "name": "mydbname", "file-path": "path/to/some.dbc", "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "fe7b6": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN network", "description": "A Network using the CAN protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "databases": { "$ref": "#/definitions/01ff2/full" }, "baudrate": { "description": "Baudrate in Baud.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/0f9b3/full" } }, "examples": [ { "name": "my_can_network" }, { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator" } ] } }, "d92db": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD network", "description": "A Network using the CANFD protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "databases": { "$ref": "#/definitions/01ff2/full" }, "mode": { "description": "Operation Mode setting (iso or non-iso Mode).", "anyOf": [ { "type": "string", "enum": ["iso", "non-iso"], "default": "iso" }, { "$ref": "#/definitions/779cd/full" } ] }, "arbitration-baudrate": { "description": "Baudrate for the arbitration phase of CAN FD in Baud.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "data-baudrate": { "description": "Baudrate for the data phase of CAN FD in Baud.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 1000000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] }, "mapping": { "$ref": "#/definitions/0f9b3/full" } }, "examples": [ { "name": "my_canfd_network" }, { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator" } ] } }, "69b41": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Ethernet network", "description": "A Network using the Ethernet protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "databases": { "$ref": "#/definitions/01ff2/full" }, "tcp-ip-stack-adapter": { "$ref": "#/definitions/bd6e5/full" }, "mapping": { "$ref": "#/definitions/0f9b3/full" }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "integer", "minimum": 1, "maximum": 32 } ] } }, "examples": [ { "name": "my_eth_network" }, { "name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_eth_network", "databases": ["DB_1", "DB_2"], "application-channel": 12, "tcp-ip-stack-adapter": { "mac-address": "02:84:cf:3b:be:01" }, "mapping": "external-sil-kit" }, { "name": "my_eth_network", "databases": ["DB_1", "DB_2"], "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": { "mtu": 1500, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.1", "subnet-mask": "255.255.0.0" } ] }, "ipv6-settings": { "address-configuration": "dhcp" }, "vlans": [ { "id": 42, "priority": 0 } ] } } ] } }, "77df9": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN replay block", "description": "A replay block for the CAN protocol.", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/79394/full" }, "replay-on-measurement-start": { "description": "Replay starts with measurement start", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "send-system-variables": { "description": "Send system variable values.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "start-timing-condition": { "$ref": "#/definitions/b8d33/full" }, "channel-mapping": { "$ref": "#/definitions/c4168/full" }, "send-tx-messages": { "description": "Replay the tx messages.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "send-rx-messages": { "description": "Replay the rx messages.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] } }, "examples": [ { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "when": "SCENARIO_NAME == \"MyScenario\"" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "replay-on-measurement-start": true, "send-system-variables": false, "send-tx-messages": true, "send-rx-messages": false, "start-timing-condition": { "condition": "immediately" }, "channel-mapping": { "default-mapping": "as-in-original" } } ] } }, "3cca7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Ethernet replay block", "description": "A replay block for the ethernet protocol.", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/79394/full" }, "replay-on-measurement-start": { "description": "Replay starts with measurement start", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "send-system-variables": { "description": "Send system variable values.", "anyOf": [ { "type": "boolean", "default": true }, { "$ref": "#/definitions/779cd/full" } ], "examples": [true, false, "${variable}"] }, "start-timing-condition": { "$ref": "#/definitions/b8d33/full" }, "channel-mapping": { "$ref": "#/definitions/c4168/full" } }, "examples": [ { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "when": "SCENARIO_NAME == \"MyScenario\"" }, { "name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "replay-on-measurement-start": true, "send-system-variables": false, "start-timing-condition": { "condition": "immediately" }, "channel-mapping": { "default-mapping": "as-in-original" } } ] } }, "4909e": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Scenario", "description": "A scenario with the option to define / override variables or defines", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "not": { "const": "Default" } }, "variables": { "$ref": "#/definitions/f9fcb/full" }, "defines": { "$ref": "#/definitions/f52d1/full" } }, "examples": [ { "name": "my_scenario_name" }, { "name": "override_variables", "variables": [ { "name": "three", "value": 3 } ] }, { "name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"] } ] } }, "51b90": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Application Model", "description": "Represents an application used in a scenario", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/619f7/full" }, "defines": { "$ref": "#/definitions/883aa/full" } }, "examples": [ { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"] }, { "file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"], "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "cd5c2": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Define", "description": "Defines to be passed to capl / vcdl.", "type": "object", "additionalProperties": false, "required": ["define"], "properties": { "when": { "$ref": "#/definitions/09e40/full" }, "define": { "anyOf": [ { "$ref": "#/definitions/a8440/full" }, { "$ref": "#/definitions/883aa/full" } ] } }, "examples": [ { "define": "mydefine1" }, { "define": ["mydefine1", "mydefine2"] }, { "define": ["mydefine1", "mydefine2"], "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "define": [ "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] } ] } }, "86b88": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Simulation Node", "description": "Represents a simulation node used in a simulation", "additionalProperties": false, "type": "object", "required": ["name", "network-assignments"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "file-path": { "$ref": "#/definitions/a10be/full" }, "network-assignments": { "$ref": "#/definitions/34322/full" }, "defines": { "$ref": "#/definitions/883aa/full" }, "modeling-libraries": { "type": "array", "items": { "$ref": "#/definitions/ee1ae/full" }, "description": "For assignment of modeling libraries to this simulation node" } }, "examples": [ { "name": "mynode", "network-assignments": [ { "network": "my_can_network_1" } ], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "mynode", "file-path": "path/to/my_dotnet.cs", "network-assignments": [ { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" }, "modeling-libraries": ["modeling/lib/2.dll"] } ], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.dll", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name\"" } ] } }, "00571": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAN network", "description": "A Network using the CAN protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "databases": { "$ref": "#/definitions/c2452/full" }, "baudrate": { "description": "Baudrate in Baud.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] } }, "examples": [ { "name": "my_can_network" }, { "name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_can_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "baudrate": 500000 } ] } }, "b0b65": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CANFD network", "description": "A Network using the CANFD protocol taking part in a simulation.", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/038dc/full" }, "when": { "$ref": "#/definitions/09e40/full" }, "databases": { "$ref": "#/definitions/c2452/full" }, "mode": { "description": "Operation Mode setting (iso or non-iso Mode).", "anyOf": [ { "type": "string", "enum": ["iso", "non-iso"], "default": "iso" }, { "$ref": "#/definitions/779cd/full" } ] }, "arbitration-baudrate": { "description": "Baudrate for the arbitration phase of CAN FD in Baud.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000 }, { "$ref": "#/definitions/779cd/full" } ] }, "data-baudrate": { "description": "Baudrate for the data phase of CAN FD in Baud.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 1000000 }, { "$ref": "#/definitions/779cd/full" } ] }, "application-channel": { "description": "Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 255, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ] } }, "examples": [ { "name": "my_canfd_network" }, { "name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\"" }, { "name": "my_canfd_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000 } ] } }, "d12ef": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Scenario", "description": "A scenario with the option to define / override variables or defines", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "not": { "const": "Default" } }, "variables": { "$ref": "#/definitions/f9fcb/full" }, "defines": { "$ref": "#/definitions/883aa/full" } }, "examples": [ { "name": "my_scenario_name" }, { "name": "override_variables", "variables": [ { "name": "three", "value": 3 } ] }, { "name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"] } ] } }, "c49a5": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "integer", "minimum": -9223372036854775808, "maximum": 9223372036854775807 } }, "39ed5": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "integer", "minimum": 0, "maximum": 18446744073709551615 } }, "f26f2": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "number", "minimum": -1.79769e308, "maximum": 1.79769e308 } }, "d6fe8": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Define to be passed to capl / vcdl.", "type": "string", "pattern": "^([a-zA-Z_]|([a-zA-Z_][a-zA-Z0-9_]*)?\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\})[a-zA-Z0-9_]*(=((0|[1-9][0-9]*)|(\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\})|[Tt]rue|[Ff]alse))?$", "examples": [ "mydefine1", "mydefine2", "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] } }, "56b2f": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Global configuration for the TCP/IP stack.", "anyOf": [ { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided", "anyOf": [ { "const": "operating-system", "description": "If set to operating-system, the machines configuration is used. (use 'canoe' if settings should be manually provided)" } ], "examples": ["canoe", "operating-system"] } } }, { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided", "anyOf": [ { "const": "canoe", "description": "If set to canoe, a custom configuration can be provided. (remove other elements for option operating-system)" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["canoe", "operating-system"] }, "activate-routing": { "$ref": "#/definitions/6d6c1/full" }, "tcp-delayed-ack": { "$ref": "#/definitions/b4b72/full" }, "ipv4-gateway": { "$ref": "#/definitions/a0f9c/full" }, "ipv6-gateway": { "$ref": "#/definitions/e231b/full" } } } ], "examples": [ { "selected-stack": "canoe", "activate-routing": true, "tcp-delayed-ack": true, "ipv4-gateway": "192.168.0.33", "ipv6-gateway": "::1" }, { "selected-stack": "operating-system" } ] } }, "dc7e6": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a vsysvar file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[vV][sS][yY][sS][vV][aA][rR]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my.vsysvar", "${path_in_variable}", "path/${name_in_variable}" ] } }, "038dc": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A C-identifier for this element (case sensitive)", "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "examples": ["myid", "THIS_IS_CASE_SENSITIVE", "__1_2_3_4_5__"] } }, "5349d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to an external database file (.arxml/.dbc/.ldf). Relative path specifications are resolved relative to the YAML configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Aa][Rr][Xx][Mm][Ll]$" }, { "pattern": "^.*\\.[Dd][Bb][Cc]$" }, { "pattern": "^.*\\.[Ll][Dd][Ff]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/some.dbc", "path/to/some.arxml", "path/to/some.ldf", "path/${var_with_name}", "${var_with_path}" ] } }, "17e6a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [ { "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, { "pattern": "^([a-zA-Z_][a-zA-Z0-9_]*)?\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}[a-zA-Z0-9_]*$" } ], "examples": [ "myid", "THIS_IS_CASE_SENSITIVE", "__1_2_3_4_5__", "${id_in_variable}" ] } }, "ad271": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Define the mapping of application channels to an underlying layer.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "const": "internal-simulator", "description": "Connect application channel to simulated network." }, { "const": "external-sil-kit", "description": "Connect application channel to SIL Kit." } ], "default": "internal-simulator", "examples": ["internal-simulator", "external-sil-kit"] } }, "bd6e5": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Address configuration for an TCP/IP stack.", "type": "object", "additionalProperties": false, "properties": { "mac-address": { "$ref": "#/definitions/04e4b/full" }, "mtu": { "$ref": "#/definitions/af2c7/full" }, "ipv4-settings": { "$ref": "#/definitions/952c9/full" }, "ipv6-settings": { "$ref": "#/definitions/0cca7/full" }, "vlans": { "$ref": "#/definitions/8d980/full" } }, "examples": [ { "mac-address": "02:84:cf:3b:be:01" }, { "mtu": 1500, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.1", "subnet-mask": "255.255.0.0" } ] }, "ipv6-settings": { "address-configuration": "dhcp" }, "vlans": [ { "id": 42, "priority": 0 } ] } ] } }, "801ff": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Via the key slot configuration it is possible to transmit two start-up/sync frames. Thus an external start-up node is not required for the start-up of a flexray cluster.", "type": "object", "additionalProperties": false, "properties": { "slot-1": { "$ref": "#/definitions/3c6d7/full" }, "slot-2": { "$ref": "#/definitions/3c6d7/full" } } } }, "a19ff": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a source file of a simulation node. Relative path specifications are resolved relative to the defining configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Cc][Aa][Nn]$" }, { "pattern": "^.*\\.[Cc][Aa][Nn][Ee][Nn][Cc][Rr]$" }, { "pattern": "^.*\\.[Cc][Ss]$" }, { "pattern": "^.*\\.[Ss][Ll][Nn]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my_capl_script.can", "path/to/my_encrypted_capl_file.canencr", "path/to/my_dotnet.cs", "path/to/my_visual_studio.sln", "${path_in_variable}", "path/${name_in_variable}" ] } }, "d0551": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "List of networks represented by this application.", "type": "array", "items": { "$ref": "#/definitions/9a1f9/full" }, "examples": [ [ { "network": "my_can_network_1" } ] ] } }, "172e4": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a vmodule modeling library. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "CANoeILNLVector.vmodule", "SomeIP_IL.vmodule", "AsrPDUIL2.vmodule", "OSEKNM01.vmodule", "DMOSEKNM.vmodule", "AsrNM30.vmodule", "AsrNM33.vmodule", "AsrUdpNm.vmodule", "AVB_IL.vmodule", "CANoeILNL_AUTOSAR_Eth.vmodule", "LINtp.vmodule", "SCC_ChargePoint.vmodule", "SCC_Monitor.vmodule", "SCC_Vehicle.vmodule", "path/to/my.vmodule", "${path_in_variable}", "path/${name_in_variable}" ] } }, "6a522": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Simulation node configuration for the TCP/IP stack.", "anyOf": [ { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used.\n If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet/tcp-ip-stack/selected-stack to be set to canoe).\n If set to individual, a custom configuration can be provided", "enum": ["operating-system", "canoe"], "default": "individual", "examples": ["operating-system", "canoe", "individual"] } } }, { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used.\n If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet/tcp-ip-stack/selected-stack to be set to canoe).\n If set to individual, a custom configuration can be provided", "anyOf": [ { "enum": ["individual"] }, { "$ref": "#/definitions/779cd/full" } ], "default": "individual", "examples": ["operating-system", "canoe", "individual"] }, "activate-routing": { "$ref": "#/definitions/6d6c1/full" }, "tcp-delayed-ack": { "$ref": "#/definitions/b4b72/full" }, "ipv4-gateway": { "$ref": "#/definitions/a0f9c/full" }, "ipv6-gateway": { "$ref": "#/definitions/e231b/full" } } } ] } }, "4de3d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Reference to external datasource files (.vcdl/.vcodm). Absolute or relative path. Relative path specifications are resolved relative to the defining configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[vV][cC][dD][lL]$" }, { "pattern": "^.*\\.[vV][cC][oO][dD][mM]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my.vcdl", "path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}" ] } }, "b8a7b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a source file of an application model (can/canencr/cs/sln/py/vmodule). Relative path specifications are resolved relative to the defining configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Cc][Ss]$" }, { "pattern": "^.*\\.[Pp][Yy]$" }, { "pattern": "^.*\\.[Ss][Ll][Nn]$" }, { "pattern": "^.*\\.[Cc][Aa][Nn]$" }, { "pattern": "^.*\\.[Cc][Aa][Nn][Ee][Nn][Cc][Rr]$" }, { "pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "my_dotnet.cs", "my_python.py", "my_visual_studio.sln", "my_capl_file.can", "my_encrypted_capl_file.canencr", "my_module.vmodule", "${some_variable}" ] } }, "81bab": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a vmodule file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my.vmodule", "${path_in_variable}", "path/${name_in_variable}" ] } }, "568cc": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a xcpcfg file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[xX][cC][pP][cC][fF][gG]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my.xcpcfg", "${path_in_variable}", "path/${name_in_variable}" ] } }, "a220f": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a YAML file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Yy][Aa]?[Mm][Ll]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my.yaml", "path/to/my.yml", "${path_in_variable}", "path/${name_in_variable}" ] } }, "8af01": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a source file of a functional mockup unit (.fmu). Relative path specifications are resolved relative to the defining configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Ff][Mm][Uu]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "my_functional_mockup_unit.fmu", "Inputs/MyFmu.FMU", "${some_variable}" ] } }, "79394": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a replay file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[bB][lL][fF]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my.blf", "${path_in_variable}", "path/${name_in_variable}" ] } }, "0a52d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Timing conditions", "description": "Timing conditions for a replay block.", "type": "object", "additionalProperties": false, "required": [], "properties": { "condition": { "description": "The condition when the replay shall start.", "anyOf": [ { "const": "immediately", "description": "The first event of the replayed file occurs with measurement start." }, { "const": "first-event-time", "description": "The original timestamp of the replayed file are used." }, { "const": "delayed", "description": "The first event is delayed. Can be configured by the 'delayed-ms' element." }, { "$ref": "#/definitions/779cd/full" } ] }, "delay-ms": { "description": "The delay in ms if the condition 'delayed' is selected. No effect otherwise.", "$ref": "#/definitions/0cd26/full" } }, "examples": [ { "condition": "immediately" }, { "condition": "first-event-time" }, { "condition": "delayed", "delay-ms": 1000 }, { "condition": "${variable}" } ] } }, "8451c": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Channel mapping", "description": "The channel mapping for a replay block.", "type": "object", "additionalProperties": false, "required": [], "properties": { "default-mapping": { "description": "The default mapping of a channel if it is not explicitely mapped.", "anyOf": [ { "const": "as-in-original", "description": "The channel is mapped to itself if there is an active network." }, { "const": "ignore-all", "description": "The channels are ignored by default." }, { "$ref": "#/definitions/779cd/full" } ] }, "mappings": { "title": "Explicit mappings", "description": "The explicitly mapped channels. Overwrites the default mapping for the source.", "type": "array", "items": { "anyOf": [ { "title": "Map source channel", "type": "object", "description": "Mapping from application channel of the replay file to a target network.", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": { "source-channel": { "description": "The source application channel from the replayed file.", "$ref": "#/definitions/f06ea/full" }, "target-network": { "description": "The target network name.", "anyOf": [ { "$ref": "#/definitions/038dc/full" }, { "$ref": "#/definitions/779cd/full" } ] } } }, { "title": "Map source network", "type": "object", "description": "Mapping from a named source network of the replay file to a named target network.", "additionalProperties": false, "required": ["source-network", "target-network"], "properties": { "source-network": { "description": "The source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.", "type": "string" }, "target-network": { "description": "The target network name.", "anyOf": [ { "$ref": "#/definitions/038dc/full" }, { "$ref": "#/definitions/779cd/full" } ] } } }, { "title": "Ignore source channel", "type": "object", "description": "Ignores an application channel of the replay file.", "additionalProperties": false, "required": ["ignore-source-channel"], "properties": { "ignore-source-channel": { "description": "The ignored source channel.", "$ref": "#/definitions/f06ea/full" } } }, { "title": "Ignore source network", "type": "object", "description": "Ignores a named source network of the replay file.", "additionalProperties": false, "required": ["ignore-source-network"], "properties": { "ignore-source-network": { "description": "The ignored source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.", "type": "string" } } } ] } } }, "examples": [ { "default-mapping": "as-in-original" }, { "default-mapping": "ignore-all", "mappings": [ { "source-channel": 1, "target-network": "CAN1" } ] }, { "default-mapping": "as-in-original", "mappings": [ { "source-network": "CAN1", "target-network": "CAN2" } ] }, { "default-mapping": "as-in-original", "mappings": [ { "ignore-source-channel": 2 }, { "ignore-source-network": "CAN4" } ] } ] } }, "b1f6d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a vmodule file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "CANoeILNLVector.vmodule", "SomeIP_IL.vmodule", "AsrPDUIL2.vmodule", "OSEKNM01.vmodule", "DMOSEKNM.vmodule", "AsrNM30.vmodule", "AsrNM33.vmodule", "AsrUdpNm.vmodule", "AVB_IL.vmodule", "CANoeILNL_AUTOSAR_Eth.vmodule", "SCC_ChargePoint.vmodule", "SCC_Monitor.vmodule", "SCC_Vehicle.vmodule", "path/to/my.vmodule", "${path_in_variable}", "path/${name_in_variable}" ] } }, "b73a4": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Global configuration for the TCP/IP stack.", "anyOf": [ { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided", "anyOf": [ { "const": "operating-system", "description": "If set to operating-system, the machines configuration is used. (use 'canoe' if settings should be manually provided)" } ], "examples": ["canoe", "operating-system"] } } }, { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided", "anyOf": [ { "const": "canoe", "description": "If set to canoe, a custom configuration can be provided. (remove other elements for option operating-system)" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["canoe", "operating-system"] }, "activate-routing": { "$ref": "#/definitions/6d6c1/full" }, "tcp-delayed-ack": { "$ref": "#/definitions/b4b72/full" }, "timestamp-option-RFC1323": { "$ref": "#/definitions/31725/full" }, "ttl": { "$ref": "#/definitions/ee197/full" }, "ipv4-gateway": { "$ref": "#/definitions/a0f9c/full" }, "ipv6-gateway": { "$ref": "#/definitions/e231b/full" } } } ] } }, "619f7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a source file of an application model (can/cs/sln/py/vmodule). Relative path specifications are resolved relative to the defining configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Cc][Ss]$" }, { "pattern": "^.*\\.[Pp][Yy]$" }, { "pattern": "^.*\\.[Ss][Ll][Nn]$" }, { "pattern": "^.*\\.[Cc][Aa][Nn]$" }, { "pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "my_dotnet.cs", "my_python.py", "my_visual_studio.sln", "my_caplfile.can", "my_module.vmodule", "${some_variable}" ] } }, "a10be": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a source file of a simulation node. Relative path specifications are resolved relative to the defining configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Cc][Aa][Nn]$" }, { "pattern": "^.*\\.[Cc][Ss]$" }, { "pattern": "^.*\\.[Ss][Ll][Nn]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my_capl_script.can", "path/to/my_dotnet.cs", "path/to/my_visual_studio.sln", "${path_in_variable}", "path/${name_in_variable}" ] } }, "f6782": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "List of network nodes represented by this application", "type": "array", "items": { "$ref": "#/definitions/2ae5f/full" }, "examples": [ [ { "network": "my_can_network_1" } ], [ { "network": "my_can_network_1", "lin-role": "master" }, { "network": "my_can_network_1", "lin-role": ["master", "config-tester"] }, { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" } } ] ] } }, "dfa4a": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Simulation node configuration for the TCP/IP stack.", "anyOf": [ { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used.\n If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet-settings/tcp-ip-stack/selected-stack to be set to canoe).\n If set to individual, a custom configuration can be provided", "enum": ["operating-system", "canoe"], "default": "individual", "examples": ["operating-system", "canoe", "individual"] } } }, { "type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": { "selected-stack": { "description": "If set to operating-system, the machines configuration is used.\n If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet-settings/tcp-ip-stack/selected-stack to be set to canoe).\n If set to individual, a custom configuration can be provided", "anyOf": [ { "enum": ["individual"] }, { "$ref": "#/definitions/779cd/full" } ], "default": "individual", "examples": ["operating-system", "canoe", "individual"] }, "activate-routing": { "$ref": "#/definitions/6d6c1/full" }, "tcp-delayed-ack": { "$ref": "#/definitions/b4b72/full" }, "timestamp-option-RFC1323": { "$ref": "#/definitions/31725/full" }, "ttl": { "$ref": "#/definitions/ee197/full" }, "ipv4-gateway": { "$ref": "#/definitions/a0f9c/full" }, "ipv6-gateway": { "$ref": "#/definitions/e231b/full" } } } ] } }, "01ff2": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A list of C-identifiers for referenced elements (case sensitive)", "type": "array", "items": { "$ref": "#/definitions/17e6a/full" }, "examples": [ ["myid"], ["THIS_IS_CASE_SENSITIVE", "__1_2_3_4_5__"], ["${id_in_variable}", "prefix_${infix_in_variable}_suffix"] ] } }, "0f9b3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Define the mapping of application channels to an underlying layer", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "const": "internal-simulator", "description": "Connect application channel to simulated network." }, { "const": "external-sil-kit", "description": "Connect application channel to SIL Kit." } ], "default": "internal-simulator", "examples": ["internal-simulator", "external-sil-kit"] } }, "b8d33": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Timing conditions", "description": "Timing conditions for a replay block.", "type": "object", "additionalProperties": false, "required": [], "properties": { "condition": { "description": "The condition when the replay shall start.", "anyOf": [ { "const": "immediately", "description": "The first event of the replayed file occurs with measurement start." }, { "const": "first-event-time", "description": "The original timestamp of the replayed file are used." }, { "const": "delayed", "description": "The first event is delayed. Can be configured by the 'delayed-ms' element." }, { "$ref": "#/definitions/779cd/full" } ] }, "delay-ms": { "description": "The delay in ms if the condition 'delayed' is selected. No effect otherwise.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 0 }, { "$ref": "#/definitions/779cd/full" } ] } }, "examples": [ { "condition": "immediately" }, { "condition": "first-event-time" }, { "condition": "delayed", "delay-ms": 1000 }, { "condition": "${variable}" } ] } }, "c4168": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Channel mapping", "description": "The channel mapping for a replay block.", "type": "object", "additionalProperties": false, "required": [], "properties": { "default-mapping": { "description": "The default mapping of a channel if it is not explicitely mapped.", "anyOf": [ { "const": "as-in-original", "description": "The channel is mapped to itself if there is an active network." }, { "const": "ignore-all", "description": "The channels are ignored by default." }, { "$ref": "#/definitions/779cd/full" } ] }, "mappings": { "title": "Explicit mappings", "description": "The explicitly mapped channels. Overwrites the default mapping for the source.", "type": "array", "items": { "anyOf": [ { "title": "Map source channel", "type": "object", "description": "Mapping from application channel of the replay file to a target network.", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": { "source-channel": { "description": "The source application channel from the replayed file.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 65535, "default": 0 }, { "$ref": "#/definitions/779cd/full" } ] }, "target-network": { "description": "The target network name.", "anyOf": [ { "$ref": "#/definitions/038dc/full" }, { "$ref": "#/definitions/779cd/full" } ] } } }, { "title": "Map source network", "type": "object", "description": "Mapping from a named source network of the replay file to a named target network.", "additionalProperties": false, "required": ["source-network", "target-network"], "properties": { "source-network": { "description": "The source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.", "type": "string" }, "target-network": { "description": "The target network name.", "anyOf": [ { "$ref": "#/definitions/038dc/full" }, { "$ref": "#/definitions/779cd/full" } ] } } }, { "title": "Ignore source channel", "type": "object", "description": "Ignores an application channel of the replay file.", "additionalProperties": false, "required": ["ignore-source-channel"], "properties": { "ignore-source-channel": { "description": "The ignored source channel.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 65535, "default": 0 }, { "$ref": "#/definitions/779cd/full" } ] } } }, { "title": "Ignore source network", "type": "object", "description": "Ignores a named source network of the replay file.", "additionalProperties": false, "required": ["ignore-source-network"], "properties": { "ignore-source-network": { "description": "The ignored source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.", "type": "string" } } } ] } } }, "examples": [ { "default-mapping": "as-in-original" }, { "default-mapping": "ignore-all", "mappings": [ { "source-channel": 1, "target-network": "CAN1" } ] }, { "default-mapping": "as-in-original", "mappings": [ { "source-network": "CAN1", "target-network": "CAN2" } ] }, { "default-mapping": "as-in-original", "mappings": [ { "ignore-source-channel": 2 }, { "ignore-source-network": "CAN4" } ] } ] } }, "883aa": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "List of defines to be passed to capl / vcdl.", "type": "array", "items": { "$ref": "#/definitions/a8440/full" }, "examples": [ ["mydefine1", "mydefine2"], [ "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] ] } }, "a8440": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Define to be passed to capl / vcdl.", "type": "string", "pattern": "^([a-zA-Z_]|([a-zA-Z_][a-zA-Z0-9_]*)?\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\})[a-zA-Z0-9_]*(=((0|[1-9][0-9]*)|(\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\})|(\"([^\"\\\\]|\\\\\"|\\\\\\\\)*\")|[Tt]rue|[Ff]alse))?$", "examples": [ "mydefine1", "mydefine2", "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}" ] } }, "34322": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "List of network nodes represented by this application", "type": "array", "items": { "$ref": "#/definitions/b2479/full" }, "examples": [ [ { "network": "my_can_network_1" } ], [ { "network": "my_can_network_1", "modeling-libraries": [ "modeling/lib/1.dll", "${path_in_var}", "path/${name_in_var}" ] }, { "network": "my_can_network_1", "lin-role": "master" }, { "network": "my_can_network_1", "lin-role": ["master", "config-tester"] }, { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" } } ] ] } }, "ee1ae": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Absolute or relative path to a dll or vmodule file. Relative path specifications are resolved relative to the configuration file.", "type": "string", "anyOf": [ { "pattern": "^.*\\.[Dd][Ll]{2}$" }, { "pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$" }, { "pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$" } ], "examples": [ "path/to/my.dll", "path/to/my.vmodule", "${path_in_variable}", "path/${name_in_variable}" ] } }, "c2452": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A list of C-identifiers for referenced elements (case sensitive)", "type": "array", "items": { "$ref": "#/definitions/e4921/full" }, "examples": [ ["myid"], ["THIS_IS_CASE_SENSITIVE", "__1_2_3_4_5__"], ["${id_in_variable}", "prefix_${infix_in_variable}_suffix"] ] } }, "6d6c1": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Activates TCP Routing", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/779cd/full" } ], "default": false } }, "b4b72": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Activates the TCP Delayed Ack Option.", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "boolean" } ], "default": true } }, "a0f9c": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "IPv4-Address of the Gateway", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "$ref": "#/definitions/ea732/full" } ], "default": "0.0.0.0" } }, "e231b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "IPv6-Address of the Gateway", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "$ref": "#/definitions/bbbd7/full" } ], "default": "::1" } }, "04e4b": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "MAC-Address of the current TcpIpStack. (Can't be a multicast address.)", "type": "string", "anyOf": [ { "pattern": "[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}" }, { "$ref": "#/definitions/779cd/full" } ], "examples": [ "02:84:cf:3b:be:01", "aa:bb:cc:dd:ee:ff", "AA:BB:CC:DD:EE:FF" ] } }, "af2c7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Maximum Transmittion Unit.", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 1500 }, { "$ref": "#/definitions/779cd/full" } ], "default": 1500 } }, "952c9": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Configurations for IPv4.", "anyOf": [ { "type": "object", "additionalProperties": false, "required": ["address-configuration"], "properties": { "address-configuration": { "description": "Defines how the addresses are configured. Use 'static' to configure them manually with the 'addresses' property or use 'dhcp' for automatic configuration.", "examples": ["dhcp", "static", "linked-local"], "anyOf": [ { "enum": ["dhcp", "linked-local"] }, { "$ref": "#/definitions/779cd/full" } ] } } }, { "type": "object", "additionalProperties": false, "required": ["address-configuration", "addresses"], "properties": { "addresses": { "$ref": "#/definitions/91edd/full" }, "address-configuration": { "description": "Defines how the addresses are configured. Use 'static' to configure them manually with the 'addresses' property or use 'dhcp' for automatic configuration.", "anyOf": [ { "const": "static" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["dhcp", "static", "linked-local"] } } } ], "examples": [ { "address-configuration": "dhcp" }, { "address-configuration": "static", "addresses": [ { "address": "192.168.0.2", "subnet-mask": "255.255.255.0" }, { "address": "192.168.0.3", "subnet-prefix-length": 24 } ] } ] } }, "0cca7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Configurations for IPv6.", "anyOf": [ { "type": "object", "additionalProperties": false, "required": ["address-configuration"], "properties": { "address-configuration": { "description": "Defines how the addresses are configured. Use 'static' to configure them manually with the 'addresses' property or use 'dhcp' for automatic configuration.", "examples": ["dhcp", "static"], "anyOf": [ { "enum": ["dhcp", "linked-local"] }, { "$ref": "#/definitions/779cd/full" } ] } } }, { "type": "object", "additionalProperties": false, "required": ["address-configuration", "addresses"], "properties": { "addresses": { "$ref": "#/definitions/66666/full" }, "address-configuration": { "description": "Defines how the addresses are configured. Use 'static' to configure them manually with the 'addresses' property or use 'dhcp' for automatic configuration.", "anyOf": [ { "const": "static" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["dhcp", "static"] } } } ], "examples": [ { "address-configuration": "dhcp" }, { "address-configuration": "static", "addresses": [ { "address": "1234::abce", "subnet-prefix-length": 42 }, { "address": "1234::abcf", "subnet-prefix-length": 24 } ] } ] } }, "8d980": { "local": { "vlan-settings": { "type": "object", "description": "Defines a VLAN with its relevant seetings.", "additionalProperties": false, "required": ["id", "priority"], "properties": { "id": { "description": "Id of the current VLAN.", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 4094 }, { "$ref": "#/definitions/779cd/full" } ], "$comment": "reason for 4094: see https://en.wikipedia.org/wiki/IEEE_802.1Q - VLAN identifier (VID)", "examples": [1, 2, 3, 4, 4094] }, "priority": { "description": "Priority of the current VLAN.", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 7 }, { "$ref": "#/definitions/779cd/full" } ], "examples": [0, 1, 2, 3, 4, 5, 6, 7] }, "ipv4-settings": { "$ref": "#/definitions/952c9/full" }, "ipv6-settings": { "$ref": "#/definitions/0cca7/full" } } } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A list of VLANs with their relevant seetings.", "type": "array", "items": { "$ref": "#/definitions/8d980/local/vlan-settings" }, "maxItems": 4094, "examples": [ [ { "id": 42, "priority": 0 } ], [ { "id": 24, "priority": 0, "ipv4-settings": { "address-configuration": "static", "addresses": [ { "address": "192.168.0.2", "subnet-mask": "255.255.255.0" }, { "address": "192.168.0.3", "subnet-prefix-length": 24 } ] }, "ipv6-settings": { "address-configuration": "static", "addresses": [ { "address": "1234::abce", "subnet-prefix-length": 42 }, { "address": "1234::abcf", "subnet-prefix-length": 24 } ] } } ] ] } }, "3c6d7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Configuration of a key slot node.", "type": "object", "additionalProperties": false, "required": ["mode"], "properties": { "mode": { "description": "Key slot operating modes. \n'automatic': The key slot is possibly active. Any active frame in the Tx buffer will be selected for this key slot, if marked as start-up and/or sync frame. \n'off': The key slot is not used. \n'manual': Explicity definition of the key slot properties.", "default": "automatic", "oneOf": [ { "const": "automatic" }, { "const": "off" }, { "const": "manual" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["manual", "automatic"] }, "usage": { "oneOf": [ { "enum": ["startup", "sync"] }, { "$ref": "#/definitions/779cd/full" } ], "description": "The frame in this slot can be send as start-up or only as sync frame.", "default": "startup" }, "slot": { "oneOf": [ { "type": "integer", "minimum": 1, "maximum": 2047, "default": 1 }, { "$ref": "#/definitions/779cd/full" } ], "description": "Explicit slot number of the static segment that will be used as the key slot." }, "mask": { "oneOf": [ { "enum": ["A", "B", "AB"] }, { "$ref": "#/definitions/779cd/full" } ], "description": "Explicit channel mask used for the key slot.", "default": "A" }, "leading-cold-start": { "oneOf": [ { "type": "boolean" }, { "$ref": "#/definitions/779cd/full" } ], "description": "If deactivated the key slot can only act as a following start-up or integrating sync frame.", "default": true } }, "allOf": [ { "if": { "required": ["mode"], "properties": { "mode": { "const": "manual" } } }, "then": { "required": ["usage", "slot", "mask", "leading-cold-start"], "properties": { "mask": true, "usage": true, "slot": true, "leading-cold-start": true } } }, { "if": { "required": ["mode"], "properties": { "mode": { "anyOf": [ { "const": "off" }, { "const": "automatic" } ] } } }, "then": { "properties": { "usage": false, "slot": false, "mask": false, "leading-cold-start": false } } } ], "examples": [ { "mode": "automatic" }, { "mode": "manual", "usage": "startup", "slot": 2, "mask": "A", "leading-cold-start": true } ] } }, "9a1f9": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A network node represented by this application.", "type": "object", "additionalProperties": false, "required": ["network"], "properties": { "network": { "$ref": "#/definitions/17e6a/full", "description": "Assign the simulation node to a network.", "examples": ["network_name"] }, "tcp-ip-stack-adapter": { "$ref": "#/definitions/bd6e5/full" } }, "examples": [ { "network": "my_can_network_1" } ] } }, "0cd26": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/6daff/full", "default": 0 } }, "f06ea": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/81058/full", "default": 0 } }, "31725": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Timestamp Option for TCP (RFC1323).", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "type": "boolean" } ], "default": true } }, "ee197": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Time To Live.", "default": 64, "anyOf": [ { "type": "integer", "minimum": 0 }, { "$ref": "#/definitions/779cd/full" } ] } }, "2ae5f": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A network node represented by this application.", "type": "object", "additionalProperties": false, "required": ["network"], "properties": { "network": { "$ref": "#/definitions/17e6a/full", "description": "For assignment of this NetworkNode to a Network.", "examples": ["network_name"] }, "database-node": { "$ref": "#/definitions/21023/full" }, "lin-role": { "anyOf": [ { "$ref": "#/definitions/183d9/full" }, { "type": "array", "items": { "$ref": "#/definitions/183d9/full" } } ] }, "tcp-ip-stack-adapter": { "$ref": "#/definitions/bd6e5/full" } }, "examples": [ { "network": "my_can_network_1" }, { "network": "my_can_network_1", "lin-role": "master" }, { "network": "my_can_network_1", "lin-role": ["master", "config-tester"] }, { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" } } ] } }, "b2479": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A network node represented by this application.", "type": "object", "additionalProperties": false, "required": ["network"], "properties": { "network": { "type": "string", "description": "For assignment of this NetworkNode to a Network.", "examples": ["network_name"] }, "modeling-libraries": { "type": "array", "items": { "$ref": "#/definitions/ee1ae/full" }, "description": "For assignment of modeling libraries to this NetworkNode" }, "database-node": { "$ref": "#/definitions/9acfe/full" }, "lin-role": { "anyOf": [ { "$ref": "#/definitions/183d9/full" }, { "type": "array", "items": { "$ref": "#/definitions/183d9/full" } } ] } }, "examples": [ { "network": "my_can_network_1" }, { "network": "my_can_network_1", "modeling-libraries": [ "modeling/lib/1.dll", "${path_in_var}", "path/${name_in_var}" ] }, { "network": "my_can_network_1", "lin-role": "master" }, { "network": "my_can_network_1", "lin-role": ["master", "config-tester"] }, { "network": "my_can_network_1", "database-node": { "database": "mydatabase", "node": "mynode" } } ] } }, "e4921": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "A C-identifier for a referenced element (case sensitive)", "type": "string", "anyOf": [ { "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, { "pattern": "^([a-zA-Z_][a-zA-Z0-9_]*)?\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}[a-zA-Z0-9_]*$" } ], "examples": [ "myid", "THIS_IS_CASE_SENSITIVE", "__1_2_3_4_5__", "${id_in_variable}" ] } }, "ea732": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "IPv4 address", "type": "string", "anyOf": [ { "pattern": "((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\\.){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])" }, { "$ref": "#/definitions/779cd/full" } ], "examples": ["127.0.0.1", "192.168.0.0", "172.16.0.0", "10.0.0.0"] } }, "bbbd7": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "IPv6 address", "type": "string", "anyOf": [ { "pattern": "^([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}|:(:[0-9A-Fa-f]{1,4}){1,7}|([0-9A-Fa-f]{1,4}:){1,7}:|::|([0-9A-Fa-f]{1,4}:){1}(:[0-9A-Fa-f]{1,4}){1,6}|([0-9A-Fa-f]{1,4}:){2}(:[0-9A-Fa-f]{1,4}){1,5}|([0-9A-Fa-f]{1,4}:){3}(:[0-9A-Fa-f]{1,4}){1,4}|([0-9A-Fa-f]{1,4}:){4}(:[0-9A-Fa-f]{1,4}){1,3}|([0-9A-Fa-f]{1,4}:){5}(:[0-9A-Fa-f]{1,4}){1,2}|([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}){1})$" }, { "$ref": "#/definitions/779cd/full" } ], "examples": [ "1234:0000:0000:0000:0000:0000:0000:abcd", "1234::abcd", "::1" ] } }, "91edd": { "local": { "ipv4-subnet-mask": { "description": "Subnet mask of an IPv4 Address", "anyOf": [ { "$ref": "#/definitions/ea732/full" } ], "examples": [ "255.255.255.0", "255.255.0.0", "255.240.0.0", "255.0.0.0" ] }, "ipv4-subnet-prefix-length": { "description": "Subnet prefix of an IPv4 Address", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 32 }, { "$ref": "#/definitions/779cd/full" } ], "examples": [0, 24, 16, 12, 8, 32] }, "ipv4-with-subnet": { "type": "object", "anyOf": [ { "additionalProperties": false, "required": ["address", "subnet-mask"], "properties": { "address": { "$ref": "#/definitions/ea732/full" }, "subnet-mask": { "$ref": "#/definitions/91edd/local/ipv4-subnet-mask" } } }, { "additionalProperties": false, "required": ["address", "subnet-prefix-length"], "properties": { "address": { "$ref": "#/definitions/ea732/full" }, "subnet-prefix-length": { "$ref": "#/definitions/91edd/local/ipv4-subnet-prefix-length" } } } ] } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "List of IPv4 addresses with their subnet definition", "type": "array", "items": { "$ref": "#/definitions/91edd/local/ipv4-with-subnet" }, "examples": [ [ { "address": "192.168.0.2", "subnet-mask": "255.255.255.0" } ], [ { "address": "192.168.0.3", "subnet-prefix-length": 24 } ] ] } }, "66666": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "List of IPv6 addresses with their subnet definition", "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["address", "subnet-prefix-length"], "properties": { "address": { "$ref": "#/definitions/bbbd7/full" }, "subnet-prefix-length": { "description": "Subnetprefix of an IPv6 Address", "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 128 }, { "$ref": "#/definitions/779cd/full" } ], "examples": [0, 48, 128] } } }, "examples": [ [ { "address": "1234::abce", "subnet-prefix-length": 42 } ], [ { "address": "1234::abcf", "subnet-prefix-length": 24 } ] ] } }, "6daff": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "$ref": "#/definitions/815f9/full" } ] } }, "81058": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [ { "$ref": "#/definitions/779cd/full" }, { "$ref": "#/definitions/09338/full" } ] } }, "21023": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Reference to a certain node from a database", "type": "object", "additionalProperties": false, "required": ["node", "database"], "properties": { "node": { "type": "string", "description": "The node from the database", "examples": ["node_name"] }, "database": { "$ref": "#/definitions/17e6a/full", "description": "The database" } }, "examples": [ { "database": "mydatabase", "node": "mynode" } ] } }, "183d9": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Role of a node in a LIN network.", "type": "string", "enum": ["master", "slave", "config-tester"], "examples": ["master", "slave", "config-tester"] } }, "9acfe": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "Reference to a certain node from a database", "type": "object", "additionalProperties": false, "required": ["node", "database"], "properties": { "node": { "type": "string", "description": "The node from the database", "examples": ["node_name"] }, "database": { "$ref": "#/definitions/e4921/full", "description": "The database" } }, "examples": [ { "database": "mydatabase", "node": "mynode" } ] } }, "815f9": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "integer", "minimum": 0, "maximum": 9223372036854775807 } }, "09338": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "integer", "minimum": 0, "maximum": 65535 } } }, "title": "venvironment schema", "type": "object" }

rehyperc.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "https://json.schemastore.org/rehyperc.json", "properties": { "plugins": { "description": "The plugins field, related to plugins in options, has either an array of plugin names (or paths) or plugin–options tuples, or an object mapping plugins to their options.\nPlugin options can be false, which specifies that a plugin should not be used. In all other cases, they are treated as an object, and merged by the cascade. Thus, it's possible to specify part of the options from one configuration file, and overwrite or extend it from another file.", "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "array", "additionalItems": true, "items": [ { "type": "string" } ] } ] } }, { "type": "object" } ] }, "settings": { "type": "object", "additionalProperties": false, "properties": { "fragment": { "description": "Specify whether to parse a fragment, instead of a complete document. In document mode, unopened html, head, and body elements are opened in just the right places.", "type": ["boolean"], "default": false }, "space": { "description": "Which space the document is in.\n\nIf an svg element is found in the HTML space, parse automatically switches to the SVG space when entering the element, and switches back when exiting.\n\nNote: make sure to set fragment: true if space: 'svg'.", "enum": ["svg", "html"], "default": "html" }, "emitParseErrors": { "description": "Emit parse errors while parsing on the vfile.\n\nSetting this to true starts emitting HTML parse errors.\n\nSpecific rules can be turned off by setting them to false (or 0). The default, when emitParseErrors: true, is true (or 1), and means that rules emit as warnings. Rules can also be configured with 2, to turn them into fatal errors.", "type": ["boolean"], "default": false }, "verbose": { "description": "Patch extra positional information. If specified, the following element:", "type": ["boolean"], "default": false }, "entities": { "description": "Configuration for stringify-entities. Do not use escapeOnly, attribute, or subset (toHtml already passes those, so they won't work). However, useNamedReferences, useShortestReferences, and omitOptionalSemicolons are all fine.", "type": "object", "default": {}, "additionalProperties": false, "properties": { "useNamedReferences": { "description": "Prefer named character references (&amp;) where possible.", "type": "boolean", "default": false }, "useShortestReferences": { "description": "Prefer the shortest possible reference, if that results in less bytes.", "type": "boolean", "default": false }, "omitOptionalSemicolons": { "description": "Whether to omit semicolons when possible.", "type": "boolean", "default": false } } }, "voids": { "description": "Tag names of elements to serialize without closing tag.\n\nNot used in the SVG space.", "type": "array", "items": { "type": "string" } }, "upperDoctype": { "description": "Use a <!DOCTYPE… instead of <!doctype…. Useless except for XHTML.", "type": "boolean", "default": false }, "quote": { "description": "Preferred quote to use.", "enum": ["\"", "'"], "default": "\"" }, "quoteSmart": { "description": "Use the other quote if that results in less bytes.", "type": "boolean", "default": false }, "preferUnquoted": { "description": "Leave attributes unquoted if that results in less bytes.\n\nNot used in the SVG space.", "type": "boolean", "default": false }, "omitOptionalTags": { "description": "Omit optional opening and closing tags. For example, in <ol><li>one</li><li>two</li></ol>, both </li> closing tags can be omitted. The first because it's followed by another li, the last because it's followed by nothing.\n\nNot used in the SVG space.", "type": "boolean", "default": false }, "collapseEmptyAttributes": { "description": "Collapse empty attributes: get class instead of class=\"\". Note: boolean attributes, such as hidden, are always collapsed.\n\nNot used in the SVG space.", "type": "boolean", "default": false }, "closeSelfClosing": { "description": "Close self-closing nodes with an extra slash (/): <img /> instead of <img>. See tightSelfClosing to control whether a space is used before the slash.\n\nNot used in the SVG space.", "type": "boolean", "default": false }, "closeEmptyElements": { "description": "Close SVG elements without any content with slash (/) on the opening tag instead of an end tag: <circle /> instead of <circle></circle>. See tightSelfClosing to control whether a space is used before the slash.\n\nNot used in the HTML space.", "type": "boolean", "default": false }, "tightCommaSeparatedLists": { "description": "Join known comma-separated attribute values with just a comma (,), instead of padding them on the right as well (,·, where · represents a space).", "type": "boolean", "default": false }, "tightAttributes": { "description": "Join attributes together, without whitespace, if possible: get class=\"a b\"title=\"c d\" instead of class=\"a b\" title=\"c d\" to save bytes. Note: creates invalid (but working) markup.\n\nNot used in the SVG space.", "type": "boolean", "default": false }, "tightDoctype": { "description": "Drop unneeded spaces in doctypes: <!doctypehtml> instead of <!doctype html> to save bytes. Note: creates invalid (but working) markup.", "type": "boolean", "default": false }, "bogusComments": { "description": "Use \"bogus comments\" instead of comments to save byes: <?charlie> instead of <!--charlie-->. Note: creates invalid (but working) markup.", "type": "boolean", "default": false }, "allowParseErrors": { "description": "Do not encode characters which cause parse errors (even though they work), to save bytes. Note: creates invalid (but working) markup.\n\nNot used in the SVG space.", "type": "boolean", "default": false }, "allowDangerousHtml": { "description": "Allow raw nodes and insert them as raw HTML. When falsey, encodes raw nodes. Note: Only set this if you completely trust the content.", "type": "boolean", "default": false } } } }, "title": "JSON schema for .rehyperc", "type": "object" }

bungee-plugin.json

{ "$id": "https://json.schemastore.org/bungee-plugin", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "definitions": { "plugin-name": { "type": "string", "pattern": "^[A-Za-z0-9_\\.-]+$" } }, "properties": { "name": { "description": "The name of the plugin.", "$ref": "#/definitions/plugin-name" }, "main": { "description": "Plugin main class.", "type": "string", "pattern": "^([a-zA-Z_$][a-zA-Z\\d_$]*\\.)*[a-zA-Z_$][a-zA-Z\\d_$]*$" }, "version": { "description": "Plugin version.", "type": "string" }, "author": { "description": "Plugin author.", "type": "string" }, "depends": { "description": "Plugin hard dependencies.", "type": "array", "items": { "$ref": "#/definitions/plugin-name" } }, "softDepends": { "description": "Plugin soft dependencies.", "type": "array", "items": { "$ref": "#/definitions/plugin-name" } }, "description": { "description": "Optional description.", "type": "string" } }, "required": ["name", "main"], "title": "JSON schema for BungeeCord Plugin YAML", "type": "object" }

config_schema_v1.0.json

{ "$schema": "http://json-schema.org/draft-07/schema", "type": "object", "title": "Schema for cog.yaml", "description": "Defines how to build a Docker image and how to run predictions on your model inside that image.", "properties": { "build": { "$id": "#/properties/build", "type": "object", "description": "This stanza describes how to build the Docker image your model runs in.", "properties": { "cuda": { "$id": "#/properties/build/properties/cuda", "type": "string", "description": "Cog automatically picks the correct version of CUDA to install, but this lets you override it for whatever reason." }, "cudnn": { "$id": "#/properties/build/properties/cudnn", "type": "string", "description": "Cog automatically picks the correct version of cuDNN to install, but this lets you override it for whatever reason." }, "gpu": { "$id": "#/properties/build/properties/gpu", "type": "boolean", "description": "Enable GPUs for this model. When enabled, the [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) base image will be used, and Cog will automatically figure out what versions of CUDA and cuDNN to use based on the version of Python, PyTorch, and Tensorflow that you are using." }, "python_version": { "$id": "#/properties/build/properties/python_version", "type": ["string", "number"], "description": "The minor (`3.8`) or patch (`3.8.1`) version of Python to use." }, "python_packages": { "$id": "#/properties/build/properties/python_packages", "type": ["array", "null"], "description": "A list of Python packages to install, in the format `package==version`.", "additionalItems": true, "items": { "$id": "#/properties/build/properties/python_packages/items", "anyOf": [ { "$id": "#/properties/build/properties/python_packages/items/anyOf/0", "type": "string" } ] } }, "pre_install": { "$id": "#/properties/build/properties/pre_install", "type": ["array", "null"], "description": "A list of setup commands to run in the environment before your Python packages are installed.", "additionalItems": true, "items": { "$id": "#/properties/build/properties/pre_install/items", "anyOf": [ { "$id": "#/properties/build/properties/pre_install/items/anyOf/0", "type": "string" } ] } }, "python_requirements": { "$id": "#/properties/build/properties/python_requirements", "type": "string", "description": "A pip requirements file specifying the Python packages to install." }, "system_packages": { "$id": "#/properties/build/properties/system_packages", "type": ["array", "null"], "description": "A list of Ubuntu APT packages to install.", "additionalItems": true, "items": { "$id": "#/properties/build/properties/system_packages/items", "anyOf": [ { "$id": "#/properties/build/properties/system_packages/items/anyOf/0", "type": "string" } ] } }, "run": { "$id": "#/properties/build/properties/run", "type": ["array", "null"], "description": "A list of setup commands to run in the environment after your system packages and Python packages have been installed. If you're familiar with Docker, it's like a `RUN` instruction in your `Dockerfile`.", "additionalItems": true, "items": { "$id": "#/properties/build/properties/run/items", "anyOf": [ { "$id": "#/properties/build/properties/run/items/anyOf/0", "type": "string" }, { "$id": "#/properties/build/properties/run/items/anyOf/1", "type": "object", "properties": { "command": { "type": "string" }, "mounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["secret"] }, "id": { "type": "string" }, "target": { "type": "string" } }, "required": ["type", "id", "target"] } } }, "required": ["command"] } ] } } }, "additionalProperties": false }, "image": { "$id": "#/properties/image", "type": "string", "description": "The name given to built Docker images. If you want to push to a registry, this should also include the registry name." }, "predict": { "$id": "#/properties/predict", "type": "string", "description": "The pointer to the `Predictor` object in your code, which defines how predictions are run on your model." }, "train": { "$id": "#/properties/train", "type": "string", "description": "The pointer to the `Predictor` object in your code, which defines how predictions are run on your model." } }, "additionalProperties": false }

launchsettings.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "profile": { "type": "object", "allOf": [ { "$ref": "#/definitions/profileContent" } ], "required": ["commandName"] }, "iisSetting": { "type": "object", "allOf": [ { "$ref": "#/definitions/iisSettingContent" } ] }, "iisSettingContent": { "properties": { "windowsAuthentication": { "type": "boolean", "description": "Set to true to enable windows authentication for your site in IIS and IIS Express.", "default": false }, "anonymousAuthentication": { "type": "boolean", "description": "Set to true to enable anonymous authentication for your site in IIS and IIS Express.", "default": true }, "iisExpress": { "type": "object", "description": "Site settings to use with IISExpress profiles.", "allOf": [ { "$ref": "#/definitions/iisBindingContent" } ] }, "iis": { "type": "object", "description": "Site settings to use with IIS profiles.", "allOf": [ { "$ref": "#/definitions/iisBindingContent" } ] } } }, "iisBindingContent": { "properties": { "applicationUrl": { "type": "string", "format": "uri", "description": "The URL of the web site.", "default": "" }, "sslPort": { "type": "integer", "maximum": 65535, "minimum": 0, "description": "The SSL port to use for the web site.", "default": 0 } } }, "profileContent": { "properties": { "commandName": { "type": "string", "description": "Identifies the debug target to run.", "enum": [ "Executable", "Project", "IIS", "IISExpress", "DebugRoslynComponent", "Docker", "DockerCompose", "MsixPackage" ], "default": "", "minLength": 1 }, "commandLineArgs": { "type": "string", "description": "The arguments to pass to the target being run.", "default": "" }, "executablePath": { "type": "string", "description": "An absolute or relative path to the executable.", "default": "" }, "workingDirectory": { "type": "string", "description": "Sets the working directory of the command." }, "launchBrowser": { "type": "boolean", "description": "Set to true if the browser should be launched.", "default": false }, "launchUrl": { "type": "string", "description": "The relative URL to launch in the browser." }, "environmentVariables": { "type": "object", "description": "Set the environment variables as key/value pairs.", "additionalProperties": { "type": "string" } }, "applicationUrl": { "type": "string", "description": "A semi-colon delimited list of URL(s) to configure for the web server." }, "nativeDebugging": { "type": "boolean", "description": "Set to true to enable native code debugging.", "default": false }, "externalUrlConfiguration": { "type": "boolean", "description": "Set to true to disable configuration of the site when running the Asp.Net Core Project profile.", "default": false }, "use64Bit": { "type": "boolean", "description": "Set to true to run the 64 bit version of IIS Express, false to run the x86 version.", "default": true }, "ancmHostingModel": { "enum": ["InProcess", "OutOfProcess"], "description": "Specifies the hosting model to use when running ASP.NET core projects in IIS and IIS Express.", "default": false }, "sqlDebugging": { "type": "boolean", "description": "Set to true to enable debugging of SQL scripts and stored procedures.", "default": false }, "jsWebView2Debugging": { "type": "boolean", "description": "Set to true to enable the JavaScript debugger for Microsoft Edge (Chromium) based WebView2.", "default": false }, "leaveRunningOnClose": { "type": "boolean", "description": "Set to true to leave the IIS application pool running when the project is closed.", "default": false }, "remoteDebugEnabled": { "type": "boolean", "description": "Set to true to have the debugger attach to a process on a remote computer.", "default": false }, "remoteDebugMachine": { "type": "string", "description": "The name and port number of the remote machine in name:port format." }, "authenticationMode": { "enum": ["None", "Windows"], "description": "The authentication scheme to use when connecting to the remote computer.", "default": "None" }, "hotReloadEnabled": { "type": "boolean", "description": "Set to true to enable applying code changes to the running application.", "default": true }, "publishAllPorts": { "type": "boolean", "description": "Publish all exposed ports to random ports in Docker (-P).", "default": true }, "useSSL": { "type": "boolean", "description": "Set to true to bind the SSL port.", "default": true }, "sslPort": { "type": "integer", "maximum": 65535, "minimum": 0, "description": "The SSL port to use for the web site.", "default": 0 }, "httpPort": { "type": "integer", "maximum": 65535, "minimum": 0, "description": "The HTTP port to use for the web site.", "default": 0 }, "dotnetRunMessages": { "type": "boolean", "description": "Set to true to display a message when the project is building.", "default": true }, "inspectUri": { "type": "string", "description": "The url to enable debugging on a Blazor WebAssembly application.", "default": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}" }, "targetProject": { "type": "string", "description": "A relative ot absolute path to the .NET project file on which Roslyn component should be executed. Relative to the current project's folder.", "default": "" } } } }, "id": "https://json.schemastore.org/launchsettings.json", "properties": { "profiles": { "type": "object", "description": "A list of debug profiles", "additionalProperties": { "$ref": "#/definitions/profile" } }, "iisSettings": { "type": "object", "description": "IIS and IIS Express settings", "allOf": [ { "$ref": "#/definitions/iisSettingContent" } ] } }, "title": "JSON schema for the Visual Studio LaunchSettings.json file.", "type": "object" }

gcp-blueprint-metadata.json

{ "$defs": { "BlueprintActuationTool": { "properties": { "flavor": { "type": "string" }, "version": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "BlueprintArchitecture": { "properties": { "diagramUrl": { "type": "string" }, "description": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["diagramUrl", "description"] }, "BlueprintAuthor": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["title"] }, "BlueprintCloudProduct": { "properties": { "productId": { "type": "string" }, "pageUrl": { "type": "string" }, "label": { "type": "string" }, "isExternal": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": ["pageUrl"] }, "BlueprintContent": { "properties": { "architecture": { "$ref": "#/$defs/BlueprintArchitecture" }, "diagrams": { "items": { "$ref": "#/$defs/BlueprintDiagram" }, "type": "array" }, "documentation": { "items": { "$ref": "#/$defs/BlueprintListContent" }, "type": "array" }, "subBlueprints": { "items": { "$ref": "#/$defs/BlueprintMiscContent" }, "type": "array" }, "examples": { "items": { "$ref": "#/$defs/BlueprintMiscContent" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "BlueprintCostEstimate": { "properties": { "description": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["description", "url"] }, "BlueprintDescription": { "properties": { "tagline": { "type": "string" }, "detailed": { "type": "string" }, "preDeploy": { "type": "string" }, "html": { "type": "string" }, "eulaUrls": { "items": { "type": "string" }, "type": "array" }, "architecture": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "BlueprintDiagram": { "properties": { "name": { "type": "string" }, "altText": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["name"] }, "BlueprintInfo": { "properties": { "title": { "type": "string" }, "source": { "$ref": "#/$defs/BlueprintRepoDetail" }, "version": { "type": "string" }, "actuationTool": { "$ref": "#/$defs/BlueprintActuationTool" }, "description": { "$ref": "#/$defs/BlueprintDescription" }, "icon": { "type": "string" }, "deploymentDuration": { "$ref": "#/$defs/BlueprintTimeEstimate" }, "costEstimate": { "$ref": "#/$defs/BlueprintCostEstimate" }, "cloudProducts": { "items": { "$ref": "#/$defs/BlueprintCloudProduct" }, "type": "array" }, "quotaDetails": { "items": { "$ref": "#/$defs/BlueprintQuotaDetail" }, "type": "array" }, "author": { "$ref": "#/$defs/BlueprintAuthor" }, "softwareGroups": { "items": { "$ref": "#/$defs/BlueprintSoftwareGroup" }, "type": "array" }, "supportInfo": { "$ref": "#/$defs/BlueprintSupport" }, "orgPolicyChecks": { "items": { "$ref": "#/$defs/BlueprintOrgPolicyCheck" }, "type": "array" }, "singleDeployment": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": ["title"] }, "BlueprintInterface": { "properties": { "variables": { "items": { "$ref": "#/$defs/BlueprintVariable" }, "type": "array" }, "variableGroups": { "items": { "$ref": "#/$defs/BlueprintVariableGroup" }, "type": "array" }, "outputs": { "items": { "$ref": "#/$defs/BlueprintOutput" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "BlueprintListContent": { "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["title"] }, "BlueprintMetadata": { "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/$defs/ResourceTypeMeta" }, "spec": { "$ref": "#/$defs/BlueprintMetadataSpec" } }, "additionalProperties": false, "type": "object", "required": ["spec"] }, "BlueprintMetadataSpec": { "properties": { "info": { "$ref": "#/$defs/BlueprintInfo" }, "content": { "$ref": "#/$defs/BlueprintContent" }, "interfaces": { "$ref": "#/$defs/BlueprintInterface" }, "requirements": { "$ref": "#/$defs/BlueprintRequirements" }, "ui": { "$ref": "#/$defs/BlueprintUI" } }, "additionalProperties": false, "type": "object" }, "BlueprintMiscContent": { "properties": { "name": { "type": "string" }, "location": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["name"] }, "BlueprintOrgPolicyCheck": { "properties": { "policyId": { "type": "string" }, "requiredValues": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["policyId"] }, "BlueprintOutput": { "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["name"] }, "BlueprintQuotaDetail": { "properties": { "dynamicVariable": { "type": "string" }, "resourceType": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "quotaType": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object", "required": ["resourceType", "quotaType"] }, "BlueprintRepoDetail": { "properties": { "repo": { "type": "string" }, "sourceType": { "type": "string" }, "dir": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["repo", "sourceType"] }, "BlueprintRequirements": { "properties": { "roles": { "items": { "$ref": "#/$defs/BlueprintRoles" }, "type": "array" }, "services": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "BlueprintRoles": { "properties": { "level": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["level", "roles"] }, "BlueprintSoftware": { "properties": { "title": { "type": "string" }, "version": { "type": "string" }, "url": { "type": "string" }, "licenseUrl": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["title"] }, "BlueprintSoftwareGroup": { "properties": { "type": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "software": { "items": { "$ref": "#/$defs/BlueprintSoftware" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "BlueprintSupport": { "properties": { "description": { "type": "string" }, "url": { "type": "string" }, "entity": { "type": "string" }, "showSupportId": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": ["description"] }, "BlueprintTimeEstimate": { "properties": { "configurationSecs": { "type": "integer" }, "deploymentSecs": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "BlueprintUI": { "properties": { "input": { "$ref": "#/$defs/BlueprintUIInput" }, "runtime": { "$ref": "#/$defs/BlueprintUIOutput" } }, "additionalProperties": false, "type": "object" }, "BlueprintUIInput": { "properties": { "variables": { "patternProperties": { ".*": { "$ref": "#/$defs/DisplayVariable" } }, "type": "object" }, "sections": { "items": { "$ref": "#/$defs/DisplaySection" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "BlueprintUIOutput": { "properties": { "outputMessage": { "type": "string" }, "suggestedActions": { "items": { "$ref": "#/$defs/UIActionItem" }, "type": "array" }, "outputs": { "patternProperties": { ".*": { "$ref": "#/$defs/DisplayOutput" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "BlueprintVariable": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "varType": { "type": "string" }, "defaultValue": true, "required": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "BlueprintVariableGroup": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "variables": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["name"] }, "DisplayOutput": { "properties": { "openInNewTab": { "type": "boolean" }, "showInNotification": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "DisplaySection": { "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "tooltip": { "type": "string" }, "subtext": { "type": "string" }, "parent": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["name"] }, "DisplayVariable": { "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "invisible": { "type": "boolean" }, "tooltip": { "type": "string" }, "placeholder": { "type": "string" }, "regexValidation": { "type": "string" }, "minItems": { "type": "integer" }, "maxItems": { "type": "integer" }, "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "min": { "type": "number" }, "max": { "type": "number" }, "section": { "type": "string" }, "xGoogleProperty": { "$ref": "#/$defs/GooglePropertyExtension" }, "validation": { "type": "string" }, "subtext": { "type": "string" }, "enumValueLabels": { "items": { "$ref": "#/$defs/ValueLabel" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["name", "title"] }, "GCEDiskSizeExtension": { "properties": { "diskTypeVariable": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["diskTypeVariable"] }, "GCEExternalIPExtension": { "properties": { "networkVariable": { "type": "string" }, "type": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "notConfigurable": { "type": "boolean" }, "allowStaticIPs": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": ["networkVariable"] }, "GCEFirewallExtension": { "properties": { "networkVariable": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["networkVariable"] }, "GCEFirewallRangeExtension": { "properties": { "firewallVariable": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["firewallVariable"] }, "GCEGPUCountExtension": { "properties": { "machineTypeVariable": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["machineTypeVariable"] }, "GCEGPUTypeExtension": { "properties": { "machineType": { "type": "string" }, "gpuType": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["machineType"] }, "GCEGenericResourceExtension": { "properties": { "resourceVariable": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["resourceVariable"] }, "GCEIPForwardingExtension": { "properties": { "networkVariable": { "type": "string" }, "notConfigurable": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": ["networkVariable"] }, "GCELocationExtension": { "properties": { "allowlistedZones": { "items": { "type": "string" }, "type": "array" }, "allowlistedRegions": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "GCEMachineTypeExtension": { "properties": { "minCpu": { "type": "integer" }, "minRamGb": { "type": "number" }, "disallowCustomMachineTypes": { "type": "boolean" }, "diskImageProperty": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GCENetworkExtension": { "properties": { "allowSharedVpcs": { "type": "boolean" }, "machineTypeVariable": { "type": "string" }, "labels": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["machineTypeVariable"] }, "GCESubnetworkExtension": { "properties": { "networkVariable": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["networkVariable"] }, "GooglePropertyExtension": { "properties": { "type": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "zoneProperty": { "type": "string" }, "gceMachineType": { "$ref": "#/$defs/GCEMachineTypeExtension" }, "gceDiskSize": { "$ref": "#/$defs/GCEDiskSizeExtension" }, "gceSubnetwork": { "$ref": "#/$defs/GCESubnetworkExtension" }, "gceResource": { "$ref": "#/$defs/GCEGenericResourceExtension" }, "gceGpuType": { "$ref": "#/$defs/GCEGPUTypeExtension" }, "gceGpuCount": { "$ref": "#/$defs/GCEGPUCountExtension" }, "gceNetwork": { "$ref": "#/$defs/GCENetworkExtension" }, "gceExternalIp": { "$ref": "#/$defs/GCEExternalIPExtension" }, "gceIpForwarding": { "$ref": "#/$defs/GCEIPForwardingExtension" }, "gceFirewall": { "$ref": "#/$defs/GCEFirewallExtension" }, "gceFirewallRange": { "$ref": "#/$defs/GCEFirewallRangeExtension" }, "gceZone": { "$ref": "#/$defs/GCELocationExtension" }, "gceRegion": { "$ref": "#/$defs/GCELocationExtension" }, "iamServiceAccount": { "$ref": "#/$defs/IAMServiceAccountExtension" } }, "additionalProperties": false, "type": "object", "required": ["type"] }, "IAMServiceAccountExtension": { "properties": { "roles": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": ["roles"] }, "ResourceTypeMeta": { "properties": { "name": { "type": "string" }, "labels": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "annotations": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "UIActionItem": { "properties": { "heading": { "type": "string" }, "description": { "type": "string" }, "snippet": { "type": "string" }, "showIf": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": ["heading"] }, "Value": { "properties": { "Kind": true }, "additionalProperties": false, "type": "object", "required": ["Kind"] }, "ValueLabel": { "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false, "type": "object" } }, "$id": "https://github.com/GoogleCloudPlatform/cloud-foundation-toolkit/cli/bpmetadata/blueprint-metadata", "$ref": "#/$defs/BlueprintMetadata", "$schema": "http://json-schema.org/draft-07/schema#" }

aiproj-1.1.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "description": "Settings for project analysis by the Application Inspector", "id": "https://json.schemastore.org/aiproj-1.1.json", "properties": { "$schema": { "type": "string" }, "Version": { "type": "string", "enum": ["1.0", "1.1"] }, "BlackBoxSettings": { "type": ["object", "null"], "title": "Black box and autocheck options", "additionalProperties": false, "properties": { "AdditionalHttpHeaders": { "title": "Additional HTTP headers", "description": "Dictionary of additional HTTP headers", "type": ["array", "null"], "items": { "type": "object", "properties": { "Key": { "title": "Header", "type": "string" }, "Value": { "type": "string", "title": "value" } } } }, "WhiteListedAddresses": { "type": ["array", "null"], "title": "Whitelisted addresses", "description": "Addresses, that was added in white list", "items": { "type": "object", "properties": { "Address": { "title": "Address", "description": "Address value", "type": "string" }, "Format": { "type": "string", "title": "Address format", "description": "Type of address", "enum": ["Wildcard", "ExactMatch", "RegExp"] } } } }, "BlackListedAddresses": { "type": ["array", "null"], "title": "Blacklisted addresses", "description": "Addresses, that was added in black list", "items": { "type": "object", "properties": { "Address": { "title": "Address", "description": "Address value", "type": "string" }, "Format": { "type": "string", "title": "Address format", "description": "Type of address", "enum": ["Wildcard", "ExactMatch", "RegExp"] } } } }, "Authentication": { "oneOf": [ { "type": "object", "required": ["Cookie", "Type"], "properties": { "Type": { "enum": ["RawCookie"] }, "Cookie": { "type": "object" } } }, { "type": "object", "required": ["Form", "Type"], "properties": { "Type": { "enum": ["Form"] }, "Form": { "type": "object" } } }, { "type": "object", "required": ["Http", "Type"], "properties": { "Type": { "enum": ["Http"] }, "Http": { "type": "object" } } }, { "type": "object", "required": ["Type"], "properties": { "Type": { "enum": ["None"] } } }, { "type": "null" } ], "type": ["object", "null"], "title": "Authentication options", "additionalProperties": false, "properties": { "Cookie": { "type": ["object", "null"], "title": "Cookie options", "description": "Cookie authentication options", "required": ["Cookie", "ValidationAddress", "ValidationTemplate"], "additionalProperties": false, "properties": { "Cookie": { "title": "Cookie", "type": "string" }, "ValidationAddress": { "title": "Validation address", "description": "Verification address", "type": "string" }, "ValidationTemplate": { "title": "Validation template", "description": "String to search for", "type": "string" } } }, "Form": { "type": ["object", "null"], "title": "Form", "description": "Form-based authentication options", "additionalProperties": false, "properties": { "FormDetection": { "type": "string", "title": "Detection", "description": "Type of form authentication detection", "enum": ["Auto", "Manual"] }, "FormAddress": { "title": "Sign-in form URL" }, "FormXPath": { "title": "Sign-in form XPath" }, "Login": { "title": "User" }, "LoginKey": { "title": "User identifier" }, "Password": { "title": "Password" }, "PasswordKey": { "title": "Password identifier" }, "ValidationTemplate": { "title": "Validation template", "description": "String to search for" } }, "anyOf": [ { "properties": { "FormDetection": { "enum": ["Auto"] }, "FormAddress": { "type": ["string"] }, "FormXPath": { "type": ["null", "string"] }, "Login": { "type": "string" }, "LoginKey": { "type": ["null", "string"] }, "Password": { "type": "string" }, "PasswordKey": { "type": ["null", "string"] }, "ValidationTemplate": { "type": ["string"] } }, "required": [ "FormDetection", "Login", "Password", "FormAddress", "ValidationTemplate" ] }, { "properties": { "FormDetection": { "enum": ["Manual"] }, "FormAddress": { "type": ["string"] }, "FormXPath": { "type": ["string"] }, "Login": { "type": "string" }, "LoginKey": { "type": ["string"] }, "Password": { "type": "string" }, "PasswordKey": { "type": ["string"] }, "ValidationTemplate": { "type": ["string"] } }, "required": [ "FormDetection", "Login", "Password", "FormAddress", "ValidationTemplate", "LoginKey", "PasswordKey", "FormXPath" ] } ] }, "Http": { "type": ["object", "null"], "title": "Http", "description": "HTTP Basic authentication options", "additionalProperties": false, "required": ["Login", "Password", "ValidationAddress"], "properties": { "Login": { "title": "User", "type": "string" }, "Password": { "title": "Password", "type": "string" }, "ValidationAddress": { "title": "Validation address", "type": "string" } } }, "Type": { "title": "Type of authentication", "type": "string", "enum": ["Form", "Http", "RawCookie", "None"] } } }, "Level": { "title": "Search mode", "type": "string", "enum": ["None", "Fast", "Full", "Normal"] }, "ProxySettings": { "type": ["object", "null"], "title": "Proxy settings", "description": "Proxy server settings", "additionalProperties": false, "properties": { "Enabled": { "title": "Enabled", "type": "boolean" }, "Host": { "title": "Address", "type": ["null", "string"] }, "Login": { "title": "User", "type": ["null", "string"] }, "Password": { "title": "Password", "type": ["null", "string"] }, "Port": { "title": "Port", "type": "integer" }, "Type": { "title": "Type of proxy", "type": "string", "enum": ["Http", "Socks4", "Socks5"] } } }, "RunAutocheckAfterScan": { "title": "Run autocheck", "description": "Autocheck vulnerabilities after scanning", "type": "boolean" }, "ScanScope": { "title": "Scan scope", "type": "string", "enum": ["Domain", "Folder", "Path"] }, "Site": { "title": "Website address", "type": "string" }, "SslCheck": { "title": "Check ssl connection", "type": "boolean" } } }, "CustomParameters": { "title": "Custom parameters", "description": "Custom kernel startup parameters", "type": ["null", "string"] }, "DotNetSettings": { "type": ["object", "null"], "title": ".NET scan options", "additionalProperties": false, "properties": { "ProjectType": { "title": "Type of application", "type": "string", "enum": ["None", "Solution", "WebSite"] }, "SolutionFile": { "title": "Solution file", "description": "Path to a solution or project", "type": ["null", "string"] } } }, "JavaSettings": { "type": ["object", "null"], "title": "Java scan options", "additionalProperties": false, "properties": { "Parameters": { "title": "JVM start options", "type": ["null", "string"] }, "UnpackUserPackages": { "title": "Unpack custom JAR files", "type": "boolean" }, "UserPackagePrefixes": { "title": "Prefixes of custom packages", "type": ["null", "string"] }, "Version": { "title": "JDK version", "type": "string", "enum": ["v1_8", "v1_11"] } } }, "MailingProjectSettings": { "type": ["object", "null"], "title": "Mail settings", "description": "Report mailing options", "additionalProperties": false, "properties": { "Enabled": { "title": "Send a report by email after scanning", "type": "boolean" }, "MailProfileName": { "title": "Email profile name", "type": ["null", "string"] }, "EmailRecipients": { "title": "List of recipients", "type": "array", "items": { "type": "string", "format": "email" } } }, "oneOf": [ { "type": "object", "properties": { "Enabled": { "enum": [true] }, "MailProfileName": { "type": "string", "minLength": 1 }, "EmailRecipients": { "type": "array", "minItems": 1, "maxItems": 10 } }, "required": ["Enabled", "MailProfileName", "EmailRecipients"] }, { "properties": { "Enabled": { "enum": [false] }, "MailProfileName": { "type": ["null", "string"] }, "EmailRecipients": { "type": "array", "minItems": 0, "maxItems": 10 } }, "required": ["Enabled"] } ] }, "ProgrammingLanguage": { "title": "Active scanning language", "type": "string", "enum": [ "Java", "CSharp", "VB", "Php", "JavaScript", "Python", "ObjectiveC", "Swift", "CAndCPlusPlus", "Go", "Kotlin", "Sql" ] }, "ProjectName": { "title": "Project name", "type": "string" }, "ScanModules": { "title": "Enabled modules", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "Configuration", "Components", "BlackBox", "DataFlowAnalysis", "PatternMatching", "VulnerableSourceCode" ] } }, "SkipGitIgnoreFiles": { "title": "Skip .gitignore files", "description": "Exclude from scanning the files from the .gitignore file", "type": "boolean" }, "UsePublicAnalysisMethod": { "title": "Use public analysis method", "description": "Search from available public and protected methods", "type": "boolean" }, "UseSastRules": { "title": "Use SAST rules", "description": "Enable SAST Analysis rules", "type": "boolean" }, "UseCustomPmRules": { "title": "Use custom PM rules", "description": "Enable custom PM rules", "type": "boolean" }, "UseSecurityPolicies": { "title": "Use security policies", "description": "Check for compliance with the security policy", "type": "boolean" }, "DownloadDependencies": { "title": "Download dependencies", "type": ["null", "boolean"] } }, "required": ["ProjectName", "ProgrammingLanguage", "ScanModules"], "title": "aiproj", "type": "object" }

remarkrc.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "https://json.schemastore.org/remarkrc.json", "properties": { "plugins": { "description": "The plugins field, related to plugins in options, has either an array of plugin names (or paths) or plugin–options tuples, or an object mapping plugins to their options.\nPlugin options can be false, which specifies that a plugin should not be used. In all other cases, they are treated as an object, and merged by the cascade. Thus, it's possible to specify part of the options from one configuration file, and overwrite or extend it from another file.", "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "array", "additionalItems": true, "items": [ { "type": "string" } ] } ] } }, { "type": "object" } ] }, "settings": { "type": "object", "additionalProperties": false, "properties": { "bullet": { "description": "Marker to use to for bullets of items in unordered lists.", "enum": ["*", "+", "-"], "default": "*" }, "closeAtx": { "description": "Whether to add the same number of number signs (#) at the end of an ATX heading as the opening sequence.", "type": "boolean", "default": false }, "emphasis": { "description": "Marker to use to serialize emphasis.", "enum": ["*", "_"], "default": "*" }, "fence": { "description": "Marker to use to serialize fenced code.", "enum": ["`", "~"], "default": "`" }, "fences": { "description": "Whether to use fenced code always. The default is to fenced code if there is a language defined, if the code is empty, or if it starts or ends in empty lines", "type": "boolean", "default": false }, "incrementListMarker": { "description": "Whether to increment the value of bullets of items in ordered lists.", "type": "boolean", "default": true }, "listItemIndent": { "description": "Whether to indent the content of list items with the size of the bullet plus one space (when 'one') or a tab stop ('tab'), or depending on the item and its parent list ('mixed', uses 'one' if the item and list are tight and 'tab' otherwise)", "enum": ["one", "tab", "mixed"], "default": "tab" }, "quote": { "description": "Marker to use to serialize titles.", "enum": ["\"", "'"], "default": "\"" }, "resourceLink": { "description": "Whether to use resource links ([text](url)) always. The default is to use autolinks (<https://example.com>) when possible.", "type": "boolean", "default": false }, "rule": { "description": "Marker to use for thematic breaks.", "enum": ["*", "-", "_"], "default": "*" }, "ruleRepetition": { "description": "Number of markers to use for thematic breaks.", "type": "integer", "minimum": 3, "default": 3 }, "ruleSpaces": { "description": "Whether to add spaces between markers in thematic breaks.", "type": "boolean", "default": false }, "setext": { "description": "Whether to use setext headings when possible. Setext headings are not possible for headings with a rank more than 2 or when they're empty.", "type": "boolean", "default": false }, "strong": { "description": "Marker to use to serialize strong.", "enum": ["*", "_"], "default": "_" }, "tightDefinitions": { "description": "Whether to join definitions w/o a blank line.", "type": "boolean", "default": false } } } }, "title": "JSON schema for .remarkrc", "type": "object" }

kustomization.json

{ "$ref": "#/definitions/Kustomization", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "ConfigMapArgs": { "description": "ConfigMapArgs contains the metadata of how to generate a configmap", "properties": { "KVSources": { "items": { "$ref": "#/definitions/KVSource" }, "type": "array" }, "behavior": { "enum": ["create", "replace", "merge"] }, "env": { "description": "Deprecated. Use envs instead.", "type": "string" }, "envs": { "description": "A list of file paths. The contents of each file should be one key=value pair per line", "items": { "type": "string" }, "type": "array" }, "files": { "description": "A list of file sources to use in creating a list of key, value pairs", "items": { "type": "string" }, "type": "array" }, "literals": { "description": "A list of literal pair sources. Each literal source should be a key and literal value, e.g. `key=value`", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Name - actually the partial name - of the generated resource", "type": "string" }, "namespace": { "description": "Namespace for the configmap, optional", "type": "string" }, "options": { "$ref": "#/definitions/GeneratorOptions" } }, "additionalProperties": false, "type": "object" }, "FieldSelector": { "description": "Contains the fieldPath to an object field", "properties": { "fieldpath": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "FieldSpec": { "properties": { "create": { "type": "boolean" }, "group": { "type": "string" }, "kind": { "type": "string" }, "path": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "GeneratorOptions": { "description": "GeneratorOptions modify behavior of all ConfigMap and Secret generators", "properties": { "annotations": { "description": "Annotations to add to all generated resources", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "disableNameSuffixHash": { "description": "DisableNameSuffixHash if true disables the default behavior of adding a suffix to the names of generated resources that is a hash of the resource contents", "type": "boolean" }, "immutable": { "description": "Immutable if true add to all generated resources", "type": "boolean" }, "labels": { "description": "Labels to add to all generated resources", "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "HelmChart": { "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "repo": { "type": "string" }, "releaseName": { "type": "string" }, "namespace": { "type": "string" }, "valuesFile": { "type": "string" }, "valuesInline": { "type": "object", "patternProperties": { ".*": { "additionalProperties": true } } }, "valuesMerge": { "type": "string", "enum": ["merge", "override", "replace"] }, "includeCRDs": { "type": "boolean" }, "additionalValuesFiles": { "type": "array", "items": { "type": "string" } }, "skipTests": { "type": "boolean" }, "apiVersions": { "type": "array", "items": { "type": "string" } }, "nameTemplate": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Image": { "properties": { "digest": { "type": "string" }, "name": { "type": "string" }, "newName": { "type": "string" }, "newTag": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Inventory": { "description": "Inventory appends an object that contains the record of all other objects, which can be used in apply, prune and delete", "properties": { "configMap": { "$ref": "#/definitions/NameArgs" }, "type": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "KVSource": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "pluginType": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Kustomization": { "properties": { "apiVersion": { "type": "string" }, "bases": { "description": "DEPRECATED. Bases are relative paths or git repository URLs specifying a directory containing a kustomization.yaml file.", "items": { "type": "string" }, "type": "array" }, "commonAnnotations": { "description": "CommonAnnotations to add to all objects", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "buildMetadata": { "description": "BuildMetadata is a list of strings used to toggle different build options", "items": { "type": "string" }, "type": "array" }, "commonLabels": { "description": " CommonLabels to add to all objects and selectors", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "configMapGenerator": { "description": "ConfigMapGenerator is a list of configmaps to generate from local data (one configMap per list item)", "items": { "$ref": "#/definitions/ConfigMapArgs" }, "type": "array" }, "configurations": { "description": "Configurations is a list of transformer configuration files", "items": { "type": "string" }, "type": "array" }, "crds": { "description": "Crds specifies relative paths to Custom Resource Definition files. This allows custom resources to be recognized as operands, making it possible to add them to the Resources list. CRDs themselves are not modified.", "items": { "type": "string" }, "type": "array" }, "generatorOptions": { "$ref": "#/definitions/GeneratorOptions" }, "generators": { "description": "Generators is a list of files containing custom generators", "items": { "type": "string" }, "type": "array" }, "helmCharts": { "description": "HelmCharts is a list of helm chart configuration instances", "items": { "$ref": "#/definitions/HelmChart" }, "type": "array" }, "helmGlobals": { "description": "HelmGlobals contains helm configuration that isn't chart specific", "properties": { "chartHome": { "description": "ChartHome is a file path, relative to the kustomization root, to a directory containing a subdirectory for each chart to be included in the kustomization", "type": "string" }, "configHome": { "description": "ConfigHome defines a value that kustomize should pass to helm via the HELM_CONFIG_HOME environment variable", "type": "string" } }, "additionalProperties": false, "type": "object" }, "images": { "description": "Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.", "items": { "$ref": "#/definitions/Image" }, "type": "array" }, "inventory": { "$ref": "#/definitions/Inventory" }, "labels": { "description": "Labels to add to all objects but not selectors", "items": { "$ref": "#/definitions/Labels" }, "type": "array" }, "kind": { "type": "string" }, "metadata": { "description": "Contains metadata about a Resource", "$ref": "#/definitions/Metadata" }, "namePrefix": { "description": "NamePrefix will prefix the names of all resources mentioned in the kustomization file including generated configmaps and secrets", "type": "string" }, "nameSuffix": { "description": "NameSuffix will suffix the names of all resources mentioned in the kustomization file including generated configmaps and secrets", "type": "string" }, "namespace": { "description": "Namespace to add to all objects", "type": "string" }, "replacements": { "type": "array", "description": "Substitute field(s) in N target(s) with a field from a source", "items": { "oneOf": [ { "$ref": "#/definitions/ReplacementsPath" }, { "$ref": "#/definitions/ReplacementsInline" } ] } }, "openapi": { "description": "OpenAPI contains information about what kubernetes schema to use", "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "patches": { "description": "Apply a patch to multiple resources", "items": { "oneOf": [ { "$ref": "#/definitions/PatchesPatchPath" }, { "$ref": "#/definitions/PatchesInlinePatch" } ] }, "type": "array" }, "patchesJson6902": { "description": "JSONPatches is a list of JSONPatch for applying JSON patch. See http://jsonpatch.com", "items": { "$ref": "#/definitions/PatchJson6902" }, "type": "array" }, "patchesStrategicMerge": { "description": " PatchesStrategicMerge specifies the relative path to a file containing a strategic merge patch. URLs and globs are not supported", "items": { "type": "string" }, "type": "array" }, "replicas": { "description": "Replicas is a list of (resource name, count) for changing number of replicas for a resources. It will match any group and kind that has a matching name and that is one of: Deployment, ReplicationController, Replicaset, Statefulset.", "items": { "$ref": "#/definitions/Replicas" }, "type": "array" }, "resources": { "description": "Resources specifies relative paths to files holding YAML representations of kubernetes API objects. URLs and globs not supported.", "items": { "type": "string" }, "type": "array" }, "components": { "description": "Components are relative paths or git repository URLs specifying a directory containing a kustomization.yaml file of Kind Component.", "items": { "type": "string" }, "type": "array" }, "secretGenerator": { "description": "SecretGenerator is a list of secrets to generate from local data (one secret per list item)", "items": { "$ref": "#/definitions/SecretArgs" }, "type": "array" }, "transformers": { "description": "Transformers is a list of files containing transformers", "items": { "type": "string" }, "type": "array" }, "validators": { "description": "Validators is a list of files containing validators", "items": { "type": "string" }, "type": "array" }, "vars": { "description": "Allows things modified by kustomize to be injected into a container specification. A var is a name (e.g. FOO) associated with a field in a specific resource instance. The field must contain a value of type string, and defaults to the name field of the instance", "items": { "$ref": "#/definitions/Var" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Labels": { "properties": { "pairs": { "description": "Pairs contains the key-value pairs for labels to add", "patternProperties": { ".*": { "type": "string" } } }, "includeSelectors": { "description": "IncludeSelectors inidicates should transformer include the fieldSpecs for selectors", "type": "boolean" }, "includeTemplates": { "description": "IncludeTemplates inidicates should transformer include the template labels", "type": "boolean" }, "fields": { "description": "FieldSpec completely specifies a kustomizable field in a k8s API object. It helps define the operands of transformations", "items": { "$ref": "#/definitions/FieldSpec" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Metadata": { "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "labels": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "annotations": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "NameArgs": { "properties": { "name": { "type": "string" }, "namespace": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "PatchJson6902": { "oneOf": [ { "required": ["path", "target"], "properties": { "path": { "description": "relative file path for a json patch file inside a kustomization", "type": "string" }, "target": { "description": "Refers to a Kubernetes object that the json patch will be applied to. It must refer to a Kubernetes resource under the purview of this kustomization", "$ref": "#/definitions/PatchTarget" } }, "additionalProperties": false, "type": "object" }, { "required": ["patch", "target"], "properties": { "patch": { "description": "inline json patch", "type": "string" }, "target": { "description": "Refers to a Kubernetes object that the json patch will be applied to. It must refer to a Kubernetes resource under the purview of this kustomization", "$ref": "#/definitions/PatchTarget" } }, "additionalProperties": false, "type": "object" }, { "required": ["op", "path"], "properties": { "op": { "description": "The operation", "type": "string", "enum": ["add", "remove", "replace", "move", "copy", "test"] }, "from": { "description": "The source location.", "type": "string" }, "path": { "description": "The target location.", "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] } }, "additionalProperties": false, "type": "object" } ] }, "PatchTarget": { "required": ["kind", "name", "version"], "properties": { "group": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "version": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "PatchTargetOptional": { "properties": { "group": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "version": { "type": "string" }, "labelSelector": { "type": "string" }, "annotationSelector": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "PatchesOptions": { "properties": { "allowNameChange": { "type": "boolean" }, "allowKindChange": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "PatchesPatchPath": { "required": ["path"], "properties": { "options": { "$ref": "#/definitions/PatchesOptions" }, "path": { "type": "string" }, "target": { "description": "Refers to a Kubernetes object that the patch will be applied to. It must refer to a Kubernetes resource under the purview of this kustomization", "$ref": "#/definitions/PatchTargetOptional" } }, "additionalProperties": false }, "PatchesInlinePatch": { "required": ["patch"], "properties": { "options": { "$ref": "#/definitions/PatchesOptions" }, "patch": { "type": "string" }, "target": { "description": "Refers to a Kubernetes object that the patch will be applied to. It must refer to a Kubernetes resource under the purview of this kustomization", "$ref": "#/definitions/PatchTargetOptional" } }, "additionalProperties": false }, "ReplacementsInline": { "required": ["source", "targets"], "type": "object", "additionalProperties": false, "properties": { "source": { "type": "object", "description": "The source of the value", "properties": { "group": { "type": "string", "description": "The group of the referent" }, "version": { "type": "string", "description": "The version of the referent" }, "kind": { "type": "string", "description": "The kind of the referent" }, "name": { "type": "string", "description": "The name of the referent" }, "namespace": { "type": "string", "description": "The namespace of the referent" }, "fieldPath": { "type": "string", "description": "The structured path to the source value" }, "options": { "type": "object", "properties": { "delimiter": { "type": "string" }, "index": { "type": "number" }, "create": { "type": "boolean" } } } } }, "targets": { "description": "The N fields to write the value to", "type": "array", "items": { "required": ["select"], "type": "object", "properties": { "select": { "type": "object", "description": "Include objects that match this", "properties": { "group": { "type": "string", "description": "The group of the referent" }, "version": { "type": "string", "description": "The version of the referent" }, "kind": { "type": "string", "description": "The kind of the referent" }, "name": { "type": "string", "description": "The name of the referent" }, "namespace": { "type": "string", "description": "The namespace of the referent" } } }, "reject": { "type": "array", "description": "Exclude objects that match this", "items": { "type": "object", "description": "Exclude objects that match this", "properties": { "group": { "type": "string", "description": "The group of the referent" }, "version": { "type": "string", "description": "The version of the referent" }, "kind": { "type": "string", "description": "The kind of the referent" }, "name": { "type": "string", "description": "The name of the referent" }, "namespace": { "type": "string", "description": "The namespace of the referent" } } } }, "fieldPaths": { "type": "array", "description": "The structured path(s) to the target nodes", "items": { "type": "string", "description": "The structured path to the source value" } }, "options": { "type": "object", "properties": { "delimiter": { "type": "string" }, "index": { "type": "number" }, "create": { "type": "boolean" } } } } } } } }, "ReplacementsPath": { "required": ["path"], "type": "object", "additionalProperties": false, "properties": { "path": { "type": "string" } } }, "Replicas": { "properties": { "name": { "type": "string" }, "count": { "type": "number" } }, "additionalProperties": false, "type": "object" }, "SecretArgs": { "description": "SecretArgs contains the metadata of how to generate a secret", "properties": { "KVSources": { "items": { "$ref": "#/definitions/KVSource" }, "type": "array" }, "behavior": { "enum": ["create", "replace", "merge"] }, "env": { "type": "string" }, "envs": { "items": { "type": "string" }, "type": "array" }, "files": { "items": { "type": "string" }, "type": "array" }, "literals": { "items": { "type": "string" }, "type": "array" }, "name": { "description": "Name - actually the partial name - of the generated resource", "type": "string" }, "namespace": { "description": "Namespace for the secret, optional", "type": "string" }, "options": { "$ref": "#/definitions/GeneratorOptions" }, "type": { "description": "Type of the secret, optional", "type": "string" } }, "additionalProperties": false, "type": "object" }, "Target": { "required": ["name"], "properties": { "apiVersion": { "type": "string" }, "group": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Var": { "description": "Represents a variable whose value will be sourced from a field in a Kubernetes object.", "required": ["name", "objref"], "properties": { "fieldref": { "description": "Refers to the field of the object referred to by objref whose value will be extracted for use in replacing $(FOO)", "$ref": "#/definitions/FieldSelector" }, "name": { "description": "Value of identifier name e.g. FOO used in container args, annotations, Appears in pod template as $(FOO)", "type": "string" }, "objref": { "description": "Refers to a Kubernetes resource under the purview of this kustomization", "$ref": "#/definitions/Target" } }, "additionalProperties": false, "type": "object" } }, "id": "https://json.schemastore.org/kustomization.json" }

sil-kit-participant-configuration.json

{ "$id": "https://json.schemastore.org/sil-kit-participant-configuration.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "Description": { "type": "string", "description": "Free text commenting on or summarizing this configuration. Optional", "default": "" }, "Name": { "type": "string", "description": "Name of the endpoint" }, "Network": { "type": "string", "description": "Name of the network. Optional; Defaults to the endpoint name" }, "UseTraceSinks": { "type": "array", "description": "Names of trace sinks to use" }, "Replay": { "type": "object", "properties": { "UseTraceSource": { "type": "string", "description": "Name of a trace source used as a simulation message source for this controller" }, "Direction": { "type": "string", "description": "Filter messages to use from the trace source by their direction. May be Send, Receive or Both", "enum": ["Send", "Receive", "Both"] }, "MdfChannel": { "type": "object", "properties": { "ChannelName": { "type": "string", "description": "Name of an MDF channel in the trace source" }, "ChannelSource": { "type": "string", "description": "Name of an MDF channel's source information object" }, "ChannelPath": { "type": "string", "description": "Path of an MDF channel's source information object" }, "GroupName": { "type": "string", "description": "Name of an MDF channel group" }, "GroupSource": { "type": "string", "description": "Name of an MDF channel group's source information object" }, "GroupPath": { "type": "string", "description": "Path of an MDF channel group's source information object" } } } } }, "FlexrayClusterParameters": { "type": "object", "properties": { "gColdstartAttempts": { "type": "integer", "minimum": 2, "maximum": 31, "description": "Number of attempts for a cold start before giving up (range 2-31)" }, "gCycleCountMax": { "type": "integer", "minimum": 7, "maximum": 63, "description": "Max cycle count value in a given cluster (range 7-63, must be an odd integer)" }, "gdActionPointOffset": { "type": "integer", "minimum": 1, "maximum": 63, "description": "Time offset for a static slot in macroticks (range 1 - 63)" }, "gdDynamicSlotIdlePhase": { "type": "integer", "minimum": 0, "maximum": 2, "description": "Duration of the idle phase within a dynamic slot in gdMiniSlots (range 0 - 2)" }, "gdMiniSlot": { "type": "integer", "minimum": 2, "maximum": 63, "description": "Duration of a mini slot in macroticks (2 - 63)" }, "gdMiniSlotActionPointOffset": { "type": "integer", "minimum": 1, "maximum": 31, "description": "Time offset for a mini slot in macroticks (range 1- 31)" }, "gdStaticSlot": { "type": "integer", "minimum": 3, "maximum": 664, "description": "Duration of a static slot in macroticks (range 3 - 664)" }, "gdSymbolWindow": { "type": "integer", "minimum": 0, "maximum": 162, "description": "Duration of the symbol window in macroticks (range 0 - 162)" }, "gdSymbolWindowActionPointOffset": { "type": "integer", "minimum": 1, "maximum": 63, "description": "Time offset for a static symbol windows in macroticks (range 1 - 63)" }, "gdTSSTransmitter": { "type": "integer", "minimum": 1, "maximum": 15, "description": "Duration of TSS (Transmission Start Sequence) in gdBits (range 1 - 15)" }, "gdWakeupTxActive": { "type": "integer", "minimum": 15, "maximum": 60, "description": "Duration of LOW Phase of a wakeup symbol in gdBit (range 15 - 60)" }, "gdWakeupTxIdle": { "type": "integer", "minimum": 45, "maximum": 180, "description": "Duration of the idle of a wakeup symbol in gdBit (45 - 180)" }, "gListenNoise": { "type": "integer", "minimum": 2, "maximum": 16, "description": "Upper limit for the startup listen timeout and wakeup listen timeout in the presence of noise; Used as a multiplier of pdListenTimeout (range 2 - 16)" }, "gMacroPerCycle": { "type": "integer", "minimum": 8, "maximum": 16000, "description": "Number of macroticks per cycle (range 8 - 16000)" }, "gMaxWithoutClockCorrectionFatal": { "type": "integer", "minimum": 1, "maximum": 15, "description": "Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)" }, "gMaxWithoutClockCorrectionPassive": { "type": "integer", "minimum": 1, "maximum": 15, "description": "Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)" }, "gNumberOfMiniSlots": { "type": "integer", "minimum": 0, "maximum": 7988, "description": "Number of mini slots (range 0 - 7988)" }, "gNumberOfStaticSlots": { "type": "integer", "minimum": 2, "maximum": 1023, "description": "Number of static slots in a cycle (range 2 - 1023)" }, "gPayloadLengthStatic": { "type": "integer", "minimum": 0, "maximum": 127, "description": "Length of the payload of a static frame in 16-Bits words (range 0 - 127)" }, "gSyncFrameIDCountMax": { "type": "integer", "minimum": 2, "maximum": 15, "description": "Maximum number of distinct sync frame identifiers present in a given cluster (range 2 - 15)" } } }, "FlexrayNodeParameters": { "type": "object", "properties": { "pAllowHaltDueToClock": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Controls the transition to halt state due to clock synchronization errors. (values 0, 1)" }, "pAllowPassiveToActive": { "type": "integer", "minimum": 0, "maximum": 31, "description": "Required number of consecutive even / odd cycle pairs for normal passive to normal active (range 0 - 31)" }, "pChannels": { "type": "string", "enum": ["A", "B", "AB", "None"], "description": "Channel(s) to which the controller is connected" }, "pClusterDriftDamping": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Cluster drift damping factor for rate correction in microticks (range 0 - 10)" }, "pdAcceptedStartupRange": { "type": "integer", "minimum": 29, "maximum": 2743, "description": "Allowed deviation for startup frames during integration in microticks (range 29 - 2743)" }, "pdListenTimeout": { "type": "integer", "minimum": 1926, "maximum": 2567692, "description": "Duration of listen phase in microticks (range 1926 - 2567692)" }, "pKeySlotId": { "type": "integer", "minimum": 0, "maximum": 1023, "description": "Slot ID of the key slot (range 0 - 1023; value 0 means that there is no key slot)" }, "pKeySlotOnlyEnabled": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Shall the node enter key slot only mode after startup. (values 0, 1) (AUTOSAR pSingleSlotEnabled)" }, "pKeySlotUsedForStartup": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Key slot is used for startup (values 0, 1)" }, "pKeySlotUsedForSync": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Key slot is used for sync (values 0, 1)" }, "pLatestTx": { "type": "integer", "minimum": 0, "maximum": 7988, "description": "Last mini slot which can be transmitted (range 0 - 7988)" }, "pMacroInitialOffsetA": { "type": "integer", "minimum": 2, "maximum": 68, "description": "Initial startup offset for frame reference point on channel A (range 2 - 68 macroticks)" }, "pMacroInitialOffsetB": { "type": "integer", "minimum": 2, "maximum": 68, "description": "Initial startup offset for frame reference point on channel B (range 2 - 68 macroticks)" }, "pMicroInitialOffsetA": { "type": "integer", "minimum": 0, "maximum": 239, "description": "Offset between secondary time reference and MT boundary (range 0 - 239 microticks)" }, "pMicroInitialOffsetB": { "type": "integer", "minimum": 0, "maximum": 239, "description": "Offset between secondary time reference and MT boundary (range 0 - 239 microticks)" }, "pMicroPerCycle": { "type": "integer", "minimum": 960, "maximum": 1280000, "description": "Nominal number of microticks in the communication cycle (range 960 - 1280000)" }, "pOffsetCorrectionOut": { "type": "integer", "minimum": 15, "maximum": 16082, "description": "Maximum permissible offset correction value (range 15 - 16082 microticks)" }, "pOffsetCorrectionStart": { "type": "integer", "minimum": 7, "maximum": 15999, "description": "Start of the offset correction phase within the NIT, (7 - 15999 macroticks)" }, "pRateCorrectionOut": { "type": "integer", "minimum": 3, "maximum": 3846, "description": "Maximum permissible rate correction value (range 3 - 3846 microticks)" }, "pWakeupChannel": { "type": "string", "enum": ["A", "B"], "description": "Channel used by the node to send a wakeup pattern" }, "pWakeupPattern": { "type": "integer", "minimum": 0, "maximum": 63, "description": "Number of repetitions of the wakeup symbol (range 0 - 63, value 0 or 1 prevents sending of WUP)" }, "pdMicrotick": { "type": "string", "enum": ["12.5ns", "25ns", "50ns"], "description": "Duration of a FlexRay microtick" }, "pSamplesPerMicrotick": { "type": "integer", "minimum": 1, "maximum": 2, "description": "Number of samples per microtick (values 1, 2)" } } }, "FlexrayTxBufferConfigurations": { "type": "array", "items": { "type": "object", "properties": { "channels": { "type": "string", "enum": ["A", "B", "AB", "None"], "description": "Channel(s)" }, "slotId": { "type": "integer", "minimum": 0, "maximum": 65535, "description": "The slot Id of frame" }, "offset": { "type": "integer", "minimum": 0, "maximum": 63, "description": "Base offset for cycle multiplexing (values 0 - 63)" }, "repetition": { "type": "integer", "minimum": 0, "maximum": 64, "description": "Repetition for cycle multiplexing (values 1, 2, 4, 8, 16, 32, 64)" }, "PPindicator": { "type": "boolean", "description": "Set the PPindicator" }, "headerCrc": { "type": "integer", "description": "Header CRC, 11 bits" }, "transmissionMode": { "type": "string", "enum": ["SingleShot", "Continuous"], "description": "SingleShot or Continuous transmission mode" } } } }, "FlexrayController": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Network": { "$ref": "#/definitions/Network" }, "UseTraceSinks": { "$ref": "#/definitions/UseTraceSinks" }, "Replay": { "$ref": "#/definitions/Replay" }, "ClusterParameters": { "$ref": "#/definitions/FlexrayClusterParameters" }, "NodeParameters": { "$ref": "#/definitions/FlexrayNodeParameters" }, "TxBufferConfigurations": { "$ref": "#/definitions/FlexrayTxBufferConfigurations" } }, "additionalProperties": false, "required": ["Name"] }, "FlexrayControllers": { "type": "array", "description": "Reconfigures the FlexrayControllers of the participant", "items": { "$ref": "#/definitions/FlexrayController" } }, "Topic": { "type": "string", "description": "Name of the communication channel between DataPublisher and DataSubscribers" }, "RpcFunctionName": { "type": "string", "description": "Name of the RPC function called by RpcClients on RpcServers" }, "Logging": { "type": "object", "description": "Configures the properties of the SIL Kit Logging Service", "properties": { "LogFromRemotes": { "type": "boolean", "description": "Enables receiving of remote log messages from other participants", "default": false }, "FlushLevel": { "type": "string", "enum": ["Critical", "Error", "Warn", "Info", "Debug", "Trace", "Off"] }, "Sinks": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": ["Remote", "File", "Stdout"] }, "Level": { "type": "string", "enum": [ "Critical", "Error", "Warn", "Info", "Debug", "Trace", "Off" ], "default": "Info" }, "LogName": { "type": "string", "description": "Log name; Results in the following filename: <LogName>_%y-%m-%dT%h-%m-%s.txt" } }, "additionalProperties": false, "required": ["Type"] } } }, "additionalProperties": false, "required": ["Sinks"] } }, "description": "JSON schema for SIL Kit Participant configuration files", "properties": { "$schema": { "type": "string", "description": "The schema file", "default": "", "examples": ["./ParticipantConfiguration.schema.json"] }, "schemaVersion": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "default": 0, "description": "Version of the schema used to validate this document" }, "Description": { "$ref": "#/definitions/Description" }, "ParticipantName": { "type": "string", "description": "Name of the participant" }, "CanControllers": { "type": "array", "description": "Reconfigures the CanControllers of the participant", "items": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Network": { "$ref": "#/definitions/Network" }, "UseTraceSinks": { "$ref": "#/definitions/UseTraceSinks" }, "Replay": { "$ref": "#/definitions/Replay" } }, "additionalProperties": false, "required": ["Name"] } }, "LinControllers": { "type": "array", "description": "Reconfigures the LinControllers of the participant", "items": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Network": { "$ref": "#/definitions/Network" }, "UseTraceSinks": { "$ref": "#/definitions/UseTraceSinks" }, "Replay": { "$ref": "#/definitions/Replay" } }, "additionalProperties": false, "required": ["Name"] } }, "FlexrayControllers": { "$ref": "#/definitions/FlexrayControllers" }, "EthernetControllers": { "type": "array", "description": "Reconfigures the EthernetControllers of the participant", "items": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Network": { "$ref": "#/definitions/Network" }, "UseTraceSinks": { "$ref": "#/definitions/UseTraceSinks" }, "Replay": { "$ref": "#/definitions/Replay" } }, "additionalProperties": false, "required": ["Name"] } }, "DataPublishers": { "type": "array", "description": "Reconfigures the DataPublishers of the participant", "items": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Topic": { "$ref": "#/definitions/Topic" } }, "additionalProperties": false, "required": ["Name"] } }, "DataSubscribers": { "type": "array", "description": "Reconfigures the DataSubscribers of the participant", "items": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Topic": { "$ref": "#/definitions/Topic" } }, "additionalProperties": false, "required": ["Name"] } }, "RpcClients": { "type": "array", "description": "Reconfigures the RpcClients of the participant", "items": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "FunctionName": { "$ref": "#/definitions/RpcFunctionName" } }, "additionalProperties": false, "required": ["Name"] } }, "RpcServers": { "type": "array", "description": "Reconfigures the RpcServers of the participant", "items": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "FunctionName": { "$ref": "#/definitions/RpcFunctionName" } }, "additionalProperties": false, "required": ["Name"] } }, "Logging": { "$ref": "#/definitions/Logging" }, "HealthCheck": { "type": "object", "description": "Node to configure properties to determine the health status of the simulation", "properties": { "SoftResponseTimeout": { "type": "integer", "description": "If a simulation step is not finished before this limit, a warning is logged. Optional; Unit is in milliseconds" }, "HardResponseTimeout": { "type": "integer", "description": "If a simulation step is not finished before this limit, the participant enters error state. Optional; Unit is in milliseconds" } }, "additionalProperties": false }, "Tracing": { "type": "object", "description": "Configures the tracing service of the participant", "properties": { "TraceSinks": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the trace sink" }, "OutputPath": { "type": "string", "description": "File path of output file" }, "Type": { "type": "string", "enum": ["PcapFile", "PcapPipe", "Mdf4File"], "description": "File format specifier" } }, "additionalProperties": false } }, "TraceSources": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the trace source", "examples": ["SomeTraceSource"] }, "InputPath": { "type": "string", "description": "File path of input file" }, "Type": { "type": "string", "enum": ["PcapFile", "PcapPipe", "Mdf4File"], "description": "File format specifier" } }, "additionalProperties": false } } } }, "Extensions": { "type": "object", "description": "Optional configuration for the extension loading mechanism", "properties": { "SearchPathHints": { "type": "array", "items": { "type": "string", "description": "A filesystem path to additionally search for extensions" } } }, "additionalProperties": false }, "Middleware": { "type": "object", "description": "Optional configuration of the SIL Kit middleware", "properties": { "RegistryUri": { "type": "string", "default": "silkit://localhost:8500" }, "ConnectAttempts": { "type": "integer", "default": "1" }, "TcpNoDelay": { "type": "boolean", "default": true }, "TcpQuickAck": { "type": "boolean", "default": false }, "TcpSendBufferSize": { "type": "integer" }, "TcpReceiveBufferSize": { "type": "integer" }, "EnableDomainSockets": { "type": "boolean", "default": true } }, "additionalProperties": false } }, "type": "object" }

tsdrc.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, "id": "https://json.schemastore.org/tsdrc.json", "properties": { "strictSSL": { "type": "boolean", "description": "Enabled by default, setting this option to false disables strict SSL. Passed to request package. Useful behind (corporate) proxies that act like man-in-the middle on https connections.", "default": true }, "proxy": { "type": "string", "description": "Any standard http-proxy as supported by the request package.", "format": "uri" }, "token": { "type": "string", "description": "The OAuth token can be used to boost the GitHub API rate-limit from 60 to 5000 (non-cached) requests per hour. The is token needs just 'read-only access to public information' so no additional OAuth scopes are necessary." } }, "title": "JSON schema for .tsdrc files", "type": "object" }