greentic-interfaces 1.1.1

Greentic ABI: WIT contracts, generated bindings, thin mappers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// SPDX-License-Identifier: MIT

package greentic:worker@1.0.0;

interface worker-api {
  /// clouds & platforms kept stable for worker deployment metadata
  enum cloud { aws, gcp, azure, hetzner, local, other }

  enum platform { k8s, nomad, systemd, cfworkers, lambda, baremetal, other }

  /// Flow deployment context supplied by hosts.
  record deployment-ctx {
    cloud: cloud,
    region: option<string>,
    platform: platform,
    runtime: option<string>,
    i18n-id: option<string>,
  }

  /// Tenant identity and invocation metadata used by worker requests.
  record tenant-ctx {
    tenant: string,
    team: option<string>,
    user: option<string>,
    deployment: deployment-ctx,
    trace-id: option<string>,
    i18n-id: option<string>,
    session-id: option<string>,
    flow-id: option<string>,
    node-id: option<string>,
    provider-id: option<string>,
  }

  /// Generic worker invocation envelope.
  record worker-request {
    /// ABI version identifier (e.g. "1.0").
    version: string,
    /// Tenant execution context.
    tenant: tenant-ctx,
    /// Worker identifier (e.g. "greentic-repo-assistant").
    worker-id: string,
    /// Optional correlation handle.
    correlation-id: option<string>,
    /// Optional session identifier.
    session-id: option<string>,
    /// Optional thread identifier.
    thread-id: option<string>,
    /// JSON-encoded payload (opaque to the ABI).
    payload-json: string,
    /// ISO8601 UTC timestamp.
    timestamp-utc: string,
  }

  /// Generic worker message emitted in a response.
  record worker-message {
    /// Message kind (e.g. "text", "card", "event").
    kind: string,
    /// JSON-encoded message/card/event payload.
    payload-json: string,
  }

  /// Worker response envelope (non-streaming).
  record worker-response {
    /// Mirrors the request version.
    version: string,
    /// Tenant execution context.
    tenant: tenant-ctx,
    /// Worker identifier (e.g. "greentic-repo-assistant").
    worker-id: string,
    /// Optional correlation handle.
    correlation-id: option<string>,
    /// Optional session identifier.
    session-id: option<string>,
    /// Optional thread identifier.
    thread-id: option<string>,
    /// Accumulated worker messages.
    messages: list<worker-message>,
    /// ISO8601 UTC timestamp.
    timestamp-utc: string,
  }

  /// Structured worker error payload.
  record worker-error {
    /// Error category (e.g. "transport_error", "bad_request").
    code: string,
    /// Human-readable error description.
    message: string,
  }

  /// Execute a worker for the given request.
  /// Implementations may be local or remote.
  exec: func(req: worker-request) -> result<worker-response, worker-error>;
}

world worker {
  export worker-api;
}