@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/update/update-mf-webhook/UpdateMfWebhook.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var MFWebhookOptions = require('../../../options/MFWebhookOptions.js');

/*
 * Copyright (c) 2019 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.
 */
const UpdateMfWebhookDefinition = {
    name: "mf-webhook-settings",
    aliases: ["mf-webhook"],
    type: "command",
    handler: __dirname + "/UpdateMfWebhook.handler",
    description: "Update an existing MF Webhook Server.",
    summary: "Update MF Webhook Server.",
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    positionals: [MFWebhookOptions.MFWebhookOptions.ID],
    options: [
        MFWebhookOptions.MFWebhookOptions.DESCRIPTION,
        MFWebhookOptions.MFWebhookOptions.RECIPIENT,
        MFWebhookOptions.MFWebhookOptions.AUTH_NAME,
        MFWebhookOptions.MFWebhookOptions.AUTH_SECRET,
        MFWebhookOptions.MFWebhookOptions.WATCH_DIR,
        MFWebhookOptions.MFWebhookOptions.ENABLED,
    ],
    outputFormatOptions: true,
    examples: [
        {
            description: "Update existing MF webhook settings using the default EBG profile",
            options: '"MF-WEBHOOK-ID --enabled true " +\n' +
                '        "--description description --recipient user@broadcom.com --watched-directories "/u/location1" "/u/location2" "',
        },
    ],
};

exports.UpdateMfWebhookDefinition = UpdateMfWebhookDefinition;