array_create_labeled.json

{
    "id": "array_create_labeled",
    "summary": "Create a labeled array",
    "description": "Creates a new labeled array by using the values from the `labels` array as labels and the values from the `data` array as the corresponding values.\n\nThe exception `ArrayLengthMismatch` is thrown, if the number of the values in the given arrays don't match exactly.\n\nThe primary use case here is to be able to transmit labeled arrays from the client to the server as JSON doesn't support this data type.",
    "categories": [
        "arrays"
    ],
    "experimental": true,
    "parameters": [
        {
            "name": "data",
            "description": "An array of values to be used.",
            "schema": {
                "description": "Any data type is allowed."
            }
        },
        {
            "name": "labels",
            "description": "An array of labels to be used.",
            "schema": {
                "type": "array",
                "items": {
                    "type": [
                        "number",
                        "string"
                    ]
                }
            }
        }
    ],
    "returns": {
        "description": "The newly created labeled array.",
        "schema": {
            "type": "array",
            "subtype": "labeled-array",
            "items": {
                "description": "Any data type is allowed."
            }
        }
    },
    "exceptions": {
        "ArrayLengthMismatch": {
            "message": "The number of values in the parameters `data` and `labels` don't match."
        }
    }
}