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
minecraft-biome.json
downfall
A grass and foliage color for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0, "maximum": 1}
minecraft-biome.json
creature_spawn_friendly
Spawns passive mobs as long as random value is less than this https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0, "maximum": 1}
minecraft-biome.json
effects
Effect options for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"fog_color": {"type": "integer"}, "foliage_color": {"type": "integer"}, "grass_color": {"type": "integer"}, "sky_color": {"type": "integer"}, "water_color": {"type": "integer"}, "water_fog_color": {"type": "integer"}, "grass_color_modifier": {"type": "string", "enum": ["none", "dark_forest", "swamp"], "default": "none"}, "particle": {"type": "object", "properties": {"probability": {"type": "number", "minimum": 0, "maximum": 1}, "options": {"type": "object", "properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}}, "allOf": [{"if": {"properties": {"type": {"const": "item"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "id": {"type": "string", "minLength": 1}, "Count": {"type": "integer", "minimum": 0}, "tag": {"type": "string", "minLength": 1}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "dust"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "color": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "scale": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "dust_color_transition"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "fromColor": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "toColor": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "scale": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "sculk_charge"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "roll": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "vibration"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "destination": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}}, "allOf": [{"if": {"properties": {"type": {"const": "block"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "pos": {"type": "array", "items": {"type": "integer"}, "minItems": 3, "maxItems": 3}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "entity"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "source_entity": {"type": "array", "items": {"type": "integer"}, "minItems": 4, "maxItems": 4}}, "additionalProperties": false}}]}, "arrival_in_ticks": {"type": "integer", "minimum": 0}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "shriek"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "delay": {"type": "integer"}}, "additionalProperties": false}}]}}, "additionalProperties": false}, "ambient_sound": {"type": "string"}, "mood_sound": {"type": "object", "properties": {"sound": {"type": "string"}, "tick_delay": {"type": "integer"}, "block_search_context": {"type": "integer"}, "offset": {"type": "integer"}}}, "additions_sound": {"type": "object", "properties": {"sound": {"type": "string"}, "tick_chance": {"type": "integer"}}}, "music": {"type": "object", "properties": {"sound": {"type": "string"}, "min_delay": {"type": "integer"}, "max_delay": {"type": "integer"}, "replace_current_music": {"type": "boolean"}}}}, "additionalProperties": false}
minecraft-biome.json
fog_color
A fog color https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
foliage_color
Decimal value converted from Hex color to use for tree leaves and vines. If not present, the value depends on humidity and temperature https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
grass_color
A grass color https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
sky_color
A sky color https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
water_color
A water color https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
water_fog_color
Decimal value converted from Hex color to use for fog https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
grass_color_modifier
A grass color modifier https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "enum": ["none", "dark_forest", "swamp"], "default": "none"}
minecraft-biome.json
particle
Particle options for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"probability": {"type": "number", "minimum": 0, "maximum": 1}, "options": {"type": "object", "properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}}, "allOf": [{"if": {"properties": {"type": {"const": "item"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "id": {"type": "string", "minLength": 1}, "Count": {"type": "integer", "minimum": 0}, "tag": {"type": "string", "minLength": 1}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "dust"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "color": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "scale": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "dust_color_transition"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "fromColor": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "toColor": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "scale": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "sculk_charge"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "roll": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "vibration"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "destination": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}}, "allOf": [{"if": {"properties": {"type": {"const": "block"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "pos": {"type": "array", "items": {"type": "integer"}, "minItems": 3, "maxItems": 3}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "entity"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "source_entity": {"type": "array", "items": {"type": "integer"}, "minItems": 4, "maxItems": 4}}, "additionalProperties": false}}]}, "arrival_in_ticks": {"type": "integer", "minimum": 0}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "shriek"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "delay": {"type": "integer"}}, "additionalProperties": false}}]}}, "additionalProperties": false}
minecraft-biome.json
probability
A particle spawning frequency for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0, "maximum": 1}
minecraft-biome.json
options
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}}, "allOf": [{"if": {"properties": {"type": {"const": "item"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "id": {"type": "string", "minLength": 1}, "Count": {"type": "integer", "minimum": 0}, "tag": {"type": "string", "minLength": 1}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "dust"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "color": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "scale": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "dust_color_transition"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "fromColor": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "toColor": {"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}, "scale": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "sculk_charge"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "roll": {"type": "number"}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "vibration"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "destination": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}}, "allOf": [{"if": {"properties": {"type": {"const": "block"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "pos": {"type": "array", "items": {"type": "integer"}, "minItems": 3, "maxItems": 3}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "entity"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "source_entity": {"type": "array", "items": {"type": "integer"}, "minItems": 4, "maxItems": 4}}, "additionalProperties": false}}]}, "arrival_in_ticks": {"type": "integer", "minimum": 0}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "shriek"}}}, "then": {"properties": {"type": {"type": "string"}, "value": {"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}, "delay": {"type": "integer"}}, "additionalProperties": false}}]}
minecraft-biome.json
type
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
value
A particle state for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}
minecraft-biome.json
Name
A particle identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
additionalProperties
Particle properties for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
type
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
value
A particle state for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}
minecraft-biome.json
Name
A particle identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
additionalProperties
Particle properties for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
id
A particle namespaced identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
Count
A particle amount for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer", "minimum": 0}
minecraft-biome.json
tag
A particle NBT data for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
type
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
value
A particle state for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}
minecraft-biome.json
Name
A particle identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
additionalProperties
Particle properties for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
color
A dust color for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}
minecraft-biome.json
items
A dust color component for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0, "maximum": 1}
minecraft-biome.json
scale
A paricle size for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number"}
minecraft-biome.json
type
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
value
A particle state for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}
minecraft-biome.json
Name
A particle identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
additionalProperties
Particle properties for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
fromColor
A start dust color for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}
minecraft-biome.json
items
A dust color component for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0, "maximum": 1}
minecraft-biome.json
toColor
An end dust color for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "items": {"type": "number", "minimum": 0, "maximum": 1}, "minItems": 3, "maxItems": 3}
minecraft-biome.json
items
A dust color component for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0, "maximum": 1}
minecraft-biome.json
scale
A paricle size for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number"}
minecraft-biome.json
type
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
value
A particle state for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}
minecraft-biome.json
Name
A particle identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
additionalProperties
Particle properties for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
roll
A particle angle in radians for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number"}
minecraft-biome.json
type
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
value
A particle state for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}
minecraft-biome.json
Name
A particle identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
additionalProperties
Particle properties for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
destination
A particle angle in radians for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}}, "allOf": [{"if": {"properties": {"type": {"const": "block"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "pos": {"type": "array", "items": {"type": "integer"}, "minItems": 3, "maxItems": 3}}, "additionalProperties": false}}, {"if": {"properties": {"type": {"const": "entity"}}}, "then": {"properties": {"type": {}, "y_offset": {"type": "number", "default": 0}, "source_entity": {"type": "array", "items": {"type": "integer"}, "minItems": 4, "maxItems": 4}}, "additionalProperties": false}}]}
minecraft-biome.json
type
A namespaced identifier of the position source type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
y_offset
An offset from entity's feet for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "default": 0}
minecraft-biome.json
type
A namespaced identifier of the position source type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
y_offset
An offset from entity's feet for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "default": 0}
minecraft-biome.json
pos
A block position for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "items": {"type": "integer"}, "minItems": 3, "maxItems": 3}
minecraft-biome.json
items
A position component for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
type
A namespaced identifier of the position source type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
y_offset
An offset from entity's feet for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "default": 0}
minecraft-biome.json
source_entity
A block position for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "items": {"type": "integer"}, "minItems": 4, "maxItems": 4}
minecraft-biome.json
items
A position component for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
arrival_in_ticks
A particle move duration for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer", "minimum": 0}
minecraft-biome.json
type
A particle type for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
value
A particle state for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"Name": {"type": "string", "minLength": 1}}, "additionalProperties": {}}
minecraft-biome.json
Name
A particle identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
additionalProperties
Particle properties for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{}
minecraft-biome.json
delay
A particle delay in ticks for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
ambient_sound
Sound event to use for ambient sound https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
mood_sound
Settings for mood sound https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"sound": {"type": "string"}, "tick_delay": {"type": "integer"}, "block_search_context": {"type": "integer"}, "offset": {"type": "integer"}}}
minecraft-biome.json
sound
Sound event to use https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
block_search_context
Determines the cubic range of possible positions to play the mood sound. The player is at the center of the cubic range, and the edge length is 2 * block_search_extent + 1 https://minecraft.fandom.com/wiki/Custom_biome
{"type": "integer"}
minecraft-biome.json
additions_sound
Settings for additions sound https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"sound": {"type": "string"}, "tick_chance": {"type": "integer"}}}
minecraft-biome.json
sound
Sound event to use https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
music
Specific music that should be played in the biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"sound": {"type": "string"}, "min_delay": {"type": "integer"}, "max_delay": {"type": "integer"}, "replace_current_music": {"type": "boolean"}}}
minecraft-biome.json
sound
Sound event to use https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
replace_current_music
Whether or not to replace music which is already playing https://minecraft.fandom.com/wiki/Custom_biome
{"type": "boolean"}
minecraft-biome.json
surface_builder
The namespaced id of the configured surface builder to use https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
carvers
Carvers to use for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"air": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}, "liquid": {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}}, "additionalProperties": false}
minecraft-biome.json
air
Carvers used during air generation step for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}
minecraft-biome.json
items
A namespaced id of a configured carver for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
liquid
Carvers used during liquid generation step for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}
minecraft-biome.json
items
A namespaced id of a configured carver for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string", "minLength": 1}
minecraft-biome.json
features
Features for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "uniqueItems": true, "items": {"type": ["string", "array"]}}
minecraft-biome.json
items
A feature for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": ["string", "array"]}
minecraft-biome.json
creature_spawn_probability
A creature spawn probability for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0, "exclusiveMaximum": 1}
minecraft-biome.json
starts
The structures to generate in this biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "array", "items": {"type": "string"}}
minecraft-biome.json
items
The namespaced ID of a configured structure feature https://minecraft.fandom.com/wiki/Custom_biome
{"type": "string"}
minecraft-biome.json
spawners
Entity spawning options for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"monster": {}, "creature": {}, "ambient": {}, "water_creature": {}, "underground_water_creature": {}, "water_ambient": {}, "misc": {}, "axolotls": {}}, "additionalProperties": false}
minecraft-biome.json
spawn_costs
Entity identifiers for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "additionalProperties": {"type": "object", "properties": {"energy_budget": {"type": "number", "minimum": 0}, "charge": {"type": "number", "minimum": 0}}, "additionalProperties": false}}
minecraft-biome.json
additionalProperties
A namespaced entity identifier for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "object", "properties": {"energy_budget": {"type": "number", "minimum": 0}, "charge": {"type": "number", "minimum": 0}}, "additionalProperties": false}
minecraft-biome.json
energy_budget
A new mob maximum potential for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0}
minecraft-biome.json
charge
A new mob charge for the current biome https://minecraft.fandom.com/wiki/Custom_biome
{"type": "number", "minimum": 0}
flow.schema.json
Each catalog source defines a portion of a Flow Catalog, by defining collections, derivations, tests, and materializations of the Catalog. Catalog sources may reference and import other sources, in order to collections and other entities that source defines.
{"$schema": "https://json-schema.org/draft/2019-09/schema", "type": "object", "properties": {"$schema": {"type": "string"}, "captures": {"examples": [{"acmeCo/capture": {"autoDiscover": {"addNewBindings": true, "evolveIncompatibleCollections": true}, "bindings": [{"resource": {"stream": "a_stream"}, "target": "target/collection"}], "endpoint": {"connector": {"config": "connector-config.yaml", "image": "connector/image:tag"}}}}], "type": "object", "patternProperties": {"^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$": {}}, "additionalProperties": false}, "collections": {"examples": [{"acmeCo/collection": {"key": ["/json/ptr"], "schema": {"properties": {"bar": {"const": 42}, "foo": {"type": "integer"}}, "type": "object"}}}], "type": "object", "patternProperties": {"^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$": {}}, "additionalProperties": false}, "import": {"type": "array", "items": {}}, "materializations": {"examples": [{"acmeCo/materialization": {"bindings": [{"fields": {"recommended": true}, "resource": {"table": "a_table"}, "source": "source/collection"}], "endpoint": {"connector": {"config": "connector-config.yaml", "image": "connector/image:tag"}}}}], "type": "object", "patternProperties": {"^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$": {}}, "additionalProperties": false}, "tests": {"examples": [{"acmeCo/conversions/test": [{"ingest": {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}}, {"verify": {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}}]}], "type": "object", "patternProperties": {"^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$": {"type": "array", "items": {}}}, "additionalProperties": false}}, "additionalProperties": false, "definitions": {"AutoDiscover": {"type": "object", "properties": {"addNewBindings": {"default": false, "type": "boolean"}, "evolveIncompatibleCollections": {"default": false, "type": "boolean"}}, "additionalProperties": false}, "Capture": {"examples": ["acmeCo/capture"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"}, "CaptureBinding": {"examples": [{"resource": {"stream": "a_stream"}, "target": "target/collection"}], "type": "object", "required": ["resource", "target"], "properties": {"disable": {"type": "boolean"}, "resource": {}, "target": {}}, "additionalProperties": false}, "CaptureDef": {"type": "object", "required": ["bindings", "endpoint"], "properties": {"autoDiscover": {}, "bindings": {"type": "array", "items": {}}, "endpoint": {}, "interval": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "shards": {}}, "additionalProperties": false}, "CaptureEndpoint": {"oneOf": [{"type": "object", "required": ["connector"], "properties": {"connector": {}}, "additionalProperties": false}]}, "Collection": {"examples": ["acmeCo/collection"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"}, "CollectionDef": {"examples": [{"key": ["/json/ptr"], "schema": {"properties": {"bar": {"const": 42}, "foo": {"type": "integer"}}, "type": "object"}}], "type": "object", "oneOf": [{"required": ["schema"], "properties": {"readSchema": false, "writeSchema": false}}, {"required": ["readSchema", "writeSchema"], "properties": {"schema": false}}], "required": ["key"], "properties": {"derive": {}, "journals": {}, "key": {}, "projections": {"examples": [{"a_field": "/json/ptr", "a_partition": {"location": "/json/ptr", "partition": true}}], "type": "object", "patternProperties": {"^([^/~]|(~[01]))+(/([^/~]|(~[01]))+)*$": {}}, "additionalProperties": false}, "readSchema": {}, "schema": {"examples": ["../path/to/schema#/$defs/subPath"]}, "writeSchema": {}}, "additionalProperties": false}, "CompositeKey": {"examples": [["/json/ptr"]], "type": "array", "items": {}}, "CompressionCodec": {"examples": ["GZIP_OFFLOAD_DECOMPRESSION"], "type": "string", "enum": ["NONE", "GZIP", "ZSTANDARD", "SNAPPY", "GZIP_OFFLOAD_DECOMPRESSION"]}, "ConnectorConfig": {"type": "object", "required": ["config", "image"], "properties": {"config": {}, "image": {"type": "string"}}}, "Derivation": {"type": "object", "required": ["transforms", "using"], "properties": {"shards": {}, "shuffleKeyTypes": {"type": "array", "items": {}}, "transforms": {"type": "array", "items": {}}, "using": {}}, "additionalProperties": false}, "DeriveUsing": {"oneOf": [{"type": "object", "required": ["connector"], "properties": {"connector": {}}, "additionalProperties": false}, {"type": "object", "required": ["sqlite"], "properties": {"sqlite": {}}, "additionalProperties": false}, {"type": "object", "required": ["typescript"], "properties": {"typescript": {}}, "additionalProperties": false}]}, "DeriveUsingSqlite": {"type": "object", "properties": {"migrations": {"type": "array", "items": {"oneOf": [{"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"}, {"type": "string", "contentMediaType": "text/x.sql"}]}}}, "additionalProperties": false}, "DeriveUsingTypescript": {"type": "object", "required": ["module"], "properties": {"module": {"oneOf": [{"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"}, {"type": "string", "contentMediaType": "text/x.typescript"}]}}, "additionalProperties": false}, "Field": {"examples": ["my_field"], "type": "string", "pattern": "^([^/~]|(~[01]))+(/([^/~]|(~[01]))+)*$"}, "FragmentTemplate": {"examples": [{"compressionCodec": "ZSTANDARD", "flushInterval": "1h"}], "type": "object", "properties": {"compressionCodec": {}, "flushInterval": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "length": {"type": "integer", "format": "uint32", "maximum": 4096.0, "minimum": 32.0}, "retention": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}}, "additionalProperties": false}, "FullSource": {"examples": [{"name": "source/collection"}], "type": "object", "required": ["name"], "properties": {"name": {}, "notAfter": {"type": ["string", "null"], "format": "date-time"}, "notBefore": {"type": ["string", "null"], "format": "date-time"}, "partitions": {"examples": [{"exclude": {"other_partition": [32, 64]}, "include": {"a_partition": ["A", "B"]}}]}}, "additionalProperties": false}, "JournalTemplate": {"examples": [{"fragments": {"compressionCodec": "ZSTANDARD", "flushInterval": "1h"}}], "type": "object", "required": ["fragments"], "properties": {"fragments": {}}, "additionalProperties": false}, "JsonPointer": {"examples": ["/json/ptr"], "type": "string", "pattern": "^(/([^/~]|(~[01]))+)*$"}, "Materialization": {"examples": ["acmeCo/materialization"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"}, "MaterializationBinding": {"examples": [{"fields": {"recommended": true}, "resource": {"table": "a_table"}, "source": "source/collection"}], "type": "object", "required": ["resource", "source"], "properties": {"disable": {"type": "boolean"}, "fields": {"default": {"recommended": true}}, "priority": {"type": "integer", "format": "uint32", "minimum": 0.0}, "resource": {}, "source": {}}, "additionalProperties": false}, "MaterializationDef": {"type": "object", "required": ["bindings", "endpoint"], "properties": {"bindings": {"type": "array", "items": {}}, "endpoint": {}, "shards": {}, "sourceCapture": {}}, "additionalProperties": false}, "MaterializationEndpoint": {"oneOf": [{"type": "object", "required": ["connector"], "properties": {"connector": {}}, "additionalProperties": false}]}, "MaterializationFields": {"examples": [{"exclude": ["removed"], "include": {"added": {}}, "recommended": true}], "type": "object", "required": ["recommended"], "properties": {"exclude": {"type": "array", "items": {}}, "include": {"type": "object", "additionalProperties": true}, "recommended": {"type": "boolean"}}, "additionalProperties": false}, "PartitionSelector": {"examples": [{"exclude": {"other_partition": [32, 64]}, "include": {"a_partition": ["A", "B"]}}], "type": "object", "properties": {"exclude": {"default": {}, "type": "object", "additionalProperties": {"type": "array", "items": true}}, "include": {"default": {}, "type": "object", "additionalProperties": {"type": "array", "items": true}}}, "additionalProperties": false}, "Projection": {"anyOf": [{}, {"type": "object", "required": ["location"], "properties": {"location": {}, "partition": {"default": false, "type": "boolean"}}, "additionalProperties": false}]}, "RelativeUrl": {"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"}, "Schema": {"examples": ["http://example/schema#/$defs/subPath", "../path/to/schema#/$defs/subPath", {"properties": {"bar": {"const": 42}, "foo": {"type": "integer"}}, "type": "object"}]}, "ShardTemplate": {"examples": [{"hotStandbys": 1, "maxTxnDuration": "30s"}], "type": "object", "properties": {"disable": {"type": "boolean"}, "hotStandbys": {"type": "integer", "format": "uint32", "minimum": 0.0}, "logLevel": {"type": "string"}, "maxTxnDuration": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "minTxnDuration": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "readChannelSize": {"type": "integer", "format": "uint32", "minimum": 0.0}, "ringBufferSize": {"type": "integer", "format": "uint32", "minimum": 0.0}}, "additionalProperties": false}, "Shuffle": {"examples": [{"key": ["/json/ptr"]}], "oneOf": [{"type": "string", "enum": ["any"]}, {"type": "object", "required": ["key"], "properties": {"key": {}}, "additionalProperties": false}, {"type": "object", "required": ["lambda"], "properties": {"lambda": true}, "additionalProperties": false}]}, "ShuffleType": {"type": "string", "enum": ["boolean", "integer", "string"]}, "Source": {"examples": ["source/collection"], "anyOf": [{}, {}]}, "Test": {"examples": ["acmeCo/conversions/test"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"}, "TestDocuments": {"examples": ["../path/to/test-documents.json", [{"a": "document"}, {"another": "document"}]]}, "TestStep": {"examples": [{"ingest": {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}}, {"verify": {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}}], "oneOf": [{"type": "object", "required": ["ingest"], "properties": {"ingest": {}}, "additionalProperties": false}, {"type": "object", "required": ["verify"], "properties": {"verify": {}}, "additionalProperties": false}]}, "TestStepIngest": {"examples": [{"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}], "type": "object", "required": ["collection", "documents"], "properties": {"collection": {}, "documents": {}}, "additionalProperties": false}, "TestStepVerify": {"examples": [{"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}], "type": "object", "required": ["collection", "documents"], "properties": {"collection": {}, "documents": {}}, "additionalProperties": false}, "Transform": {"examples": ["myTransform"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+$"}, "TransformDef": {"examples": [{"name": "my-transform", "shuffle": "any", "source": "some/source/collection"}], "type": "object", "required": ["name", "shuffle", "source"], "properties": {"disable": {"type": "boolean"}, "lambda": {}, "name": {}, "priority": {"type": "integer", "format": "uint32", "minimum": 0.0}, "readDelay": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "shuffle": {}, "source": {}}, "additionalProperties": false}}}
flow.schema.json
import
By importing another Flow catalog source, its collections, schemas, and derivations are bundled into the publication context of this specification. Imports are relative or absolute URLs, relative to this specification's location.
{"type": "array", "items": {}}
flow.schema.json
ingest
Description of the ingestion.
{"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}
flow.schema.json
verify
Description of the verification.
{"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}
flow.schema.json
AutoDiscover
Settings to determine how Flow should stay abreast of ongoing changes to collections and schemas.
{"type": "object", "properties": {"addNewBindings": {"default": false, "type": "boolean"}, "evolveIncompatibleCollections": {"default": false, "type": "boolean"}}, "additionalProperties": false}
flow.schema.json
addNewBindings
Automatically add new bindings discovered from the source.
{"default": false, "type": "boolean"}
flow.schema.json
evolveIncompatibleCollections
Whether to automatically evolve collections and/or materialization bindings to handle changes to collections that would otherwise be incompatible with the existing catalog.
{"default": false, "type": "boolean"}
flow.schema.json
Capture
Capture names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'.
{"examples": ["acmeCo/capture"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"}
flow.schema.json
disable
Disabled bindings are inactive, and not validated. They can be used to represent discovered resources that are intentionally not being captured.
{"type": "boolean"}