schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
component_spec.json_schema.json
ComponentReference
Component reference. Contains information that can be used to locate and load a component by name, digest or URL
{"type": "object", "properties": {"name": {"type": "string"}, "digest": {"type": "string"}, "tag": {"type": "string"}, "url": {"type": "string"}, "spec": {}}, "additionalProperties": false}
component_spec.json_schema.json
GraphInputArgument
Represents the component argument value that comes from the graph component input.
{"type": "object", "required": ["graphInput"], "properties": {"graphInput": {"type": "object", "required": ["inputName"], "properties": {"inputName": {"type": "string"}, "type": {}}, "additionalProperties": false}}, "additionalProperties": false}
component_spec.json_schema.json
graphInput
References the input of the graph/pipeline.
{"type": "object", "required": ["inputName"], "properties": {"inputName": {"type": "string"}, "type": {}}, "additionalProperties": false}
component_spec.json_schema.json
TaskOutputArgument
Represents the component argument value that comes from the output of a sibling task.
{"type": "object", "required": ["taskOutput"], "properties": {"taskOutput": {"type": "object", "required": ["taskId", "outputName"], "properties": {"taskId": {"type": "string"}, "outputName": {"type": "string"}, "type": {}}, "additionalProperties": false}}, "additionalProperties": false}
component_spec.json_schema.json
taskOutput
References the output of a sibling task.
{"type": "object", "required": ["taskId", "outputName"], "properties": {"taskId": {"type": "string"}, "outputName": {"type": "string"}, "type": {}}, "additionalProperties": false}
component_spec.json_schema.json
TwoArgumentOperands
Pair of operands for a binary operation.
{"type": "object", "required": ["op1", "op2"], "properties": {"op1": {}, "op2": {}}, "additionalProperties": false}
component_spec.json_schema.json
TwoLogicalOperands
Pair of operands for a binary logical operation.
{"type": "object", "required": ["op1", "op2"], "properties": {"op1": {}, "op2": {}}, "additionalProperties": false}
component_spec.json_schema.json
RetryStrategySpec
Optional configuration that specifies how the task should be retried if it fails.
{"type": "object", "properties": {"maxRetries": {"type": "integer"}}, "additionalProperties": false}
component_spec.json_schema.json
CachingStrategySpec
Optional configuration that specifies how the task execution may be skipped if the output data exist in cache.
{"type": "object", "properties": {"maxCacheStaleness": {"type": "string", "format": "duration"}}, "additionalProperties": false}
component_spec.json_schema.json
ExecutionOptionsSpec
Optional configuration that specifies how the task should be executed. Can be used to set some platform-specific options.
{"type": "object", "properties": {"retryStrategy": {}, "cachingStrategy": {}}, "additionalProperties": false}
component_spec.json_schema.json
TaskSpec
'Task specification. Task is a configured component - a component supplied with arguments and other applied configuration changes.
{"type": "object", "required": ["componentRef"], "properties": {"componentRef": {}, "arguments": {"type": "object", "additionalProperties": {}}, "isEnabled": {}, "executionOptions": {}, "annotations": {"type": "object"}}, "additionalProperties": false}
component_spec.json_schema.json
GraphSpec
Describes the graph component implementation. It represents a graph of component tasks connected to the upstream sources of data using the argument specifications. It also describes the sources of graph output values.
{"type": "object", "required": ["tasks"], "properties": {"tasks": {"type": "object", "additionalProperties": {}}, "outputValues": {"type": "object", "additionalProperties": {}}}, "additionalProperties": false}
component_spec.json_schema.json
GraphImplementation
Represents the graph component implementation.
{"type": "object", "required": ["graph"], "properties": {"graph": {}}, "additionalProperties": false}
component_spec.json_schema.json
PipelineRunSpec
The object that can be sent to the backend to start a new Run.
{"type": "object", "required": ["rootTask"], "properties": {"rootTask": {}, "onExitTask": {}}, "additionalProperties": false}
minecraft-advancement.json
A data pack advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"jsonTextComponent": {"type": ["string", "boolean", "number", "array", "object"], "properties": {"extra": {"type": "array", "items": {}}, "color": {"type": "string", "anyOf": [{"enum": ["black", "dark_blue", "dark_green", "dark_aqua", "dark_red", "dark_purple", "gold", "gray", "dark_gray", "blue", "green", "aqua", "red", "light_purple", "yellow", "white", "reset"]}, {"pattern": "#[A-F\\d]{6}"}]}, "font": {"type": "string", "default": "minecraft:default"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}, "underlined": {"type": "boolean"}, "strikethrough": {"type": "boolean"}, "obfuscated": {"type": "boolean"}, "insertion": {"type": "string"}, "clickEvent": {"type": "object", "properties": {"action": {"type": "string", "enum": ["open_url", "open_file", "run_command", "suggest_command", "change_page", "copy_to_clipboard"]}, "value": {"type": "string"}}}, "hoverEvent": {"type": "object", "properties": {"action": {"type": "string", "enum": ["show_text", "show_item", "show_entity"]}, "value": {"type": "string"}, "contents": {"type": "object"}}}, "text": {"type": ["string", "number", "boolean"]}, "translate": {"type": "string"}, "with": {"type": "array", "items": {}}}}}, "properties": {"display": {"type": "object", "properties": {"icon": {"type": "object", "properties": {"item": {"type": "string", "minLength": 1}, "nbt": {"type": "string", "minLength": 1}}}, "frame": {"type": "string", "enum": ["challenge", "goal", "task"], "default": "task"}, "background": {}, "show_toast": {"type": "boolean", "default": true}, "annouce_to_chat": {"type": "boolean", "default": true}, "hidden": {"type": "boolean", "default": false}}}, "parent": {}, "criteria": {"type": "object", "additionalProperties": {"type": "object", "properties": {"trigger": {"type": "string"}, "conditions": {"type": "object", "properties": {"player": {"type": ["array", "object"]}}}}}}, "requirements": {"type": "array", "uniqueItems": true, "items": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}}, "rewards": {"type": "object", "properties": {"recipes": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}, "loot": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}, "experience": {"type": "integer", "minimum": 0}, "function": {"type": "string", "minLength": 1}}, "additionalProperties": false}}, "type": "object"}
minecraft-advancement.json
extra
A list of additional raw JSON text components to be displayed after this one.
{"type": "array", "items": {}}
minecraft-advancement.json
items
A child text component. Child text components inherit all formatting and interactivity from the parent component, unless they explicitly override them.
{}
minecraft-advancement.json
color
The color to render the content in.
{"type": "string", "anyOf": [{"enum": ["black", "dark_blue", "dark_green", "dark_aqua", "dark_red", "dark_purple", "gold", "gray", "dark_gray", "blue", "green", "aqua", "red", "light_purple", "yellow", "white", "reset"]}, {"pattern": "#[A-F\\d]{6}"}]}
minecraft-advancement.json
font
The resource location of the font for this component in the resource pack within assets/<namespace>/font.
{"type": "string", "default": "minecraft:default"}
minecraft-advancement.json
bold
Whether to render the content in bold.
{"type": "boolean"}
minecraft-advancement.json
italic
Whether to render the content in italics. Note that text that is italicized by default, such as custom item names, can be unitalicized by setting this to false.
{"type": "boolean"}
minecraft-advancement.json
underlined
Whether to underline the content.
{"type": "boolean"}
minecraft-advancement.json
strikethrough
Whether to strikethrough the content.
{"type": "boolean"}
minecraft-advancement.json
obfuscated
Whether to render the content obfuscated.
{"type": "boolean"}
minecraft-advancement.json
insertion
When the text is shift-clicked by a player, this string is inserted in their chat input. It does not overwrite any existing text the player was writing. This only works in chat messages.
{"type": "string"}
minecraft-advancement.json
clickEvent
Allows for events to occur when the player clicks on text. Only work in chat messages and written books, unless specified otherwise.
{"type": "object", "properties": {"action": {"type": "string", "enum": ["open_url", "open_file", "run_command", "suggest_command", "change_page", "copy_to_clipboard"]}, "value": {"type": "string"}}}
minecraft-advancement.json
action
The action to perform when clicked.
{"type": "string", "enum": ["open_url", "open_file", "run_command", "suggest_command", "change_page", "copy_to_clipboard"]}
minecraft-advancement.json
value
The URL, file path, chat, command or book page used by the specified action.
{"type": "string"}
minecraft-advancement.json
hoverEvent
Allows for a tooltip to be displayed when the player hovers their mouse over text.
{"type": "object", "properties": {"action": {"type": "string", "enum": ["show_text", "show_item", "show_entity"]}, "value": {"type": "string"}, "contents": {"type": "object"}}}
minecraft-advancement.json
action
The type of tooltip to show.
{"type": "string", "enum": ["show_text", "show_item", "show_entity"]}
minecraft-advancement.json
value
The formatting and type of this tag varies depending on the action.
{"type": "string"}
minecraft-advancement.json
contents
The formatting of this tag varies depending on the action.
{"type": "object"}
minecraft-advancement.json
text
A string containing plain text to display directly. Can also be a number or boolean that is displayed directly.
{"type": ["string", "number", "boolean"]}
minecraft-advancement.json
translate
A translation identifier, corresponding to the identifiers found in loaded language files. Displayed as the corresponding text in the player's selected language. If no corresponding translation can be found, the identifier itself is used as the translated text.
{"type": "string"}
minecraft-advancement.json
with
A list of raw JSON text components to be inserted into slots in the translation text.
{"type": "array", "items": {}}
minecraft-advancement.json
items
A raw JSON text component. If no component is provided for a slot, the slot is displayed as no text.
{}
minecraft-advancement.json
display
Display options for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "object", "properties": {"icon": {"type": "object", "properties": {"item": {"type": "string", "minLength": 1}, "nbt": {"type": "string", "minLength": 1}}}, "frame": {"type": "string", "enum": ["challenge", "goal", "task"], "default": "task"}, "background": {}, "show_toast": {"type": "boolean", "default": true}, "annouce_to_chat": {"type": "boolean", "default": true}, "hidden": {"type": "boolean", "default": false}}}
minecraft-advancement.json
icon
Icon options for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "object", "properties": {"item": {"type": "string", "minLength": 1}, "nbt": {"type": "string", "minLength": 1}}}
minecraft-advancement.json
item
An item identifier for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "string", "minLength": 1}
minecraft-advancement.json
nbt
A named binary tag of an item for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "string", "minLength": 1}
minecraft-advancement.json
title
A title for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{}
minecraft-advancement.json
frame
A frame type for the icon for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "string", "enum": ["challenge", "goal", "task"], "default": "task"}
minecraft-advancement.json
background
A background directory for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{}
minecraft-advancement.json
description
A description for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{}
minecraft-advancement.json
show_toast
Whether or not to show the toast pop up after completing the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "boolean", "default": true}
minecraft-advancement.json
annouce_to_chat
Whether or not to announce in the chat when the current advancement has been completed https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "boolean", "default": true}
minecraft-advancement.json
hidden
Whether or not to hide this advancement and all its children from the advancement screen until the current advancement have been completed https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "boolean", "default": false}
minecraft-advancement.json
parent
A parent directory for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{}
minecraft-advancement.json
criteria
Required criterias have to be met for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "object", "additionalProperties": {"type": "object", "properties": {"trigger": {"type": "string"}, "conditions": {"type": "object", "properties": {"player": {"type": ["array", "object"]}}}}}}
minecraft-advancement.json
additionalProperties
Required criteria have to be met for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "object", "properties": {"trigger": {"type": "string"}, "conditions": {"type": "object", "properties": {"player": {"type": ["array", "object"]}}}}}
minecraft-advancement.json
trigger
A trigger for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria
{"type": "string"}
minecraft-advancement.json
conditions
Conditions need to be met when the trigger gets activated for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria
{"type": "object", "properties": {"player": {"type": ["array", "object"]}}}
minecraft-advancement.json
player
Check properties of the player for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria
{"type": ["array", "object"]}
minecraft-advancement.json
requirements
Requirements for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "array", "uniqueItems": true, "items": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}}
minecraft-advancement.json
items
Criterions for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}
minecraft-advancement.json
items
Criterion name for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "string", "minLength": 1}
minecraft-advancement.json
rewards
Rewards for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "object", "properties": {"recipes": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}, "loot": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}, "experience": {"type": "integer", "minimum": 0}, "function": {"type": "string", "minLength": 1}}, "additionalProperties": false}
minecraft-advancement.json
recipes
Recipes to unlock for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}
minecraft-advancement.json
items
A namespaced identifier for a recipe for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "string", "minLength": 1}
minecraft-advancement.json
loot
Loot tables to give to the player for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}
minecraft-advancement.json
items
A namespaced identifier for a loot table for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "string", "minLength": 1}
minecraft-advancement.json
experience
An experience amount for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "integer", "minimum": 0}
minecraft-advancement.json
function
A function to run for the current advancement https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend
{"type": "string", "minLength": 1}
cluster.yml.json
config_file
ConfigFile is a multiline string that represent a custom webhook config file
{"type": "string"}
cluster.yml.json
cache_timeout
CacheTimeout controls how long to cache authentication decisions
{"type": "string"}
cluster.yml.json
strategy
Authentication strategy that will be used in kubernetes cluster
{"type": "string"}
cluster.yml.json
sans
List of additional hostnames and IPs to include in the api server PKI cert
{"items": {"type": "string"}, "type": "array"}
cluster.yml.json
webhook
Webhook configuration options
{}
cluster.yml.json
mode
Authorization mode used by kubernetes
{"type": "string"}
cluster.yml.json
options
Authorization mode options
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.yml.json
cloud
The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13
{"type": "string"}
cluster.yml.json
tenantId
The AAD Tenant ID for the Subscription that the cluster is deployed in
{"type": "string"}
cluster.yml.json
subscriptionId
The ID of the Azure Subscription that the cluster is deployed in
{"type": "string"}
cluster.yml.json
resourceGroup
The name of the resource group that the cluster is deployed in
{"type": "string"}
cluster.yml.json
location
The location of the resource group that the cluster is deployed in
{"type": "string"}
cluster.yml.json
vnetName
The name of the VNet that the cluster is deployed in
{"type": "string"}
cluster.yml.json
vnetResourceGroup
The name of the resource group that the Vnet is deployed in
{"type": "string"}
cluster.yml.json
subnetName
The name of the subnet that the cluster is deployed in
{"type": "string"}
cluster.yml.json
securityGroupName
The name of the security group attached to the cluster's subnet
{"type": "string"}
cluster.yml.json
routeTableName
(Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in
{"type": "string"}
cluster.yml.json
primaryAvailabilitySetName
(Optional) The name of the availability set that should be used as the load balancer backend If this is set, the Azure cloudprovider will only add nodes from that availability set to the load balancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then the cloudprovider will try to add all nodes to a single backend pool which is forbidden. In other words, if you use multiple agent pools (availability sets), you MUST set this field.
{"type": "string"}
cluster.yml.json
vmType
The type of azure nodes. Candidate valudes are: vmss and standard. If not set, it will be default to standard.
{"type": "string"}
cluster.yml.json
primaryScaleSetName
The name of the scale set that should be used as the load balancer backend. If this is set, the Azure cloudprovider will only add nodes from that scale set to the load balancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then the cloudprovider will try to add all nodes to a single backend pool which is forbidden. In other words, if you use multiple agent pools (scale sets), you MUST set this field.
{"type": "string"}
cluster.yml.json
aadClientId
The ClientID for an AAD application with RBAC access to talk to Azure RM APIs This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md
{"type": "string"}
cluster.yml.json
aadClientSecret
The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md
{"type": "string"}
cluster.yml.json
aadClientCertPath
The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service
{"type": "string"}
cluster.yml.json
aadClientCertPassword
The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service
{"type": "string"}
cluster.yml.json
cloudProviderBackoff
Enable exponential backoff to manage resource request retries
{"type": "boolean"}
cluster.yml.json
cloudProviderBackoffRetries
Backoff retry limit
{"type": "integer"}
cluster.yml.json
cloudProviderBackoffExponent
Backoff exponent
{"type": "integer"}
cluster.yml.json
cloudProviderBackoffDuration
Backoff duration
{"type": "integer"}
cluster.yml.json
cloudProviderBackoffJitter
Backoff jitter
{"type": "integer"}
cluster.yml.json
cloudProviderRateLimit
Enable rate limiting
{"type": "boolean"}
cluster.yml.json
cloudProviderRateLimitQPS
Rate limit QPS
{"type": "integer"}
cluster.yml.json
cloudProviderRateLimitBucket
Rate limit Bucket Size
{"type": "integer"}
cluster.yml.json
useInstanceMetadata
Use instance metadata service where possible
{"type": "boolean"}
cluster.yml.json
useManagedIdentityExtension
Use managed service identity for the virtual machine to access Azure ARM APIs This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview For user-assigned managed identity, need to set the below UserAssignedIdentityID
{"type": "boolean"}
cluster.yml.json
userAssignedIdentityID
The Client ID of the user assigned MSI which is assigned to the underlying VMs This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview
{"type": "string"}
cluster.yml.json
maximumLoadBalancerRuleCount
Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148
{"type": "integer"}
cluster.yml.json
loadBalancerSku
Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`
{"type": "string"}