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


description Required

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

field_name Required

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

generic Required

This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.

long_option Required

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

short_option Optional

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

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.

JSON Example

    "description": "string",
    "field_name": "string",
    "generic": "enum",
    "long_option": "string",
    "type": "string"

Was this page helpful?