Interface SchemaEntry

One entry of a document's actions array.

interface SchemaEntry {
    description?: string;
    headers?: HeaderEntry[];
    inputs?: PortEntry[];
    name: string;
    output_to_json_field?: Record<string, string>;
    outputs?: PortEntry[];
    runnable?: boolean;
}

Index

Properties

description? headers? inputs? name output_to_json_field? outputs? runnable?

Properties

`Optional`description

description?: string

Developer-facing action description.

`Optional`headers

headers?: HeaderEntry[]

Binary metadata contracts.

`Optional`inputs

inputs?: PortEntry[]

Callable or complete input contracts.

name

name: string

Registered action name.

`Optional`output_to_json_field

output_to_json_field?: Record<string, string>

Output-to-result JSON mappings.

`Optional`outputs

outputs?: PortEntry[]

Callable or complete output contracts.

`Optional`runnable

runnable?: boolean

Whether this document's producer can execute the action.