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
98
99
100
101
102
103
104
105
106
107
108
109
110

// SPDX-License-Identifier: MIT

package greentic:provision@0.1.0;

/// Provisioning entry points implemented by provider extension packs.
interface provisioner {
  /// Diagnostics emitted during plan/apply steps.
  record diagnostic {
    /// "info" | "warn" | "error".
    severity: string,
    code: string,
    message: string,
    path: option<string>,
    hint: option<string>,
  }

  /// Tenant context supplied by the host.
  record tenant-context {
    tenant-id: string,
    tenant-name: option<string>,
    org-id: option<string>,
    org-name: option<string>,
  }

  /// Provider install context supplied by the host.
  record provider-context {
    provider-id: string,
    install-id: string,
    public-base-url: option<string>,
  }

  /// High-level provisioning mode.
  enum provision-mode {
    install,
    update,
    remove,
  }

  /// Answer provided by an operator or UI flow.
  record answer {
    key: string,
    value: string,
  }

  /// Webhook operation verbs.
  enum webhook-action {
    create,
    update,
    delete,
  }

  /// Webhook operation requested by the provisioner.
  record webhook-op {
    action: webhook-action,
    name: string,
    url: string,
    events: list<string>,
  }

  /// Subscription operation verbs.
  enum subscription-action {
    create,
    update,
    delete,
  }

  /// Subscription operation requested by the provisioner.
  record subscription-op {
    action: subscription-action,
    topic: string,
    endpoint: string,
  }

  /// Existing host state relevant to provisioning.
  record existing-state {
    config-json: option<string>,
    secrets-json: option<string>,
    webhooks: list<webhook-op>,
    subscriptions: list<subscription-op>,
  }

  /// Inputs provided to provisioning components.
  record provision-inputs {
    tenant: tenant-context,
    provider: provider-context,
    mode: provision-mode,
    answers: list<answer>,
    existing: option<existing-state>,
  }

  /// Provisioning plan output (host applies patches/ops).
  record provision-plan {
    /// JSON patch/merge patch payload for configuration changes.
    config-patch: option<string>,
    /// JSON patch/merge patch payload for secret changes.
    secrets-patch: option<string>,
    webhooks: list<webhook-op>,
    subscriptions: list<subscription-op>,
    diagnostics: list<diagnostic>,
  }

  /// Build a provisioning plan for the current inputs.
  plan: func(inputs: provision-inputs) -> provision-plan;
  /// Apply a plan and emit diagnostics for host display.
  apply: func(inputs: provision-inputs, plan: provision-plan) -> list<diagnostic>;
}

world provision-runner {
  export provisioner;
}