GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — python/action.schema.json at master · datatorch/python

Expand file tree

/

action.schema.json

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
222 lines (222 loc) · 7.75 KB
/

action.schema.json

Copy path

File metadata and controls

222 lines (222 loc) · 7.75 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "http://datatorch.io/schema/action.v1.json",
"title": "DataTorch Action Schema",
"description": "Schema for authoring DataTorch actions (action-datatorch.yaml). This schema is authoring guidance for editors: it is stricter than the agent runtime, which ignores unknown keys.",
"additionalProperties": false,
"required": ["name", "runs"],
"properties": {
"$schema": {
"type": "string",
"description": "Optional reference to this schema for editor tooling."
},
"name": {
"type": "string",
"description": "The name of your action. DataTorch displays the name when the action is ran.",
"maxLength": 40
},
"author": {
"type": "string",
"description": "The name of the action's author."
},
"description": {
"type": "string",
"maxLength": 500
},
"cache": {
"type": "boolean",
"description": "Enable caching of results keyed on the action's inputs. A pipeline step's cache setting overrides this."
},
"inputs": {
"description": "Input parameters allow you to specify data that the action expects to use during runtime.",
"type": "object",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"description": "A string identifier to associate with the input.",
"properties": {
"type": {
"type": "string",
"description": "Expected type of the input.",
"enum": ["string", "float", "integer", "boolean", "array", "list"],
"default": "string"
},
"description": {
"description": "A string description of the input parameter.",
"type": "string"
},
"deprecationMessage": {
"description": "A string shown to users using deprecated inputs.",
"type": "string"
},
"required": {
"type": "boolean",
"description": "A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required."
},
"default": {
"description": "The default value is used when an input parameter isn't specified in a workflow file.",
"type": ["string", "boolean", "number", "null", "integer", "array"]
},
"multiline": {
"type": "boolean",
"description": "String inputs only: render as a multi-line text area in forms."
},
"options": {
"type": "array",
"description": "String inputs only: restrict the value to this list (rendered as a select in forms; membership enforced server-side).",
"items": { "type": "string" },
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"outputs": {
"description": "Output parameters allow you to specify the data that subsequent actions can use later in the workflow after the action that defines these outputs has run.",
"type": "object",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"description": "A string identifier to associate with the output.",
"properties": {
"type": {
"type": "string",
"description": "Expected type of the output.",
"enum": ["string", "number", "boolean"],
"default": "string"
},
"description": {
"description": "A string description of the output parameter.",
"type": "string"
},
"multiline": {
"type": "boolean",
"description": "String outputs only: render as a multi-line text area in human task forms."
},
"options": {
"type": "array",
"description": "String outputs only: restrict the value to this list (rendered as a select in human task forms; membership enforced at submission).",
"items": { "type": "string" },
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"env": {
"description": "Environment variables the action reads from the agent's environment (e.g. API keys). Declare names and descriptions only — NEVER values. Values are provided by the agent's environment; declaring them here documents the requirement and feeds the pipeline requirements manifest.",
"type": "object",
"patternProperties": {
"^[A-Z_][A-Z0-9_]*$": {
"properties": {
"description": {
"type": "string",
"description": "Why/when the action needs this variable (e.g. 'Needed when provider is anthropic')."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"runs": {
"description": "Describes how to execute the action.",
"type": "object",
"properties": {
"using": {
"description": "The application to use to execute the code specified in main.",
"type": "string",
"enum": ["cmd", "script", "node", "python", "docker", "human"]
},
"command": {
"type": "string",
"description": "Required for 'cmd': Command to execute. Read step inputs from $INPUT_<NAME> environment variables — interpolating ${{ input.* }} into a command raises InputInjectionError."
},
"main": {
"type": "string",
"description": "Required for 'python' and 'node': The code file that contains your action code."
},
"image": {
"type": "string",
"description": "Required for 'docker': The Docker image to use as the container to run the action."
}
},
"oneOf": [
{
"properties": {
"using": { "const": "node" },
"image": { "not": {} },
"command": { "not": {} }
},
"required": ["main"]
},
{
"properties": {
"using": { "const": "python" },
"image": { "not": {} },
"command": { "not": {} }
},
"required": ["main"]
},
{
"properties": {
"using": { "const": "script" },
"image": { "not": {} },
"command": { "not": {} }
},
"required": ["main"]
},
{
"properties": {
"using": { "const": "cmd" },
"image": { "not": {} },
"main": { "not": {} }
},
"required": ["command"]
},
{
"properties": {
"using": { "const": "docker" },
"main": { "not": {} }
},
"required": ["image"]
},
{
"properties": {
"using": { "const": "human" },
"image": { "not": {} },
"command": { "not": {} },
"main": { "not": {} }
}
}
]
}
},
"examples": [
{
"name": "Echo Input",
"author": "DataTorch Developers",
"description": "Prints input from the command line.",
"inputs": {
"string": {
"type": "string",
"description": "Text to print.",
"default": "Hello world"
}
},
"env": {
"EXAMPLE_API_KEY": {
"description": "Example of declaring a required environment variable. Never put values here."
}
},
"runs": {
"using": "cmd",
"command": "echo \"$INPUT_STRING\""
}
}
]
}
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.