@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/create/create-webhook/CreateWebhook.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var WebhookOptions = require('../../../options/WebhookOptions.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 CreateWebhookDefinition = {
    name: "webhook-settings",
    aliases: ["webhook"],
    type: "command",
    handler: __dirname + "/CreateWebhook.handler",
    description: "Create webhook used by Endevor Bridge for Git.",
    summary: "Create webhook",
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    positionals: [WebhookOptions.WebhookOptions.CONTEXT, WebhookOptions.WebhookOptions.MAPPING],
    options: [
        WebhookOptions.WebhookOptions.URL,
        WebhookOptions.WebhookOptions.NAME,
        WebhookOptions.WebhookOptions.DESCRIPTION,
        WebhookOptions.WebhookOptions.OPERATION_TYPES,
        WebhookOptions.WebhookOptions.OPERATION_RESULTS,
        WebhookOptions.WebhookOptions.BRANCHES,
        WebhookOptions.WebhookOptions.AUTH_NAME,
        WebhookOptions.WebhookOptions.AUTH_SECRET,
    ],
    examples: [
        {
            description: "Create global webhook that captures successful and failed sync and refresh oprations",
            options: "--url URL --name NAME --description DESCRIPTION --operation-types SYNC REFRESH --operation-results SUCCESS FAILED",
        },
        {
            description: "Create mapping webhook that captures successful and failed sync and refresh oprations",
            options: "MY-CONTEXT MY-MAPPING --url URL --name NAME --description DESCRIPTION --operation-types SYNC REFRESH --operation-results SUCCESS FAILED",
        },
    ],
};

exports.CreateWebhookDefinition = CreateWebhookDefinition;