vapi metadata cli namespace: info

The info structure contains information about a namespace. It includes the identity of the namespace, a description, information children namespaces.

Representation:

{
    "children"[
        {
            "path""string",
            "name""string"
        },
        {
            "path""string",
            "name""string"
        }
    ],
    "identity"{
        "path""string",
        "name""string"
    },
    "description""string"
}

Attributes:

Name Type Description
Required
identity identity Basic namespace identity.

identity.path string The dot-separated path of the namespace containing the namespace in the CLI node tree. For top-level namespace this will be empty.

identity.name string The name displayed to the user for this namespace.

description string The text description displayed to the user in help output.

children identity[] The children of this namespace in the tree of CLI namespaces.

children[].path string The dot-separated path of the namespace containing the namespace in the CLI node tree. For top-level namespace this will be empty.

children[].name string The name displayed to the user for this namespace.