@broadcom/ca7-for-zowe-cli/lib/cli/batch/items/PostBatch.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"use strict";
/*
* Copyright (c) 2025 Broadcom.  All Rights Reserved.  The term
* "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
*
* This software and all information contained therein is
* confidential and proprietary and shall not be duplicated,
* used, disclosed, or disseminated in any way except as
* authorized by the applicable license agreement, without the
* express written permission of Broadcom.  All authorized
* reproductions must be marked with this language.
*
* EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
* THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
* SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
* LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
* FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
* BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
* DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
* INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
* INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
* EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.PostBatchDefinition = void 0;
exports.PostBatchDefinition = {
    name: "batch",
    aliases: ["bat"],
    summary: "Issue multiple requests",
    description: "Call multiple APIs in the same CA 7 session",
    examples: [
        {
            options: "--ca7Id Instance1 --path path1 --path path2 --method POST --method PUT --body \"{body parameters}\" --body \"{body parameters}\" ",
            description: "Call multiple APIs(with details of path, method, body, and/or parameters) in the same CA 7 session on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostBatch.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7Id",
            description: "CA 7 instance" +
                "\nAll API requests in the request body will be routed to the ca7Id specified." +
                "\nIf ca7Id is not specified, all requests will be routed to the DEFAULT_INSTANCE.",
            type: "string",
            required: false
        },
        {
            name: "path",
            description: "The path as shown in Swagger for the endpoint associated with this API request",
            type: "array",
            required: true
        },
        {
            name: "method",
            description: "The API method\n" +
                "Valid values are POST, PUT or DELETE.",
            type: "array",
            required: true
        },
        {
            name: "body",
            description: "The request body required for the API specified by path\n" +
                "Note that double quotes (\") in the original API request body should be replaced with single quotes (') in the body value." +
                "Required if the method is POST, PUT, or DELETE\n" +
                "Invalid if the method is GET",
            type: "array",
            required: false
        },
        {
            name: "parameters",
            description: "Name/value pairs specified using standard JSON format enclosed in curly brackets { }\n" +
                "Optional depending upon the path and method",
            type: "array",
            required: false
        }
        /*{
            name: "batchRequestBody",
            aliases: ["brb"],
            description: "The request body specifies an array of API request descriptors.\n" +
                "Each descriptor describes an API request and is enclosed in curly brackets { }.\n" +
                "Descriptors are separated by commas.\n" +
                "The array is enclosed in square brackets. For E.g.\n[\n{\n" +
                "    \"path\": \"/api/v1/job/definition/job\",\n" +
                "    \"method\": \"POST\",\n" +
                "    \"body\": \"{'job': 'ANEW1','job-type': 'CPU','system': 'MORTGAGE'}\"\n" +
                "  },\n" +
                "  {\n" +
                "    \"path\": \"/api/v1/commands/demand\",\n" +
                "    \"method\": \"POST\",\n" +
                "    \"body\": \"{'job': 'NOTHERE'}\"\n" +
                "  }\n].\n" +
                "path : The path as shown in Swagger for the endpoint associated with this API request.\n" +
                "The API method - Valid values are POST, PUT or DELETE.\n" +
                "The request body required for the API specified by path. Note that double quotes (\") in the original API request body should be replaced with single quotes (') in the body value.",
            type: "array",
            required: true
        }*/
    ]
};
//# sourceMappingURL=PostBatch.definition.js.map