schema.blocks.put.json

{
    "$schema": "http://json-schema.org/draft-06/schema#",
    "type": "array",
    "items": {
        "$ref": "#/definitions/BlockPlacementInstructionElement"
    },
    "definitions": {
        "BlockPlacementInstructionElement": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "title": "Block ID",
                    "description": "Any namespaced block ID (https://minecraft.wiki/w/Java_Edition_data_values#Blocks)",
                    "examples": [
                        "minecraft:stone",
                        "minecraft:clay",
                        "minecraft:green_stained_glass"
                    ]
                },
                "x": {
                    "$ref": "#/definitions/PosAxis"
                },
                "y": {
                    "$ref": "#/definitions/PosAxis"
                },
                "z": {
                    "$ref": "#/definitions/PosAxis"
                },
                "state": {
                    "type": "object",
                    "title": "Block State",
                    "description": "Object containing block state (https://minecraft.wiki/w/Block_states) information",
                    "examples": [
                        {
                            "facing": "east",
                            "lit": "false"
                        }
                    ],
                    "default": null
                },
                "data": {
                    "type": "string",
                    "title": "Block Entity Data",
                    "description": "SNBT-formatted string (https://minecraft.wiki/w/NBT_format#SNBT_format) containing block entity data (https://minecraft.wiki/w/Chunk_format#Block_entity_format) information",
                    "examples": [
                        "{Items:[{Count:48b,Slot:0b,id:\"minecraft:lantern\"},{Count:1b,Slot:1b,id:\"minecraft:golden_axe\",tag:{Damage:0}}]}"
                    ],
                    "default": null
                }
            },
            "required": [
                "id"
            ],
            "title": "Block Placement Instruction Element"
        },
        "PosAxis": {
            "anyOf": [
                {
                    "type": "integer",
                    "description": "Any negative or positive whole number to represent absolute world coordinates",
                    "examples": [
                        -2,
                        781
                    ]
                },
                {
                    "type": "string",
                    "description": "Any negative or positive whole number to represent absolute world coordinates, a relative coordinate (https://minecraft.wiki/w/Coordinates#Relative_world_coordinates) or a local coordinate (https://minecraft.wiki/w/Coordinates#Local_coordinates)",
                    "examples": [
                        "-2",
                        "~84",
                        "^-412"
                    ]
                }
            ],
            "title": "Position Axis",
            "description": "Describe x/y/z placement position for block. If omitted, axis value defaults to the corresponding axis in the request URL. Each block position in the array of BlockPlacementInstructionElements should be unique."
        }
    }
}