array_concat.json

{
    "id": "array_concat",
    "summary": "Merge two arrays",
    "description": "Concatenates two arrays into a single array by appending the second array to the first array.\n\nArray labels are kept only if both given arrays are labeled. Otherwise, the labels get discarded from both arrays. The process fails with an `ArrayLabelConflict` exception if a label is present in both arrays. Conflicts must be resolved beforehand.",
    "categories": [
        "arrays"
    ],
    "parameters": [
        {
            "name": "array1",
            "description": "The first array.",
            "schema": {
                "type": "array",
                "items": {
                    "description": "Any data type is allowed."
                }
            }
        },
        {
            "name": "array2",
            "description": "The second array.",
            "schema": {
                "type": "array",
                "items": {
                    "description": "Any data type is allowed."
                }
            }
        }
    ],
    "returns": {
        "description": "The merged array.",
        "schema": {
            "type": "array",
            "items": {
                "description": "Any data type is allowed."
            }
        }
    },
    "exceptions": {
        "ArrayLabelConflict": {
            "message": "At least one label exists in both arrays and the conflict must be resolved before."
        }
    },
    "examples": [
        {
            "description": "Concatenates two numerical arrays.",
            "arguments": {
                "array1": [
                    1.5,
                    2.5
                ],
                "array2": [
                    5
                ]
            },
            "returns": [
                1.5,
                2.5,
                5
            ]
        },
        {
            "description": "Concatenates two arrays containing different data type, may not always be supported.",
            "arguments": {
                "array1": [
                    "a",
                    "b"
                ],
                "array2": [
                    1,
                    2
                ]
            },
            "returns": [
                "a",
                "b",
                1,
                2
            ]
        }
    ]
}