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

// SPDX-License-Identifier: MIT

package greentic:scan@1.0.0;

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

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

  /// Scan category.
  enum scan-kind {
    sast,
    deps,
    container,
    secrets,
    other,
  }

  /// SBOM reference.
  record sbom-ref {
    id: string,
    uri: option<string>,
    digest: option<string>,
    extra: option<string>,
  }

  /// Scan request payload.
  record scan-request {
    request-id: string,
    kind: scan-kind,
    target-ref: string,
    params-json: option<string>,
    extra: option<string>,
  }

  /// Scan lifecycle state.
  enum scan-state {
    queued,
    running,
    passed,
    failed,
  }

  /// Scan result payload.
  record scan-result {
    request-id: string,
    kind: scan-kind,
    state: scan-state,
    started-at-utc: option<string>,
    finished-at-utc: option<string>,
    sbom: option<sbom-ref>,
    findings-json: option<string>,
    extra: option<string>,
  }

  execute-scan: func(ctx: tenant-ctx, request: scan-request) -> result<scan-result, host-error>;
}

world scanner {
  export scanner-api;
}