add_dimension.json

{
    "id": "add_dimension",
    "summary": "Add a new dimension",
    "description": "Adds a new named dimension to the data cube.\n\nAfterwards, the dimension can be referenced with the specified `name`. If a dimension with the specified name exists, the process fails with a `DimensionExists` error. The dimension value of the dimension is set to the specified `value`.",
    "categories": [
        "cubes"
    ],
    "parameter_order": ["data", "name", "value", "type"],
    "parameters": {
        "data": {
            "description": "A data cube to add the dimension to.",
            "schema": {
                "type": "object",
                "format": "raster-cube"
            },
            "required": true
        },
        "name": {
            "description": "Name for the dimension.",
            "schema": {
                "type": "string"
            },
            "required": true
        },
        "value": {
            "description": "A dimension value (**not** a pixel value).",
            "schema": {
                "anyOf": [
                    {
                        "type": "number"
                    },
                    {
                        "type": "string"
                    },
                    {
                        "type": "string",
                        "format": "date-time"
                    },
                    {
                        "type": "string",
                        "format": "date"
                    },
                    {
                        "type": "string",
                        "format": "time"
                    }
                ]
            },
            "required": true
        },
        "type": {
            "description": "The type of dimension, defaults to `other`.",
            "schema": {
                "type": "string",
                "enum": [
                    "spatial",
                    "temporal",
                    "bands",
                    "other"
                ],
                "default": "other"
            }
        }
    },
    "returns": {
        "description": "The data cube with a newly added dimension.",
        "schema": {
            "type": "object",
            "format": "raster-cube"
        }
    },
    "exceptions": {
        "DimensionExists": {
            "message": "A dimension with the specified name already exists."
        }
    }
}