Metadata_Cli_Command_OptionInfo

The Command.OptionInfo structure describes information about a specific input option of a command.

JSON Example

{
    "long_option": "string",
    "short_option": "string",
    "field_name": "string",
    "description": "string",
    "type": "string",
    "generic": "string"
}

string

long_option

Required

The long option name of the parameter as used by the user.

string

short_option

Optional

The single character value option name. If not present, there's no single character option for the parameter.

string

field_name

Required

The fully qualified name of the option referred to by the operation element in Command.Info.operation-id.

string

description

Required

The description of the option to be displayed to the user when they request usage information for a CLI command.

string

type

Required

The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumerated type this stores the fully qualified enumerated type id.

Metadata_Cli_Command_GenericType

generic

Required

The Command.GenericType enumerated type defines generic types supported by Command service. See Command.OptionInfo.generic.
NONE : Default case.
OPTIONAL : Input parameter is an optional.
LIST : Input parameter is a list.
OPTIONAL_LIST : Input parameter is an optional of type list.
LIST_OPTIONAL : Input parameter is a list of optionals.