rename_dimension.json

{
    "id": "rename_dimension",
    "summary": "Rename a dimension",
    "description": "Renames a dimension in the data cube while preserving all other properties.",
    "categories": [
        "cubes"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "The data cube.",
            "schema": {
                "type": "object",
                "subtype": "raster-cube"
            }
        },
        {
            "name": "source",
            "description": "The current name of the dimension. Fails with a `DimensionNotAvailable` error if the specified dimension does not exist.",
            "schema": {
                "type": "string"
            }
        },
        {
            "name": "target",
            "description": "A new Name for the dimension. Fails with a `DimensionExists` error if a dimension with the specified name exists.",
            "schema": {
                "type": "string"
            }
        }
    ],
    "returns": {
        "description": "The data cube with the renamed dimension. The old name can not be referenced any longer.",
        "schema": {
            "type": "object",
            "subtype": "raster-cube"
        }
    },
    "exceptions": {
        "DimensionNotAvailable": {
            "message": "A dimension with the specified name does not exist."
        },
        "DimensionExists": {
            "message": "A dimension with the specified name already exists."
        }
    }
}