apiconnect-cli-catalogs/lib/plugin-def.js

// Copyright IBM Corp. 2016. All Rights Reserved.
// Node module: apiconnect-cli-catalogs
// US Government Users Restricted Rights - Use, duplication or disclosure
// restricted by GSA ADP Schedule Contract with IBM Corp.

/********************************************************* {COPYRIGHT-TOP} ***
 * IBM Confidential
 * OCO Source Materials
 * 5725-C11, 5725-C12, 7198-8FX, 5725-F70, 5725-F71, 5725-F72, 5725-L30
 *
 * (C) Copyright IBM Corporation 2015  All Rights Reserved.
 *
 * The source code for this program is not published or otherwise
 * divested of its trade secrets, irrespective of what has been
 * deposited with the U.S. Copyright Office.
 ********************************************************* {COPYRIGHT-END} **/
/*eslint brace-style: 0, max-len: 0*/

var g = require('strong-globalize')();

module.exports = {
  name: 'catalogs',
  version: require('../package.json').version,
  path: __filename,
  isBuiltin: true,
  topics: getTopics,
};

function getTopics() {
  return [ {
    name: 'catalogs',
    commands: [
      {
        command: 'list',
        loginRequired: 'org',
        aliases: [ 'catalogs' ],
        helpInfo: function() {
          return g.f('apic_catalogs_list_help.txt');
        },
        action: function(opts) {
          return require('./plugin-impl').catalogsList(opts);
        },
        options: [
          { name: 'all-organizations', rune: 'O', type: 'boolean' },
          { name: 'organization', rune: 'o', type: 'name', default: '$APIC_CONFIG$.org.data.orgs' },
          { name: 'server', rune: 's', type: 'hostname', default: '$APIC_CONFIG$.org.hostname', required: true },
        ],
      },
      {
        command: 'create <displayName>',
        loginRequired: 'org',
        helpInfo: function() {
          return g.f('apic_catalogs_create_help.txt');
        },
        action: function(displayName, opts) {
          return require('./plugin-impl').catalogsCreate(displayName, opts);
        },
        options: [
          { name: 'name' },
          { name: 'organization', rune: 'o', type: 'name', default: '$APIC_CONFIG$.org.data.orgs', required: true },
          { name: 'server', rune: 's', type: 'hostname', default: '$APIC_CONFIG$.org.hostname', required: true },
        ],
      },
      {
        command: 'get <name>',
        loginRequired: 'org',
        helpInfo: function() {
          return g.f('apic_catalogs_get_help.txt');
        },
        action: function(name, opts) {
          return require('./plugin-impl').catalogsGet(name, opts);
        },
        options: [
          { name: 'organization', rune: 'o', type: 'name', default: '$APIC_CONFIG$.org.data.orgs', required: true },
          { name: 'server', rune: 's', type: 'hostname', default: '$APIC_CONFIG$.org.hostname', required: true },
        ],
      },
      {
        command: 'delete <name>',
        loginRequired: 'org',
        helpInfo: function() {
          return g.f('apic_catalogs_delete_help.txt');
        },
        action: function(name, opts) {
          return require('./plugin-impl').catalogsDelete(name, opts);
        },
        options: [
          { name: 'organization', rune: 'o', type: 'name', default: '$APIC_CONFIG$.org.data.orgs', required: true },
          { name: 'server', rune: 's', type: 'hostname', default: '$APIC_CONFIG$.org.hostname', required: true },
        ],
      },
      {
        command: 'set <name>',
        loginRequired: 'org',
        helpInfo: function() {
          return g.f('apic_catalogs_set_help.txt');
        },
        action: function(name, opts) {
          return require('./plugin-impl').catalogsSet(name, opts);
        },
        options: [
          { name: 'name' },
          { name: 'display-name' },
          { name: 'organization', rune: 'o', type: 'name', default: '$APIC_CONFIG$.org.data.orgs', required: true },
          { name: 'server', rune: 's', type: 'hostname', default: '$APIC_CONFIG$.org.hostname', required: true },
          { name: 'spaces', type: 'enum', values: [ 'enabled', 'disabled' ] },
        ],
      },
    ],
  } ];
}