schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
pyproject.json | documentation | Documentation URL for the project. | {"type": "string", "format": "uri"} |
pyproject.json | license | License name. | {"type": "string"} |
pyproject.json | readme | The path to the README file. | {"type": "string"} |
pyproject.json | readme | A list of paths to the readme files. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | classifiers | A list of trove classifers. | {"type": "array"} |
pyproject.json | packages | A list of packages to include in the final distribution. | {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["include"], "properties": {"include": {}, "from": {"type": "string"}, "format": {}}}} |
pyproject.json | items | Information about where the package resides. | {"type": "object", "additionalProperties": false, "required": ["include"], "properties": {"include": {}, "from": {"type": "string"}, "format": {}}} |
pyproject.json | from | Where the source directory of the package resides. | {"type": "string"} |
pyproject.json | include | A list of files and folders to include. | {"type": "array", "items": {"anyOf": [{}, {"type": "object", "additionalProperties": false, "required": ["path"], "properties": {"path": {}, "format": {}}}]}} |
pyproject.json | exclude | A list of files and folders to exclude. | {"type": "array"} |
pyproject.json | dependencies | This is a hash of package name (keys) and version constraints (values) that are required to run this package. | {"type": "object", "required": ["python"], "properties": {"python": {"type": "string"}}, "patternProperties": {"^(?!python$)[a-zA-Z-_.0-9]+$": {}}} |
pyproject.json | python | The Python versions the package is compatible with. | {"type": "string"} |
pyproject.json | dev-dependencies | This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such). | {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {}}} |
pyproject.json | group | This represents groups of dependencies | {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"type": "object", "required": ["dependencies"], "properties": {"optional": {"type": "boolean"}, "dependencies": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {}}, "additionalProperties": false}}, "additionalProperties": false}}} |
pyproject.json | ^[a-zA-Z-_.0-9]+$ | This represents a single dependency group | {"type": "object", "required": ["dependencies"], "properties": {"optional": {"type": "boolean"}, "dependencies": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {}}, "additionalProperties": false}}, "additionalProperties": false} |
pyproject.json | optional | Whether the dependency group is optional or not | {"type": "boolean"} |
pyproject.json | dependencies | The dependencies of this dependency group | {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {}}, "additionalProperties": false} |
pyproject.json | scripts | A hash of scripts to be installed. | {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"oneOf": [{}, {}]}}} |
pyproject.json | plugins | A hash of hashes representing plugins | {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"type": "string"}}}}} |
pyproject.json | ^.+$ | The full url of the custom url. | {"type": "string"} |
pyproject.json | readme | AKA the README | {"oneOf": [{"type": "string"}, {"type": "object", "required": ["content-type"], "properties": {"content-type": {"type": "string"}}, "oneOf": [{"additionalProperties": false, "required": ["file"], "properties": {"content-type": true, "file": {"type": "string"}}}, {"additionalProperties": false, "required": ["text"], "properties": {"content-type": true, "text": {"type": "string"}}}]}], "examples": ["README.md", {"file": "README.txt", "content-type": "text/plain"}, {"text": "# Example project\n\nAn example project", "content-type": "text/markdown"}]} |
pyproject.json | content-type | RFC 1341 compliant content-type (with optional charset, defaulting to UTF-8) | {"type": "string"} |
pyproject.json | license | A SPDX license identifier | {"type": "string"} |
pyproject.json | optional-dependencies | keys are extra names | {"type": "object", "patternProperties": {"^([a-z\\d]|[a-z\\d]([a-z\\d-](?!--))*[a-z\\d])$": {"type": "array", "items": {"type": "string"}}}, "examples": [{"typing": ["boto3-stubs", "typing-extensions ~= 4.1"]}]} |
resolutions-schema.json | The OSS-Review-Toolkit (ORT) provides a possibility to resolve issues, rule violations and security vulnerabilities in a resolutions file. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-resolutions-yml.md. | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"issues": {"type": "array", "items": {"type": "object", "properties": {"message": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["message", "reason"]}}, "rule_violations": {"type": "array", "items": {"type": "object", "properties": {"message": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["message", "reason"]}}, "vulnerabilities": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["id", "reason"]}}}, "anyOf": [{"required": ["issues"]}, {"required": ["rule_violations"]}, {"required": ["vulnerabilities"]}], "definitions": {"issueResolutionReason": {"enum": ["BUILD_TOOL_ISSUE", "CANT_FIX_ISSUE", "SCANNER_ISSUE"]}, "ruleViolationResolutionReason": {"enum": ["CANT_FIX_EXCEPTION", "DYNAMIC_LINKAGE_EXCEPTION", "EXAMPLE_OF_EXCEPTION", "LICENSE_ACQUIRED_EXCEPTION", "NOT_MODIFIED_EXCEPTION", "PATENT_GRANT_EXCEPTION"]}, "vulnerabilityResolutionReason": {"enum": ["CANT_FIX_VULNERABILITY", "INEFFECTIVE_VULNERABILITY", "INVALID_MATCH_VULNERABILITY", "MITIGATED_VULNERABILITY", "WILL_NOT_FIX_VULNERABILITY", "WORKAROUND_FOR_VULNERABILITY"]}}} |
|
zapp-schema-1.0.0.json | JSON schema for zapp.json and zapp.yaml files. Version 1.0.0 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022. All Rights Reserved. | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "definitions": {"coreProperties": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string", "maxLength": 214, "minLength": 1}, "version": {"type": "string", "default": "1.0.0"}, "groupId": {"type": "string", "examples": ["com.ibm.wazi", "payments"]}, "artifactId": {"type": "string", "default": "", "examples": ["sam"]}, "parentId": {"type": "string", "default": "", "examples": ["com.ibm.wazi.parent"]}, "keywords": {"type": "array", "items": {"type": "string"}}, "homepage": {"type": "string", "oneOf": [{"format": "uri"}, {"enum": ["."]}]}, "license": {"type": "string"}, "author": {}, "contributors": {"type": "array", "items": {}, "minItems": 1}, "maintainers": {"type": "array", "items": {}, "minItems": 1}, "propertyGroups": {"type": "array", "items": {}, "minItems": 1}, "profiles": {"type": "array", "items": {}, "minItems": 1}}}, "propertyGroupItem": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string", "examples": ["sample-local"]}, "language": {"type": "string", "enum": ["cobol", "pl1", "hlasm", "rexx", "jcl"]}, "compilerOptions": {"type": "string"}, "libraries": {"type": "array", "items": {}, "minItems": 1}}}, "libraryItem": {"type": "object", "additionalProperties": false, "required": ["name", "type", "locations"], "properties": {"name": {"type": "string", "default": "syslib", "examples": ["syslib", "currencylib"]}, "type": {"type": "string", "enum": ["mvs", "local"], "default": "local", "examples": ["local", "mvs"]}, "locations": {"type": "array", "items": {"type": "string"}, "minItems": 1, "examples": ["**/copybook", "USER1.SAMPLE.COBCOPY"]}}}, "person": {"type": ["object", "string"], "required": ["name"], "properties": {"name": {"type": "string"}, "url": {"type": "string", "format": "uri"}, "email": {"type": "string", "format": "email"}}}, "profile": {"type": "object", "additionalProperties": false, "required": ["name", "type"], "properties": {"name": {"type": "string", "examples": ["dbb-build"]}, "type": {"type": "string", "enum": ["dbb", "rseapi", "debug"], "default": "dbb", "examples": ["dbb", "rseapi"]}, "settings": {"type": "object"}}, "anyOf": [{"required": ["name", "type", "settings"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "type": {"const": "dbb", "type": "string"}, "settings": {}}}, {"required": ["name", "type", "settings"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "type": {"const": "rseapi", "type": "string"}, "settings": {}}}]}, "dbbSettingsItem": {"type": "object", "additionalProperties": false, "required": ["application", "command"], "properties": {"application": {"type": "string"}, "command": {"type": "string"}, "buildScriptPath": {"type": "string"}, "buildScriptArgs": {"type": "array", "items": {"type": "string"}}, "additionalDependencies": {"type": "array", "items": {"type": "string"}}, "logFilePatterns": {"type": "array", "items": {"type": "string"}}}}, "rseapiSettingsItem": {"type": "object", "additionalProperties": false, "required": ["mappings", "default.encoding"], "properties": {"mappings": {"type": "array", "items": {}}, "default.encoding": {"type": "string"}}}, "rseapiSettingsItemMapping": {"type": "object", "additionalProperties": false, "properties": {"extension": {"type": "string"}, "transfer": {"type": "string", "enum": ["text", "binary"]}, "resource": {"type": "string"}, "encoding": {"type": "string"}, "memberMappings": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"extension": {"type": "string"}, "transfer": {"type": "string", "enum": ["text", "binary"]}, "encoding": {"type": "string"}, "resource": {"type": "string"}}}}}}}, "anyOf": [{}]} |
|
zapp-schema-1.0.0.json | name | The name of the Z Project. | {"type": "string", "maxLength": 214, "minLength": 1} |
zapp-schema-1.0.0.json | description | This helps people understand your project as it would be used by tools. | {"type": "string"} |
zapp-schema-1.0.0.json | version | Version is a string and it must be parsable for managing dependencies. | {"type": "string", "default": "1.0.0"} |
zapp-schema-1.0.0.json | groupId | Defines a group name that is shared for each application part in case of applications composed of multiple parts. Allows to uniquely identify the parts by concatenating with the artifact id. For example a groupId `com.ibm.wazi` with an artifactId `service` would create the unique application identifier `com.ibm.wazi.service`. | {"type": "string", "examples": ["com.ibm.wazi", "payments"]} |
zapp-schema-1.0.0.json | artifactId | Define id of the application artifact. Use it in combination with a groupId for multi-part applications. | {"type": "string", "default": "", "examples": ["sam"]} |
zapp-schema-1.0.0.json | parentId | In case of a multi-part application defines the name of the parent application part. This zapp will inherit properties such as propertyGroups defined in the parent. | {"type": "string", "default": "", "examples": ["com.ibm.wazi.parent"]} |
zapp-schema-1.0.0.json | keywords | This helps people discover your project. | {"type": "array", "items": {"type": "string"}} |
zapp-schema-1.0.0.json | homepage | The url to the project homepage. | {"type": "string", "oneOf": [{"format": "uri"}, {"enum": ["."]}]} |
zapp-schema-1.0.0.json | license | 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. | {"type": "string"} |
zapp-schema-1.0.0.json | contributors | A list of people who contributed to this package. | {"type": "array", "items": {}, "minItems": 1} |
zapp-schema-1.0.0.json | maintainers | A list of people who maintain this package. | {"type": "array", "items": {}, "minItems": 1} |
zapp-schema-1.0.0.json | propertyGroups | A list properties defining path names for resolving dependencies. | {"type": "array", "items": {}, "minItems": 1} |
zapp-schema-1.0.0.json | profiles | Profiles are additional groups of properties that should only should become valid under specific conditions such as running in a build job or as part of a debug session. | {"type": "array", "items": {}, "minItems": 1} |
zapp-schema-1.0.0.json | name | The name of the property group, which is used in hovers and error messages. | {"type": "string", "examples": ["sample-local"]} |
zapp-schema-1.0.0.json | language | Limits the property group to one specific language. | {"type": "string", "enum": ["cobol", "pl1", "hlasm", "rexx", "jcl"]} |
zapp-schema-1.0.0.json | compilerOptions | Global compiler options separated by a comma that impact the parsing of the programs for the editor. Requires that you specify a language. If there are multiple Property Groups for a language with compiler option then they will be concatenated. | {"type": "string"} |
zapp-schema-1.0.0.json | libraries | An array of potential library locations defining the search order for include files. Libraries with the name 'syslib' will be handled as default include locations. The list can contain many entries of the type 'local' or 'mvs'. It can contain items of the same type twice in case, for example, you want to search in remote locations first, then some local location, and if still not found more remote locations. | {"type": "array", "items": {}, "minItems": 1} |
zapp-schema-1.0.0.json | name | Name of the library. The default name should be `syslib` if using unamed libraries. | {"type": "string", "default": "syslib", "examples": ["syslib", "currencylib"]} |
zapp-schema-1.0.0.json | type | The type of the property group defining where dependencies should be located. Allowed values are 'local' for using a local workspace and 'mvs' for dependencies located in MVS Datasets. | {"type": "string", "enum": ["mvs", "local"], "default": "local", "examples": ["local", "mvs"]} |
zapp-schema-1.0.0.json | locations | An array of include file locations. For 'local' libraries values can be absolute and relative filename paths using GLOB patterns. For 'mvs' libraries value can be data set names. GLOB patterns for dat sets are currently not supported. | {"type": "array", "items": {"type": "string"}, "minItems": 1, "examples": ["**/copybook", "USER1.SAMPLE.COBCOPY"]} |
zapp-schema-1.0.0.json | person | 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"}}} |
zapp-schema-1.0.0.json | profile | Profiles are additional groups of properties that should only should become valid under specific conditions such as running in a build job or as part of a debug session. | {"type": "object", "additionalProperties": false, "required": ["name", "type"], "properties": {"name": {"type": "string", "examples": ["dbb-build"]}, "type": {"type": "string", "enum": ["dbb", "rseapi", "debug"], "default": "dbb", "examples": ["dbb", "rseapi"]}, "settings": {"type": "object"}}, "anyOf": [{"required": ["name", "type", "settings"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "type": {"const": "dbb", "type": "string"}, "settings": {}}}, {"required": ["name", "type", "settings"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "type": {"const": "rseapi", "type": "string"}, "settings": {}}}]} |
zapp-schema-1.0.0.json | name | The name of the profile. | {"type": "string", "examples": ["dbb-build"]} |
zapp-schema-1.0.0.json | type | The type of the profile. | {"type": "string", "enum": ["dbb", "rseapi", "debug"], "default": "dbb", "examples": ["dbb", "rseapi"]} |
zapp-schema-1.0.0.json | settings | Settings objects specific to the type specified for the profile. | {"type": "object"} |
zapp-schema-1.0.0.json | dbbSettingsItem | DBB build script properties for running User Build on remote host. | {"type": "object", "additionalProperties": false, "required": ["application", "command"], "properties": {"application": {"type": "string"}, "command": {"type": "string"}, "buildScriptPath": {"type": "string"}, "buildScriptArgs": {"type": "array", "items": {"type": "string"}}, "additionalDependencies": {"type": "array", "items": {"type": "string"}}, "logFilePatterns": {"type": "array", "items": {"type": "string"}}}} |
zapp-schema-1.0.0.json | application | Defines the name of the application to build. Will be used to create a folder on USS to upload all files to. | {"type": "string"} |
zapp-schema-1.0.0.json | command | Command that the build script is executed with such as the path to groovyz and it's parameters. | {"type": "string"} |
zapp-schema-1.0.0.json | buildScriptPath | The full path of build script on the remote host that should be used with the command. | {"type": "string"} |
zapp-schema-1.0.0.json | buildScriptArgs | A list of strings that are the parameters for the build script. Check the documentation for built-in variables, such as the name of the program to build, that can be used here. | {"type": "array", "items": {"type": "string"}} |
zapp-schema-1.0.0.json | additionalDependencies | Lists of GLOB patterns that define the files that should be uploaded to USS for a build. Relative path names are interpreted relative to the location of the ZAPP file that is being used for the build, which is a ZAPP file in the same workspace as the program to be build. | {"type": "array", "items": {"type": "string"}} |
zapp-schema-1.0.0.json | logFilePatterns | Lists of GLOB patterns that define the files that should be downloaded from USS after the build. Relative path names are interpreted relative to the DBB log directory user setting. If not provided then all files of the user setting location will be downloaded. | {"type": "array", "items": {"type": "string"}} |
zapp-schema-1.0.0.json | rseapiSettingsItem | RSE API client settings for interactions with a z/OS remote host running an RSE API server. | {"type": "object", "additionalProperties": false, "required": ["mappings", "default.encoding"], "properties": {"mappings": {"type": "array", "items": {}}, "default.encoding": {"type": "string"}}} |
zapp-schema-1.0.0.json | mappings | A list of mapping objects that map local file extensions to transfer modes and encodings to MVS datasets that can be specified using wildcards. | {"type": "array", "items": {}} |
zapp-schema-1.0.0.json | default.encoding | The encoding to be used when no mapping can be found. If not provided then either the user or server default will be used. | {"type": "string"} |
zapp-schema-1.0.0.json | rseapiSettingsItemMapping | One mapping that contains at least transfer and resource values. | {"type": "object", "additionalProperties": false, "properties": {"extension": {"type": "string"}, "transfer": {"type": "string", "enum": ["text", "binary"]}, "resource": {"type": "string"}, "encoding": {"type": "string"}, "memberMappings": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"extension": {"type": "string"}, "transfer": {"type": "string", "enum": ["text", "binary"]}, "encoding": {"type": "string"}, "resource": {"type": "string"}}}}}} |
zapp-schema-1.0.0.json | extension | A local file extension such as cbl or pl1. | {"type": "string"} |
zapp-schema-1.0.0.json | transfer | The transfer mode to be used. Can be 'text' or 'binary'. | {"type": "string", "enum": ["text", "binary"]} |
zapp-schema-1.0.0.json | resource | The data set name to be mapped to. Can use a wildcard such as '**CPY'. | {"type": "string"} |
zapp-schema-1.0.0.json | encoding | The encoding to be used for text transfer. See the RSE API documentation for the values allowed. | {"type": "string"} |
zapp-schema-1.0.0.json | memberMappings | A nested mappings array with resource mappings to members of the data sets that were mapped by the parent mapping. | {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"extension": {"type": "string"}, "transfer": {"type": "string", "enum": ["text", "binary"]}, "encoding": {"type": "string"}, "resource": {"type": "string"}}}} |
zapp-schema-1.0.0.json | items | One member mapping that contains at least transfer and resource values. | {"type": "object", "additionalProperties": false, "properties": {"extension": {"type": "string"}, "transfer": {"type": "string", "enum": ["text", "binary"]}, "encoding": {"type": "string"}, "resource": {"type": "string"}}} |
zapp-schema-1.0.0.json | extension | A local file extension such as cbl or pl1. | {"type": "string"} |
zapp-schema-1.0.0.json | transfer | The transfer mode to be used. Can be 'text' or 'binary'. | {"type": "string", "enum": ["text", "binary"]} |
zapp-schema-1.0.0.json | encoding | The encoding to be used for text transfer. See the RSE API documentation for the values allowed. | {"type": "string"} |
zapp-schema-1.0.0.json | resource | The data set member name to be mapped to. Can use a wildcard such as '**CPY'. | {"type": "string"} |
madness.json | Settings of the current site
https://madness.dannyb.co/#configuration-file | {"$schema": "http://json-schema.org/draft-07/schema", "type": "object", "properties": {"path": {"type": "string", "minLength": 1, "default": "."}, "port": {"type": "integer", "minimum": 0, "default": "3000"}, "bind": {"type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$", "default": "0.0.0.0"}, "base_uri": {"oneOf": [{"type": "string", "minLength": 1, "examples": ["/docs"], "not": {"pattern": "//"}}, {"type": "null"}]}, "sidebar": {"type": "boolean", "default": "true"}, "auto_h1": {"type": "boolean", "default": "true"}, "auto_nav": {"type": "boolean", "default": "true"}, "auto_toc": {"type": "boolean", "default": "true"}, "highlighter": {"type": "boolean", "default": "true"}, "copy_code": {"type": "boolean", "default": "true"}, "shortlinks": {"type": "boolean", "default": "false"}, "toc": {"oneOf": [{"type": "string", "minLength": 1, "examples": ["Table of Contents"]}, {"type": "null"}]}, "theme": {"oneOf": [{"type": "string", "minLength": 1, "examples": ["_theme"]}, {"type": "null"}]}, "source_link": {"oneOf": [{"type": "string", "minLength": 1, "examples": ["http://example.com/%{path}"]}, {"type": "null"}]}, "source_link_label": {"type": "string", "minLength": 1, "default": "Page Source"}, "source_link_pos": {"type": "string", "enum": ["top", "bottom"], "default": "bottom"}, "open": {"type": "boolean", "default": "false"}, "auth": {"oneOf": [{"type": "boolean", "const": false}, {"type": "string", "pattern": "^[^:]+:[^:]+$", "examples": ["admin:s3cr3t"]}]}, "auth_zone": {"type": "string", "default": "Restricted Documentation"}, "expose_extensions": {"oneOf": [{"type": "string", "examples": ["pdf,docx,xlsx,txt"], "not": {"pattern": ",,|^,|,$"}}, {"type": "null"}]}, "exclude": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "default": "^[a-z_\\-0-9]+$"}}}, "additionalProperties": false} |
|
madness.json | path | A path to the documentation root of the current site
https://madness.dannyb.co/#configuration-file | {"type": "string", "minLength": 1, "default": "."} |
madness.json | port | A server port of the current site
https://madness.dannyb.co/#configuration-file | {"type": "integer", "minimum": 0, "default": "3000"} |
madness.json | bind | A server listen address of the current site
https://madness.dannyb.co/#configuration-file | {"type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$", "default": "0.0.0.0"} |
madness.json | base_uri | A server root path of the current site
https://madness.dannyb.co/#configuration-file | {"oneOf": [{"type": "string", "minLength": 1, "examples": ["/docs"], "not": {"pattern": "//"}}, {"type": "null"}]} |
madness.json | sidebar | Whether to enable sidebar of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "true"} |
madness.json | auto_h1 | Whether to add H1 title to files that do not have one of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "true"} |
madness.json | auto_nav | Whether to append navigation to directory READMEs of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "true"} |
madness.json | auto_toc | Whether to enable table of contents of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "true"} |
madness.json | highlighter | Whether to enable syntax highlighter for code snippets of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "true"} |
madness.json | copy_code | Whether to enable the copy to clipboard icon for code snippets of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "true"} |
madness.json | shortlinks | Whether to convert [[Links]] to [Links](Links) of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "false"} |
madness.json | toc | Whether to generate a table of contents file with this name of the current site
https://madness.dannyb.co/#configuration-file | {"oneOf": [{"type": "string", "minLength": 1, "examples": ["Table of Contents"]}, {"type": "null"}]} |
madness.json | theme | A theme directory of the current site
https://madness.dannyb.co/#configuration-file | {"oneOf": [{"type": "string", "minLength": 1, "examples": ["_theme"]}, {"type": "null"}]} |
madness.json | source_link | A link to the page source of the current site
https://madness.dannyb.co/#configuration-file | {"oneOf": [{"type": "string", "minLength": 1, "examples": ["http://example.com/%{path}"]}, {"type": "null"}]} |
madness.json | source_link_label | A link of page source label of the current site
https://madness.dannyb.co/#configuration-file | {"type": "string", "minLength": 1, "default": "Page Source"} |
madness.json | source_link_pos | A link of page source position of the current site
https://madness.dannyb.co/#configuration-file | {"type": "string", "enum": ["top", "bottom"], "default": "bottom"} |
madness.json | open | Whether to open the server URL in the browser of the current site
https://madness.dannyb.co/#configuration-file | {"type": "boolean", "default": "false"} |
madness.json | auth | Whether to provide user:password for basic authentication of the current site
https://madness.dannyb.co/#configuration-file | {"oneOf": [{"type": "boolean", "const": false}, {"type": "string", "pattern": "^[^:]+:[^:]+$", "examples": ["admin:s3cr3t"]}]} |
madness.json | auth_zone | An auth realm name of the current site
https://madness.dannyb.co/#configuration-file | {"type": "string", "default": "Restricted Documentation"} |
madness.json | expose_extensions | Whether to show files with these extensions in the navigation and search of the current site
https://madness.dannyb.co/#configuration-file | {"oneOf": [{"type": "string", "examples": ["pdf,docx,xlsx,txt"], "not": {"pattern": ",,|^,|,$"}}, {"type": "null"}]} |
madness.json | exclude | Excluded directories of the current site
https://madness.dannyb.co/#configuration-file | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "default": "^[a-z_\\-0-9]+$"}} |
madness.json | items | An excluded directory of the current site
https://madness.dannyb.co/#configuration-file | {"type": "string", "default": "^[a-z_\\-0-9]+$"} |
template.schema.json | NetinDS device configuration template, defines the drivers used to collect the datapoints and the transformations and alarms to be applied to these datapoints | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "definitions": {"schemaVersionDef": {"type": "string", "pattern": "(?<=^v?|\\sv?)(?:(?:0|[1-9][0-9]*).){2}(?:0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*)(?:.(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*))*)?(?:\\+[0-9a-z-]+(?:.[0-9a-z-]+)*)?\\b", "examples": ["1.5.2", "7.5.3", "7.5.3-test"], "errorMessage": "Not valid version string, for more information see : https://semver.org/"}, "originDef": {"type": "string", "pattern": "^\\/\\{[a-zA-Z0-9-_.]{1,80}\\}\\/$|^[a-zA-Z0-9-_.]{1,80}$", "errorMessage": "origin should be a string. Maximum size of 80 alphanumerical characters or symbol: -_."}, "templateIdDef": {"type": "string", "pattern": "^[a-zA-Z0-9-_ ]{1,80}$", "errorMessage": "templateId should be a string. Maximum size of 80 alphanumerical characters or symbol: -_"}, "templateVersionDef": {"type": "string", "pattern": "(?<=^v?|\\sv?)(?:(?:0|[1-9][0-9]*).){2}(?:0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*)(?:.(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*))*)?(?:\\+[0-9a-z-]+(?:.[0-9a-z-]+)*)?\\b", "examples": ["1.5.2", "7.5.3", "7.5.3-test"], "errorMessage": "templateVersion should be a valid version string. For more information see : https://semver.org/"}, "descriptionDef": {"type": "string", "minLength": 1, "maxLength": 800, "errorMessage": "description should be a string of at least one character and maximum 800 characters"}, "rangerFilterDef": {"type": "object", "properties": {"deviceID": {"type": "string", "examples": ["0x0A01", "0x0A0B"], "errorMessage": "DeviceID should be a string"}, "vendorID": {"type": "string", "examples": ["0x002A"], "errorMessage": "vendorID should be a string"}}, "defaultSnippets": [{"label": "PROFINET based", "body": {"deviceID": "0x0A01", "vendorID": "0x002A"}}, {"label": "SNMP based", "body": {}}]}, "originTypeDef": {"type": "string", "pattern": "^[a-zA-Z0-9-]{1,80}$", "errorMessage": "Should be a string and follow the pattern: alphanumerical characters and - symbol, maximum length 80"}, "originTypeConfigDef": {"type": "object", "properties": {"originType": {}}, "defaultSnippets": [{"label": "PROFINET Driver", "body": {"originType": "netin-ds-drv-pnio", "ipAddress": "/{DCP_IPAddress}/", "gsd": "GSDML-V2.35-Siemens-ET200SP-20200729"}}, {"label": "SNMP Driver", "body": {"originType": "netin-ds-drv-snmp", "basicConfig": {"retries": 2, "address": "/{ICMP_IPAddress}/", "port": 161, "version": 2, "timeout": 5000}, "snmpCommunities": {"readCommunity": "public", "writeCommunity": "private"}, "snmpV3Security": {"authAlgorithm": "MD5", "privacyAlgorithm": "DES", "usmUser": "", "authPassword": "", "privacyPassword": ""}}}, {"label": "ICMP Driver", "body": {"originType": "netin-ds-drv-icmp", "address": "/{ICMP_IPAddress}/", "count": 4, "timeout": 1000}}, {"label": "S7 Driver", "body": {"originType": "netin-ds-drv-s7", "s7basicConfig": {"address": "/{ICMP_IPAddress}/", "rack": 0, "slot": 2, "deviceType": "S7-300"}, "s7extraConfig": {"requestTimeout": 15000, "connectionTimeout": 3000, "port": 102}, "s7security": {"password": "", "accessProtection": false}, "s7diagnosticBuffer": {"loggingEnabled": false}}}, {"label": "MQTT Broker Driver", "body": {"originType": "netin-ds-drv-mqtt", "source": "/{DCP_IPAddress}/", "topics": [{"topicName": "MyTopic", "datapointSet": "MyDatapointSet", "originStrategy": {"strategyId": "property", "property": "MyProperty", "expression": "^[a-zA-Z0-9-]*"}, "operationMode": "extract"}]}}, {"label": "MODBUS Driver", "body": {"originType": "netin-ds-drv-modbus-tcp", "address": "/{DCP_IPAddress}/", "slaveId": 1, "port": 502}}], "additionalProperties": true, "required": ["originType"]}, "datapointSetTypeDef": {"type": "string", "enum": ["map", "tableStatic", "tableDynamic"], "errorMessage": "datapointSetType should be a string. DatapointSet type is datapointSetType, and should be one of: map, tableStatic, tableDynamic"}, "datapointSetIdDef": {"type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$", "errorMessage": "DatapointSet identification must be alphanumeric string [1-40], \"-\" & \"_\" are also allowed"}, "tableAddressDef": {"type": "object", "properties": {"rootAddress": {"type": "string", "maxLength": 240, "errorMessage": "rootAddress should be a string [0-240]"}, "indexes": {"type": "array", "items": {"type": "string", "pattern": "^[a-zA-Z0-9#&_-]{1,80}$"}, "errorMessage": "Indexes must be an array of datapoint identification strings"}}}, "broadcastDef": {"type": "boolean", "errorMessage": "Broadcast flag should be a boolean"}, "routingDef": {"type": "object", "properties": {"topic": {"type": "string", "maxLength": 80, "errorMessage": "Should be a string of less than 80 characters"}, "service": {"type": "string", "maxLength": 80, "errorMessage": "Should be a string of less than 80 characters"}, "serviceConfig": {"type": "object", "additionalProperties": true}}, "required": ["topic"]}, "dataTypeDef": {"type": "string", "enum": ["BYTE", "INTEGER", "LONG", "FLOAT", "DOUBLE", "STRING", "BOOLEAN", "DATE", "ARRAY", "INTEGER_ARRAY", "STRING_ARRAY", "DOUBLE_ARRAY", "BOOLEAN_ARRAY", "FLOAT_ARRAY", "LONG_ARRAY", "OBJECT"], "errorMessage": "DataType should be one of: BYTE, INTEGER, LONG, FLOAT, DOUBLE, STRING, BOOLEAN, DATE, ARRAY, INTEGER_ARRAY, STRING_ARRAY, DOUBLE_ARRAY, BOOLEAN_ARRAY, FLOAT_ARRAY, LONG_ARRAY, OBJECT"}, "originDataTypeDef": {"type": "string", "pattern": "^[a-zA-Z0-9-_]{1,80}$", "errorMessage": "Driver side data type should follow the pattern: alphanumerical string +\"-\" and \"_\", size [1-80]"}, "originAddressDef": {"type": "string", "pattern": "^[\\w\\d_&#:$.-]{1,80}$", "errorMessage": "Datapoint address should be an alphanumerical string [1-80] and [_&#:$.-]"}, "originAccessTypeDef": {"type": "string", "enum": ["read-only", "write-only", "read-write", "not-accessible"], "errorMessage": "Datapoint access type should be a string and one of: read-only, write-only, read-write, not-accessible"}, "receiveModeDef": {"type": "string", "enum": ["polling", "singleQuery", "subscription"], "errorMessage": "Receive mode should be a string and one of: polling, singleQuery, subscription"}, "pollingGroupDef": {"type": "string", "enum": ["5s", "10s", "30s", "1m", "5m", "10m", "15m", "30m", "1h", "4h", "6h", "12h", "1d"], "errorMessage": "Polling group should be a string and one of: 5s, 10s, 30s, 1m, 5m, 10m, 15m, 30m, 1h, 4h, 6h, 12h, 1d"}, "datapointTypeDef": {"type": "string", "enum": ["SIMPLE", "TIMEPOINT", "DATAPOINT", "@DATAPOINT", "@TIMEPOINT", "#DATAPOINT", "#TIMEPOINT"], "errorMessage": "DatapointType must be one of: SIMPLE, TIMEPOINT, DATAPOINT, @DATAPOINT, @TIMEPOINT, #DATAPOINT, #TIMEPOINT"}, "datapointIdDef": {"type": "string", "pattern": "^[a-zA-Z0-9#&_-]{1,80}$", "errorMessage": "Should be a string and follow the pattern: alphanumerical and symbols #&_- with less than 41 characters"}, "symbolDef": {"type": "string", "minLength": 1, "errorMessage": "Should be a string of at least one characters and less than 40 characters"}, "expressionDef": {"type": "string", "examples": ["(^(5|[5-9]\\d*)\\.(3|[3-9]\\d*)\\.(0|[1-9]\\d*)?$).test(datapoint.value)", "datapoint.rawValue"], "minLength": 1, "maxLength": 800, "errorMessage": "Should be a string of at least one character and less than 800 characters"}, "expressionLogicObjectDef": {"type": "object", "properties": {"expression": {}, "symbol": {}}, "additionalProperties": false, "required": ["expression", "symbol"]}, "severityDef": {"type": "integer", "minimum": -1, "maximum": 1000, "errorMessage": "Should be a number greater than -1 and lower than 1001"}, "severityForAlarmsDef": {"type": "integer", "minimum": 201, "maximum": 1000, "errorMessage": "Should be a number greater than 200 and lower than 1001"}, "severityForLogsDef": {"type": "integer", "minimum": 1, "maximum": 200, "errorMessage": "Should be a number greater than 0 and lower than 201"}, "textDef": {"type": "string", "minLength": 1, "maxLength": 800, "errorMessage": "Should be a string of at least one character and less than 500 characters"}, "auditedDef": {"type": "boolean", "errorMessage": "Should be boolean"}, "hiddenDef": {"type": "boolean", "errorMessage": "Should be boolean"}, "facilityDef": {"type": "integer", "minimum": -1, "maximum": 255, "errorMessage": "Should be a number in the range [-1, 255]"}, "logicDef": {"type": "string", "examples": ["evalID1 & evalID2"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one character and less than 80 characters"}, "evaluationForLogsDef": {"type": "object", "properties": {"expressions": {"type": "array", "items": {}}, "logic": {}, "severity": {}, "text": {}, "textHelp": {}, "onStartup": {"type": "boolean"}, "audited": {}, "hidden": {}, "broadcast": {}, "facility": {}, "routing": {}}, "additionalProperties": true, "required": ["expressions", "logic", "severity", "text", "textHelp", "onStartup", "audited", "hidden", "broadcast", "facility"]}, "evaluationForAlarmsDef": {"type": "object", "properties": {"expressions": {"type": "array", "items": {}}, "logic": {}, "severity": {}, "text": {}, "textHelp": {}, "onStartup": {"type": "boolean"}, "audited": {}, "hidden": {}, "broadcast": {}, "facility": {}, "routing": {}}, "additionalProperties": true, "required": ["expressions", "logic", "severity", "text", "textHelp", "onStartup", "audited", "hidden", "broadcast", "facility"]}, "valueDef": {"anyOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "array"}, {"type": "object"}]}, "commonConfigDef": {"type": "object", "properties": {"alias": {"type": "string", "examples": ["Packets errors", "Partner"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one character and less than 80 characters"}, "syntaxInfo": {"type": "string", "minLength": 0, "maxLength": 1200, "errorMessage": "Should be a string of at least one character and less than 1200 characters"}, "datapointType": {}, "datapointId": {}, "additionalProperties": false}, "required": ["datapointId", "datapointType"]}, "addressConfigDef": {"type": "object", "properties": {"dataType": {}, "originType": {}, "originDataType": {}, "originAddress": {}, "originAccessType": {}, "receiveMode": {}, "pollingGroup": {}}, "additionalProperties": false, "required": ["dataType", "originType", "originDataType", "originAddress", "originAccessType", "receiveMode", "pollingGroup"]}, "alertConfigDef": {"type": "object", "properties": {"evaluations": {"oneOf": [{"type": "array", "items": {}, "minItems": 1, "uniqueItemProperties": ["severity"]}, {"type": "array", "items": {}, "minItems": 1, "uniqueItemProperties": ["severity"]}]}}, "additionalProperties": false, "required": ["evaluations"]}, "calcConfig": {"type": "object", "properties": {"expression": {}}, "additionalProperties": false, "required": ["expression"]}, "convConfigDef": {"type": "object", "properties": {"expression": {}}, "additionalProperties": false, "required": ["expression"]}, "defaultValueConfigDef": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "rawValue": {}, "value": {}}, "additionalProperties": false, "anyOf": [{"required": ["isDefault", "rawValue", "value"]}, {"required": ["isDefault", "value"]}, {"required": ["isDefault", "rawValue"]}]}, "rowFilterConfigDef": {"type": "object", "properties": {"expressions": {"type": "array", "items": {}}, "logic": {}}}, "unitsConfigDef": {"type": "object", "properties": {"from": {"type": "string", "examples": ["m", "g"]}, "to": {"type": "string", "examples": ["m", "g"]}, "toBest": {"type": "boolean"}, "exclude": {"type": "array", "items": {"type": "string", "examples": ["m", "g"]}}, "units": {"type": "boolean"}}, "additionalProperties": false, "anyOf": [{"required": ["from", "to"], "not": {"required": ["toBest", "exclude"]}}, {"required": ["from", "toBest"], "not": {"required": ["to"]}}]}, "valueMapConfigDef": {"type": "object", "properties": {"map": {"type": "array", "items": {"type": "object", "properties": {"key": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "integer"}]}}}}}, "additionalProperties": false, "required": ["map"]}, "datapointConfigDef": {"type": "object", "properties": {"addressConfig": {}, "commonConfig": {}, "alertConfig": {}, "calcConfig": {}, "convConfig": {}, "defaultValueConfig": {}, "rowFilterConfig": {}, "unitsConfig": {}, "valueMapConfig": {}}, "additionalProperties": {"type": "object"}, "allOf": [{"if": {"properties": {"commonConfig": {"type": "object", "properties": {"datapointType": {"const": "#TIMEPOINT"}}}}, "required": ["commonConfig"]}, "then": {"properties": {"addressConfig": {}, "commonConfig": {}}, "required": ["commonConfig", "addressConfig"], "additionalProperties": false}}, {"anyOf": [{"required": ["commonConfig", "addressConfig"], "not": {"required": ["calcConfig"]}}, {"required": ["commonConfig", "calcConfig"], "not": {"required": ["addressConfig"]}}, {"required": ["commonConfig", "defaultValueConfig"], "not": {"required": ["addressConfig", "calcConfig"]}}, {"required": ["commonConfig", "defaultValueConfig, addressConfig"], "not": {"required": ["calcConfig"]}}, {"required": ["commonConfig", "defaultValueConfig", "calcConfig"], "not": {"required": ["addressConfig"]}}]}]}, "datapointSetConfigDef": {"type": "object", "properties": {"datapointSetType": {}, "datapointSetId": {}, "alias": {"type": "string", "default": "none", "examples": ["Port information"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one characters and less than 80 characters"}, "tableAddress": {}, "broadcast": {}, "routing": {}, "datapoints": {"type": "array", "items": {}, "minItems": 1, "errorMessage": "Should be an array of datapoint configuration objects. There should be at least one datapoint in a datapointSet"}}, "additionalProperties": false, "required": ["alias", "datapoints", "datapointSetId", "datapointSetType", "description"], "allOf": [{"if": {"properties": {"datapointSetType": {"enum": ["tableStatic", "tableDynamic"]}}}, "then": {"required": ["tableAddress"]}}]}, "representationDataDef": {"type": "string", "pattern": "^device\\[[a-zA-Z0-9_-]{1,40}((\\.[0-9]+)?\\.[a-zA-Z0-9#&_-]{1,80})?\\]$", "examples": ["device[deviceInfo]", "device[deviceInfo.deviceSatate]", "device[pnioAPIs.0.cmInitiatorStationName]"], "errorMessage": "Data should be an string of device[datapointSetId] or device[datapointSetId.datapointId]"}, "representationMapConfigDef": {"type": "object", "properties": {"format": {"type": "array", "items": {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]}, "minItems": 1}}, "additionalProperties": false, "required": ["format"]}, "representationTableConfigDef": {"type": "object", "properties": {"format": {"type": "array", "items": {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}, "fieldGroup": {"type": "string", "enum": ["basic", "advanced"]}, "filterable": {"type": "boolean"}, "filterType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "width": {"type": "integer", "minimum": 1, "examples": [60, 120, 200]}, "minScreenSize": {"type": "string", "enum": ["xs", "s", "m", "l"]}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]}, "minItems": 1}, "pageSize": {"type": "number", "minimum": 2, "maximum": 10, "examples": [6, 7, 9]}, "filterable": {"type": "boolean"}}, "additionalProperties": true, "required": ["format"]}, "representationMetricConfigDef": {"type": "object", "properties": {"url": {"type": "string", "examples": ["http://${device[origin]}"]}, "titleEnabled": {"type": "boolean"}, "urlEnabled": {"type": "boolean"}, "lastUpdateEnabled": {"type": "boolean"}}, "additionalProperties": false}, "representationGaugeConfigDef": {"type": "object", "properties": {"format": {"type": "array", "items": {"type": "object", "properties": {"datapoint": {}, "color": {"type": "string", "default": "#45A5F5"}, "units": {"type": "string", "examples": ["Mb/s", "%", "m/s"]}}, "additionalProperties": true, "required": ["datapoint"]}, "minItems": 1}, "maxValue": {"type": "number", "examples": [6, 72, 90]}, "minValue": {"type": "number"}, "ranges": {"type": "array", "items": {"type": "object", "properties": {"from": {"type": "integer"}, "to": {"type": "integer"}, "severity": {"type": "integer"}}, "additionalProperties": false, "required": ["from", "to", "severity"]}}}, "additionalProperties": true, "required": ["format", "maxValue", "minValue"]}, "representationCommonConfigDef": {"type": "object", "properties": {"firstRow": {"type": "integer", "minimum": 1, "examples": [1, 3, 4], "errorMessage": "First row should be a number greater than 1"}, "firstColumn": {"type": "integer", "minimum": 1, "maximum": 8, "examples": [1, 4, 5], "errorMessage": "First column should be a number between 1 and 8"}, "widgetWidth": {"type": "integer", "minimum": 1, "maximum": 8, "examples": [2, 4, 6], "errorMessage": "Widget width should be a number between 1 and 8"}, "widgetHeight": {"type": "integer", "minimum": 1, "examples": [5, 2, 3], "errorMessage": "Widget height should be a number greater than 1"}, "widgetType": {"type": "string", "enum": ["map", "table", "metric", "gauge"], "examples": ["map", "table"], "errorMessage": "Widget type should be one of the following options: map, table, metric, gauge"}, "widgetTitle": {"type": "string", "minLength": 1, "maxLength": 800, "examples": ["Device Info", "PNIO-Fault"], "errorMessage": "Widget title should be a string of at least one character and maximum 800 characters"}}, "required": ["firstRow", "firstColumn", "widgetWidth", "widgetHeight", "widgetType", "widgetTitle"]}, "representationDef": {"type": "object", "properties": {"data": {}, "commonConfig": {}}, "allOf": [{"if": {"properties": {"commonConfig": {"type": "object", "properties": {"widgetType": {"const": "map"}}}}, "required": ["commonConfig"]}, "then": {"properties": {"data": {}, "commonConfig": {}, "specificConfig": {}}, "required": ["data", "commonConfig", "specificConfig"]}}, {"if": {"properties": {"commonConfig": {"type": "object", "properties": {"widgetType": {"const": "table"}}}}}, "then": {"properties": {"data": {}, "commonConfig": {}, "specificConfig": {}}, "required": ["data", "commonConfig", "specificConfig"]}}, {"if": {"properties": {"commonConfig": {"type": "object", "properties": {"widgetType": {"const": "metric"}}}}}, "then": {"properties": {"data": {}, "commonConfig": {}, "specificConfig": {}}, "required": ["data", "commonConfig", "specificConfig"]}}, {"if": {"properties": {"commonConfig": {"type": "object", "properties": {"widgetType": {"const": "gauge"}}}}, "required": ["commonConfig"]}, "then": {"properties": {"data": {}, "commonConfig": {}, "specificConfig": {}}, "required": ["data", "commonConfig", "specificConfig"]}}]}}, "properties": {"schemaVersion": {}, "origin": {}, "templateId": {}, "templateVersion": {}, "rangerFilter": {}, "alias": {"type": "string", "examples": ["SCALANCE XC-200", "SCALANCE X-200"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one character and less than 80 characters"}, "originTypes": {"type": "array", "items": {}, "minItems": 1, "uniqueItems": true, "errorMessage": "Should be a array and have at least one entry"}, "datapointSets": {"type": "array", "items": {}, "uniqueItemProperties": ["datapointSetId"], "minItems": 1, "errorMessage": "Should be a array"}, "representation": {"type": "array", "minItems": 1, "errorMessage": "Representation should be a array and have at least one entry", "items": {}}}, "additionalProperties": false, "required": ["origin", "templateId", "templateVersion", "description", "datapointSets"], "errorMessage": "Not valid template object"} |
|
template.schema.json | schemaVersionDef | Fixed value designating the version of the template schema | {"type": "string", "pattern": "(?<=^v?|\\sv?)(?:(?:0|[1-9][0-9]*).){2}(?:0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*)(?:.(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*))*)?(?:\\+[0-9a-z-]+(?:.[0-9a-z-]+)*)?\\b", "examples": ["1.5.2", "7.5.3", "7.5.3-test"], "errorMessage": "Not valid version string, for more information see : https://semver.org/"} |
template.schema.json | originDef | Monitored system, subsystem, device or ... source of the datapoint | {"type": "string", "pattern": "^\\/\\{[a-zA-Z0-9-_.]{1,80}\\}\\/$|^[a-zA-Z0-9-_.]{1,80}$", "errorMessage": "origin should be a string. Maximum size of 80 alphanumerical characters or symbol: -_."} |
template.schema.json | templateIdDef | Template identification string | {"type": "string", "pattern": "^[a-zA-Z0-9-_ ]{1,80}$", "errorMessage": "templateId should be a string. Maximum size of 80 alphanumerical characters or symbol: -_"} |
template.schema.json | templateVersionDef | SemVer style template version | {"type": "string", "pattern": "(?<=^v?|\\sv?)(?:(?:0|[1-9][0-9]*).){2}(?:0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*)(?:.(?:0|[1-9][0-9]*|[0-9a-z-]*[a-z-][0-9a-z-]*))*)?(?:\\+[0-9a-z-]+(?:.[0-9a-z-]+)*)?\\b", "examples": ["1.5.2", "7.5.3", "7.5.3-test"], "errorMessage": "templateVersion should be a valid version string. For more information see : https://semver.org/"} |
Subsets and Splits