Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
 Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sil-kit-participant-configuration.json
pAllowHaltDueToClock
Controls the transition to halt state due to clock synchronization errors. (values 0, 1)
{"type": "integer", "minimum": 0, "maximum": 1}
sil-kit-participant-configuration.json
pAllowPassiveToActive
Required number of consecutive even / odd cycle pairs for normal passive to normal active (range 0 - 31)
{"type": "integer", "minimum": 0, "maximum": 31}
sil-kit-participant-configuration.json
pChannels
Channel(s) to which the controller is connected
{"type": "string", "enum": ["A", "B", "AB", "None"]}
sil-kit-participant-configuration.json
pClusterDriftDamping
Cluster drift damping factor for rate correction in microticks (range 0 - 10)
{"type": "integer", "minimum": 0, "maximum": 10}
sil-kit-participant-configuration.json
pdAcceptedStartupRange
Allowed deviation for startup frames during integration in microticks (range 29 - 2743)
{"type": "integer", "minimum": 29, "maximum": 2743}
sil-kit-participant-configuration.json
pdListenTimeout
Duration of listen phase in microticks (range 1926 - 2567692)
{"type": "integer", "minimum": 1926, "maximum": 2567692}
sil-kit-participant-configuration.json
pKeySlotId
Slot ID of the key slot (range 0 - 1023; value 0 means that there is no key slot)
{"type": "integer", "minimum": 0, "maximum": 1023}
sil-kit-participant-configuration.json
pKeySlotOnlyEnabled
Shall the node enter key slot only mode after startup. (values 0, 1) (AUTOSAR pSingleSlotEnabled)
{"type": "integer", "minimum": 0, "maximum": 1}
sil-kit-participant-configuration.json
pKeySlotUsedForStartup
Key slot is used for startup (values 0, 1)
{"type": "integer", "minimum": 0, "maximum": 1}
sil-kit-participant-configuration.json
pKeySlotUsedForSync
Key slot is used for sync (values 0, 1)
{"type": "integer", "minimum": 0, "maximum": 1}
sil-kit-participant-configuration.json
pLatestTx
Last mini slot which can be transmitted (range 0 - 7988)
{"type": "integer", "minimum": 0, "maximum": 7988}
sil-kit-participant-configuration.json
pMacroInitialOffsetA
Initial startup offset for frame reference point on channel A (range 2 - 68 macroticks)
{"type": "integer", "minimum": 2, "maximum": 68}
sil-kit-participant-configuration.json
pMacroInitialOffsetB
Initial startup offset for frame reference point on channel B (range 2 - 68 macroticks)
{"type": "integer", "minimum": 2, "maximum": 68}
sil-kit-participant-configuration.json
pMicroInitialOffsetA
Offset between secondary time reference and MT boundary (range 0 - 239 microticks)
{"type": "integer", "minimum": 0, "maximum": 239}
sil-kit-participant-configuration.json
pMicroInitialOffsetB
Offset between secondary time reference and MT boundary (range 0 - 239 microticks)
{"type": "integer", "minimum": 0, "maximum": 239}
sil-kit-participant-configuration.json
pMicroPerCycle
Nominal number of microticks in the communication cycle (range 960 - 1280000)
{"type": "integer", "minimum": 960, "maximum": 1280000}
sil-kit-participant-configuration.json
pOffsetCorrectionOut
Maximum permissible offset correction value (range 15 - 16082 microticks)
{"type": "integer", "minimum": 15, "maximum": 16082}
sil-kit-participant-configuration.json
pOffsetCorrectionStart
Start of the offset correction phase within the NIT, (7 - 15999 macroticks)
{"type": "integer", "minimum": 7, "maximum": 15999}
sil-kit-participant-configuration.json
pRateCorrectionOut
Maximum permissible rate correction value (range 3 - 3846 microticks)
{"type": "integer", "minimum": 3, "maximum": 3846}
sil-kit-participant-configuration.json
pWakeupChannel
Channel used by the node to send a wakeup pattern
{"type": "string", "enum": ["A", "B"]}
sil-kit-participant-configuration.json
pWakeupPattern
Number of repetitions of the wakeup symbol (range 0 - 63, value 0 or 1 prevents sending of WUP)
{"type": "integer", "minimum": 0, "maximum": 63}
sil-kit-participant-configuration.json
pdMicrotick
Duration of a FlexRay microtick
{"type": "string", "enum": ["12.5ns", "25ns", "50ns"]}
sil-kit-participant-configuration.json
pSamplesPerMicrotick
Number of samples per microtick (values 1, 2)
{"type": "integer", "minimum": 1, "maximum": 2}
sil-kit-participant-configuration.json
channels
Channel(s)
{"type": "string", "enum": ["A", "B", "AB", "None"]}
sil-kit-participant-configuration.json
slotId
The slot Id of frame
{"type": "integer", "minimum": 0, "maximum": 65535}
sil-kit-participant-configuration.json
offset
Base offset for cycle multiplexing (values 0 - 63)
{"type": "integer", "minimum": 0, "maximum": 63}
sil-kit-participant-configuration.json
repetition
Repetition for cycle multiplexing (values 1, 2, 4, 8, 16, 32, 64)
{"type": "integer", "minimum": 0, "maximum": 64}
sil-kit-participant-configuration.json
PPindicator
Set the PPindicator
{"type": "boolean"}
sil-kit-participant-configuration.json
headerCrc
Header CRC, 11 bits
{"type": "integer"}
sil-kit-participant-configuration.json
transmissionMode
SingleShot or Continuous transmission mode
{"type": "string", "enum": ["SingleShot", "Continuous"]}
sil-kit-participant-configuration.json
FlexrayControllers
Reconfigures the FlexrayControllers of the participant
{"type": "array", "items": {}}
sil-kit-participant-configuration.json
Topic
Name of the communication channel between DataPublisher and DataSubscribers
{"type": "string"}
sil-kit-participant-configuration.json
RpcFunctionName
Name of the RPC function called by RpcClients on RpcServers
{"type": "string"}
sil-kit-participant-configuration.json
Logging
Configures the properties of the SIL Kit Logging Service
{"type": "object", "properties": {"LogFromRemotes": {"type": "boolean", "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"}}, "additionalProperties": false, "required": ["Type"]}}}, "additionalProperties": false, "required": ["Sinks"]}
sil-kit-participant-configuration.json
LogFromRemotes
Enables receiving of remote log messages from other participants
{"type": "boolean", "default": false}
sil-kit-participant-configuration.json
LogName
Log name; Results in the following filename: <LogName>_%y-%m-%dT%h-%m-%s.txt
{"type": "string"}
sil-kit-participant-configuration.json
$schema
The schema file
{"type": "string", "default": "", "examples": ["./ParticipantConfiguration.schema.json"]}
sil-kit-participant-configuration.json
schemaVersion
Version of the schema used to validate this document
{"anyOf": [{"type": "integer"}, {"type": "string"}], "default": 0}
sil-kit-participant-configuration.json
ParticipantName
Name of the participant
{"type": "string"}
sil-kit-participant-configuration.json
CanControllers
Reconfigures the CanControllers of the participant
{"type": "array", "items": {"type": "object", "properties": {"Name": {}, "Network": {}, "UseTraceSinks": {}, "Replay": {}}, "additionalProperties": false, "required": ["Name"]}}
sil-kit-participant-configuration.json
LinControllers
Reconfigures the LinControllers of the participant
{"type": "array", "items": {"type": "object", "properties": {"Name": {}, "Network": {}, "UseTraceSinks": {}, "Replay": {}}, "additionalProperties": false, "required": ["Name"]}}
sil-kit-participant-configuration.json
EthernetControllers
Reconfigures the EthernetControllers of the participant
{"type": "array", "items": {"type": "object", "properties": {"Name": {}, "Network": {}, "UseTraceSinks": {}, "Replay": {}}, "additionalProperties": false, "required": ["Name"]}}
sil-kit-participant-configuration.json
DataPublishers
Reconfigures the DataPublishers of the participant
{"type": "array", "items": {"type": "object", "properties": {"Name": {}, "Topic": {}}, "additionalProperties": false, "required": ["Name"]}}
sil-kit-participant-configuration.json
DataSubscribers
Reconfigures the DataSubscribers of the participant
{"type": "array", "items": {"type": "object", "properties": {"Name": {}, "Topic": {}}, "additionalProperties": false, "required": ["Name"]}}
sil-kit-participant-configuration.json
RpcClients
Reconfigures the RpcClients of the participant
{"type": "array", "items": {"type": "object", "properties": {"Name": {}, "FunctionName": {}}, "additionalProperties": false, "required": ["Name"]}}
sil-kit-participant-configuration.json
RpcServers
Reconfigures the RpcServers of the participant
{"type": "array", "items": {"type": "object", "properties": {"Name": {}, "FunctionName": {}}, "additionalProperties": false, "required": ["Name"]}}
sil-kit-participant-configuration.json
HealthCheck
Node to configure properties to determine the health status of the simulation
{"type": "object", "properties": {"SoftResponseTimeout": {"type": "integer"}, "HardResponseTimeout": {"type": "integer"}}, "additionalProperties": false}
sil-kit-participant-configuration.json
SoftResponseTimeout
If a simulation step is not finished before this limit, a warning is logged. Optional; Unit is in milliseconds
{"type": "integer"}
sil-kit-participant-configuration.json
HardResponseTimeout
If a simulation step is not finished before this limit, the participant enters error state. Optional; Unit is in milliseconds
{"type": "integer"}
sil-kit-participant-configuration.json
Tracing
Configures the tracing service of the participant
{"type": "object", "properties": {"TraceSinks": {"type": "array", "items": {"type": "object", "properties": {"Name": {"type": "string"}, "OutputPath": {"type": "string"}, "Type": {"type": "string", "enum": ["PcapFile", "PcapPipe", "Mdf4File"]}}, "additionalProperties": false}}, "TraceSources": {"type": "array", "items": {"type": "object", "properties": {"Name": {"type": "string", "examples": ["SomeTraceSource"]}, "InputPath": {"type": "string"}, "Type": {"type": "string", "enum": ["PcapFile", "PcapPipe", "Mdf4File"]}}, "additionalProperties": false}}}}
sil-kit-participant-configuration.json
Name
Name of the trace sink
{"type": "string"}
sil-kit-participant-configuration.json
OutputPath
File path of output file
{"type": "string"}
sil-kit-participant-configuration.json
Type
File format specifier
{"type": "string", "enum": ["PcapFile", "PcapPipe", "Mdf4File"]}
sil-kit-participant-configuration.json
Name
Name of the trace source
{"type": "string", "examples": ["SomeTraceSource"]}
sil-kit-participant-configuration.json
InputPath
File path of input file
{"type": "string"}
sil-kit-participant-configuration.json
Type
File format specifier
{"type": "string", "enum": ["PcapFile", "PcapPipe", "Mdf4File"]}
sil-kit-participant-configuration.json
Extensions
Optional configuration for the extension loading mechanism
{"type": "object", "properties": {"SearchPathHints": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}
sil-kit-participant-configuration.json
items
A filesystem path to additionally search for extensions
{"type": "string"}
sil-kit-participant-configuration.json
Middleware
Optional configuration of the SIL Kit middleware
{"type": "object", "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}
tsdrc.json
strictSSL
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.
{"type": "boolean", "default": true}
tsdrc.json
proxy
Any standard http-proxy as supported by the request package.
{"type": "string", "format": "uri"}
tsdrc.json
token
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.
{"type": "string"}
minecraft-trim-pattern.json
A trim pattern for a Minecraft data pack config schema
{"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"asset_id": {"type": "string"}, "template_item": {"type": "string"}}, "required": ["asset_id", "description", "template_item"], "type": "object"}
filespec-schema.json
JFrog File Spec schema definition.
{"$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "properties": {"files": {"type": "array", "items": {}, "minItems": 1, "uniqueItems": true, "default": [{"pattern": ""}]}}, "$file": {"additionalProperties": false, "properties": {"ant": {"type": "string", "enum": ["true", "false"], "default": "false"}, "aql": {"additionalProperties": false, "properties": {"items.find": {}}, "default": {"items.find": {"repo": "my-local-repo", "path": "my-path", "file": "my-file"}}}, "archive": {"type": "string", "enum": ["zip"]}, "archiveEntries": {"type": "string"}, "build": {"type": "string", "examples": ["buildName", "buildName/buildNumber"]}, "bundle": {"type": "string", "examples": ["buildName/bundleVersion"]}, "excludeArtifacts": {"type": "string", "enum": ["true", "false"], "default": "false"}, "excludeProps": {"type": "string", "examples": ["key1=value1;key2=value2;key3=value3"]}, "exclusions": {"type": "array", "examples": [["*.sha1", "*.md5"]]}, "explode": {"type": "string", "enum": ["true", "false"], "default": "false"}, "bypass-archive-inspection": {"type": "string", "enum": ["true", "false"], "default": "false"}, "flat": {"type": "string", "enum": ["true", "false"], "default": "true"}, "includeDeps": {"type": "string", "enum": ["true", "false"], "default": "true"}, "includeDirs": {"type": "string", "enum": ["true", "false"], "default": "false"}, "limit": {"type": "integer"}, "offset": {"type": "integer"}, "pattern": {"type": "string"}, "props": {"type": "string", "examples": ["key1=value1;key2=value2;key3=value3"]}, "recursive": {"type": "string", "enum": ["true", "false"], "default": "true"}, "regexp": {"type": "string", "default": "false"}, "sortBy": {"type": "array", "items": {"type": "string"}, "examples": ["repo", "path", "name", "created", "modified", "updated", "created_by", "modified_by", "type", "depth", "original_md5", "actual_md5", "original_sha1", "actual_sha1", "sha256", "size", "virtual_repos"]}, "sortOrder": {"type": "string", "enum": ["asc", "desc"], "default": "asc"}, "symlinks": {"type": "string", "default": "false"}, "target": {"type": "string", "default": "./"}, "targetProps": {"type": "string", "examples": ["key1=value1;key2=value2;key3=value3"]}, "validateSymlinks": {"type": "string", "default": "false"}, "include-dirs": {"type": "string", "enum": ["true", "false"], "default": "false"}, "from-rt": {"type": "string", "enum": ["true", "false"], "default": "false"}, "gpg-key": {"type": "string"}}, "anyOf": [{"required": ["pattern"]}, {"required": ["aql"]}, {"required": ["build"]}, {"required": ["bundle"]}], "dependencies": {"pattern": {"not": {"required": ["aql"]}}, "aql": {"not": {"required": ["pattern", "exclusions", "props", "targetProps", "excludeProps", "recursive", "regexp", "archiveEntries"]}}, "build": {"not": {"required": ["bundle", "limit", "offset"]}}, "bundle": {"not": {"required": ["build", "limit", "offset"]}}, "excludeArtifacts": {"required": ["build"]}, "includeDeps": {"required": ["build"]}}}}
filespec-schema.json
files
Details of files to be uploaded or downloaded from Artifactory.
{"type": "array", "items": {}, "minItems": 1, "uniqueItems": true, "default": [{"pattern": ""}]}
filespec-schema.json
ant
If true, the command will interpret the patterns which describes the local file-system paths, as ANT patterns.
{"type": "string", "enum": ["true", "false"], "default": "false"}
filespec-schema.json
aql
An AQL query that specified artifacts in Artifactory.
{"additionalProperties": false, "properties": {"items.find": {}}, "default": {"items.find": {"repo": "my-local-repo", "path": "my-path", "file": "my-file"}}}
filespec-schema.json
archive
Set to "zip" to pack and deploy the files to Artifactory inside a ZIP archive. Currently, the only packaging format supported is zip.
{"type": "string", "enum": ["zip"]}
filespec-schema.json
archiveEntries
If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts.
{"type": "string"}
filespec-schema.json
build
If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number.
{"type": "string", "examples": ["buildName", "buildName/buildNumber"]}
filespec-schema.json
bundle
If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version.
{"type": "string", "examples": ["buildName/bundleVersion"]}
filespec-schema.json
excludeArtifacts
If specified, build artifacts are not matched.
{"type": "string", "enum": ["true", "false"], "default": "false"}
filespec-schema.json
excludeProps
List of "key=value" pairs separated by a semi-colon. Only artifacts without all of the specified properties names and values will be affected.
{"type": "string", "examples": ["key1=value1;key2=value2;key3=value3"]}
filespec-schema.json
exclusions
An array (enclosed with square brackets) of patterns to be excluded from uploading/downloading.
{"type": "array", "examples": [["*.sha1", "*.md5"]]}
filespec-schema.json
explode
If true, archive file is extracted after the operation. The archived file itself is deleted. The supported archive types are: zip, tar; tar.gz; and tgz.
{"type": "string", "enum": ["true", "false"], "default": "false"}
filespec-schema.json
bypass-archive-inspection
If true, bypass the security inspection the archive go through before it is unarchived.
{"type": "string", "enum": ["true", "false"], "default": "false"}
filespec-schema.json
flat
If true, artifacts are uploaded/downloaded to the exact target path specified and their hierarchy in the source file system is ignored.
{"type": "string", "enum": ["true", "false"], "default": "true"}
filespec-schema.json
includeDeps
If specified, also dependencies of the specified build are matched.
{"type": "string", "enum": ["true", "false"], "default": "true"}
filespec-schema.json
includeDirs
If true, the source path applies to bottom-chain directories and not only to files. Bottom-chain directories are either empty or do not include other directories that match the source path.
{"type": "string", "enum": ["true", "false"], "default": "false"}
filespec-schema.json
limit
The maximum number of items to fetch. Usually used with the sortBy option.
{"type": "integer"}
filespec-schema.json
offset
The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option.
{"type": "integer"}
filespec-schema.json
pattern
Specifies a local file system path or a path in Artifactory.
{"type": "string"}
filespec-schema.json
props
List of "key=value" pairs separated by a semi-colon. Only artifacts with all of the specified properties names and values will be affected.
{"type": "string", "examples": ["key1=value1;key2=value2;key3=value3"]}
filespec-schema.json
recursive
If true, files are also collected from sub-folders of the source directory.
{"type": "string", "enum": ["true", "false"], "default": "true"}
filespec-schema.json
regexp
If true, the command will interpret the patterns which describes the local file-system paths, as regular expressions.
{"type": "string", "default": "false"}
filespec-schema.json
sortBy
A list of fields to sort by. The fields must be part of the 'items' AQL domain.
{"type": "array", "items": {"type": "string"}, "examples": ["repo", "path", "name", "created", "modified", "updated", "created_by", "modified_by", "type", "depth", "original_md5", "actual_md5", "original_sha1", "actual_sha1", "sha256", "size", "virtual_repos"]}
filespec-schema.json
sortOrder
The order by which fields in the sortBy option should be sorted.
{"type": "string", "enum": ["asc", "desc"], "default": "asc"}
filespec-schema.json
symlinks
If true, the command will preserve the soft links structure in Artifactory. The symlink file representation will contain the symbolic link and checksum properties.
{"type": "string", "default": "false"}
filespec-schema.json
target
Specifies a local file system path or a path in Artifactory.
{"type": "string", "default": "./"}
filespec-schema.json
targetProps
List of "key=value" pairs separated by a semi-colon. The specified properties will be attached to the affected artifacts.
{"type": "string", "examples": ["key1=value1;key2=value2;key3=value3"]}
filespec-schema.json
validateSymlinks
If true, the command will validate that symlinks are pointing to existing and unchanged files, by comparing their sha1. Applicable to files and not directories.
{"type": "string", "default": "false"}
filespec-schema.json
include-dirs
Set to true if you'd like to also apply the source path pattern for directories and not just for files.
{"type": "string", "enum": ["true", "false"], "default": "false"}
filespec-schema.json
from-rt
If true, search the files in Artifactory, rather than on the local file system. The --regexp option is not supported when --from-rt is set to true.
{"type": "string", "enum": ["true", "false"], "default": "false"}
filespec-schema.json
gpg-key
Path to the public GPG key file located on the file system, used to validate downloaded release bundles.
{"type": "string"}
global.json
sdk
Specify information about the SDK.
{"type": "object", "properties": {"version": {"type": "string", "pattern": "^(?<major>0|[1-9]\\d*)\\.(?<minor>0|[1-9]\\d*)\\.(?<patch>0|[1-9]\\d*)(?:-(?<prerelease>(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}, "allowPrerelease": {"type": "boolean"}, "rollForward": {"type": "string", "enum": ["patch", "feature", "minor", "major", "latestPatch", "latestFeature", "latestMinor", "latestMajor", "disable"], "default": "disable"}}}
global.json
version
The version of the SDK to use.
{"type": "string", "pattern": "^(?<major>0|[1-9]\\d*)\\.(?<minor>0|[1-9]\\d*)\\.(?<patch>0|[1-9]\\d*)(?:-(?<prerelease>(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}
global.json
rollForward
The roll-forward policy when selecting an SDK version, either as a fallback to accommodate missing a specific SDK version or as a directive to use a later version.
{"type": "string", "enum": ["patch", "feature", "minor", "major", "latestPatch", "latestFeature", "latestMinor", "latestMajor", "disable"], "default": "disable"}
prometheus.json
Prometheus configuration file
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"duration": {"type": ["string", "null"], "pattern": "^[0-9]+(ms|[smhdwy])$"}, "label_name": {"type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"}, "label_value": {"type": "string"}, "labels": {"type": ["object", "null"], "patternProperties": {"^[a-zA-Z_][a-zA-Z0-9_]*$": {}}, "additionalProperties": false}, "filepath_glob": {"type": "string"}, "filepath": {"type": ["string", "null"], "format": "uri-reference"}, "basic_auth": {"type": ["object", "null"], "properties": {"username": {"type": "string"}, "password": {"type": ["string", "null"]}, "password_file": {}}, "oneOf": [{"required": ["password"]}, {"required": ["password_file"]}], "additionalProperties": false, "required": ["username"]}, "authorization": {"type": ["object", "null"], "properties": {"type": {"type": ["string", "null"], "default": "Bearer"}, "credentials": {"type": ["string", "null"]}, "credentials_file": {}}, "oneOf": [{"required": ["credentials"]}, {"required": ["credentials_file"]}], "additionalProperties": false}, "sigv4": {"type": ["object", "null"], "properties": {"region": {"type": ["string", "null"]}, "access_key": {"type": ["string", "null"]}, "secret_key": {"type": ["string", "null"]}, "profile": {"type": ["string", "null"]}, "role_arn": {"type": ["string", "null"]}}, "additionalProperties": false}, "oauth2": {"type": ["object", "null"], "properties": {"client_id": {"type": ["string"]}, "client_secret": {"type": ["string", "null"]}, "client_secret_file": {}, "scopes": {"type": ["array", "null"], "items": {"type": ["string", "null"]}}, "token_url": {"type": ["string"]}, "endpoint_params": {"type": ["object", "null"], "additionalProperties": {"type": "string"}}, "tls_config": {}}, "oneOf": [{"required": ["client_secret"]}, {"required": ["client_secret_file"]}], "additionalProperties": false, "required": ["client_id", "token_url"]}, "bearer_token": {"type": ["string", "null"]}, "bearer_token_file": {}, "auth": {"allOf": [{"if": {"not": {"properties": {"basic_auth": {"const": null}}}}, "then": {"properties": {"authorization": {"const": null}, "sigv4": {"const": null}, "oauth2": {"const": null}, "bearer_token": {"const": null}, "bearer_token_file": {"const": null}}}}, {"if": {"not": {"properties": {"authorization": {"const": null}}}}, "then": {"properties": {"basic_auth": {"const": null}, "sigv4": {"const": null}, "oauth2": {"const": null}, "bearer_token": {"const": null}, "bearer_token_file": {"const": null}}}}, {"if": {"not": {"properties": {"sigv4": {"const": null}}}}, "then": {"properties": {"basic_auth": {"const": null}, "authorization": {"const": null}, "oauth2": {"const": null}, "bearer_token": {"const": null}, "bearer_token_file": {"const": null}}}}, {"if": {"not": {"properties": {"oauth2": {"const": null}}}}, "then": {"properties": {"basic_auth": {"const": null}, "authorization": {"const": null}, "sigv4": {"const": null}, "bearer_token": {"const": null}, "bearer_token_file": {"const": null}}}}, {"if": {"not": {"properties": {"bearer_token": {"const": null}}}}, "then": {"properties": {"basic_auth": {"const": null}, "authorization": {"const": null}, "sigv4": {"const": null}, "oauth2": {"const": null}, "bearer_token_file": {"const": null}}}}, {"if": {"not": {"properties": {"bearer_token_file": {"const": null}}}}, "then": {"properties": {"basic_auth": {"const": null}, "authorization": {"const": null}, "sigv4": {"const": null}, "oauth2": {"const": null}, "bearer_token": {"const": null}}}}]}, "relabel_configs": {"type": ["array", "null"], "items": {"type": "object", "properties": {"source_labels": {"type": "array", "items": {}}, "separator": {"type": "string", "default": ";"}, "target_label": {"type": "string"}, "regex": {"default": "(.*)"}, "modulus": {"type": "integer"}, "replacement": {"type": "string", "default": "$1"}, "action": {"type": "string", "enum": ["replace", "lowercase", "uppercase", "keep", "drop", "keepequal", "dropequal", "hashmod", "labelmap", "labeldrop", "labelkeep"], "default": "replace"}}, "if": {"properties": {"action": {"const": "replace"}}}, "then": {"required": ["target_label"]}}}, "tls_config": {"type": ["object", "null"], "properties": {"ca_file": {}, "cert_file": {}, "key_file": {}, "server_name": {"type": ["string", "null"]}, "insecure_skip_verify": {"type": ["boolean", "null"]}}, "additionalProperties": false}, "scheme": {"type": ["string", "null"], "enum": ["http", "https", null]}, "azure_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "consul_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "digitalocean_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "docker_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "dockerswarm_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "dns_sd_configs": {"type": ["array", "null"], "items": {"type": "object", "properties": {"names": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "type": {"type": ["string", "null"], "enum": ["SRV", "A", "AAAA"], "default": "SRV"}, "port": {"type": ["integer", "null"]}, "refresh_interval": {"default": "30s"}}, "required": ["names"], "additionalProperties": false}}, "ec2_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "eureka_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "file_sd_configs": {"type": ["array", "null"], "items": {"type": "object", "properties": {"files": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "refresh_interval": {"default": "5m"}}}}, "gce_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "hetzner_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "http_sd_configs": {"type": ["array", "null"], "items": {"type": "object", "properties": {"url": {"type": "string", "format": "uri-reference"}, "refresh_interval": {"default": "60s"}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}}, "required": ["url"], "allOf": [{}], "additionalProperties": false}}, "kubernetes_sd_configs": {"type": ["array", "null"], "items": {"type": "object", "properties": {"api_server": {"type": ["string", "null"], "format": "uri-reference"}, "role": {"type": "string", "enum": ["endpoints", "service", "pod", "node", "ingress"]}, "kubeconfig_file": {}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}, "namespaces": {"type": ["object", "null"], "properties": {"own_namespace": {"type": "boolean"}, "names": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "selectors": {"type": ["array", "null"], "items": {"type": "object", "properties": {"role": {"type": "string"}, "label": {"type": ["string", "null"]}, "field": {"type": ["string", "null"]}}, "required": ["role"], "additionalProperties": false}}}, "allOf": [{}], "additionalProperties": false}}, "kuma_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "lightsail_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "linode_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "marathon_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "nerve_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "openstack_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "puppetdb_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "scaleway_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "serverset_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "triton_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "uyuni_sd_configs": {"type": ["array", "null"], "items": {"type": "object"}}, "static_configs": {"type": ["array", "null"], "items": {"type": "object", "properties": {"targets": {"type": ["array", "null"], "items": {"type": "string"}}, "labels": {}}}}}, "properties": {"global": {"type": ["object", "null"], "properties": {"scrape_interval": {"default": "1m"}, "scrape_timeout": {"default": "10s"}, "evaluation_interval": {"default": "1m"}, "external_labels": {}, "query_log_file": {}}, "additionalProperties": false}, "rule_files": {"type": ["array", "null"], "items": {}}, "remote_write": {"type": ["array", "null"], "items": {"type": "object", "properties": {"url": {"type": "string", "format": "uri-reference"}, "remote_timeout": {"default": "30s"}, "headers": {"type": ["object", "null"], "additionalProperties": {"type": "string"}}, "write_relabel_configs": {}, "name": {"type": ["string", "null"]}, "send_exemplars": {"type": ["boolean", "null"], "default": false}, "basic_auth": {}, "authorization": {}, "sigv4": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "queue_config": {"type": ["object", "null"], "properties": {"capacity": {"type": ["integer", "null"], "default": 2500}, "max_shards": {"type": ["integer", "null"], "default": 200}, "min_shards": {"type": ["integer", "null"], "default": 1}, "max_samples_per_send": {"type": ["integer", "null"], "default": 500}, "batch_send_deadline": {"default": "5s"}, "min_backoff": {"default": "30ms"}, "max_backoff": {"default": "5s"}, "retry_on_http_429": {"type": ["boolean", "null"], "default": false}}, "additionalProperties": false}, "metadata_config": {"type": ["object", "null"], "properties": {"send": {"type": ["boolean", "null"], "default": true}, "send_interval": {"default": "1m"}, "max_samples_per_send": {"type": ["integer", "null"], "default": 500}}, "additionalProperties": false}}, "allOf": [{}], "additionalProperties": false, "required": ["url"]}}, "remote_read": {"type": ["array", "null"], "items": {"type": "object", "properties": {"url": {"type": "string", "format": "uri-reference"}, "name": {"type": ["string", "null"]}, "required_matchers": {}, "remote_timeout": {"default": "1m"}, "headers": {"type": ["object", "null"], "additionalProperties": {"type": "string"}}, "read_recent": {"type": ["boolean", "null"], "default": false}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}}, "allOf": [{}], "additionalProperties": false, "required": ["url"]}}, "scrape_config_files": {"type": ["array", "null"], "items": {}}, "scrape_configs": {"type": ["array", "null"], "items": {"type": "object", "properties": {"job_name": {"type": "string"}, "scrape_interval": {}, "scrape_timeout": {}, "metrics_path": {"type": ["string", "null"], "default": "/metrics"}, "honor_labels": {"type": ["boolean", "null"], "default": false}, "honor_timestamps": {"type": ["boolean", "null"], "default": true}, "scheme": {"default": "http"}, "params": {"type": ["object", "null"], "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "azure_sd_configs": {}, "consul_sd_configs": {}, "digitalocean_sd_configs": {}, "docker_sd_configs": {}, "dockerswarm_sd_configs": {}, "dns_sd_configs": {}, "ec2_sd_configs": {}, "eureka_sd_configs": {}, "file_sd_configs": {}, "gce_sd_configs": {}, "hetzner_sd_configs": {}, "http_sd_configs": {}, "kubernetes_sd_configs": {}, "kuma_sd_configs": {}, "lightsail_sd_configs": {}, "linode_sd_configs": {}, "marathon_sd_configs": {}, "nerve_sd_configs": {}, "openstack_sd_configs": {}, "puppetdb_sd_configs": {}, "scaleway_sd_configs": {}, "serverset_sd_configs": {}, "triton_sd_configs": {}, "uyuni_sd_configs": {}, "static_configs": {}, "relabel_configs": {}, "metric_relabel_configs": {}, "body_size_limit": {"type": ["integer", "null"], "default": 0}, "sample_limit": {"type": ["integer", "null"], "default": 0}, "label_limit": {"type": ["integer", "null"], "default": 0}, "label_name_length_limit": {"type": ["integer", "null"], "default": 0}, "label_value_length_limit": {"type": ["integer", "null"], "default": 0}, "target_limit": {"type": ["integer", "null"], "default": 0}}, "allOf": [{}], "additionalProperties": false, "required": ["job_name"]}}, "alerting": {"type": ["object", "null"], "properties": {"alert_relabel_configs": {}, "alertmanagers": {"type": ["array", "null"], "items": {"type": "object", "properties": {"timeout": {"default": "10s"}, "api_version": {"type": ["string", "null"], "default": "v2"}, "path_prefix": {"type": ["string", "null"], "default": "/"}, "scheme": {"default": "http"}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "azure_sd_configs": {}, "consul_sd_configs": {}, "digitalocean_sd_configs": {}, "docker_sd_configs": {}, "dockerswarm_sd_configs": {}, "dns_sd_configs": {}, "ec2_sd_configs": {}, "eureka_sd_configs": {}, "file_sd_configs": {}, "gce_sd_configs": {}, "hetzner_sd_configs": {}, "http_sd_configs": {}, "kubernetes_sd_configs": {}, "kuma_sd_configs": {}, "lightsail_sd_configs": {}, "linode_sd_configs": {}, "marathon_sd_configs": {}, "nerve_sd_configs": {}, "openstack_sd_configs": {}, "puppetdb_sd_configs": {}, "scaleway_sd_configs": {}, "serverset_sd_configs": {}, "triton_sd_configs": {}, "uyuni_sd_configs": {}, "static_configs": {}, "relabel_configs": {}}, "allOf": [{}]}}}}, "storage": {"type": ["array", "null"], "items": {"type": "object", "properties": {"max_exemplars": {"type": ["integer", "null"], "default": 100000}}, "additionalProperties": false}}}, "type": ["object", "null"]}
prometheus.json
basic_auth
Sets the `Authorization` header on every remote write request with the configured username and password. password and password_file are mutually exclusive.
{"type": ["object", "null"], "properties": {"username": {"type": "string"}, "password": {"type": ["string", "null"]}, "password_file": {}}, "oneOf": [{"required": ["password"]}, {"required": ["password_file"]}], "additionalProperties": false, "required": ["username"]}
prometheus.json
authorization
Sets the `Authorization` header on every scrape request with the configured credentials.
{"type": ["object", "null"], "properties": {"type": {"type": ["string", "null"], "default": "Bearer"}, "credentials": {"type": ["string", "null"]}, "credentials_file": {}}, "oneOf": [{"required": ["credentials"]}, {"required": ["credentials_file"]}], "additionalProperties": false}