schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
strmprivacy.api.entities.v1.Stream.json
event_rate
filled in from customer profile
{"oneOf": [{"oneOf": [{"type": "string"}, {"type": "integer"}]}, {"type": "null"}], "default": 0}
strmprivacy.api.entities.v1.Stream.json
field_patterns
map of event-contract-ref vs field patterns constraints: data-contract-refs should be existing data contracts field_patterns should be valid values (checked by events-core) the field_patterns list should have no duplicates.
{"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{}, {"type": "null"}], "default": {}}}, {"type": "null"}], "default": {}}
strmprivacy.api.entities.v1.Stream.json
hash_type
Default Murmurhash3 if empty
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.Stream.json
seed
hashing seed
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.Stream.json
strmprivacy.api.entities.v1.Stream
Streams are source or derived streams depending on whether or not linked_stream is null. Key streams are a separate entity in the api.
{"type": "object", "properties": {"enabled": {}, "maskedFields": {}, "kafkaTopic": {}, "limits": {}, "ref": {}, "tags": {}, "consentLevelType": {}, "linkedStream": {}, "policyId": {}, "credentials": {}, "consentLevels": {}}, "patternProperties": {"^consent_level_type$": {}, "^consent_levels$": {}, "^kafka_topic$": {}, ...
strmprivacy.api.entities.v1.Stream.json
enabled
whether or not this stream is enabled.
{"oneOf": [{"type": "boolean"}, {"type": "null"}], "default": false}
strmprivacy.api.entities.v1.Stream.json
consent_levels
consent levels for derived streams constraints: if consent_level_type == CUMULATIVE then size = 1 endif
{"oneOf": [{"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "integer"}]}}, {"type": "null"}], "default": null}
strmprivacy.api.entities.v1.Stream.json
description
Stream description
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.Stream.json
limits
stream limits
{"oneOf": [{}, {"type": "null"}], "default": {}}
strmprivacy.api.entities.v1.Stream.json
tags
tags are meant for customers to tag their streams
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "null"}], "default": null}
strmprivacy.api.entities.v1.Stream.json
consent_level_type
how event consent-levels are interpreted by decrypters.
{"oneOf": [{}, {"type": "null"}], "default": "CONSENT_LEVEL_TYPE_UNSPECIFIED"}
strmprivacy.api.entities.v1.Stream.json
linked_stream
null for source streams
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.Stream.json
policy_id
The id of the policy that should be applied to this stream's data
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.Stream.json
kafka_topic
Kafka topic of the stream. Deprecated in favor of topic in message ExtendedStream
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": "", "deprecationMessage": "Field \"kafka_topic\" is marked as deprecated"}
strmprivacy.api.entities.v1.Stream.json
masked_fields
field masking is defined per OUTPUT stream and event-contract ref. combination The default empty map means no masking. Otherwise, the algorithm in the decrypter is as follows. A source stream is (partially) decrypted, and events that don't have enough permissions are dropped. the event contract ref string is used t...
{"oneOf": [{}, {"type": "null"}], "default": {}}
strmprivacy.api.entities.v1.Stream.json
strmprivacy.api.entities.v1.StreamRef
refers to a event stream.
{"type": "object", "properties": {"billingId": {}, "name": {}, "projectId": {}}, "patternProperties": {"^billing_id$": {}, "^project_id$": {}}, "additionalProperties": {}, "definitions": {"billing_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": "", "deprecationMessage": "Field \"billing_id\" is marked...
strmprivacy.api.entities.v1.Stream.json
name
the name of the stream constraints: generic name
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
minecraft-configured-carver.json
A carver for a data pack for Minecraft https://minecraft.fandom.com/wiki/Custom_world_generation#Carvers
{"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"type": {"type": "string", "enum": ["minecraft:cave", "cave", "minecraft:nether_cave", "nether_cave", "minecraft:canyon", "canyon", "minecraft:underwater_canyon", "underwater_canyon", "minecraft:underwater_cave", "underwater_cave"]}, "config": {"type...
minecraft-configured-carver.json
type
A type for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "string", "enum": ["minecraft:cave", "cave", "minecraft:nether_cave", "nether_cave", "minecraft:canyon", "canyon", "minecraft:underwater_canyon", "underwater_canyon", "minecraft:underwater_cave", "underwater_cave"]}
minecraft-configured-carver.json
config
Options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object", "properties": {"probability": {"type": "number", "minimum": 0, "maximum": 1}, "y": {"type": "object"}, "lava_level": {"type": "string", "enum": ["absolute", "above_bottom", "below_top"]}, "replaceable": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "array", "uniqueItems": true, "items": {"t...
minecraft-configured-carver.json
probability
A probability that each chunk attempts to generate for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "number", "minimum": 0, "maximum": 1}
minecraft-configured-carver.json
y
A height at which to generate the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object"}
minecraft-configured-carver.json
lava_level
A height at which to generate the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "string", "enum": ["absolute", "above_bottom", "below_top"]}
minecraft-configured-carver.json
replaceable
Blocks can be carved for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"oneOf": [{"type": "string", "minLength": 1}, {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}]}
minecraft-configured-carver.json
items
A block can be carved for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "string", "minLength": 1}
minecraft-configured-carver.json
debug_settings
Replace blocks for debugging for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object", "properties": {"debug_mode": {"type": "boolean", "default": false}, "air_state": {"type": "object", "additionalProperties": true}, "water_state": {"type": "object", "additionalProperties": true}, "lava_state": {"type": "object", "additionalProperties": true}, "barrier_state": {"type": "object", "addi...
minecraft-configured-carver.json
debug_mode
Whether to enable debug mode for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "boolean", "default": false}
minecraft-configured-carver.json
air_state
Air replacement options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object", "additionalProperties": true}
minecraft-configured-carver.json
water_state
Water replacement options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object", "additionalProperties": true}
minecraft-configured-carver.json
lava_state
Lava replacement options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object", "additionalProperties": true}
minecraft-configured-carver.json
barrier_state
Barrier replacement options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object", "additionalProperties": true}
minecraft-configured-carver.json
yScale
Vertical scaling options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
minecraft-configured-carver.json
horizontal_radius_multiplier
Horizontal tunnel scaling options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
minecraft-configured-carver.json
vertical_radius_multiplier
Vertical tunnel scaling options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
minecraft-configured-carver.json
floor_level
Floor level options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"oneOf": [{"type": "number", "minimum": -1, "maximum": 1}, {"type": "object", "additionalProperties": true}]}
minecraft-configured-carver.json
vertical_rotation
Vertical rotation options for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
minecraft-configured-carver.json
shape
Ravine shape for the current carver https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
{"type": "object", "additionalProperties": true}
csslintrc.json
rule
CSS Lint rule 'false' means rule is off 'true' means it is a warning '2' means the rule is an error
{"enum": [2, true, false]}
drone.json
tolerations
If specified, the pod's tolerations.
{"items": {}, "type": "array"}
drone.json
dns_config
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
{}
drone.json
host_aliases
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
{"items": {}, "type": "array"}
drone.json
node_selector
A list of node selector terms.
{"items": {}}
drone.json
service_account_name
The name of the service account to use when running the kubernetes pipeline
{"type": "string"}
execution-environment.json
See V1: https://docs.ansible.com/automation-controller/latest/html/userguide/ee_reference.html V3: https://ansible-builder.readthedocs.io/en/latest/definition/
{"$defs": {"TYPE_DictOrStringOrListOfStrings": {"anyOf": [{"type": "object"}, {"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "TYPE_StringOrListOfStrings": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "v1": {"additionalProperties": false, "properties": {"additio...
execution-environment.json
dependencies
Allows adding system, python or galaxy dependencies.
{"properties": {"galaxy": {"examples": ["requirements.yml"], "type": "string"}, "python": {"examples": ["requirements.txt"], "type": "string"}, "system": {"examples": ["bindep.txt"], "type": "string"}}, "type": "object"}
execution-environment.json
additional_build_files
Describes files to add to the build context
{"items": {"additionalProperties": false, "properties": {"dest": {"type": "string"}, "src": {"type": "string"}}, "required": ["src", "dest"], "type": "object"}, "type": "array"}
execution-environment.json
dest
Relative subdirectory under build context to place file
{"type": "string"}
execution-environment.json
src
File to add to build context
{"type": "string"}
execution-environment.json
dependencies
Allows adding system, python or galaxy dependencies.
{"properties": {"ansible_core": {"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}, "ansible_runner": {"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "...
execution-environment.json
ansible_core
Ansible package installation
{"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}
execution-environment.json
package_pip
Ansible package to install via pip
{"type": "string"}
execution-environment.json
ansible_runner
Ansible Runner package installation
{"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}
execution-environment.json
package_pip
Ansible Runner package to install via pip
{"type": "string"}
execution-environment.json
python_interpreter
Python package name and path
{"additionalProperties": false, "properties": {"package_system": {"type": "string"}, "python_path": {"type": "string"}}, "type": "object"}
execution-environment.json
package_system
The python package to install via system package manager
{"type": "string"}
execution-environment.json
python_path
Path to the python interpreter
{"type": "string"}
execution-environment.json
options
Options that effect runtime behavior
{"additionalProperties": false, "properties": {"container_init": {"additionalProperties": false, "properties": {"cmd": {"type": "string"}, "entrypoint": {"type": "string"}, "package_pip": {"type": "string"}}, "type": "object"}, "package_manager_path": {"type": "string"}, "relax_passwd_permissions": {"type": "boolean"},...
execution-environment.json
container_init
Customize container startup behavior
{"additionalProperties": false, "properties": {"cmd": {"type": "string"}, "entrypoint": {"type": "string"}, "package_pip": {"type": "string"}}, "type": "object"}
execution-environment.json
cmd
literal value for CMD Containerfile directive
{"type": "string"}
execution-environment.json
entrypoint
literal value for ENTRYPOINT Containerfile directive
{"type": "string"}
execution-environment.json
package_pip
package to install via pip for entrypoint support
{"type": "string"}
execution-environment.json
package_manager_path
Path to the system package manager to use
{"type": "string"}
execution-environment.json
relax_passwd_permissions
allows GID0 write access to /etc/passwd; currently necessary for many uses
{"type": "boolean"}
execution-environment.json
skip_ansible_check
Disables the check for Ansible/Runner in final image
{"type": "boolean"}
execution-environment.json
user
Sets the username or UID
{"type": "string"}
execution-environment.json
workdir
Default working directory, also often the homedir for ephemeral UIDs
{"type": ["string", "null"]}
devfile.json
Devfile describes the structure of a cloud-native devworkspace and development environment.
{"type": "object", "required": ["schemaVersion"], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "commands": {"type": "array", "items": {"type": "object", "required": ["id"], "oneOf": [{"required": ["exec"]}, {"required": ["apply"]}, {"required": ["composite"]}], "properties": {"apply": ...
devfile.json
attributes
Map of implementation-dependant free-form YAML attributes.
{"type": "object", "additionalProperties": true}
devfile.json
commands
Predefined, ready-to-use, devworkspace-related commands
{"type": "array", "items": {"type": "object", "required": ["id"], "oneOf": [{"required": ["exec"]}, {"required": ["apply"]}, {"required": ["composite"]}], "properties": {"apply": {"type": "object", "required": ["component"], "properties": {"component": {"type": "string"}, "group": {"type": "object", "required": ["kind"...
devfile.json
apply
Command that consists in applying a given component definition, typically bound to a devworkspace event. For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its ...
{"type": "object", "required": ["component"], "properties": {"component": {"type": "string"}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"ty...
devfile.json
component
Describes component that will be applied
{"type": "string"}
devfile.json
group
Defines the group this command is part of
{"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}
devfile.json
isDefault
Identifies the default command for a given group kind
{"type": "boolean"}
devfile.json
kind
Kind of group the command is part of
{"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}
devfile.json
label
Optional label that provides a label for this command to be used in Editor UI menus for example
{"type": "string"}
devfile.json
attributes
Map of implementation-dependant free-form YAML attributes.
{"type": "object", "additionalProperties": true}
devfile.json
composite
Composite command that allows executing several sub-commands either sequentially or concurrently
{"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"ty...
devfile.json
commands
The commands that comprise this composite command
{"type": "array", "items": {"type": "string"}}
devfile.json
group
Defines the group this command is part of
{"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}
devfile.json
isDefault
Identifies the default command for a given group kind
{"type": "boolean"}
devfile.json
kind
Kind of group the command is part of
{"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}
devfile.json
label
Optional label that provides a label for this command to be used in Editor UI menus for example
{"type": "string"}
devfile.json
parallel
Indicates if the sub-commands should be executed concurrently
{"type": "boolean"}
devfile.json
exec
CLI Command executed in an existing component container
{"type": "object", "required": ["commandLine", "component"], "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperti...
devfile.json
commandLine
The actual command-line string Special variables that can be used: - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the...
{"type": "string"}
devfile.json
component
Describes component to which given action relates
{"type": "string"}
devfile.json
env
Optional list of environment variables that have to be set before running the command
{"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}
devfile.json
group
Defines the group this command is part of
{"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}
devfile.json
isDefault
Identifies the default command for a given group kind
{"type": "boolean"}
devfile.json
kind
Kind of group the command is part of
{"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}
devfile.json
hotReloadCapable
Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own. Default value is `false`
{"type": "boolean"}
devfile.json
label
Optional label that provides a label for this command to be used in Editor UI menus for example
{"type": "string"}
devfile.json
workingDir
Working directory where the command should be executed Special variables that can be used: - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects...
{"type": "string"}
devfile.json
id
Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.
{"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}
devfile.json
components
List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components
{"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["container"]}, {"required": ["kubernetes"]}, {"required": ["openshift"]}, {"required": ["volume"]}, {"required": ["image"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "container": {"type": "...
devfile.json
attributes
Map of implementation-dependant free-form YAML attributes.
{"type": "object", "additionalProperties": true}
devfile.json
container
Allows adding and configuring devworkspace-related containers
{"type": "object", "required": ["image"], "properties": {"annotation": {"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "args": {"type": "array", "it...
devfile.json
annotation
Annotations that should be added to specific resources for this container
{"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}
devfile.json
deployment
Annotations to be added to deployment
{"type": "object", "additionalProperties": {"type": "string"}}
devfile.json
service
Annotations to be added to service
{"type": "object", "additionalProperties": {"type": "string"}}