Saxonberg Server API
    Preparing search index...

    Interface CommandSchemaPayload

    Schema-delivery payload for system.commands.{added,reset}. Mirrors the YAML view minus runtime-only bits.

    interface CommandSchemaPayload {
        args?: PositionalDefinition[];
        controller?: string;
        description: string;
        examples?: ExampleDefinition[];
        fallthrough?: boolean;
        help?: string;
        options?: Record<string, OptionDefinition>;
        payload?: Record<string, OptionDefinition>;
        subcommands?: Record<string, SubcommandDefinition>;
        verbs: string[];
    }
    Index

    Properties

    args? controller? description examples? fallthrough? help? options? payload? subcommands? verbs

    Properties

    args?: PositionalDefinition[]
    controller?: string
    description: string
    examples?: ExampleDefinition[]

    Worked invocations (see CommandView.examples).

    fallthrough?: boolean
    help?: string

    Authored help prose (see CommandView.help).

    options?: Record<string, OptionDefinition>
    payload?: Record<string, OptionDefinition>

    Structured-form-only fields. Surfaces to widget / editor clients so they know which keys to attach to their structured payloads.

    subcommands?: Record<string, SubcommandDefinition>
    verbs: string[]

    Settings

    Member Visibility

    On This Page

    Properties