spec/schema/input.ts at 26598c706c72b141d31de20ac2207100c560a3a3 · bradrydzewski/spec · GitHub

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
import { UiConfig } from "./ui";

/**
 * @x-go-file input.go
 */
export interface Input {

    /**
     * Type defines the input type.
     */
    type:
        "string"
      | "number"
      | "boolean"
      | "array"
      | "duration"
      | "choice"      // GitHub compatibility
      | "environment" // GitHub compatibility
      | "secret"

    /**
     * Description defines the input description.
     */
    description?: string

    /**
     * @go-type: interface{}
     * Default value populated for this input
     */
    default?: any

    /**
     * Required indicates the input is required.
     */
    required?: boolean;

    /**
     * Items defines an array type.
     */
    items?: any[]

    /**
     * Enum defines a list of accepted input values.
     */
    enum?: any[]

    /**
     * Pattern defines a regular expression input constraint.
     */
    pattern?: string;

    /**
     * Options defines a list of accepted input values.
     * This is an alias for enum.
     * @github
     */
    options?: any[]

    /**
     * Mask indicates the input should be masked.
     * @deprecated
     */
    mask?: boolean

    /**
     * Label to be displayed in the UI for this input
     */
    label?: string

    /**
     * Config to override default UI rendering behaviour
     */
    ui?: UiConfig
}