Vapi Metadata Cli Command Info

Vapi Metadata Cli Command Info
Vapi Metadata Cli Command Info

The Vapi Metadata Cli Command Info schema contains information about a command. It includes the identity of the command, a description, information about the resource and operation that implement the command, and CLI-specific information for the command.

JSON Example
{
    "identity": {
        "path": "string",
        "name": "string"
    },
    "description": "string",
    "service_id": "string",
    "operation_id": "string",
    "options": [
        {
            "long_option": "string",
            "short_option": "string",
            "field_name": "string",
            "description": "string",
            "type": "string",
            "generic": "string"
        }
    ],
    "formatter": "string",
    "output_field_list": [
        {
            "structure_id": "string",
            "output_fields": [
                {
                    "field_name": "string",
                    "display_name": "string"
                }
            ]
        }
    ]
}
identity
Required

Basic command identity.

string
description
Required

The text description displayed to the user in help output.

string
service_id
Required

The service identifier that contains the operations for this CLI command.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.service.

string
operation_id
Required

The operation identifier corresponding to this CLI command.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.operation.

array of Vapi Metadata Cli Command OptionInfo
options
Required

The input for this command.

string
formatter
Optional

The formatter to use when displaying the output of this command.

For more information see: Vapi Metadata Cli Command FormatterType.

If not present, client can choose a default output formatter.

array of Vapi Metadata Cli Command OutputInfo
output_field_list
Required

List of output structure name and output field info.

Returned By