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

// SPDX-License-Identifier: MIT

package greentic:distribution@1.0.0;

interface distribution-api {
  use greentic:interfaces-types/types@0.1.0.{tenant-ctx};

  /// Opaque metadata preserved end-to-end.
  record metadata-entry {
    key: string,
    value: string,
  }

  /// Reference to a distributor-managed environment.
  record environment-ref {
    id: string,
    alias: option<string>,
    distributor-ref: option<string>,
    connection-kind: option<string>,
    labels: list<metadata-entry>,
  }

  /// Opaque desired state handle.
  type desired-state-ref = string;

  /// Desired state version marker (opaque string to the ABI).
  type desired-state-version = string;

  /// Captured desired state payload for an environment.
  record desired-state {
    ref: desired-state-ref,
    environment: environment-ref,
    version: desired-state-version,
    payload-json: string,
    metadata: list<metadata-entry>,
  }

  /// Canonical host error payload.
  record host-error {
    code: string,
    message: string,
  }

  /// Submit a desired state payload for an environment.
  submit-desired-state: func(
    tenant: tenant-ctx,
    environment: environment-ref,
    payload-json: string,
    metadata: list<metadata-entry>
  ) -> result<desired-state-ref, host-error>;

  /// Fetch a desired state by reference.
  get-desired-state: func(
    tenant: tenant-ctx,
    state: desired-state-ref
  ) -> result<desired-state, host-error>;
}

world distribution {
  export distribution-api;
}