You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/openapi.yaml
+40-55Lines changed: 40 additions & 55 deletions
Original file line number
Diff line number
Diff line change
@@ -184,20 +184,18 @@ components:
184
184
type: array
185
185
description: List of arguments passed to the package's runtime command (such as docker or npx).
186
186
items:
187
-
$ref: '#/components/schemas/Input'
187
+
$ref: '#/components/schemas/Argument'
188
188
package_arguments:
189
189
type: array
190
190
description: List of arguments passed to the package's binary.
191
191
items:
192
-
$ref: '#/components/schemas/Input'
192
+
$ref: '#/components/schemas/Argument'
193
193
environment_variables:
194
194
type: array
195
195
items:
196
-
anyOf:
197
-
- $ref: '#/components/schemas/NamedInput'
198
-
- $ref: '#/components/schemas/TemplateInput'
196
+
$ref: '#/components/schemas/KeyValueInput'
199
197
200
-
UserInput:
198
+
Input:
201
199
type: object
202
200
properties:
203
201
description:
@@ -213,7 +211,7 @@ components:
213
211
default: string
214
212
value:
215
213
type: string
216
-
description: The default value for the input. If this is not set, the user will be asked to provide a value.
214
+
description: The default value for the input. If this is not set, the user will be asked to provide a value. If the `variables` property is provided, then values wrapped in `{curly_braces}` will be replaced with the corresponding variables.
217
215
is_secret:
218
216
type: boolean
219
217
description: Whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.
@@ -228,10 +226,21 @@ components:
228
226
type: string
229
227
example: []
230
228
231
-
PositionalInput:
229
+
InputWithVariables:
230
+
allOf:
231
+
- $ref: '#/components/schemas/Input'
232
+
- type: object
233
+
properties:
234
+
variables:
235
+
type: object
236
+
description: A map of variable names to their values. Keys in the input `value` wrapped in `{curly_braces}` will be replaced with the corresponding variables.
237
+
additionalProperties:
238
+
$ref: '#/components/schemas/Input'
239
+
240
+
PositionalArgument:
232
241
description: A positional input is a value inserted verbatim into the command line.
233
242
allOf:
234
-
- $ref: '#/components/schemas/UserInput'
243
+
- $ref: '#/components/schemas/InputWithVariables'
235
244
- type: object
236
245
required:
237
246
- type
@@ -243,72 +252,50 @@ components:
243
252
example: "positional"
244
253
name:
245
254
type: string
246
-
description: Name of the positional argument. This is not part of the command line, but can be used for reference by client configuration.
255
+
description: Name of the positional argument. This is not part of the command line, but can be used for reference by client configuration and used to hint users.
247
256
example: file_path
248
257
is_repeated:
249
258
type: boolean
250
259
description: Whether the input can be repeated multiple times in the command line.
251
260
default: false
252
261
253
-
NamedInput:
254
-
description: A command-line `--flag={value}`, named environment variable or header.
262
+
NamedArgument:
263
+
description: A command-line `--flag={value}`.
255
264
allOf:
256
-
- $ref: '#/components/schemas/UserInput'
265
+
- $ref: '#/components/schemas/InputWithVariables'
257
266
- type: object
258
267
required:
259
268
- type
260
-
- name
269
+
- flag
261
270
properties:
262
271
type:
263
272
type: string
264
273
enum: [named]
265
274
example: "named"
266
-
name:
275
+
flag:
267
276
type: string
268
277
example: "--port"
269
278
is_repeated:
270
279
type: boolean
271
-
description: Whether the argument or header can be repeated multiple times. Has no effect for environment variables.
280
+
description: Whether the argument can be repeated multiple times. Has no effect for environment variables.
272
281
default: false
273
282
274
-
TemplateInput:
275
-
- type: object
276
-
required:
277
-
- type
278
-
- template
279
-
- name
280
-
properties:
281
-
type:
282
-
type: string
283
-
enum: [template]
284
-
name:
285
-
type: string
286
-
example: mount_config
287
-
description: The name of the input, which can be used by clients as an identifier to reference the input. For environment variables and headers, this is the environment variable or header names. For arguments, this is solely for reference and not part of the command line.
288
-
description:
289
-
description: A description of the input, which can be used by clients to provide context to the user.
290
-
type: string
291
-
is_required:
292
-
type: boolean
293
-
default: false
294
-
is_repeated:
295
-
type: boolean
296
-
description: Whether the argument or header can be repeated multiple times. Has no effect for environment variables.
297
-
default: false
298
-
template:
299
-
type: string
300
-
description: The template string that will be used to generate the value. Values wrapped in `{curly_braces}` will be replaced with the corresponding variables. Input which is not `is_required` is replaced with its `default` value, or otherwise an empty string.
0 commit comments