schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.3.json
guid
The 'guid' property of the referenced toolComponent.
{"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}$"}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the toolComponentReference.
{}
sarif-2.1.0-rtm.3.json
translationMetadata
Provides additional metadata related to translation.
{"type": "object", "properties": {"name": {"type": "string"}, "fullName": {"type": "string"}, "shortDescription": {}, "fullDescription": {}, "downloadUri": {"type": "string", "format": "uri"}, "informationUri": {"type": "string", "format": "uri"}, "properties": {}}, "required": ["name"]}
sarif-2.1.0-rtm.3.json
name
The name associated with the translation metadata.
{"type": "string"}
sarif-2.1.0-rtm.3.json
fullName
The full name associated with the translation metadata.
{"type": "string"}
sarif-2.1.0-rtm.3.json
shortDescription
A brief description of the translation metadata.
{}
sarif-2.1.0-rtm.3.json
fullDescription
A comprehensive description of the translation metadata.
{}
sarif-2.1.0-rtm.3.json
downloadUri
The absolute URI from which the translation metadata can be downloaded.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
informationUri
The absolute URI from which information related to the translation metadata can be downloaded.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the translation metadata.
{}
sarif-2.1.0-rtm.3.json
versionControlDetails
Specifies the information necessary to retrieve a desired revision from a version control system.
{"type": "object", "additionalProperties": false, "properties": {"repositoryUri": {"type": "string", "format": "uri"}, "revisionId": {"type": "string"}, "branch": {"type": "string"}, "revisionTag": {"type": "string"}, "asOfTimeUtc": {"type": "string", "format": "date-time"}, "mappedTo": {}, "properties": {}}, "required": ["repositoryUri"]}
sarif-2.1.0-rtm.3.json
repositoryUri
The absolute URI of the repository.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
revisionId
A string that uniquely and permanently identifies the revision within the repository.
{"type": "string"}
sarif-2.1.0-rtm.3.json
branch
The name of a branch containing the revision.
{"type": "string"}
sarif-2.1.0-rtm.3.json
revisionTag
A tag that has been applied to the revision.
{"type": "string"}
sarif-2.1.0-rtm.3.json
asOfTimeUtc
A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.3.json
mappedTo
The location in the local file system to which the root of the repository was mapped at the time of the analysis.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the version control details.
{}
sarif-2.1.0-rtm.3.json
webRequest
A web request object.
{"type": "object", "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "protocol": {"type": "string"}, "version": {"type": "string"}, "target": {"type": "string"}, "method": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "parameters": {"type": "object", "additionalProperties": {"type": "string"}}, "body": {}, "properties": {}}}
sarif-2.1.0-rtm.3.json
index
The index within the run.webRequests array of the request object associated with this result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
protocol
The request protocol. Example: 'http'.
{"type": "string"}
sarif-2.1.0-rtm.3.json
version
The request version. Example: '1.1'.
{"type": "string"}
sarif-2.1.0-rtm.3.json
target
The target of the request.
{"type": "string"}
sarif-2.1.0-rtm.3.json
method
The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.
{"type": "string"}
sarif-2.1.0-rtm.3.json
headers
The request headers.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.3.json
parameters
The request parameters.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.3.json
body
The body of the request.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the request.
{}
sarif-2.1.0-rtm.3.json
webResponse
A web response object.
{"type": "object", "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "protocol": {"type": "string"}, "version": {"type": "string"}, "statusCode": {"type": "integer"}, "reasonPhrase": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "body": {}, "noResponseReceived": {"type": "boolean", "default": false}, "properties": {}}}
sarif-2.1.0-rtm.3.json
index
The index within the run.webResponses array of the response object associated with this result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
protocol
The response protocol. Example: 'http'.
{"type": "string"}
sarif-2.1.0-rtm.3.json
version
The response version. Example: '1.1'.
{"type": "string"}
sarif-2.1.0-rtm.3.json
statusCode
The response status code. Example: 451.
{"type": "integer"}
sarif-2.1.0-rtm.3.json
reasonPhrase
The response reason. Example: 'Not found'.
{"type": "string"}
sarif-2.1.0-rtm.3.json
headers
The response headers.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.3.json
body
The body of the response.
{}
sarif-2.1.0-rtm.3.json
noResponseReceived
Specifies whether a response was received from the server.
{"type": "boolean", "default": false}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the response.
{}
sarif-2.1.0-rtm.3.json
$schema
The URI of the JSON schema corresponding to the version.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
version
The SARIF format version of this log file.
{"enum": ["2.1.0"]}
sarif-2.1.0-rtm.3.json
runs
The set of runs contained in this log file.
{"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.3.json
inlineExternalProperties
References to external property files that share data between runs.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the log file.
{}
discovery.schema.json
Meltano (https://meltano.com) is an open source platform for building, running & orchestrating ELT pipelines
{"$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": {"version": {"type": "integer"}, "extractors": {"type": "array", "items": {}}, "loaders": {"type": "array", "items": {}}, "orchestrators": {"type": "array", "items": {}}, "transformers": {"type": "array", "items": {}}, "files": {"type": "array", "items": {}}, "utilities": {"type": "array", "items": {}}, "transforms": {"type": "array", "items": {}}, "mappers": {"type": "array", "items": {}}}, "$defs": {"common": {"type": "object", "additionalProperties": true, "required": ["name", "namespace"], "allOf": [{}, {"properties": {"name": {"type": "string", "examples": ["target-jsonl"]}, "namespace": {"type": "string", "examples": ["tap_csv", "target_jsonl"]}, "label": {"type": "string", "examples": ["Stripe", "Facebook Ads"]}, "commands": {"type": "object"}, "docs": {"type": "string"}, "executable": {"type": "string", "examples": ["tap-stripe", "tap-covid-19"]}, "variant": {"type": "string", "examples": ["singer-io"]}, "variants": {"type": "array", "items": {"type": "object", "allOf": [{}, {}]}}, "requires": {}}}]}, "variant_base": {"type": "object", "additionalProperties": true, "properties": {"pip_url": {"type": "string", "examples": ["target-jsonl", "git+https://gitlab.com/meltano/tap-facebook.git", "wtforms==2.2.1 apache-airflow==1.10.2"]}, "docs": {"type": "string"}, "executable": {"type": "string", "examples": ["tap-stripe", "tap-covid-19"]}, "repo": {"type": "string"}, "settings": {"type": "array", "items": {}}, "settings_group_validation": {"type": "array", "items": {"type": "array", "items": {"type": "string"}}}, "commands": {"type": "object"}}}, "variants_base": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "examples": ["singer-io"]}}}, "extractor_specific": {"type": "object", "properties": {"capabilities": {"type": "array", "items": {"type": "string", "enum": ["properties", "catalog", "discover", "state", "about", "stream-maps", "activate-version", "batch", "test", "log-based"]}}, "metadata": {"type": "object", "default": {}}, "schema": {"type": "object", "default": {}}, "select": {"type": "array", "default": ["*.*"], "items": {"type": "string"}}}}, "extractors": {"type": "object", "allOf": [{}, {}, {"type": "object", "properties": {"variants": {"type": "array", "items": {"type": "object"}}}}], "unevaluatedProperties": false}, "loader_specific": {"type": "object", "properties": {"dialect": {}, "target_schema": {}, "capabilities": {"type": "array", "items": {"type": "string", "enum": ["about", "stream-maps", "activate-version", "batch", "soft-delete", "hard-delete", "datatype-failsafe", "record-flattening"]}}}}, "loaders": {"type": "object", "allOf": [{}, {}, {"properties": {"variants": {"type": "array", "items": {"type": "object"}}}}], "unevaluatedProperties": false}, "orchestrators": {"type": "object", "unevaluatedProperties": false}, "transformers": {"type": "object", "unevaluatedProperties": false}, "files": {"type": "object", "allOf": [{}, {"properties": {"update": {"type": "object", "additionalProperties": {"type": "boolean"}}}}], "unevaluatedProperties": false}, "utilities": {"type": "object", "unevaluatedProperties": false}, "transforms": {"type": "object", "allOf": [{}, {"properties": {"vars": {"type": "object"}, "package_name": {}}}], "unevaluatedProperties": false}, "mapper_specific": {"type": "object", "properties": {"mappings": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "config": {"type": "object"}}}, "required": ["config", "name"]}}}, "mappers": {"type": "object", "allOf": [{}, {}, {"properties": {"variants": {"type": "array", "items": {"type": "object", "allOf": [{}, {}]}}}}], "unevaluatedProperties": false}, "base_setting": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string", "examples": ["account_id"]}, "aliases": {"type": "array", "examples": ["accountId", "account_identifier"], "items": {"type": "string"}}, "label": {"type": "string", "examples": ["Account ID"]}, "value": {}, "placeholder": {"type": "string", "examples": ["Ex. 18161"]}, "kind": {"type": "string", "enum": ["oauth", "hidden", "password", "date_iso8601", "file", "email", "integer", "options", "object", "array", "boolean", "string"]}, "tooltip": {"type": "string", "examples": ["Here is some additional info..."]}, "documentation": {"type": "string", "examples": ["https://meltano.com/"]}, "protected": {"type": "boolean", "default": false}, "env": {"type": "string", "examples": ["DBT_PROFILES_DIR", "GE_HOME"]}, "value_processor": {"type": "string", "enum": ["upcase_string", "nest_object", "stringify"]}, "value_post_processor": {"type": "string", "enum": ["upcase_string", "nest_object", "stringify"]}, "oauth": {"type": "object", "required": ["provider"], "properties": {"provider": {"type": "string", "examples": ["google-adwords"]}}}, "options": {"type": "array", "items": {"type": "object", "properties": {"label": {"type": "string"}, "value": {"type": "string"}}}}, "docs": {"type": "string"}}}, "requires": {"type": "object", "additionalProperties": false, "patternProperties": {"^(extractors|loaders|transforms|orchestrators|transformers|files|utilities|mappers)$": {"type": "array", "items": {}}}}, "plugin_requirement": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "variant": {"type": "string"}}}}}
discovery.schema.json
name
The name of the plugin.
{"type": "string", "examples": ["target-jsonl"]}
discovery.schema.json
namespace
The namespace of this plugin
{"type": "string", "examples": ["tap_csv", "target_jsonl"]}
discovery.schema.json
label
A user friendly label describing the plugin
{"type": "string", "examples": ["Stripe", "Facebook Ads"]}
discovery.schema.json
description
A description for what the plugin does
{"type": "string"}
discovery.schema.json
commands
An object containing commands to be run by the plugin, the keys are the name of the command and the values are the arguments to be passed to the plugin executable.
{"type": "object"}
discovery.schema.json
docs
A URL to the documentation for this plugin
{"type": "string"}
discovery.schema.json
executable
The plugin's executable name, as defined in setup.py (if a Python based plugin)
{"type": "string", "examples": ["tap-stripe", "tap-covid-19"]}
discovery.schema.json
variant
The same of the variant.
{"type": "string", "examples": ["singer-io"]}
discovery.schema.json
pip_url
The pip hosted package name or URL
{"type": "string", "examples": ["target-jsonl", "git+https://gitlab.com/meltano/tap-facebook.git", "wtforms==2.2.1 apache-airflow==1.10.2"]}
discovery.schema.json
docs
A URL to the documentation for this plugin
{"type": "string"}
discovery.schema.json
executable
The plugin's executable name, as defined in setup.py (if a Python based plugin)
{"type": "string", "examples": ["tap-stripe", "tap-covid-19"]}
discovery.schema.json
repo
The URL to the repository where the plugin code lives.
{"type": "string"}
discovery.schema.json
items
A set consisting of one valid combination of required setting names
{"type": "array", "items": {"type": "string"}}
discovery.schema.json
commands
An object containing commands to be run by the plugin, the keys are the name of the command and the values are the arguments to be passed to the plugin executable.
{"type": "object"}
discovery.schema.json
name
The name of the variant.
{"type": "string", "examples": ["singer-io"]}
discovery.schema.json
metadata
An object containing Singer stream and property metadata
{"type": "object", "default": {}}
discovery.schema.json
schema
An object representing override rules for a Singer stream schema
{"type": "object", "default": {}}
discovery.schema.json
select
An array of entity selection rules in the form '<entity|*>.<attribute|*>'
{"type": "array", "default": ["*.*"], "items": {"type": "string"}}
discovery.schema.json
extractors
https://docs.meltano.com/concepts/plugins#extractors
{"type": "object", "allOf": [{}, {}, {"type": "object", "properties": {"variants": {"type": "array", "items": {"type": "object"}}}}], "unevaluatedProperties": false}
discovery.schema.json
dialect
The name of the dialect of the target database, so that transformers in the same pipeline and Meltano UI's Analysis feature can determine the type of database to connect to.
{}
discovery.schema.json
target_schema
The name of the database schema the loader has been configured to load data into (assuming the destination supports schemas), so that transformers in the same pipeline can determine the database schema to load data from.
{}
discovery.schema.json
loaders
https://docs.meltano.com/concepts/plugins#loaders
{"type": "object", "allOf": [{}, {}, {"properties": {"variants": {"type": "array", "items": {"type": "object"}}}}], "unevaluatedProperties": false}
discovery.schema.json
orchestrators
https://docs.meltano.com/concepts/plugins#orchestrators
{"type": "object", "unevaluatedProperties": false}
discovery.schema.json
transformers
https://docs.meltano.com/concepts/plugins#transforms
{"type": "object", "unevaluatedProperties": false}
discovery.schema.json
files
https://docs.meltano.com/concepts/plugins#file-bundles
{"type": "object", "allOf": [{}, {"properties": {"update": {"type": "object", "additionalProperties": {"type": "boolean"}}}}], "unevaluatedProperties": false}
discovery.schema.json
utilities
https://docs.meltano.com/concepts/plugins#utilities
{"type": "object", "unevaluatedProperties": false}
discovery.schema.json
transforms
https://docs.meltano.com/concepts/plugins#transforms
{"type": "object", "allOf": [{}, {"properties": {"vars": {"type": "object"}, "package_name": {}}}], "unevaluatedProperties": false}
discovery.schema.json
vars
An object containing dbt model variables
{"type": "object"}
discovery.schema.json
package_name
The name of the dbt package's internal dbt project: the value of name in dbt_project.yml.
{}
discovery.schema.json
mappings
Name of the invokable mappings and their associated configs.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "config": {"type": "object"}}}, "required": ["config", "name"]}
discovery.schema.json
mappers
https://docs.meltano.com/concepts/plugins#mappers
{"type": "object", "allOf": [{}, {}, {"properties": {"variants": {"type": "array", "items": {"type": "object", "allOf": [{}, {}]}}}}], "unevaluatedProperties": false}
discovery.schema.json
name
The name of the setting
{"type": "string", "examples": ["account_id"]}
discovery.schema.json
aliases
Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'
{"type": "array", "examples": ["accountId", "account_identifier"], "items": {"type": "string"}}
discovery.schema.json
label
A user friendly label for the setting
{"type": "string", "examples": ["Account ID"]}
discovery.schema.json
value
The default value of this setting if not otherwise defined
{}
discovery.schema.json
placeholder
A placeholder value for this setting
{"type": "string", "examples": ["Ex. 18161"]}
discovery.schema.json
kind
The type of value this setting contains
{"type": "string", "enum": ["oauth", "hidden", "password", "date_iso8601", "file", "email", "integer", "options", "object", "array", "boolean", "string"]}
discovery.schema.json
description
A description for what this setting does
{"type": "string", "examples": ["The unique account identifier for your Stripe Account"]}
discovery.schema.json
tooltip
A phrase to provide additional information on this setting
{"type": "string", "examples": ["Here is some additional info..."]}
discovery.schema.json
documentation
A link to documentation on this setting
{"type": "string", "examples": ["https://meltano.com/"]}
discovery.schema.json
protected
A protected setting cannot be changed from the UI
{"type": "boolean", "default": false}
discovery.schema.json
env
An environment variable that will be initialized with the setting's value whenever the plugin is invoked. This is used to inject environment variables into the plugin's execution context. If the named environment variable is already defined at runtime, Meltano will use the passed value from context instead of the configured value.
{"type": "string", "examples": ["DBT_PROFILES_DIR", "GE_HOME"]}
discovery.schema.json
value_processor
Used with `kind: object` to process the keys in a particular way.
{"type": "string", "enum": ["upcase_string", "nest_object", "stringify"]}
discovery.schema.json
value_post_processor
Used with `kind: object` to process the keys in a particular way.
{"type": "string", "enum": ["upcase_string", "nest_object", "stringify"]}
discovery.schema.json
provider
The name of a Meltano-supported OAuth provider
{"type": "string", "examples": ["google-adwords"]}
discovery.schema.json
label
A user friendly label describing the plugin
{"type": "string"}
discovery.schema.json
value
The defined value of the option.
{"type": "string"}
discovery.schema.json
docs
A URL to the documentation for this plugin
{"type": "string"}
discovery.schema.json
requires
A set of plugin requirements.
{"type": "object", "additionalProperties": false, "patternProperties": {"^(extractors|loaders|transforms|orchestrators|transformers|files|utilities|mappers)$": {"type": "array", "items": {}}}}
discovery.schema.json
plugin_requirement
A single plugin requirement
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "variant": {"type": "string"}}}
discovery.schema.json
name
The name of the required plugin
{"type": "string"}
discovery.schema.json
variant
The variant of the required plugin
{"type": "string"}
strmprivacy.api.entities.v1.Stream.json
strmprivacy.api.entities.v1.ConsentLevelType
Consent level is meant to interpret the consent-levels of an event for decryption purposes only. Cumulative means that the highest consent-level in an event must be greater than or equal to the single requested level for the decrypted stream. Granular means that the set of consent-levels in an event must enclose the set of requested event levels for the decrypted stream.
{"enum": ["CONSENT_LEVEL_TYPE_UNSPECIFIED", 0, "CUMULATIVE", 1, "GRANULAR", 2], "markdownEnumDescriptions": ["(or 0) ", "(or \"CONSENT_LEVEL_TYPE_UNSPECIFIED\") ", "(or 1) ", "(or \"CUMULATIVE\") ", "(or 2) ", "(or \"GRANULAR\") "]}
strmprivacy.api.entities.v1.Stream.json
strmprivacy.api.entities.v1.Credentials
Credentials to produce to the event-gateway, or to consume from egress.
{"type": "object", "properties": {"billingId": {}, "clientId": {}, "clientSecret": {}, "projectId": {}}, "patternProperties": {"^billing_id$": {}, "^client_id$": {}, "^client_secret$": {}, "^project_id$": {}}, "additionalProperties": {}, "definitions": {"billing_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "client_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "client_secret": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "project_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}}}
strmprivacy.api.entities.v1.Stream.json
client_secret
as this property is secret, it is not always returned
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.Stream.json
event_count
filled in from customer profile
{"oneOf": [{"oneOf": [{"type": "string"}, {"type": "integer"}]}, {"type": "null"}], "default": 0}