@galaxy-tool-util/schema 1.13.1 → 1.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/dist/index.d.ts +5 -3
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/index.js +5 -3
  4. package/dist/index.js.map +1 -1
  5. package/dist/test-format/tests.schema.generated.d.ts +47 -0
  6. package/dist/test-format/tests.schema.generated.d.ts.map +1 -1
  7. package/dist/test-format/tests.schema.generated.js +62 -0
  8. package/dist/test-format/tests.schema.generated.js.map +1 -1
  9. package/dist/user-tool-source/schema.generated.d.ts +1203 -266
  10. package/dist/user-tool-source/schema.generated.d.ts.map +1 -1
  11. package/dist/user-tool-source/schema.generated.js +1522 -367
  12. package/dist/user-tool-source/schema.generated.js.map +1 -1
  13. package/dist/workflow/draft-checks.d.ts.map +1 -1
  14. package/dist/workflow/draft-checks.js +105 -59
  15. package/dist/workflow/draft-checks.js.map +1 -1
  16. package/dist/workflow/index.d.ts +5 -3
  17. package/dist/workflow/index.d.ts.map +1 -1
  18. package/dist/workflow/index.js +5 -3
  19. package/dist/workflow/index.js.map +1 -1
  20. package/dist/workflow/input-parameter.d.ts +280 -0
  21. package/dist/workflow/input-parameter.d.ts.map +1 -0
  22. package/dist/workflow/input-parameter.js +38 -0
  23. package/dist/workflow/input-parameter.js.map +1 -0
  24. package/dist/workflow/layout-properties.d.ts +10 -0
  25. package/dist/workflow/layout-properties.d.ts.map +1 -0
  26. package/dist/workflow/layout-properties.js +112 -0
  27. package/dist/workflow/layout-properties.js.map +1 -0
  28. package/dist/workflow/layout.d.ts +84 -0
  29. package/dist/workflow/layout.d.ts.map +1 -0
  30. package/dist/workflow/layout.js +356 -0
  31. package/dist/workflow/layout.js.map +1 -0
  32. package/dist/workflow/lint-rules.d.ts +6 -0
  33. package/dist/workflow/lint-rules.d.ts.map +1 -1
  34. package/dist/workflow/lint-rules.js +6 -0
  35. package/dist/workflow/lint-rules.js.map +1 -1
  36. package/dist/workflow/lint.d.ts +1 -1
  37. package/dist/workflow/lint.d.ts.map +1 -1
  38. package/dist/workflow/lint.js +232 -58
  39. package/dist/workflow/lint.js.map +1 -1
  40. package/dist/workflow/lint_profiles.yml +1 -0
  41. package/dist/workflow/mermaid.d.ts.map +1 -1
  42. package/dist/workflow/mermaid.js +1 -0
  43. package/dist/workflow/mermaid.js.map +1 -1
  44. package/dist/workflow/normalized/expanded.d.ts +12 -0
  45. package/dist/workflow/normalized/expanded.d.ts.map +1 -1
  46. package/dist/workflow/normalized/expanded.js +42 -1
  47. package/dist/workflow/normalized/expanded.js.map +1 -1
  48. package/dist/workflow/normalized/index.d.ts +2 -2
  49. package/dist/workflow/normalized/index.d.ts.map +1 -1
  50. package/dist/workflow/normalized/index.js +2 -2
  51. package/dist/workflow/normalized/index.js.map +1 -1
  52. package/dist/workflow/normalized/labels.d.ts +7 -0
  53. package/dist/workflow/normalized/labels.d.ts.map +1 -1
  54. package/dist/workflow/normalized/labels.js +11 -0
  55. package/dist/workflow/normalized/labels.js.map +1 -1
  56. package/dist/workflow/normalized/native.js +5 -4
  57. package/dist/workflow/normalized/native.js.map +1 -1
  58. package/dist/workflow/normalized/toFormat2.d.ts +2 -0
  59. package/dist/workflow/normalized/toFormat2.d.ts.map +1 -1
  60. package/dist/workflow/normalized/toFormat2.js +28 -14
  61. package/dist/workflow/normalized/toFormat2.js.map +1 -1
  62. package/dist/workflow/normalized/toNative.d.ts +19 -2
  63. package/dist/workflow/normalized/toNative.d.ts.map +1 -1
  64. package/dist/workflow/normalized/toNative.js +55 -17
  65. package/dist/workflow/normalized/toNative.js.map +1 -1
  66. package/dist/workflow/raw/gxformat2-draft.d.ts +67 -9
  67. package/dist/workflow/raw/gxformat2-draft.d.ts.map +1 -1
  68. package/dist/workflow/raw/gxformat2-draft.effect.d.ts +1073 -161
  69. package/dist/workflow/raw/gxformat2-draft.effect.d.ts.map +1 -1
  70. package/dist/workflow/raw/gxformat2-draft.effect.js +184 -120
  71. package/dist/workflow/raw/gxformat2-draft.effect.js.map +1 -1
  72. package/dist/workflow/raw/gxformat2-draft.js +6 -0
  73. package/dist/workflow/raw/gxformat2-draft.js.map +1 -1
  74. package/dist/workflow/raw/gxformat2.d.ts +67 -9
  75. package/dist/workflow/raw/gxformat2.d.ts.map +1 -1
  76. package/dist/workflow/raw/gxformat2.effect.d.ts +591 -143
  77. package/dist/workflow/raw/gxformat2.effect.d.ts.map +1 -1
  78. package/dist/workflow/raw/gxformat2.effect.js +169 -105
  79. package/dist/workflow/raw/gxformat2.effect.js.map +1 -1
  80. package/dist/workflow/raw/gxformat2.js +6 -0
  81. package/dist/workflow/raw/gxformat2.js.map +1 -1
  82. package/dist/workflow/raw/native.d.ts +14 -0
  83. package/dist/workflow/raw/native.d.ts.map +1 -1
  84. package/dist/workflow/raw/native.effect.d.ts +45 -30
  85. package/dist/workflow/raw/native.effect.d.ts.map +1 -1
  86. package/dist/workflow/raw/native.effect.js +40 -26
  87. package/dist/workflow/raw/native.effect.js.map +1 -1
  88. package/dist/workflow/raw/native.js.map +1 -1
  89. package/dist/workflow/schema_rules.yml +9 -0
  90. package/dist/workflow/semantic-validators.d.ts +9 -0
  91. package/dist/workflow/semantic-validators.d.ts.map +1 -1
  92. package/dist/workflow/semantic-validators.js +42 -20
  93. package/dist/workflow/semantic-validators.js.map +1 -1
  94. package/dist/workflow/strict-checks.d.ts.map +1 -1
  95. package/dist/workflow/strict-checks.js +2 -3
  96. package/dist/workflow/strict-checks.js.map +1 -1
  97. package/dist/workflow/validators.d.ts +7 -4
  98. package/dist/workflow/validators.d.ts.map +1 -1
  99. package/dist/workflow/validators.js +20 -9
  100. package/dist/workflow/validators.js.map +1 -1
  101. package/package.json +1 -1
@@ -1,6 +1,7 @@
1
1
  export declare const userToolSourceSchema: {
2
2
  readonly $defs: {
3
3
  readonly Citation: {
4
+ readonly additionalProperties: false;
4
5
  readonly properties: {
5
6
  readonly content: {
6
7
  readonly title: "Content";
@@ -32,6 +33,7 @@ export declare const userToolSourceSchema: {
32
33
  readonly type: "object";
33
34
  };
34
35
  readonly Container: {
36
+ readonly additionalProperties: false;
35
37
  readonly properties: {
36
38
  readonly container_id: {
37
39
  readonly title: "Container Id";
@@ -48,6 +50,7 @@ export declare const userToolSourceSchema: {
48
50
  readonly type: "object";
49
51
  };
50
52
  readonly ContainerRequirement: {
53
+ readonly additionalProperties: false;
51
54
  readonly properties: {
52
55
  readonly container: {
53
56
  readonly $ref: "#/$defs/Container";
@@ -64,9 +67,14 @@ export declare const userToolSourceSchema: {
64
67
  };
65
68
  readonly EmptyFieldParameterValidatorModel: {
66
69
  readonly additionalProperties: false;
70
+ readonly description: "Require a value that is neither an empty string nor null.";
71
+ readonly examples: readonly [{
72
+ readonly type: "empty_field";
73
+ }];
67
74
  readonly properties: {
68
75
  readonly implicit: {
69
76
  readonly default: false;
77
+ readonly description: "Set internally when Galaxy added the validator automatically; tool authors normally leave this false.";
70
78
  readonly title: "Implicit";
71
79
  readonly type: "boolean";
72
80
  };
@@ -77,26 +85,40 @@ export declare const userToolSourceSchema: {
77
85
  readonly type: "null";
78
86
  }];
79
87
  readonly default: null;
88
+ readonly description: "Error message shown when validation fails; `%s` is replaced with the rejected value.";
80
89
  readonly title: "Message";
81
90
  };
82
91
  readonly negate: {
83
92
  readonly default: false;
93
+ readonly description: "Require the value to be empty or null instead.";
84
94
  readonly title: "Negate";
85
95
  readonly type: "boolean";
86
96
  };
87
97
  readonly type: {
88
98
  readonly const: "empty_field";
89
99
  readonly default: "empty_field";
100
+ readonly description: "Fails validation when the submitted value is an empty string or null.";
90
101
  readonly title: "Type";
91
102
  readonly type: "string";
92
103
  };
93
104
  };
94
105
  readonly title: "EmptyFieldParameterValidatorModel";
95
106
  readonly type: "object";
107
+ readonly "x-parameter-example": {
108
+ readonly label: "Sample name";
109
+ readonly name: "sample_name";
110
+ readonly type: "text";
111
+ readonly validators: readonly [{
112
+ readonly type: "empty_field";
113
+ }];
114
+ };
96
115
  };
97
116
  readonly FilePatternDatasetCollectionDescription: {
117
+ readonly additionalProperties: false;
98
118
  readonly properties: {
99
119
  readonly assign_primary_output: {
120
+ readonly default: false;
121
+ readonly description: "Whether the first matching file replaces the primary dataset output.";
100
122
  readonly title: "Assign Primary Output";
101
123
  readonly type: "boolean";
102
124
  };
@@ -106,10 +128,14 @@ export declare const userToolSourceSchema: {
106
128
  }, {
107
129
  readonly type: "null";
108
130
  }];
131
+ readonly default: null;
132
+ readonly description: "Directory to search, relative to the job working directory.";
109
133
  readonly title: "Directory";
110
134
  };
111
135
  readonly discover_via: {
112
136
  readonly const: "pattern";
137
+ readonly default: "pattern";
138
+ readonly description: "Discover datasets by matching files produced by the command.";
113
139
  readonly title: "Discover Via";
114
140
  readonly type: "string";
115
141
  };
@@ -119,45 +145,60 @@ export declare const userToolSourceSchema: {
119
145
  }, {
120
146
  readonly type: "null";
121
147
  }];
148
+ readonly default: null;
149
+ readonly description: "Galaxy datatype extension assigned to each discovered dataset.";
122
150
  readonly title: "Format";
123
151
  };
124
152
  readonly match_relative_path: {
153
+ readonly default: false;
154
+ readonly description: "Whether `pattern` matches each file's relative path instead of only its filename.";
125
155
  readonly title: "Match Relative Path";
126
156
  readonly type: "boolean";
127
157
  };
128
158
  readonly pattern: {
159
+ readonly description: "Regular expression matched against produced filenames. Named groups such as `name`, `designation`, `ext`, and `dbkey` set discovered dataset metadata.";
129
160
  readonly title: "Pattern";
130
161
  readonly type: "string";
131
162
  };
132
163
  readonly recurse: {
164
+ readonly default: false;
165
+ readonly description: "Whether to search recursively below `directory`.";
133
166
  readonly title: "Recurse";
134
167
  readonly type: "boolean";
135
168
  };
136
169
  readonly sort_comp: {
170
+ readonly default: "lexical";
171
+ readonly description: "Whether the sort key is compared as text or as a number.";
137
172
  readonly enum: readonly ["lexical", "numeric"];
138
173
  readonly title: "Sort Comp";
139
174
  readonly type: "string";
140
175
  };
141
176
  readonly sort_key: {
177
+ readonly default: "filename";
178
+ readonly description: "Discovered metadata used to order matching files.";
142
179
  readonly enum: readonly ["filename", "name", "designation", "dbkey"];
143
180
  readonly title: "Sort Key";
144
181
  readonly type: "string";
145
182
  };
146
183
  readonly sort_reverse: {
147
184
  readonly default: false;
185
+ readonly description: "Whether to reverse the discovered dataset order.";
148
186
  readonly title: "Sort Reverse";
149
187
  readonly type: "boolean";
150
188
  };
151
189
  readonly visible: {
190
+ readonly default: false;
191
+ readonly description: "Whether discovered datasets are visible in the history.";
152
192
  readonly title: "Visible";
153
193
  readonly type: "boolean";
154
194
  };
155
195
  };
156
- readonly required: readonly ["discover_via", "format", "visible", "assign_primary_output", "directory", "recurse", "match_relative_path", "sort_key", "sort_comp", "pattern"];
196
+ readonly required: readonly ["pattern"];
157
197
  readonly title: "FilePatternDatasetCollectionDescription";
158
198
  readonly type: "object";
159
199
  };
160
200
  readonly HelpContent: {
201
+ readonly additionalProperties: false;
161
202
  readonly properties: {
162
203
  readonly content: {
163
204
  readonly title: "Content";
@@ -175,19 +216,28 @@ export declare const userToolSourceSchema: {
175
216
  };
176
217
  readonly InRangeParameterValidatorModel: {
177
218
  readonly additionalProperties: false;
219
+ readonly description: "Require a numeric value to fall within optional lower and upper bounds.";
220
+ readonly examples: readonly [{
221
+ readonly max: 1;
222
+ readonly min: 0;
223
+ readonly type: "in_range";
224
+ }];
178
225
  readonly properties: {
179
226
  readonly exclude_max: {
180
227
  readonly default: false;
228
+ readonly description: "Whether a value equal to `max` is rejected.";
181
229
  readonly title: "Exclude Max";
182
230
  readonly type: "boolean";
183
231
  };
184
232
  readonly exclude_min: {
185
233
  readonly default: false;
234
+ readonly description: "Whether a value equal to `min` is rejected.";
186
235
  readonly title: "Exclude Min";
187
236
  readonly type: "boolean";
188
237
  };
189
238
  readonly implicit: {
190
239
  readonly default: false;
240
+ readonly description: "Set internally when Galaxy added the validator automatically; tool authors normally leave this false.";
191
241
  readonly title: "Implicit";
192
242
  readonly type: "boolean";
193
243
  };
@@ -200,6 +250,7 @@ export declare const userToolSourceSchema: {
200
250
  readonly type: "null";
201
251
  }];
202
252
  readonly default: null;
253
+ readonly description: "Rejects larger values; omit to leave the range without an upper bound.";
203
254
  readonly title: "Max";
204
255
  };
205
256
  readonly message: {
@@ -209,6 +260,7 @@ export declare const userToolSourceSchema: {
209
260
  readonly type: "null";
210
261
  }];
211
262
  readonly default: null;
263
+ readonly description: "Error message shown when validation fails; `%s` is replaced with the rejected value.";
212
264
  readonly title: "Message";
213
265
  };
214
266
  readonly min: {
@@ -220,24 +272,43 @@ export declare const userToolSourceSchema: {
220
272
  readonly type: "null";
221
273
  }];
222
274
  readonly default: null;
275
+ readonly description: "Rejects smaller values; omit to leave the range without a lower bound.";
223
276
  readonly title: "Min";
224
277
  };
225
278
  readonly negate: {
226
279
  readonly default: false;
280
+ readonly description: "Reject values inside the configured range instead of values outside it.";
227
281
  readonly title: "Negate";
228
282
  readonly type: "boolean";
229
283
  };
230
284
  readonly type: {
231
285
  readonly const: "in_range";
232
286
  readonly default: "in_range";
287
+ readonly description: "Enforces the numeric boundaries configured by `min` and `max`.";
233
288
  readonly title: "Type";
234
289
  readonly type: "string";
235
290
  };
236
291
  };
237
292
  readonly title: "InRangeParameterValidatorModel";
238
293
  readonly type: "object";
294
+ readonly "x-parameter-example": {
295
+ readonly label: "Score threshold";
296
+ readonly name: "threshold";
297
+ readonly type: "float";
298
+ readonly validators: readonly [{
299
+ readonly max: 1;
300
+ readonly min: 0;
301
+ readonly type: "in_range";
302
+ }];
303
+ readonly value: 0.5;
304
+ };
239
305
  };
240
- readonly IncomingToolOutputCollection: {
306
+ readonly IncomingToolOutputBoolean: {
307
+ readonly description: "A boolean value emitted as a workflow-visible scalar output.";
308
+ readonly examples: readonly [{
309
+ readonly name: "matched";
310
+ readonly type: "boolean";
311
+ }];
241
312
  readonly properties: {
242
313
  readonly hidden: {
243
314
  readonly anyOf: readonly [{
@@ -256,9 +327,125 @@ export declare const userToolSourceSchema: {
256
327
  readonly type: "null";
257
328
  }];
258
329
  readonly default: null;
259
- readonly description: "Output label. Will be used as dataset name in history.";
330
+ readonly description: "Name shown for the produced dataset or collection in the history.";
331
+ readonly title: "Label";
332
+ };
333
+ readonly name: {
334
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
335
+ readonly title: "Name";
336
+ readonly type: "string";
337
+ };
338
+ readonly type: {
339
+ readonly const: "boolean";
340
+ readonly title: "Type";
341
+ readonly type: "string";
342
+ };
343
+ };
344
+ readonly required: readonly ["name", "type"];
345
+ readonly title: "IncomingToolOutputBoolean";
346
+ readonly type: "object";
347
+ };
348
+ readonly IncomingToolOutputCollection: {
349
+ readonly additionalProperties: false;
350
+ readonly description: "A dataset collection populated by discovering files produced by the command.";
351
+ readonly examples: readonly [{
352
+ readonly collection_type: "list";
353
+ readonly discover_datasets: readonly [{
354
+ readonly format: "txt";
355
+ readonly pattern: "(?P<name>.+)\\.txt";
356
+ }];
357
+ readonly label: "Results";
358
+ readonly name: "results";
359
+ readonly type: "collection";
360
+ }];
361
+ readonly properties: {
362
+ readonly collection_type: {
363
+ readonly anyOf: readonly [{
364
+ readonly type: "string";
365
+ }, {
366
+ readonly type: "null";
367
+ }];
368
+ readonly default: null;
369
+ readonly description: "Fixed structure Galaxy creates for this output, such as `list`, `paired`, or a nested type such as `list:paired`.";
370
+ readonly title: "Collection Type";
371
+ };
372
+ readonly collection_type_source: {
373
+ readonly anyOf: readonly [{
374
+ readonly type: "string";
375
+ }, {
376
+ readonly type: "null";
377
+ }];
378
+ readonly default: null;
379
+ readonly description: "Declared data-collection input whose runtime structure determines this output's collection type.";
380
+ readonly title: "Collection Type Source";
381
+ };
382
+ readonly discover_datasets: {
383
+ readonly anyOf: readonly [{
384
+ readonly items: {
385
+ readonly anyOf: readonly [{
386
+ readonly $ref: "#/$defs/FilePatternDatasetCollectionDescription";
387
+ }, {
388
+ readonly $ref: "#/$defs/ToolProvidedMetadataDatasetCollection";
389
+ }];
390
+ };
391
+ readonly type: "array";
392
+ }, {
393
+ readonly type: "null";
394
+ }];
395
+ readonly default: null;
396
+ readonly description: "Rules used to discover and populate collection elements from produced files.";
397
+ readonly title: "Discover Datasets";
398
+ };
399
+ readonly format: {
400
+ readonly anyOf: readonly [{
401
+ readonly type: "string";
402
+ }, {
403
+ readonly type: "null";
404
+ }];
405
+ readonly default: null;
406
+ readonly description: "Default datatype extension assigned to collection elements.";
407
+ readonly title: "Format";
408
+ };
409
+ readonly format_source: {
410
+ readonly anyOf: readonly [{
411
+ readonly type: "string";
412
+ }, {
413
+ readonly type: "null";
414
+ }];
415
+ readonly default: null;
416
+ readonly description: "Input whose datatype supplies the default format for collection elements.";
417
+ readonly title: "Format Source";
418
+ };
419
+ readonly hidden: {
420
+ readonly anyOf: readonly [{
421
+ readonly type: "boolean";
422
+ }, {
423
+ readonly type: "null";
424
+ }];
425
+ readonly default: null;
426
+ readonly description: "Hide the output in the history. The dataset is still created and usable by other tools and workflows.";
427
+ readonly title: "Hidden";
428
+ };
429
+ readonly label: {
430
+ readonly anyOf: readonly [{
431
+ readonly type: "string";
432
+ }, {
433
+ readonly type: "null";
434
+ }];
435
+ readonly default: null;
436
+ readonly description: "Name shown for the produced dataset or collection in the history.";
260
437
  readonly title: "Label";
261
438
  };
439
+ readonly metadata_source: {
440
+ readonly anyOf: readonly [{
441
+ readonly type: "string";
442
+ }, {
443
+ readonly type: "null";
444
+ }];
445
+ readonly default: null;
446
+ readonly description: "Dataset input whose metadata supplies defaults for collection elements.";
447
+ readonly title: "Metadata Source";
448
+ };
262
449
  readonly name: {
263
450
  readonly anyOf: readonly [{
264
451
  readonly type: "string";
@@ -266,23 +453,39 @@ export declare const userToolSourceSchema: {
266
453
  readonly type: "null";
267
454
  }];
268
455
  readonly default: null;
269
- readonly description: "Parameter name. Used when referencing parameter in workflows.";
456
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
270
457
  readonly title: "Name";
271
458
  };
272
- readonly structure: {
273
- readonly $ref: "#/$defs/ToolOutputCollectionStructure";
459
+ readonly structured_like: {
460
+ readonly anyOf: readonly [{
461
+ readonly type: "string";
462
+ }, {
463
+ readonly type: "null";
464
+ }];
465
+ readonly default: null;
466
+ readonly description: "Declared input whose element count, identifiers, and nesting this output mirrors. Use this when each produced element corresponds to an input element.";
467
+ readonly title: "Structured Like";
274
468
  };
275
469
  readonly type: {
276
470
  readonly const: "collection";
471
+ readonly description: "Creates one history dataset collection populated from files produced by the command.";
277
472
  readonly title: "Type";
278
473
  readonly type: "string";
279
474
  };
280
475
  };
281
- readonly required: readonly ["type", "structure"];
476
+ readonly required: readonly ["type"];
282
477
  readonly title: "IncomingToolOutputCollection";
283
478
  readonly type: "object";
284
479
  };
285
480
  readonly IncomingToolOutputDataset: {
481
+ readonly description: "A dataset collected from a file produced in the job working directory.";
482
+ readonly examples: readonly [{
483
+ readonly format: "txt";
484
+ readonly from_work_dir: "result.txt";
485
+ readonly label: "Result";
486
+ readonly name: "result";
487
+ readonly type: "data";
488
+ }];
286
489
  readonly properties: {
287
490
  readonly discover_datasets: {
288
491
  readonly anyOf: readonly [{
@@ -298,6 +501,7 @@ export declare const userToolSourceSchema: {
298
501
  readonly type: "null";
299
502
  }];
300
503
  readonly default: null;
504
+ readonly description: "Rules for discovering additional datasets produced by the command.";
301
505
  readonly title: "Discover Datasets";
302
506
  };
303
507
  readonly format: {
@@ -307,7 +511,7 @@ export declare const userToolSourceSchema: {
307
511
  readonly type: "null";
308
512
  }];
309
513
  readonly default: null;
310
- readonly description: "The short name for the output datatype.";
514
+ readonly description: "Galaxy datatype extension assigned when the command always produces a fixed representation. Use `format_source` instead when the datatype depends on an input.";
311
515
  readonly title: "Format";
312
516
  };
313
517
  readonly format_source: {
@@ -317,7 +521,7 @@ export declare const userToolSourceSchema: {
317
521
  readonly type: "null";
318
522
  }];
319
523
  readonly default: null;
320
- readonly description: "This sets the data type of the output dataset(s) to be the same format as that of the specified tool input.";
524
+ readonly description: "Data or collection input whose datatype extension this output inherits. Use this when the command preserves the input representation, such as filtering reads without changing their format.";
321
525
  readonly title: "Format Source";
322
526
  };
323
527
  readonly from_work_dir: {
@@ -327,7 +531,7 @@ export declare const userToolSourceSchema: {
327
531
  readonly type: "null";
328
532
  }];
329
533
  readonly default: null;
330
- readonly description: "Relative path to a file produced by the tool in its working directory. Output’s contents are set to this file’s contents.";
534
+ readonly description: "Relative path, inside the job working directory, that the command writes for this output. Galaxy claims that file after the command finishes.";
331
535
  readonly title: "from_work_dir";
332
536
  };
333
537
  readonly hidden: {
@@ -337,7 +541,7 @@ export declare const userToolSourceSchema: {
337
541
  readonly type: "null";
338
542
  }];
339
543
  readonly default: null;
340
- readonly description: "If true, the output will not be shown in the history.";
544
+ readonly description: "Hide the output in the history. The dataset is still created and usable by other tools and workflows.";
341
545
  readonly title: "Hidden";
342
546
  };
343
547
  readonly label: {
@@ -347,7 +551,7 @@ export declare const userToolSourceSchema: {
347
551
  readonly type: "null";
348
552
  }];
349
553
  readonly default: null;
350
- readonly description: "Output label. Will be used as dataset name in history.";
554
+ readonly description: "Name shown for the produced dataset or collection in the history.";
351
555
  readonly title: "Label";
352
556
  };
353
557
  readonly metadata_source: {
@@ -357,7 +561,7 @@ export declare const userToolSourceSchema: {
357
561
  readonly type: "null";
358
562
  }];
359
563
  readonly default: null;
360
- readonly description: "This copies the metadata information from the tool’s input dataset to serve as default for information that cannot be detected from the output. One prominent use case is interval data with a non-standard column order that cannot be deduced from a header line, but which is known to be identical in the input and output datasets.";
564
+ readonly description: "Data input whose datatype-specific metadata this output copies as defaults. Use this when the command preserves metadata Galaxy cannot infer from the output, such as interval column assignments.";
361
565
  readonly title: "Metadata Source";
362
566
  };
363
567
  readonly name: {
@@ -367,7 +571,7 @@ export declare const userToolSourceSchema: {
367
571
  readonly type: "null";
368
572
  }];
369
573
  readonly default: null;
370
- readonly description: "Parameter name. Used when referencing parameter in workflows.";
574
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
371
575
  readonly title: "Name";
372
576
  };
373
577
  readonly precreate_directory: {
@@ -377,10 +581,12 @@ export declare const userToolSourceSchema: {
377
581
  readonly type: "null";
378
582
  }];
379
583
  readonly default: false;
584
+ readonly description: "Set true when `from_work_dir` names a produced directory for a composite datatype. Galaxy copies the directory contents into the output dataset's extra-files area.";
380
585
  readonly title: "Precreate Directory";
381
586
  };
382
587
  readonly type: {
383
588
  readonly const: "data";
589
+ readonly description: "Creates one history dataset from a file produced by the command.";
384
590
  readonly title: "Type";
385
591
  readonly type: "string";
386
592
  };
@@ -389,12 +595,549 @@ export declare const userToolSourceSchema: {
389
595
  readonly title: "IncomingToolOutputDataset";
390
596
  readonly type: "object";
391
597
  };
598
+ readonly IncomingToolOutputFloat: {
599
+ readonly description: "A floating-point value emitted as a workflow-visible scalar output.";
600
+ readonly examples: readonly [{
601
+ readonly name: "score";
602
+ readonly type: "float";
603
+ }];
604
+ readonly properties: {
605
+ readonly hidden: {
606
+ readonly anyOf: readonly [{
607
+ readonly type: "boolean";
608
+ }, {
609
+ readonly type: "null";
610
+ }];
611
+ readonly default: null;
612
+ readonly description: "If true, the output will not be shown in the history.";
613
+ readonly title: "Hidden";
614
+ };
615
+ readonly label: {
616
+ readonly anyOf: readonly [{
617
+ readonly type: "string";
618
+ }, {
619
+ readonly type: "null";
620
+ }];
621
+ readonly default: null;
622
+ readonly description: "Name shown for the produced dataset or collection in the history.";
623
+ readonly title: "Label";
624
+ };
625
+ readonly name: {
626
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
627
+ readonly title: "Name";
628
+ readonly type: "string";
629
+ };
630
+ readonly type: {
631
+ readonly const: "float";
632
+ readonly title: "Type";
633
+ readonly type: "string";
634
+ };
635
+ };
636
+ readonly required: readonly ["name", "type"];
637
+ readonly title: "IncomingToolOutputFloat";
638
+ readonly type: "object";
639
+ };
640
+ readonly IncomingToolOutputInteger: {
641
+ readonly description: "An integer value emitted as a workflow-visible scalar output.";
642
+ readonly examples: readonly [{
643
+ readonly name: "match_count";
644
+ readonly type: "integer";
645
+ }];
646
+ readonly properties: {
647
+ readonly hidden: {
648
+ readonly anyOf: readonly [{
649
+ readonly type: "boolean";
650
+ }, {
651
+ readonly type: "null";
652
+ }];
653
+ readonly default: null;
654
+ readonly description: "If true, the output will not be shown in the history.";
655
+ readonly title: "Hidden";
656
+ };
657
+ readonly label: {
658
+ readonly anyOf: readonly [{
659
+ readonly type: "string";
660
+ }, {
661
+ readonly type: "null";
662
+ }];
663
+ readonly default: null;
664
+ readonly description: "Name shown for the produced dataset or collection in the history.";
665
+ readonly title: "Label";
666
+ };
667
+ readonly name: {
668
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
669
+ readonly title: "Name";
670
+ readonly type: "string";
671
+ };
672
+ readonly type: {
673
+ readonly const: "integer";
674
+ readonly title: "Type";
675
+ readonly type: "string";
676
+ };
677
+ };
678
+ readonly required: readonly ["name", "type"];
679
+ readonly title: "IncomingToolOutputInteger";
680
+ readonly type: "object";
681
+ };
682
+ readonly IncomingToolOutputText: {
683
+ readonly description: "A text value emitted as a workflow-visible scalar output.";
684
+ readonly examples: readonly [{
685
+ readonly name: "message";
686
+ readonly type: "text";
687
+ }];
688
+ readonly properties: {
689
+ readonly hidden: {
690
+ readonly anyOf: readonly [{
691
+ readonly type: "boolean";
692
+ }, {
693
+ readonly type: "null";
694
+ }];
695
+ readonly default: null;
696
+ readonly description: "If true, the output will not be shown in the history.";
697
+ readonly title: "Hidden";
698
+ };
699
+ readonly label: {
700
+ readonly anyOf: readonly [{
701
+ readonly type: "string";
702
+ }, {
703
+ readonly type: "null";
704
+ }];
705
+ readonly default: null;
706
+ readonly description: "Name shown for the produced dataset or collection in the history.";
707
+ readonly title: "Label";
708
+ };
709
+ readonly name: {
710
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
711
+ readonly title: "Name";
712
+ readonly type: "string";
713
+ };
714
+ readonly type: {
715
+ readonly const: "text";
716
+ readonly title: "Type";
717
+ readonly type: "string";
718
+ };
719
+ };
720
+ readonly required: readonly ["name", "type"];
721
+ readonly title: "IncomingToolOutputText";
722
+ readonly type: "object";
723
+ };
724
+ readonly IncomingUserToolOutputCollection: {
725
+ readonly additionalProperties: false;
726
+ readonly description: "A user-defined tool collection populated only by matching produced filenames.";
727
+ readonly examples: readonly [{
728
+ readonly collection_type: "list";
729
+ readonly discover_datasets: readonly [{
730
+ readonly format: "txt";
731
+ readonly pattern: "(?P<name>.+)\\.txt";
732
+ }];
733
+ readonly label: "Results";
734
+ readonly name: "results";
735
+ readonly type: "collection";
736
+ }];
737
+ readonly properties: {
738
+ readonly collection_type: {
739
+ readonly anyOf: readonly [{
740
+ readonly type: "string";
741
+ }, {
742
+ readonly type: "null";
743
+ }];
744
+ readonly default: null;
745
+ readonly description: "Fixed structure Galaxy creates for this output, such as `list`, `paired`, or a nested type such as `list:paired`.";
746
+ readonly title: "Collection Type";
747
+ };
748
+ readonly collection_type_source: {
749
+ readonly anyOf: readonly [{
750
+ readonly type: "string";
751
+ }, {
752
+ readonly type: "null";
753
+ }];
754
+ readonly default: null;
755
+ readonly description: "Declared data-collection input whose runtime structure determines this output's collection type.";
756
+ readonly title: "Collection Type Source";
757
+ };
758
+ readonly discover_datasets: {
759
+ readonly anyOf: readonly [{
760
+ readonly items: {
761
+ readonly $ref: "#/$defs/FilePatternDatasetCollectionDescription";
762
+ };
763
+ readonly type: "array";
764
+ }, {
765
+ readonly type: "null";
766
+ }];
767
+ readonly default: null;
768
+ readonly description: "Filename pattern used to discover and populate collection elements.";
769
+ readonly title: "Discover Datasets";
770
+ };
771
+ readonly format: {
772
+ readonly anyOf: readonly [{
773
+ readonly type: "string";
774
+ }, {
775
+ readonly type: "null";
776
+ }];
777
+ readonly default: null;
778
+ readonly description: "Default datatype extension assigned to collection elements.";
779
+ readonly title: "Format";
780
+ };
781
+ readonly format_source: {
782
+ readonly anyOf: readonly [{
783
+ readonly type: "string";
784
+ }, {
785
+ readonly type: "null";
786
+ }];
787
+ readonly default: null;
788
+ readonly description: "Input whose datatype supplies the default format for collection elements.";
789
+ readonly title: "Format Source";
790
+ };
791
+ readonly hidden: {
792
+ readonly anyOf: readonly [{
793
+ readonly type: "boolean";
794
+ }, {
795
+ readonly type: "null";
796
+ }];
797
+ readonly default: null;
798
+ readonly description: "Hide the output in the history. The dataset is still created and usable by other tools and workflows.";
799
+ readonly title: "Hidden";
800
+ };
801
+ readonly label: {
802
+ readonly anyOf: readonly [{
803
+ readonly maxLength: 250;
804
+ readonly type: "string";
805
+ }, {
806
+ readonly type: "null";
807
+ }];
808
+ readonly default: null;
809
+ readonly description: "Name shown for the produced dataset or collection in the history. `$(inputs.<name>)` and `$(runtime.on_string)` references are filled in when the job is created.";
810
+ readonly title: "Label";
811
+ };
812
+ readonly metadata_source: {
813
+ readonly anyOf: readonly [{
814
+ readonly type: "string";
815
+ }, {
816
+ readonly type: "null";
817
+ }];
818
+ readonly default: null;
819
+ readonly description: "Dataset input whose metadata supplies defaults for collection elements.";
820
+ readonly title: "Metadata Source";
821
+ };
822
+ readonly name: {
823
+ readonly anyOf: readonly [{
824
+ readonly type: "string";
825
+ }, {
826
+ readonly type: "null";
827
+ }];
828
+ readonly default: null;
829
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
830
+ readonly title: "Name";
831
+ };
832
+ readonly structured_like: {
833
+ readonly anyOf: readonly [{
834
+ readonly type: "string";
835
+ }, {
836
+ readonly type: "null";
837
+ }];
838
+ readonly default: null;
839
+ readonly description: "Declared input whose element count, identifiers, and nesting this output mirrors. Use this when each produced element corresponds to an input element.";
840
+ readonly title: "Structured Like";
841
+ };
842
+ readonly type: {
843
+ readonly const: "collection";
844
+ readonly description: "Creates one history dataset collection populated from files produced by the command.";
845
+ readonly title: "Type";
846
+ readonly type: "string";
847
+ };
848
+ };
849
+ readonly required: readonly ["type"];
850
+ readonly title: "IncomingUserToolOutputCollection";
851
+ readonly type: "object";
852
+ readonly "x-usage-examples": readonly [{
853
+ readonly definition: {
854
+ readonly inputs: readonly [];
855
+ readonly outputs: readonly [{
856
+ readonly collection_type: "list";
857
+ readonly discover_datasets: readonly [{
858
+ readonly directory: "reports";
859
+ readonly format: "tabular";
860
+ readonly pattern: "(?P<name>.+)\\.tsv";
861
+ }];
862
+ readonly name: "reports";
863
+ readonly type: "collection";
864
+ }];
865
+ readonly shell_command: "mkdir reports && printf 'sample\\tvalue\\nA\\t1\\n' > reports/A.tsv && printf 'sample\\tvalue\\nB\\t2\\n' > reports/B.tsv";
866
+ };
867
+ readonly description: "`collection_type` can be used to declare a fixed output structure. A `list` contains an ordered set of discovered elements; `paired` requires `forward` and `reverse` identifiers.";
868
+ readonly field: "collection_type";
869
+ }, {
870
+ readonly definition: {
871
+ readonly inputs: readonly [{
872
+ readonly collection_type: "paired";
873
+ readonly format: readonly ["fastqsanger"];
874
+ readonly name: "reads";
875
+ readonly type: "data_collection";
876
+ }];
877
+ readonly outputs: readonly [{
878
+ readonly collection_type_source: "reads";
879
+ readonly discover_datasets: readonly [{
880
+ readonly directory: "copied";
881
+ readonly format: "fastqsanger";
882
+ readonly pattern: "(?P<name>forward|reverse)\\.fastq";
883
+ }];
884
+ readonly name: "copied_reads";
885
+ readonly type: "collection";
886
+ }];
887
+ readonly shell_command: "mkdir copied && cp '$(inputs.reads.elements.forward.path)' copied/forward.fastq && cp '$(inputs.reads.elements.reverse.path)' copied/reverse.fastq";
888
+ };
889
+ readonly description: "`collection_type_source` can be used when the output has the same runtime collection type as a declared data-collection input, including when that input accepts more than one structure.";
890
+ readonly field: "collection_type_source";
891
+ }, {
892
+ readonly definition: {
893
+ readonly inputs: readonly [{
894
+ readonly collection_type: "paired";
895
+ readonly format: readonly ["fastqsanger"];
896
+ readonly name: "reads";
897
+ readonly type: "data_collection";
898
+ }];
899
+ readonly outputs: readonly [{
900
+ readonly collection_type: "paired";
901
+ readonly discover_datasets: readonly [{
902
+ readonly directory: "trimmed";
903
+ readonly format: "fastqsanger";
904
+ readonly pattern: "(?P<name>forward|reverse)\\.fastq";
905
+ }];
906
+ readonly name: "trimmed_reads";
907
+ readonly structured_like: "reads";
908
+ readonly type: "collection";
909
+ }];
910
+ readonly shell_command: "mkdir trimmed && head -n 400 '$(inputs.reads.elements.forward.path)' > trimmed/forward.fastq && head -n 400 '$(inputs.reads.elements.reverse.path)' > trimmed/reverse.fastq";
911
+ };
912
+ readonly description: "`structured_like` can be used when each produced element corresponds to an element of a declared input. Galaxy mirrors that input's element identifiers and nesting in the output.";
913
+ readonly field: "structured_like";
914
+ }];
915
+ };
916
+ readonly IncomingUserToolOutputDataset: {
917
+ readonly additionalProperties: false;
918
+ readonly description: "A user-defined tool dataset discovered only from files inside the job working directory.";
919
+ readonly examples: readonly [{
920
+ readonly format: "txt";
921
+ readonly from_work_dir: "result.txt";
922
+ readonly label: "Result";
923
+ readonly name: "result";
924
+ readonly type: "data";
925
+ }];
926
+ readonly properties: {
927
+ readonly discover_datasets: {
928
+ readonly anyOf: readonly [{
929
+ readonly items: {
930
+ readonly $ref: "#/$defs/FilePatternDatasetCollectionDescription";
931
+ };
932
+ readonly type: "array";
933
+ }, {
934
+ readonly type: "null";
935
+ }];
936
+ readonly default: null;
937
+ readonly description: "Filename pattern used to discover additional datasets produced by the command.";
938
+ readonly title: "Discover Datasets";
939
+ };
940
+ readonly format: {
941
+ readonly anyOf: readonly [{
942
+ readonly type: "string";
943
+ }, {
944
+ readonly type: "null";
945
+ }];
946
+ readonly default: null;
947
+ readonly description: "Galaxy datatype extension assigned when the command always produces a fixed representation. Use `format_source` instead when the datatype depends on an input.";
948
+ readonly title: "Format";
949
+ };
950
+ readonly format_source: {
951
+ readonly anyOf: readonly [{
952
+ readonly type: "string";
953
+ }, {
954
+ readonly type: "null";
955
+ }];
956
+ readonly default: null;
957
+ readonly description: "Data or collection input whose datatype extension this output inherits. Use this when the command preserves the input representation, such as filtering reads without changing their format.";
958
+ readonly title: "Format Source";
959
+ };
960
+ readonly from_work_dir: {
961
+ readonly anyOf: readonly [{
962
+ readonly type: "string";
963
+ }, {
964
+ readonly type: "null";
965
+ }];
966
+ readonly default: null;
967
+ readonly description: "Relative path, inside the job working directory, that the command writes for this output. Galaxy claims that file after the command finishes.";
968
+ readonly title: "from_work_dir";
969
+ };
970
+ readonly hidden: {
971
+ readonly anyOf: readonly [{
972
+ readonly type: "boolean";
973
+ }, {
974
+ readonly type: "null";
975
+ }];
976
+ readonly default: null;
977
+ readonly description: "Hide the output in the history. The dataset is still created and usable by other tools and workflows.";
978
+ readonly title: "Hidden";
979
+ };
980
+ readonly label: {
981
+ readonly anyOf: readonly [{
982
+ readonly maxLength: 250;
983
+ readonly type: "string";
984
+ }, {
985
+ readonly type: "null";
986
+ }];
987
+ readonly default: null;
988
+ readonly description: "Name shown for the produced dataset or collection in the history. `$(inputs.<name>)` and `$(runtime.on_string)` references are filled in when the job is created.";
989
+ readonly title: "Label";
990
+ };
991
+ readonly metadata_source: {
992
+ readonly anyOf: readonly [{
993
+ readonly type: "string";
994
+ }, {
995
+ readonly type: "null";
996
+ }];
997
+ readonly default: null;
998
+ readonly description: "Data input whose datatype-specific metadata this output copies as defaults. Use this when the command preserves metadata Galaxy cannot infer from the output, such as interval column assignments.";
999
+ readonly title: "Metadata Source";
1000
+ };
1001
+ readonly name: {
1002
+ readonly anyOf: readonly [{
1003
+ readonly type: "string";
1004
+ }, {
1005
+ readonly type: "null";
1006
+ }];
1007
+ readonly default: null;
1008
+ readonly description: "Identifier used to connect this output in workflows and address it in tool tests.";
1009
+ readonly title: "Name";
1010
+ };
1011
+ readonly precreate_directory: {
1012
+ readonly anyOf: readonly [{
1013
+ readonly type: "boolean";
1014
+ }, {
1015
+ readonly type: "null";
1016
+ }];
1017
+ readonly default: false;
1018
+ readonly description: "Set true when `from_work_dir` names a produced directory for a composite datatype. Galaxy copies the directory contents into the output dataset's extra-files area.";
1019
+ readonly title: "Precreate Directory";
1020
+ };
1021
+ readonly type: {
1022
+ readonly const: "data";
1023
+ readonly description: "Creates one history dataset from a file produced by the command.";
1024
+ readonly title: "Type";
1025
+ readonly type: "string";
1026
+ };
1027
+ };
1028
+ readonly required: readonly ["type"];
1029
+ readonly title: "IncomingUserToolOutputDataset";
1030
+ readonly type: "object";
1031
+ readonly "x-usage-examples": readonly [{
1032
+ readonly definition: {
1033
+ readonly inputs: readonly [{
1034
+ readonly format: readonly ["fastqsanger"];
1035
+ readonly name: "reads";
1036
+ readonly type: "data";
1037
+ }];
1038
+ readonly outputs: readonly [{
1039
+ readonly format: "fastqsanger";
1040
+ readonly from_work_dir: "first.fastq";
1041
+ readonly label: "$(inputs.reads.element_identifier) (first 400 lines)";
1042
+ readonly name: "first_reads";
1043
+ readonly type: "data";
1044
+ }];
1045
+ readonly shell_command: "head -n 400 '$(inputs.reads.path)' > first.fastq";
1046
+ };
1047
+ readonly description: "`label` can be used to name the output after the run's inputs. When the run maps over a collection, `$(inputs.reads.element_identifier)` is the sample name. [Output labels](#output-labels) lists the references a label can use.";
1048
+ readonly field: "label";
1049
+ }, {
1050
+ readonly definition: {
1051
+ readonly inputs: readonly [];
1052
+ readonly outputs: readonly [{
1053
+ readonly format: "tabular";
1054
+ readonly from_work_dir: "scores.tsv";
1055
+ readonly name: "scores";
1056
+ readonly type: "data";
1057
+ }];
1058
+ readonly shell_command: "printf 'gene\\tscore\\nBRCA1\\t0.95\\n' > scores.tsv";
1059
+ };
1060
+ readonly description: "`format` can be used to assign a fixed Galaxy datatype when every run writes the same representation. The value is a datatype extension, not a filename suffix.";
1061
+ readonly field: "format";
1062
+ }, {
1063
+ readonly definition: {
1064
+ readonly inputs: readonly [{
1065
+ readonly format: readonly ["fastq", "fastqsanger"];
1066
+ readonly name: "reads";
1067
+ readonly type: "data";
1068
+ }];
1069
+ readonly outputs: readonly [{
1070
+ readonly format_source: "reads";
1071
+ readonly from_work_dir: "first.fastq";
1072
+ readonly name: "first_reads";
1073
+ readonly type: "data";
1074
+ }];
1075
+ readonly shell_command: "head -n 400 '$(inputs.reads.path)' > first.fastq";
1076
+ };
1077
+ readonly description: "`format_source` can be used to assign an output the selected input dataset's datatype when the command preserves its representation.";
1078
+ readonly field: "format_source";
1079
+ }, {
1080
+ readonly definition: {
1081
+ readonly inputs: readonly [{
1082
+ readonly format: readonly ["interval"];
1083
+ readonly name: "intervals";
1084
+ readonly type: "data";
1085
+ }];
1086
+ readonly outputs: readonly [{
1087
+ readonly format: "interval";
1088
+ readonly from_work_dir: "filtered.interval";
1089
+ readonly metadata_source: "intervals";
1090
+ readonly name: "filtered_intervals";
1091
+ readonly type: "data";
1092
+ }];
1093
+ readonly shell_command: "awk '$3 > $2' '$(inputs.intervals.path)' > filtered.interval";
1094
+ };
1095
+ readonly description: "`metadata_source` can be used to copy datatype-specific metadata from an input when the command preserves information Galaxy cannot infer from the produced file, such as interval column assignments.";
1096
+ readonly field: "metadata_source";
1097
+ }, {
1098
+ readonly definition: {
1099
+ readonly inputs: readonly [{
1100
+ readonly label: "Message";
1101
+ readonly name: "message";
1102
+ readonly type: "text";
1103
+ }];
1104
+ readonly outputs: readonly [{
1105
+ readonly format: "txt";
1106
+ readonly from_work_dir: "message.txt";
1107
+ readonly name: "message_file";
1108
+ readonly type: "data";
1109
+ }];
1110
+ readonly shell_command: "printf '%s\\n' '$(inputs.message)' > message.txt";
1111
+ };
1112
+ readonly description: "`from_work_dir` can be used to claim a file written by the command. The relative path must match the command's destination and remain inside the job working directory.";
1113
+ readonly field: "from_work_dir";
1114
+ }, {
1115
+ readonly definition: {
1116
+ readonly inputs: readonly [{
1117
+ readonly format: readonly ["fasta"];
1118
+ readonly name: "reference";
1119
+ readonly type: "data";
1120
+ }];
1121
+ readonly outputs: readonly [{
1122
+ readonly format: "bwa_mem2_index";
1123
+ readonly from_work_dir: "index";
1124
+ readonly name: "index";
1125
+ readonly precreate_directory: true;
1126
+ readonly type: "data";
1127
+ }];
1128
+ readonly shell_command: "mkdir index && bwa-mem2 index -p index/reference '$(inputs.reference.path)'";
1129
+ };
1130
+ readonly description: "`precreate_directory` can be used with a directory-backed composite datatype. The command creates the directory named by `from_work_dir`; Galaxy then copies its contents into the output dataset's extra-files area.";
1131
+ readonly field: "precreate_directory";
1132
+ }];
1133
+ };
392
1134
  readonly JavascriptRequirement: {
1135
+ readonly additionalProperties: false;
393
1136
  readonly properties: {
394
1137
  readonly expression_lib: {
395
1138
  readonly anyOf: readonly [{
396
1139
  readonly items: {
397
- readonly description: "Provide Javascript/ECMAScript 5.1 code here that will be available for expressions inside the `shell_command` field.";
1140
+ readonly description: "Provide Javascript/ECMAScript 5.1 code here that will be available for expressions inside `shell_command` and `configfiles[*].content`.";
398
1141
  readonly examples: readonly ["function pickValue() {\n if (inputs.conditional_parameter.test_parameter == \"a\") {\n return inputs.conditional_parameter.integer_parameter\n } else {\n return inputs.conditional_parameter.boolean_parameter\n }\n}"];
399
1142
  readonly title: "expression_lib";
400
1143
  readonly type: "string";
@@ -417,9 +1160,16 @@ export declare const userToolSourceSchema: {
417
1160
  };
418
1161
  readonly LengthParameterValidatorModel: {
419
1162
  readonly additionalProperties: false;
1163
+ readonly description: "Require the number of characters in a text value to fall within optional bounds.";
1164
+ readonly examples: readonly [{
1165
+ readonly max: 20;
1166
+ readonly min: 1;
1167
+ readonly type: "length";
1168
+ }];
420
1169
  readonly properties: {
421
1170
  readonly implicit: {
422
1171
  readonly default: false;
1172
+ readonly description: "Set internally when Galaxy added the validator automatically; tool authors normally leave this false.";
423
1173
  readonly title: "Implicit";
424
1174
  readonly type: "boolean";
425
1175
  };
@@ -430,6 +1180,7 @@ export declare const userToolSourceSchema: {
430
1180
  readonly type: "null";
431
1181
  }];
432
1182
  readonly default: null;
1183
+ readonly description: "Rejects text with more characters; omit to leave the length without an upper bound.";
433
1184
  readonly title: "Max";
434
1185
  };
435
1186
  readonly message: {
@@ -439,6 +1190,7 @@ export declare const userToolSourceSchema: {
439
1190
  readonly type: "null";
440
1191
  }];
441
1192
  readonly default: null;
1193
+ readonly description: "Error message shown when validation fails; `%s` is replaced with the rejected value.";
442
1194
  readonly title: "Message";
443
1195
  };
444
1196
  readonly min: {
@@ -448,28 +1200,63 @@ export declare const userToolSourceSchema: {
448
1200
  readonly type: "null";
449
1201
  }];
450
1202
  readonly default: null;
1203
+ readonly description: "Rejects text with fewer characters; omit to leave the length without a lower bound.";
451
1204
  readonly title: "Min";
452
1205
  };
453
1206
  readonly negate: {
454
1207
  readonly default: false;
1208
+ readonly description: "Reject values whose length is inside the configured range instead of outside it.";
455
1209
  readonly title: "Negate";
456
1210
  readonly type: "boolean";
457
1211
  };
458
1212
  readonly type: {
459
1213
  readonly const: "length";
460
1214
  readonly default: "length";
1215
+ readonly description: "Enforces character-count boundaries on a submitted text value.";
461
1216
  readonly title: "Type";
462
1217
  readonly type: "string";
463
1218
  };
464
1219
  };
465
1220
  readonly title: "LengthParameterValidatorModel";
466
1221
  readonly type: "object";
1222
+ readonly "x-parameter-example": {
1223
+ readonly label: "Sample name";
1224
+ readonly name: "sample_name";
1225
+ readonly type: "text";
1226
+ readonly validators: readonly [{
1227
+ readonly max: 20;
1228
+ readonly min: 1;
1229
+ readonly type: "length";
1230
+ }];
1231
+ };
1232
+ };
1233
+ readonly MarkdownHelpContent: {
1234
+ readonly additionalProperties: false;
1235
+ readonly properties: {
1236
+ readonly content: {
1237
+ readonly title: "Content";
1238
+ readonly type: "string";
1239
+ };
1240
+ readonly format: {
1241
+ readonly const: "markdown";
1242
+ readonly title: "Format";
1243
+ readonly type: "string";
1244
+ };
1245
+ };
1246
+ readonly required: readonly ["format", "content"];
1247
+ readonly title: "MarkdownHelpContent";
1248
+ readonly type: "object";
467
1249
  };
468
1250
  readonly NoOptionsParameterValidatorModel: {
469
1251
  readonly additionalProperties: false;
1252
+ readonly description: "Require a select parameter to have at least one available option.";
1253
+ readonly examples: readonly [{
1254
+ readonly type: "no_options";
1255
+ }];
470
1256
  readonly properties: {
471
1257
  readonly implicit: {
472
1258
  readonly default: false;
1259
+ readonly description: "Set internally when Galaxy added the validator automatically; tool authors normally leave this false.";
473
1260
  readonly title: "Implicit";
474
1261
  readonly type: "boolean";
475
1262
  };
@@ -480,22 +1267,37 @@ export declare const userToolSourceSchema: {
480
1267
  readonly type: "null";
481
1268
  }];
482
1269
  readonly default: null;
1270
+ readonly description: "Error message shown when validation fails; `%s` is replaced with the rejected value.";
483
1271
  readonly title: "Message";
484
1272
  };
485
1273
  readonly negate: {
486
1274
  readonly default: false;
1275
+ readonly description: "Require the select parameter to have no available options instead.";
487
1276
  readonly title: "Negate";
488
1277
  readonly type: "boolean";
489
1278
  };
490
1279
  readonly type: {
491
1280
  readonly const: "no_options";
492
1281
  readonly default: "no_options";
1282
+ readonly description: "Fails validation when a select input has no choices available.";
493
1283
  readonly title: "Type";
494
1284
  readonly type: "string";
495
1285
  };
496
1286
  };
497
1287
  readonly title: "NoOptionsParameterValidatorModel";
498
1288
  readonly type: "object";
1289
+ readonly "x-parameter-example": {
1290
+ readonly label: "Reference database";
1291
+ readonly name: "database";
1292
+ readonly options: readonly [{
1293
+ readonly label: "Human";
1294
+ readonly value: "human";
1295
+ }];
1296
+ readonly type: "select";
1297
+ readonly validators: readonly [{
1298
+ readonly type: "no_options";
1299
+ }];
1300
+ };
499
1301
  };
500
1302
  readonly OutputCompareType: {
501
1303
  readonly enum: readonly ["diff", "re_match", "sim_size", "re_match_multiline", "contains", "image_diff"];
@@ -504,14 +1306,20 @@ export declare const userToolSourceSchema: {
504
1306
  };
505
1307
  readonly RegexParameterValidatorModel: {
506
1308
  readonly additionalProperties: false;
507
- readonly description: "Check if a regular expression **matches** the value, i.e. appears\nat the beginning of the value. To enforce a match of the complete value use\n``$`` at the end of the expression. The expression is given is the content\nof the validator tag. Note that for ``selects`` each option is checked\nseparately.";
1309
+ readonly description: "Require a regular expression to match from the start of the value.\n\nEnd the expression with ``$`` to require a full-value match. Each option of\na select parameter is checked separately.";
1310
+ readonly examples: readonly [{
1311
+ readonly expression: "^[ACGT]+$";
1312
+ readonly type: "regex";
1313
+ }];
508
1314
  readonly properties: {
509
1315
  readonly expression: {
1316
+ readonly description: "Regular expression matched from the start of the value. Add `$` at the end to require a complete-value match.";
510
1317
  readonly title: "Expression";
511
1318
  readonly type: "string";
512
1319
  };
513
1320
  readonly implicit: {
514
1321
  readonly default: false;
1322
+ readonly description: "Set internally when Galaxy added the validator automatically; tool authors normally leave this false.";
515
1323
  readonly title: "Implicit";
516
1324
  readonly type: "boolean";
517
1325
  };
@@ -522,16 +1330,19 @@ export declare const userToolSourceSchema: {
522
1330
  readonly type: "null";
523
1331
  }];
524
1332
  readonly default: null;
1333
+ readonly description: "Error message shown when validation fails; `%s` is replaced with the rejected value.";
525
1334
  readonly title: "Message";
526
1335
  };
527
1336
  readonly negate: {
528
1337
  readonly default: false;
1338
+ readonly description: "Reject matching values instead of values that do not match.";
529
1339
  readonly title: "Negate";
530
1340
  readonly type: "boolean";
531
1341
  };
532
1342
  readonly type: {
533
1343
  readonly const: "regex";
534
1344
  readonly default: "regex";
1345
+ readonly description: "Applies the regular expression in `expression` to each submitted text value.";
535
1346
  readonly title: "Type";
536
1347
  readonly type: "string";
537
1348
  };
@@ -539,14 +1350,27 @@ export declare const userToolSourceSchema: {
539
1350
  readonly required: readonly ["expression"];
540
1351
  readonly title: "RegexParameterValidatorModel";
541
1352
  readonly type: "object";
1353
+ readonly "x-parameter-example": {
1354
+ readonly label: "DNA motif";
1355
+ readonly name: "motif";
1356
+ readonly type: "text";
1357
+ readonly validators: readonly [{
1358
+ readonly expression: "^[ACGT]+$";
1359
+ readonly type: "regex";
1360
+ }];
1361
+ };
542
1362
  };
543
1363
  readonly ResourceRequirement: {
1364
+ readonly additionalProperties: false;
1365
+ readonly description: "A tool's compute resource request.\n\nSet the minimum resources needed to run the job and, when useful, an upper\nlimit. Galaxy exposes the allocated CPU count to the command as\n``$GALAXY_SLOTS``. Use numbers or numeric strings. Other strings are\nreserved for expressions, which are not supported yet: a non-numeric value\nfails the create-time lint check.";
544
1366
  readonly properties: {
545
1367
  readonly cores_max: {
546
1368
  readonly anyOf: readonly [{
547
1369
  readonly type: "integer";
548
1370
  }, {
549
1371
  readonly type: "number";
1372
+ }, {
1373
+ readonly type: "string";
550
1374
  }, {
551
1375
  readonly type: "null";
552
1376
  }];
@@ -559,6 +1383,8 @@ export declare const userToolSourceSchema: {
559
1383
  readonly type: "integer";
560
1384
  }, {
561
1385
  readonly type: "number";
1386
+ }, {
1387
+ readonly type: "string";
562
1388
  }, {
563
1389
  readonly type: "null";
564
1390
  }];
@@ -568,57 +1394,72 @@ export declare const userToolSourceSchema: {
568
1394
  };
569
1395
  readonly cuda_compute_capability: {
570
1396
  readonly anyOf: readonly [{
1397
+ readonly type: "integer";
1398
+ }, {
571
1399
  readonly type: "number";
572
1400
  }, {
573
- readonly type: "integer";
1401
+ readonly type: "string";
574
1402
  }, {
575
1403
  readonly type: "null";
576
1404
  }];
577
1405
  readonly default: null;
1406
+ readonly description: "Minimum CUDA compute capability required, e.g. 7.5.";
578
1407
  readonly title: "Cuda Compute Capability";
579
1408
  };
580
1409
  readonly cuda_device_count_max: {
581
1410
  readonly anyOf: readonly [{
1411
+ readonly type: "integer";
1412
+ }, {
582
1413
  readonly type: "number";
583
1414
  }, {
584
- readonly type: "integer";
1415
+ readonly type: "string";
585
1416
  }, {
586
1417
  readonly type: "null";
587
1418
  }];
588
1419
  readonly default: null;
1420
+ readonly description: "Maximum number of GPUs to reserve.";
589
1421
  readonly title: "Cuda Device Count Max";
590
1422
  };
591
1423
  readonly cuda_device_count_min: {
592
1424
  readonly anyOf: readonly [{
1425
+ readonly type: "integer";
1426
+ }, {
593
1427
  readonly type: "number";
594
1428
  }, {
595
- readonly type: "integer";
1429
+ readonly type: "string";
596
1430
  }, {
597
1431
  readonly type: "null";
598
1432
  }];
599
1433
  readonly default: null;
1434
+ readonly description: "Minimum number of GPUs to reserve.";
600
1435
  readonly title: "Cuda Device Count Min";
601
1436
  };
602
1437
  readonly cuda_version_min: {
603
1438
  readonly anyOf: readonly [{
1439
+ readonly type: "integer";
1440
+ }, {
604
1441
  readonly type: "number";
605
1442
  }, {
606
- readonly type: "integer";
1443
+ readonly type: "string";
607
1444
  }, {
608
1445
  readonly type: "null";
609
1446
  }];
610
1447
  readonly default: null;
1448
+ readonly description: "Minimum CUDA runtime version required, e.g. 11.2.";
611
1449
  readonly title: "Cuda Version Min";
612
1450
  };
613
1451
  readonly gpu_memory_min: {
614
1452
  readonly anyOf: readonly [{
1453
+ readonly type: "integer";
1454
+ }, {
615
1455
  readonly type: "number";
616
1456
  }, {
617
- readonly type: "integer";
1457
+ readonly type: "string";
618
1458
  }, {
619
1459
  readonly type: "null";
620
1460
  }];
621
1461
  readonly default: null;
1462
+ readonly description: "Minimum GPU memory required, in mebibytes (2**20).";
622
1463
  readonly title: "Gpu Memory Min";
623
1464
  };
624
1465
  readonly ram_max: {
@@ -626,6 +1467,8 @@ export declare const userToolSourceSchema: {
626
1467
  readonly type: "integer";
627
1468
  }, {
628
1469
  readonly type: "number";
1470
+ }, {
1471
+ readonly type: "string";
629
1472
  }, {
630
1473
  readonly type: "null";
631
1474
  }];
@@ -638,6 +1481,8 @@ export declare const userToolSourceSchema: {
638
1481
  readonly type: "integer";
639
1482
  }, {
640
1483
  readonly type: "number";
1484
+ }, {
1485
+ readonly type: "string";
641
1486
  }, {
642
1487
  readonly type: "null";
643
1488
  }];
@@ -647,13 +1492,16 @@ export declare const userToolSourceSchema: {
647
1492
  };
648
1493
  readonly shm_size: {
649
1494
  readonly anyOf: readonly [{
1495
+ readonly type: "integer";
1496
+ }, {
650
1497
  readonly type: "number";
651
1498
  }, {
652
- readonly type: "integer";
1499
+ readonly type: "string";
653
1500
  }, {
654
1501
  readonly type: "null";
655
1502
  }];
656
1503
  readonly default: null;
1504
+ readonly description: "Size of /dev/shm to request, in bytes.";
657
1505
  readonly title: "Shm Size";
658
1506
  };
659
1507
  readonly timelimit: {
@@ -661,6 +1509,8 @@ export declare const userToolSourceSchema: {
661
1509
  readonly type: "integer";
662
1510
  }, {
663
1511
  readonly type: "number";
1512
+ }, {
1513
+ readonly type: "string";
664
1514
  }, {
665
1515
  readonly type: "null";
666
1516
  }];
@@ -670,24 +1520,30 @@ export declare const userToolSourceSchema: {
670
1520
  };
671
1521
  readonly tmpdir_max: {
672
1522
  readonly anyOf: readonly [{
1523
+ readonly type: "integer";
1524
+ }, {
673
1525
  readonly type: "number";
674
1526
  }, {
675
- readonly type: "integer";
1527
+ readonly type: "string";
676
1528
  }, {
677
1529
  readonly type: "null";
678
1530
  }];
679
1531
  readonly default: null;
1532
+ readonly description: "Maximum reserved temporary directory space, in mebibytes (2**20).";
680
1533
  readonly title: "Tmpdir Max";
681
1534
  };
682
1535
  readonly tmpdir_min: {
683
1536
  readonly anyOf: readonly [{
1537
+ readonly type: "integer";
1538
+ }, {
684
1539
  readonly type: "number";
685
1540
  }, {
686
- readonly type: "integer";
1541
+ readonly type: "string";
687
1542
  }, {
688
1543
  readonly type: "null";
689
1544
  }];
690
1545
  readonly default: null;
1546
+ readonly description: "Minimum reserved temporary directory space, in mebibytes (2**20).";
691
1547
  readonly title: "Tmpdir Min";
692
1548
  };
693
1549
  readonly type: {
@@ -713,6 +1569,15 @@ export declare const userToolSourceSchema: {
713
1569
  readonly default: "Collection";
714
1570
  readonly title: "Class";
715
1571
  };
1572
+ readonly count: {
1573
+ readonly anyOf: readonly [{
1574
+ readonly type: "integer";
1575
+ }, {
1576
+ readonly type: "null";
1577
+ }];
1578
+ readonly default: null;
1579
+ readonly title: "Count";
1580
+ };
716
1581
  readonly element_tests: {
717
1582
  readonly anyOf: readonly [{
718
1583
  readonly additionalProperties: {
@@ -745,6 +1610,24 @@ export declare const userToolSourceSchema: {
745
1610
  readonly default: null;
746
1611
  readonly title: "Elements";
747
1612
  };
1613
+ readonly max: {
1614
+ readonly anyOf: readonly [{
1615
+ readonly type: "integer";
1616
+ }, {
1617
+ readonly type: "null";
1618
+ }];
1619
+ readonly default: null;
1620
+ readonly title: "Maximum Count";
1621
+ };
1622
+ readonly min: {
1623
+ readonly anyOf: readonly [{
1624
+ readonly type: "integer";
1625
+ }, {
1626
+ readonly type: "null";
1627
+ }];
1628
+ readonly default: null;
1629
+ readonly title: "Minimum Count";
1630
+ };
748
1631
  };
749
1632
  readonly title: "TestCollectionCollectionElementAssertions";
750
1633
  readonly type: "object";
@@ -1129,187 +2012,12 @@ export declare const userToolSourceSchema: {
1129
2012
  readonly title: "TestDataOutputAssertions";
1130
2013
  readonly type: "object";
1131
2014
  };
1132
- readonly ToolOutputBoolean: {
1133
- readonly properties: {
1134
- readonly hidden: {
1135
- readonly description: "If true, the output will not be shown in the history.";
1136
- readonly title: "Hidden";
1137
- };
1138
- readonly label: {
1139
- readonly anyOf: readonly [{
1140
- readonly type: "string";
1141
- }, {
1142
- readonly type: "null";
1143
- }];
1144
- readonly default: null;
1145
- readonly description: "Output label. Will be used as dataset name in history.";
1146
- readonly title: "Label";
1147
- };
1148
- readonly name: {
1149
- readonly description: "Parameter name. Used when referencing parameter in workflows.";
1150
- readonly title: "Name";
1151
- };
1152
- readonly type: {
1153
- readonly const: "boolean";
1154
- readonly title: "Type";
1155
- readonly type: "string";
1156
- };
1157
- };
1158
- readonly required: readonly ["name", "hidden", "type"];
1159
- readonly title: "ToolOutputBoolean";
1160
- readonly type: "object";
1161
- };
1162
- readonly ToolOutputCollectionStructure: {
1163
- readonly properties: {
1164
- readonly collection_type: {
1165
- readonly anyOf: readonly [{
1166
- readonly type: "string";
1167
- }, {
1168
- readonly type: "null";
1169
- }];
1170
- readonly default: null;
1171
- readonly title: "Collection Type";
1172
- };
1173
- readonly collection_type_from_rules: {
1174
- readonly anyOf: readonly [{
1175
- readonly type: "string";
1176
- }, {
1177
- readonly type: "null";
1178
- }];
1179
- readonly default: null;
1180
- readonly title: "Collection Type From Rules";
1181
- };
1182
- readonly collection_type_source: {
1183
- readonly anyOf: readonly [{
1184
- readonly type: "string";
1185
- }, {
1186
- readonly type: "null";
1187
- }];
1188
- readonly default: null;
1189
- readonly title: "Collection Type Source";
1190
- };
1191
- readonly discover_datasets: {
1192
- readonly anyOf: readonly [{
1193
- readonly items: {
1194
- readonly anyOf: readonly [{
1195
- readonly $ref: "#/$defs/FilePatternDatasetCollectionDescription";
1196
- }, {
1197
- readonly $ref: "#/$defs/ToolProvidedMetadataDatasetCollection";
1198
- }];
1199
- };
1200
- readonly type: "array";
1201
- }, {
1202
- readonly type: "null";
1203
- }];
1204
- readonly default: null;
1205
- readonly title: "Discover Datasets";
1206
- };
1207
- readonly structured_like: {
1208
- readonly anyOf: readonly [{
1209
- readonly type: "string";
1210
- }, {
1211
- readonly type: "null";
1212
- }];
1213
- readonly default: null;
1214
- readonly title: "Structured Like";
1215
- };
1216
- };
1217
- readonly title: "ToolOutputCollectionStructure";
1218
- readonly type: "object";
1219
- };
1220
- readonly ToolOutputFloat: {
1221
- readonly properties: {
1222
- readonly hidden: {
1223
- readonly description: "If true, the output will not be shown in the history.";
1224
- readonly title: "Hidden";
1225
- };
1226
- readonly label: {
1227
- readonly anyOf: readonly [{
1228
- readonly type: "string";
1229
- }, {
1230
- readonly type: "null";
1231
- }];
1232
- readonly default: null;
1233
- readonly description: "Output label. Will be used as dataset name in history.";
1234
- readonly title: "Label";
1235
- };
1236
- readonly name: {
1237
- readonly description: "Parameter name. Used when referencing parameter in workflows.";
1238
- readonly title: "Name";
1239
- };
1240
- readonly type: {
1241
- readonly const: "float";
1242
- readonly title: "Type";
1243
- readonly type: "string";
1244
- };
1245
- };
1246
- readonly required: readonly ["name", "hidden", "type"];
1247
- readonly title: "ToolOutputFloat";
1248
- readonly type: "object";
1249
- };
1250
- readonly ToolOutputInteger: {
1251
- readonly properties: {
1252
- readonly hidden: {
1253
- readonly description: "If true, the output will not be shown in the history.";
1254
- readonly title: "Hidden";
1255
- };
1256
- readonly label: {
1257
- readonly anyOf: readonly [{
1258
- readonly type: "string";
1259
- }, {
1260
- readonly type: "null";
1261
- }];
1262
- readonly default: null;
1263
- readonly description: "Output label. Will be used as dataset name in history.";
1264
- readonly title: "Label";
1265
- };
1266
- readonly name: {
1267
- readonly description: "Parameter name. Used when referencing parameter in workflows.";
1268
- readonly title: "Name";
1269
- };
1270
- readonly type: {
1271
- readonly const: "integer";
1272
- readonly title: "Type";
1273
- readonly type: "string";
1274
- };
1275
- };
1276
- readonly required: readonly ["name", "hidden", "type"];
1277
- readonly title: "ToolOutputInteger";
1278
- readonly type: "object";
1279
- };
1280
- readonly ToolOutputText: {
1281
- readonly properties: {
1282
- readonly hidden: {
1283
- readonly description: "If true, the output will not be shown in the history.";
1284
- readonly title: "Hidden";
1285
- };
1286
- readonly label: {
1287
- readonly anyOf: readonly [{
1288
- readonly type: "string";
1289
- }, {
1290
- readonly type: "null";
1291
- }];
1292
- readonly default: null;
1293
- readonly description: "Output label. Will be used as dataset name in history.";
1294
- readonly title: "Label";
1295
- };
1296
- readonly name: {
1297
- readonly description: "Parameter name. Used when referencing parameter in workflows.";
1298
- readonly title: "Name";
1299
- };
1300
- readonly type: {
1301
- readonly const: "text";
1302
- readonly title: "Type";
1303
- readonly type: "string";
1304
- };
1305
- };
1306
- readonly required: readonly ["name", "hidden", "type"];
1307
- readonly title: "ToolOutputText";
1308
- readonly type: "object";
1309
- };
1310
2015
  readonly ToolProvidedMetadataDatasetCollection: {
2016
+ readonly additionalProperties: false;
1311
2017
  readonly properties: {
1312
2018
  readonly assign_primary_output: {
2019
+ readonly default: false;
2020
+ readonly description: "Whether the first matching file replaces the primary dataset output.";
1313
2021
  readonly title: "Assign Primary Output";
1314
2022
  readonly type: "boolean";
1315
2023
  };
@@ -1319,10 +2027,13 @@ export declare const userToolSourceSchema: {
1319
2027
  }, {
1320
2028
  readonly type: "null";
1321
2029
  }];
2030
+ readonly default: null;
2031
+ readonly description: "Directory to search, relative to the job working directory.";
1322
2032
  readonly title: "Directory";
1323
2033
  };
1324
2034
  readonly discover_via: {
1325
2035
  readonly const: "tool_provided_metadata";
2036
+ readonly description: "Read discovered dataset details from the tool-provided metadata file.";
1326
2037
  readonly title: "Discover Via";
1327
2038
  readonly type: "string";
1328
2039
  };
@@ -1332,27 +2043,56 @@ export declare const userToolSourceSchema: {
1332
2043
  }, {
1333
2044
  readonly type: "null";
1334
2045
  }];
2046
+ readonly default: null;
2047
+ readonly description: "Galaxy datatype extension assigned to each discovered dataset.";
1335
2048
  readonly title: "Format";
1336
2049
  };
1337
2050
  readonly match_relative_path: {
2051
+ readonly default: false;
2052
+ readonly description: "Whether `pattern` matches each file's relative path instead of only its filename.";
1338
2053
  readonly title: "Match Relative Path";
1339
2054
  readonly type: "boolean";
1340
2055
  };
1341
2056
  readonly recurse: {
2057
+ readonly default: false;
2058
+ readonly description: "Whether to search recursively below `directory`.";
1342
2059
  readonly title: "Recurse";
1343
2060
  readonly type: "boolean";
1344
2061
  };
1345
2062
  readonly visible: {
2063
+ readonly default: false;
2064
+ readonly description: "Whether discovered datasets are visible in the history.";
1346
2065
  readonly title: "Visible";
1347
2066
  readonly type: "boolean";
1348
2067
  };
1349
2068
  };
1350
- readonly required: readonly ["discover_via", "format", "visible", "assign_primary_output", "directory", "recurse", "match_relative_path"];
2069
+ readonly required: readonly ["discover_via"];
1351
2070
  readonly title: "ToolProvidedMetadataDatasetCollection";
1352
2071
  readonly type: "object";
1353
2072
  };
1354
2073
  readonly UserToolSource: {
1355
2074
  readonly additionalProperties: false;
2075
+ readonly description: "Full unprivileged tool source, including the optional ``tests`` block.\n\nThis is the model persisted and validated on the API surface\n(``DynamicUnprivilegedToolCreatePayload.representation``). LLM authoring\nuses the slimmer ``UserToolSourceAuthoringView`` parent; ``tests`` is added\nback here so direct authors and stored rows can still carry tests.";
2076
+ readonly examples: readonly [{
2077
+ readonly class: "GalaxyUserTool";
2078
+ readonly container: "quay.io/biocontainers/grep:3.4--hf43ccf4_4";
2079
+ readonly description: "from a text file";
2080
+ readonly id: "remove_comments";
2081
+ readonly inputs: readonly [{
2082
+ readonly format: readonly ["txt"];
2083
+ readonly name: "input_file";
2084
+ readonly type: "data";
2085
+ }];
2086
+ readonly name: "Remove Comment Lines";
2087
+ readonly outputs: readonly [{
2088
+ readonly format_source: "input_file";
2089
+ readonly from_work_dir: "output.txt";
2090
+ readonly name: "output_file";
2091
+ readonly type: "data";
2092
+ }];
2093
+ readonly shell_command: "grep -v '^#' '$(inputs.input_file.path)' > output.txt || test \"$?\" = 1";
2094
+ readonly version: "0.1.0";
2095
+ }];
1356
2096
  readonly properties: {
1357
2097
  readonly citations: {
1358
2098
  readonly anyOf: readonly [{
@@ -1364,6 +2104,7 @@ export declare const userToolSourceSchema: {
1364
2104
  readonly type: "null";
1365
2105
  }];
1366
2106
  readonly default: null;
2107
+ readonly description: "DOI or BibTeX references for publications describing the wrapped tool.";
1367
2108
  readonly title: "citations";
1368
2109
  };
1369
2110
  readonly class: {
@@ -1381,11 +2122,11 @@ export declare const userToolSourceSchema: {
1381
2122
  readonly type: "null";
1382
2123
  }];
1383
2124
  readonly default: null;
1384
- readonly description: "A list of config files for this tool.";
2125
+ readonly description: "Files Galaxy writes into the job working directory before running the command. Their content is evaluated with the same sandboxed ECMAScript expressions as `shell_command`. Put scripts and other substantial command logic here, then keep `shell_command` to a short invocation.";
1385
2126
  readonly title: "configfiles";
1386
2127
  };
1387
2128
  readonly container: {
1388
- readonly description: "Container image to use for this tool.";
2129
+ readonly description: "Docker container image for the tool, as a fully qualified registry/repository:tag string. This image is the tool's entire execution environment, so every command used by shell_command must already exist in it. Do not prefix the value with 'docker://' -- Galaxy adds that itself for Singularity and Apptainer destinations. An unqualified name is resolved against the container runtime's own default registry (Docker Hub), which is rarely what you want.";
1389
2130
  readonly examples: readonly ["quay.io/biocontainers/python:3.13"];
1390
2131
  readonly title: "container";
1391
2132
  readonly type: "string";
@@ -1410,6 +2151,7 @@ export declare const userToolSourceSchema: {
1410
2151
  readonly type: "null";
1411
2152
  }];
1412
2153
  readonly default: null;
2154
+ readonly description: "EDAM operation identifiers such as `operation_0308`.";
1413
2155
  readonly title: "edam_operations";
1414
2156
  };
1415
2157
  readonly edam_topics: {
@@ -1422,16 +2164,17 @@ export declare const userToolSourceSchema: {
1422
2164
  readonly type: "null";
1423
2165
  }];
1424
2166
  readonly default: null;
2167
+ readonly description: "EDAM topic identifiers such as `topic_0102`.";
1425
2168
  readonly title: "edam_topics";
1426
2169
  };
1427
2170
  readonly help: {
1428
2171
  readonly anyOf: readonly [{
1429
- readonly $ref: "#/$defs/HelpContent";
2172
+ readonly $ref: "#/$defs/MarkdownHelpContent";
1430
2173
  }, {
1431
2174
  readonly type: "null";
1432
2175
  }];
1433
2176
  readonly default: null;
1434
- readonly description: "Help text shown below the tool interface.";
2177
+ readonly description: "Help shown below the tool form. Set `format` to `markdown` and put the documentation in `content`.";
1435
2178
  readonly title: "help";
1436
2179
  };
1437
2180
  readonly id: {
@@ -1450,6 +2193,7 @@ export declare const userToolSourceSchema: {
1450
2193
  };
1451
2194
  readonly inputs: {
1452
2195
  readonly default: readonly [];
2196
+ readonly description: "Parameters displayed on the tool form. Each item needs a unique `name` and a supported `type`. Reference scalar values as `$(inputs.input_name)` and data inputs as `$(inputs.input_name.path)` in `shell_command` or config files. Conditional, repeat, and section inputs contain nested parameters.";
1453
2197
  readonly items: {
1454
2198
  readonly $ref: "#/$defs/YamlGalaxyToolParameter";
1455
2199
  };
@@ -1475,30 +2219,19 @@ export declare const userToolSourceSchema: {
1475
2219
  };
1476
2220
  readonly outputs: {
1477
2221
  readonly default: readonly [];
2222
+ readonly description: "Datasets and dataset collections Galaxy collects after the command finishes. A data output identifies its produced file with `from_work_dir` or `discover_datasets`; a collection output uses `discover_datasets`.";
1478
2223
  readonly items: {
1479
2224
  readonly discriminator: {
1480
2225
  readonly mapping: {
1481
- readonly boolean: "#/$defs/ToolOutputBoolean";
1482
- readonly collection: "#/$defs/IncomingToolOutputCollection";
1483
- readonly data: "#/$defs/IncomingToolOutputDataset";
1484
- readonly float: "#/$defs/ToolOutputFloat";
1485
- readonly integer: "#/$defs/ToolOutputInteger";
1486
- readonly text: "#/$defs/ToolOutputText";
2226
+ readonly collection: "#/$defs/IncomingUserToolOutputCollection";
2227
+ readonly data: "#/$defs/IncomingUserToolOutputDataset";
1487
2228
  };
1488
2229
  readonly propertyName: "type";
1489
2230
  };
1490
2231
  readonly oneOf: readonly [{
1491
- readonly $ref: "#/$defs/IncomingToolOutputDataset";
1492
- }, {
1493
- readonly $ref: "#/$defs/IncomingToolOutputCollection";
2232
+ readonly $ref: "#/$defs/IncomingUserToolOutputDataset";
1494
2233
  }, {
1495
- readonly $ref: "#/$defs/ToolOutputText";
1496
- }, {
1497
- readonly $ref: "#/$defs/ToolOutputInteger";
1498
- }, {
1499
- readonly $ref: "#/$defs/ToolOutputFloat";
1500
- }, {
1501
- readonly $ref: "#/$defs/ToolOutputBoolean";
2234
+ readonly $ref: "#/$defs/IncomingUserToolOutputCollection";
1502
2235
  }];
1503
2236
  };
1504
2237
  readonly title: "outputs";
@@ -1520,8 +2253,6 @@ export declare const userToolSourceSchema: {
1520
2253
  readonly $ref: "#/$defs/JavascriptRequirement";
1521
2254
  }, {
1522
2255
  readonly $ref: "#/$defs/ResourceRequirement";
1523
- }, {
1524
- readonly $ref: "#/$defs/ContainerRequirement";
1525
2256
  }];
1526
2257
  };
1527
2258
  readonly type: "array";
@@ -1529,12 +2260,12 @@ export declare const userToolSourceSchema: {
1529
2260
  readonly type: "null";
1530
2261
  }];
1531
2262
  readonly default: readonly [];
1532
- readonly description: "A list of requirements needed to execute this tool. These can be javascript expressions, resource requirements or container images.";
2263
+ readonly description: "JavaScript helpers and compute resource requests needed to execute this tool.";
1533
2264
  readonly title: "requirements";
1534
2265
  };
1535
2266
  readonly shell_command: {
1536
- readonly description: "A string that contains the command to be executed. Parameters can be referenced inside $().";
1537
- readonly examples: readonly ["head -n '$(inputs.n_lines)' '$(inputs.data_input.path)'"];
2267
+ readonly description: "A string that contains the command to be executed. Reference inputs inside `$()` as `$(inputs.input_name)` for scalar values and `$(inputs.input_name.path)` for files; `${ ... }` evaluates a JavaScript function body that must return a value. Substituted values are not shell-quoted, so quote them yourself. Because `$(` and `${` are consumed by the expression evaluator, shell command substitution and braced parameter expansion do not reach the shell: escape them as `\\$(` and `\\${`, and prefer unbraced variables such as `$GALAXY_SLOTS`.";
2268
+ readonly examples: readonly ["head -n '$(inputs.num_lines)' '$(inputs.input_file.path)' > output.txt"];
1538
2269
  readonly title: "shell_command";
1539
2270
  readonly type: "string";
1540
2271
  };
@@ -1548,18 +2279,14 @@ export declare const userToolSourceSchema: {
1548
2279
  readonly type: "null";
1549
2280
  }];
1550
2281
  readonly default: null;
2282
+ readonly description: "Tool test declarations with input values and expected outputs. Database-stored user-defined tools retain these declarations but do not currently run them in the application.";
1551
2283
  readonly title: "tests";
1552
2284
  };
1553
2285
  readonly version: {
1554
- readonly anyOf: readonly [{
1555
- readonly type: "string";
1556
- }, {
1557
- readonly type: "null";
1558
- }];
1559
- readonly default: null;
1560
2286
  readonly description: "Version for the tool.";
1561
2287
  readonly examples: readonly ["0.1.0"];
1562
2288
  readonly title: "version";
2289
+ readonly type: "string";
1563
2290
  };
1564
2291
  readonly xrefs: {
1565
2292
  readonly anyOf: readonly [{
@@ -1571,12 +2298,14 @@ export declare const userToolSourceSchema: {
1571
2298
  readonly type: "null";
1572
2299
  }];
1573
2300
  readonly default: null;
2301
+ readonly description: "External registry identifiers, each with a registry `type` and identifier `value`.";
1574
2302
  readonly title: "xrefs";
1575
2303
  };
1576
2304
  };
1577
- readonly required: readonly ["name", "shell_command", "class", "container"];
2305
+ readonly required: readonly ["version", "name", "shell_command", "class", "container"];
1578
2306
  readonly title: "UserToolSource";
1579
2307
  readonly type: "object";
2308
+ readonly "x-field-order": readonly ["class", "id", "name", "version", "description", "container", "requirements", "shell_command", "configfiles", "inputs", "outputs", "citations", "license", "profile", "edam_operations", "edam_topics", "xrefs", "help", "tests"];
1580
2309
  };
1581
2310
  readonly XrefDict: {
1582
2311
  readonly additionalProperties: false;
@@ -1596,6 +2325,13 @@ export declare const userToolSourceSchema: {
1596
2325
  };
1597
2326
  readonly YamlBooleanParameter: {
1598
2327
  readonly additionalProperties: false;
2328
+ readonly description: "A true-or-false input.";
2329
+ readonly examples: readonly [{
2330
+ readonly label: "Include a header line";
2331
+ readonly name: "include_header";
2332
+ readonly type: "boolean";
2333
+ readonly value: true;
2334
+ }];
1599
2335
  readonly properties: {
1600
2336
  readonly help: {
1601
2337
  readonly anyOf: readonly [{
@@ -1604,6 +2340,7 @@ export declare const userToolSourceSchema: {
1604
2340
  readonly type: "null";
1605
2341
  }];
1606
2342
  readonly default: null;
2343
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
1607
2344
  readonly title: "Help";
1608
2345
  };
1609
2346
  readonly label: {
@@ -1613,19 +2350,23 @@ export declare const userToolSourceSchema: {
1613
2350
  readonly type: "null";
1614
2351
  }];
1615
2352
  readonly default: null;
2353
+ readonly description: "Label shown for the input on the tool form.";
1616
2354
  readonly title: "Label";
1617
2355
  };
1618
2356
  readonly name: {
2357
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
1619
2358
  readonly title: "Name";
1620
2359
  readonly type: "string";
1621
2360
  };
1622
2361
  readonly optional: {
1623
2362
  readonly default: false;
2363
+ readonly description: "Set true when the command can run without the user supplying this input.";
1624
2364
  readonly title: "Optional";
1625
2365
  readonly type: "boolean";
1626
2366
  };
1627
2367
  readonly type: {
1628
2368
  readonly const: "boolean";
2369
+ readonly description: "Presents a true-or-false choice and supplies the selected Boolean value to expressions.";
1629
2370
  readonly title: "Type";
1630
2371
  readonly type: "string";
1631
2372
  };
@@ -1636,15 +2377,24 @@ export declare const userToolSourceSchema: {
1636
2377
  readonly type: "null";
1637
2378
  }];
1638
2379
  readonly default: false;
2380
+ readonly description: "Initial choice shown when the user first opens the tool form.";
1639
2381
  readonly title: "Value";
1640
2382
  };
1641
2383
  };
1642
2384
  readonly required: readonly ["name", "type"];
1643
2385
  readonly title: "YamlBooleanParameter";
1644
2386
  readonly type: "object";
2387
+ readonly "x-shell-command": "include_header=\"$(inputs.include_header)\"";
1645
2388
  };
1646
2389
  readonly YamlColorParameter: {
1647
2390
  readonly additionalProperties: false;
2391
+ readonly description: "A color-picker input.";
2392
+ readonly examples: readonly [{
2393
+ readonly label: "Plot color";
2394
+ readonly name: "plot_color";
2395
+ readonly type: "color";
2396
+ readonly value: "#3366cc";
2397
+ }];
1648
2398
  readonly properties: {
1649
2399
  readonly help: {
1650
2400
  readonly anyOf: readonly [{
@@ -1653,6 +2403,7 @@ export declare const userToolSourceSchema: {
1653
2403
  readonly type: "null";
1654
2404
  }];
1655
2405
  readonly default: null;
2406
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
1656
2407
  readonly title: "Help";
1657
2408
  };
1658
2409
  readonly label: {
@@ -1662,19 +2413,23 @@ export declare const userToolSourceSchema: {
1662
2413
  readonly type: "null";
1663
2414
  }];
1664
2415
  readonly default: null;
2416
+ readonly description: "Label shown for the input on the tool form.";
1665
2417
  readonly title: "Label";
1666
2418
  };
1667
2419
  readonly name: {
2420
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
1668
2421
  readonly title: "Name";
1669
2422
  readonly type: "string";
1670
2423
  };
1671
2424
  readonly optional: {
1672
2425
  readonly default: false;
2426
+ readonly description: "Set true when the command can run without the user supplying this input.";
1673
2427
  readonly title: "Optional";
1674
2428
  readonly type: "boolean";
1675
2429
  };
1676
2430
  readonly type: {
1677
2431
  readonly const: "color";
2432
+ readonly description: "Presents a color picker and supplies the selected hexadecimal color string.";
1678
2433
  readonly title: "Type";
1679
2434
  readonly type: "string";
1680
2435
  };
@@ -1685,15 +2440,47 @@ export declare const userToolSourceSchema: {
1685
2440
  readonly type: "null";
1686
2441
  }];
1687
2442
  readonly default: null;
2443
+ readonly description: "Color initially selected in the picker, written in hexadecimal notation.";
1688
2444
  readonly title: "Value";
1689
2445
  };
1690
2446
  };
1691
2447
  readonly required: readonly ["name", "type"];
1692
2448
  readonly title: "YamlColorParameter";
1693
2449
  readonly type: "object";
2450
+ readonly "x-shell-command": "plot_color=\"$(inputs.plot_color)\"";
1694
2451
  };
1695
2452
  readonly YamlConditionalParameter: {
1696
2453
  readonly additionalProperties: false;
2454
+ readonly description: "A control input that selects which nested inputs are displayed and supplied to the command.";
2455
+ readonly examples: readonly [{
2456
+ readonly name: "search_options";
2457
+ readonly test_parameter: {
2458
+ readonly label: "Search mode";
2459
+ readonly name: "mode";
2460
+ readonly options: readonly [{
2461
+ readonly label: "Fast";
2462
+ readonly selected: true;
2463
+ readonly value: "fast";
2464
+ }, {
2465
+ readonly label: "Sensitive";
2466
+ readonly selected: false;
2467
+ readonly value: "sensitive";
2468
+ }];
2469
+ readonly type: "select";
2470
+ };
2471
+ readonly type: "conditional";
2472
+ readonly whens: readonly [{
2473
+ readonly discriminator: "fast";
2474
+ readonly parameters: readonly [];
2475
+ }, {
2476
+ readonly discriminator: "sensitive";
2477
+ readonly parameters: readonly [{
2478
+ readonly name: "iterations";
2479
+ readonly type: "integer";
2480
+ readonly value: 3;
2481
+ }];
2482
+ }];
2483
+ }];
1697
2484
  readonly properties: {
1698
2485
  readonly help: {
1699
2486
  readonly anyOf: readonly [{
@@ -1702,6 +2489,7 @@ export declare const userToolSourceSchema: {
1702
2489
  readonly type: "null";
1703
2490
  }];
1704
2491
  readonly default: null;
2492
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
1705
2493
  readonly title: "Help";
1706
2494
  };
1707
2495
  readonly label: {
@@ -1711,18 +2499,22 @@ export declare const userToolSourceSchema: {
1711
2499
  readonly type: "null";
1712
2500
  }];
1713
2501
  readonly default: null;
2502
+ readonly description: "Label shown for the input on the tool form.";
1714
2503
  readonly title: "Label";
1715
2504
  };
1716
2505
  readonly name: {
2506
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
1717
2507
  readonly title: "Name";
1718
2508
  readonly type: "string";
1719
2509
  };
1720
2510
  readonly optional: {
1721
2511
  readonly default: false;
2512
+ readonly description: "Set true when the command can run without the user supplying this input.";
1722
2513
  readonly title: "Optional";
1723
2514
  readonly type: "boolean";
1724
2515
  };
1725
2516
  readonly test_parameter: {
2517
+ readonly description: "Boolean or select input whose submitted value chooses the active `whens` branch.";
1726
2518
  readonly discriminator: {
1727
2519
  readonly mapping: {
1728
2520
  readonly boolean: "#/$defs/YamlBooleanParameter";
@@ -1739,10 +2531,12 @@ export declare const userToolSourceSchema: {
1739
2531
  };
1740
2532
  readonly type: {
1741
2533
  readonly const: "conditional";
2534
+ readonly description: "Shows one set of nested inputs at a time according to a Boolean or select control.";
1742
2535
  readonly title: "Type";
1743
2536
  readonly type: "string";
1744
2537
  };
1745
2538
  readonly whens: {
2539
+ readonly description: "Maps each control value to the nested parameters shown and supplied for that branch.";
1746
2540
  readonly items: {
1747
2541
  readonly $ref: "#/$defs/YamlConditionalWhen";
1748
2542
  };
@@ -1754,6 +2548,7 @@ export declare const userToolSourceSchema: {
1754
2548
  readonly required: readonly ["name", "type", "test_parameter", "whens"];
1755
2549
  readonly title: "YamlConditionalParameter";
1756
2550
  readonly type: "object";
2551
+ readonly "x-shell-command": "mode=\"$(inputs.search_options.mode)\"\niterations=\"$(inputs.search_options.iterations)\"";
1757
2552
  };
1758
2553
  readonly YamlConditionalWhen: {
1759
2554
  readonly additionalProperties: false;
@@ -1781,6 +2576,14 @@ export declare const userToolSourceSchema: {
1781
2576
  };
1782
2577
  readonly YamlDataCollectionParameter: {
1783
2578
  readonly additionalProperties: false;
2579
+ readonly description: "A dataset collection input.";
2580
+ readonly examples: readonly [{
2581
+ readonly collection_type: "paired";
2582
+ readonly format: readonly ["fastqsanger"];
2583
+ readonly label: "Paired reads";
2584
+ readonly name: "reads";
2585
+ readonly type: "data_collection";
2586
+ }];
1784
2587
  readonly properties: {
1785
2588
  readonly collection_type: {
1786
2589
  readonly anyOf: readonly [{
@@ -1789,10 +2592,12 @@ export declare const userToolSourceSchema: {
1789
2592
  readonly type: "null";
1790
2593
  }];
1791
2594
  readonly default: null;
2595
+ readonly description: "Limits selectable collections to this structure, such as `list` or `paired`.";
1792
2596
  readonly title: "Collection Type";
1793
2597
  };
1794
2598
  readonly format: {
1795
2599
  readonly default: readonly ["data"];
2600
+ readonly description: "Requires every selectable collection element to use one of these datatype extensions.";
1796
2601
  readonly items: {
1797
2602
  readonly type: "string";
1798
2603
  };
@@ -1806,6 +2611,7 @@ export declare const userToolSourceSchema: {
1806
2611
  readonly type: "null";
1807
2612
  }];
1808
2613
  readonly default: null;
2614
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
1809
2615
  readonly title: "Help";
1810
2616
  };
1811
2617
  readonly label: {
@@ -1815,19 +2621,23 @@ export declare const userToolSourceSchema: {
1815
2621
  readonly type: "null";
1816
2622
  }];
1817
2623
  readonly default: null;
2624
+ readonly description: "Label shown for the input on the tool form.";
1818
2625
  readonly title: "Label";
1819
2626
  };
1820
2627
  readonly name: {
2628
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
1821
2629
  readonly title: "Name";
1822
2630
  readonly type: "string";
1823
2631
  };
1824
2632
  readonly optional: {
1825
2633
  readonly default: false;
2634
+ readonly description: "Set true when the command can run without the user supplying this input.";
1826
2635
  readonly title: "Optional";
1827
2636
  readonly type: "boolean";
1828
2637
  };
1829
2638
  readonly type: {
1830
2639
  readonly const: "data_collection";
2640
+ readonly description: "Lets the user select a history collection and exposes its elements to expressions.";
1831
2641
  readonly title: "Type";
1832
2642
  readonly type: "string";
1833
2643
  };
@@ -1835,12 +2645,21 @@ export declare const userToolSourceSchema: {
1835
2645
  readonly required: readonly ["name", "type"];
1836
2646
  readonly title: "YamlDataCollectionParameter";
1837
2647
  readonly type: "object";
2648
+ readonly "x-shell-command": "forward='$(inputs.reads.elements.forward.path)'\nreverse='$(inputs.reads.elements.reverse.path)'";
1838
2649
  };
1839
2650
  readonly YamlDataParameter: {
1840
2651
  readonly additionalProperties: false;
2652
+ readonly description: "One dataset, or a list of datasets when ``multiple`` is true.";
2653
+ readonly examples: readonly [{
2654
+ readonly format: readonly ["txt", "tabular"];
2655
+ readonly label: "Input file";
2656
+ readonly name: "input_file";
2657
+ readonly type: "data";
2658
+ }];
1841
2659
  readonly properties: {
1842
2660
  readonly format: {
1843
2661
  readonly default: readonly ["data"];
2662
+ readonly description: "Limits selectable datasets to these Galaxy datatype extensions.";
1844
2663
  readonly items: {
1845
2664
  readonly type: "string";
1846
2665
  };
@@ -1854,6 +2673,7 @@ export declare const userToolSourceSchema: {
1854
2673
  readonly type: "null";
1855
2674
  }];
1856
2675
  readonly default: null;
2676
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
1857
2677
  readonly title: "Help";
1858
2678
  };
1859
2679
  readonly label: {
@@ -1863,42 +2683,29 @@ export declare const userToolSourceSchema: {
1863
2683
  readonly type: "null";
1864
2684
  }];
1865
2685
  readonly default: null;
2686
+ readonly description: "Label shown for the input on the tool form.";
1866
2687
  readonly title: "Label";
1867
2688
  };
1868
- readonly max: {
1869
- readonly anyOf: readonly [{
1870
- readonly type: "integer";
1871
- }, {
1872
- readonly type: "null";
1873
- }];
1874
- readonly default: null;
1875
- readonly title: "Max";
1876
- };
1877
- readonly min: {
1878
- readonly anyOf: readonly [{
1879
- readonly type: "integer";
1880
- }, {
1881
- readonly type: "null";
1882
- }];
1883
- readonly default: null;
1884
- readonly title: "Min";
1885
- };
1886
2689
  readonly multiple: {
1887
2690
  readonly default: false;
2691
+ readonly description: "Set true to accept several datasets (a list) for this input instead of one.";
1888
2692
  readonly title: "Multiple";
1889
2693
  readonly type: "boolean";
1890
2694
  };
1891
2695
  readonly name: {
2696
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
1892
2697
  readonly title: "Name";
1893
2698
  readonly type: "string";
1894
2699
  };
1895
2700
  readonly optional: {
1896
2701
  readonly default: false;
2702
+ readonly description: "Set true when the command can run without the user supplying this input.";
1897
2703
  readonly title: "Optional";
1898
2704
  readonly type: "boolean";
1899
2705
  };
1900
2706
  readonly type: {
1901
2707
  readonly const: "data";
2708
+ readonly description: "Lets the user select history datasets and exposes their paths and metadata to expressions.";
1902
2709
  readonly title: "Type";
1903
2710
  readonly type: "string";
1904
2711
  };
@@ -1906,9 +2713,19 @@ export declare const userToolSourceSchema: {
1906
2713
  readonly required: readonly ["name", "type"];
1907
2714
  readonly title: "YamlDataParameter";
1908
2715
  readonly type: "object";
2716
+ readonly "x-shell-command": "input_file='$(inputs.input_file.path)'";
1909
2717
  };
1910
2718
  readonly YamlFloatParameter: {
1911
2719
  readonly additionalProperties: false;
2720
+ readonly description: "A numeric input with optional bounds and validators.";
2721
+ readonly examples: readonly [{
2722
+ readonly label: "Score threshold";
2723
+ readonly max: 1;
2724
+ readonly min: 0;
2725
+ readonly name: "threshold";
2726
+ readonly type: "float";
2727
+ readonly value: 0.5;
2728
+ }];
1912
2729
  readonly properties: {
1913
2730
  readonly help: {
1914
2731
  readonly anyOf: readonly [{
@@ -1917,6 +2734,7 @@ export declare const userToolSourceSchema: {
1917
2734
  readonly type: "null";
1918
2735
  }];
1919
2736
  readonly default: null;
2737
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
1920
2738
  readonly title: "Help";
1921
2739
  };
1922
2740
  readonly label: {
@@ -1926,6 +2744,7 @@ export declare const userToolSourceSchema: {
1926
2744
  readonly type: "null";
1927
2745
  }];
1928
2746
  readonly default: null;
2747
+ readonly description: "Label shown for the input on the tool form.";
1929
2748
  readonly title: "Label";
1930
2749
  };
1931
2750
  readonly max: {
@@ -1935,6 +2754,7 @@ export declare const userToolSourceSchema: {
1935
2754
  readonly type: "null";
1936
2755
  }];
1937
2756
  readonly default: null;
2757
+ readonly description: "Rejects submitted values larger than this inclusive upper bound.";
1938
2758
  readonly title: "Max";
1939
2759
  };
1940
2760
  readonly min: {
@@ -1944,24 +2764,29 @@ export declare const userToolSourceSchema: {
1944
2764
  readonly type: "null";
1945
2765
  }];
1946
2766
  readonly default: null;
2767
+ readonly description: "Rejects submitted values smaller than this inclusive lower bound.";
1947
2768
  readonly title: "Min";
1948
2769
  };
1949
2770
  readonly name: {
2771
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
1950
2772
  readonly title: "Name";
1951
2773
  readonly type: "string";
1952
2774
  };
1953
2775
  readonly optional: {
1954
2776
  readonly default: false;
2777
+ readonly description: "Set true when the command can run without the user supplying this input.";
1955
2778
  readonly title: "Optional";
1956
2779
  readonly type: "boolean";
1957
2780
  };
1958
2781
  readonly type: {
1959
2782
  readonly const: "float";
2783
+ readonly description: "Accepts a number, including decimal values, and supplies it to expressions.";
1960
2784
  readonly title: "Type";
1961
2785
  readonly type: "string";
1962
2786
  };
1963
2787
  readonly validators: {
1964
2788
  readonly default: readonly [];
2789
+ readonly description: "Additional validation rules; supports `in_range`.";
1965
2790
  readonly items: {
1966
2791
  readonly $ref: "#/$defs/InRangeParameterValidatorModel";
1967
2792
  };
@@ -1975,12 +2800,14 @@ export declare const userToolSourceSchema: {
1975
2800
  readonly type: "null";
1976
2801
  }];
1977
2802
  readonly default: null;
2803
+ readonly description: "Number prefilled when the user first opens the tool form.";
1978
2804
  readonly title: "Value";
1979
2805
  };
1980
2806
  };
1981
2807
  readonly required: readonly ["name", "type"];
1982
2808
  readonly title: "YamlFloatParameter";
1983
2809
  readonly type: "object";
2810
+ readonly "x-shell-command": "threshold=\"$(inputs.threshold)\"";
1984
2811
  };
1985
2812
  readonly YamlGalaxyToolParameter: {
1986
2813
  readonly discriminator: {
@@ -2026,6 +2853,15 @@ export declare const userToolSourceSchema: {
2026
2853
  };
2027
2854
  readonly YamlIntegerParameter: {
2028
2855
  readonly additionalProperties: false;
2856
+ readonly description: "A whole-number input with optional bounds and validators.";
2857
+ readonly examples: readonly [{
2858
+ readonly label: "Number of lines";
2859
+ readonly max: 1000;
2860
+ readonly min: 1;
2861
+ readonly name: "num_lines";
2862
+ readonly type: "integer";
2863
+ readonly value: 10;
2864
+ }];
2029
2865
  readonly properties: {
2030
2866
  readonly help: {
2031
2867
  readonly anyOf: readonly [{
@@ -2034,6 +2870,7 @@ export declare const userToolSourceSchema: {
2034
2870
  readonly type: "null";
2035
2871
  }];
2036
2872
  readonly default: null;
2873
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
2037
2874
  readonly title: "Help";
2038
2875
  };
2039
2876
  readonly label: {
@@ -2043,6 +2880,7 @@ export declare const userToolSourceSchema: {
2043
2880
  readonly type: "null";
2044
2881
  }];
2045
2882
  readonly default: null;
2883
+ readonly description: "Label shown for the input on the tool form.";
2046
2884
  readonly title: "Label";
2047
2885
  };
2048
2886
  readonly max: {
@@ -2052,6 +2890,7 @@ export declare const userToolSourceSchema: {
2052
2890
  readonly type: "null";
2053
2891
  }];
2054
2892
  readonly default: null;
2893
+ readonly description: "Rejects submitted values larger than this inclusive upper bound.";
2055
2894
  readonly title: "Max";
2056
2895
  };
2057
2896
  readonly min: {
@@ -2061,24 +2900,29 @@ export declare const userToolSourceSchema: {
2061
2900
  readonly type: "null";
2062
2901
  }];
2063
2902
  readonly default: null;
2903
+ readonly description: "Rejects submitted values smaller than this inclusive lower bound.";
2064
2904
  readonly title: "Min";
2065
2905
  };
2066
2906
  readonly name: {
2907
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
2067
2908
  readonly title: "Name";
2068
2909
  readonly type: "string";
2069
2910
  };
2070
2911
  readonly optional: {
2071
2912
  readonly default: false;
2913
+ readonly description: "Set true when the command can run without the user supplying this input.";
2072
2914
  readonly title: "Optional";
2073
2915
  readonly type: "boolean";
2074
2916
  };
2075
2917
  readonly type: {
2076
2918
  readonly const: "integer";
2919
+ readonly description: "Accepts a whole number and supplies it as a numeric value to expressions.";
2077
2920
  readonly title: "Type";
2078
2921
  readonly type: "string";
2079
2922
  };
2080
2923
  readonly validators: {
2081
2924
  readonly default: readonly [];
2925
+ readonly description: "Additional validation rules; supports `in_range`.";
2082
2926
  readonly items: {
2083
2927
  readonly $ref: "#/$defs/InRangeParameterValidatorModel";
2084
2928
  };
@@ -2092,14 +2936,17 @@ export declare const userToolSourceSchema: {
2092
2936
  readonly type: "null";
2093
2937
  }];
2094
2938
  readonly default: null;
2939
+ readonly description: "Number prefilled when the user first opens the tool form.";
2095
2940
  readonly title: "Value";
2096
2941
  };
2097
2942
  };
2098
2943
  readonly required: readonly ["name", "type"];
2099
2944
  readonly title: "YamlIntegerParameter";
2100
2945
  readonly type: "object";
2946
+ readonly "x-shell-command": "num_lines=\"$(inputs.num_lines)\"";
2101
2947
  };
2102
2948
  readonly YamlLabelValue: {
2949
+ readonly additionalProperties: false;
2103
2950
  readonly description: "YAML-friendly option model — ``selected`` defaults to ``False``.";
2104
2951
  readonly properties: {
2105
2952
  readonly label: {
@@ -2122,6 +2969,19 @@ export declare const userToolSourceSchema: {
2122
2969
  };
2123
2970
  readonly YamlRepeatParameter: {
2124
2971
  readonly additionalProperties: false;
2972
+ readonly description: "A group the user may add multiple times, with ``parameters`` defining one repeated entry.";
2973
+ readonly examples: readonly [{
2974
+ readonly label: "Additional files";
2975
+ readonly max: 3;
2976
+ readonly min: 0;
2977
+ readonly name: "extra_files";
2978
+ readonly parameters: readonly [{
2979
+ readonly format: readonly ["txt"];
2980
+ readonly name: "input_file";
2981
+ readonly type: "data";
2982
+ }];
2983
+ readonly type: "repeat";
2984
+ }];
2125
2985
  readonly properties: {
2126
2986
  readonly help: {
2127
2987
  readonly anyOf: readonly [{
@@ -2130,6 +2990,7 @@ export declare const userToolSourceSchema: {
2130
2990
  readonly type: "null";
2131
2991
  }];
2132
2992
  readonly default: null;
2993
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
2133
2994
  readonly title: "Help";
2134
2995
  };
2135
2996
  readonly label: {
@@ -2139,6 +3000,7 @@ export declare const userToolSourceSchema: {
2139
3000
  readonly type: "null";
2140
3001
  }];
2141
3002
  readonly default: null;
3003
+ readonly description: "Label shown for the input on the tool form.";
2142
3004
  readonly title: "Label";
2143
3005
  };
2144
3006
  readonly max: {
@@ -2148,6 +3010,7 @@ export declare const userToolSourceSchema: {
2148
3010
  readonly type: "null";
2149
3011
  }];
2150
3012
  readonly default: null;
3013
+ readonly description: "Prevents the user from adding more than this many entries.";
2151
3014
  readonly title: "Max";
2152
3015
  };
2153
3016
  readonly min: {
@@ -2157,19 +3020,23 @@ export declare const userToolSourceSchema: {
2157
3020
  readonly type: "null";
2158
3021
  }];
2159
3022
  readonly default: null;
3023
+ readonly description: "Keeps at least this many entries in the group and creates them when the form opens.";
2160
3024
  readonly title: "Min";
2161
3025
  };
2162
3026
  readonly name: {
3027
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
2163
3028
  readonly title: "Name";
2164
3029
  readonly type: "string";
2165
3030
  };
2166
3031
  readonly optional: {
2167
3032
  readonly default: false;
3033
+ readonly description: "Set true when the command can run without the user supplying this input.";
2168
3034
  readonly title: "Optional";
2169
3035
  readonly type: "boolean";
2170
3036
  };
2171
3037
  readonly parameters: {
2172
3038
  readonly default: readonly [];
3039
+ readonly description: "Nested inputs that make up one entry in the repeated group.";
2173
3040
  readonly items: {
2174
3041
  readonly $ref: "#/$defs/YamlGalaxyToolParameter";
2175
3042
  };
@@ -2178,6 +3045,7 @@ export declare const userToolSourceSchema: {
2178
3045
  };
2179
3046
  readonly type: {
2180
3047
  readonly const: "repeat";
3048
+ readonly description: "Lets the user add multiple entries that all contain the same nested inputs.";
2181
3049
  readonly title: "Type";
2182
3050
  readonly type: "string";
2183
3051
  };
@@ -2185,9 +3053,23 @@ export declare const userToolSourceSchema: {
2185
3053
  readonly required: readonly ["name", "type"];
2186
3054
  readonly title: "YamlRepeatParameter";
2187
3055
  readonly type: "object";
3056
+ readonly "x-shell-command": "files='$(inputs.extra_files.map((item) => item.input_file.path).join(\" \"))'";
2188
3057
  };
2189
3058
  readonly YamlSectionParameter: {
2190
3059
  readonly additionalProperties: false;
3060
+ readonly description: "Related inputs that users can expand or collapse to reduce form complexity.";
3061
+ readonly examples: readonly [{
3062
+ readonly label: "Advanced options";
3063
+ readonly name: "advanced";
3064
+ readonly parameters: readonly [{
3065
+ readonly max: 1;
3066
+ readonly min: 0;
3067
+ readonly name: "threshold";
3068
+ readonly type: "float";
3069
+ readonly value: 0.5;
3070
+ }];
3071
+ readonly type: "section";
3072
+ }];
2191
3073
  readonly properties: {
2192
3074
  readonly help: {
2193
3075
  readonly anyOf: readonly [{
@@ -2196,6 +3078,7 @@ export declare const userToolSourceSchema: {
2196
3078
  readonly type: "null";
2197
3079
  }];
2198
3080
  readonly default: null;
3081
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
2199
3082
  readonly title: "Help";
2200
3083
  };
2201
3084
  readonly label: {
@@ -2205,19 +3088,23 @@ export declare const userToolSourceSchema: {
2205
3088
  readonly type: "null";
2206
3089
  }];
2207
3090
  readonly default: null;
3091
+ readonly description: "Label shown for the input on the tool form.";
2208
3092
  readonly title: "Label";
2209
3093
  };
2210
3094
  readonly name: {
3095
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
2211
3096
  readonly title: "Name";
2212
3097
  readonly type: "string";
2213
3098
  };
2214
3099
  readonly optional: {
2215
3100
  readonly default: false;
3101
+ readonly description: "Set true when the command can run without the user supplying this input.";
2216
3102
  readonly title: "Optional";
2217
3103
  readonly type: "boolean";
2218
3104
  };
2219
3105
  readonly parameters: {
2220
3106
  readonly default: readonly [];
3107
+ readonly description: "Nested inputs displayed together inside the section.";
2221
3108
  readonly items: {
2222
3109
  readonly $ref: "#/$defs/YamlGalaxyToolParameter";
2223
3110
  };
@@ -2226,6 +3113,7 @@ export declare const userToolSourceSchema: {
2226
3113
  };
2227
3114
  readonly type: {
2228
3115
  readonly const: "section";
3116
+ readonly description: "Places related inputs in a collapsible group to simplify the tool form.";
2229
3117
  readonly title: "Type";
2230
3118
  readonly type: "string";
2231
3119
  };
@@ -2233,9 +3121,25 @@ export declare const userToolSourceSchema: {
2233
3121
  readonly required: readonly ["name", "type"];
2234
3122
  readonly title: "YamlSectionParameter";
2235
3123
  readonly type: "object";
3124
+ readonly "x-shell-command": "threshold=\"$(inputs.advanced.threshold)\"";
2236
3125
  };
2237
3126
  readonly YamlSelectParameter: {
2238
3127
  readonly additionalProperties: false;
3128
+ readonly description: "A choice from a fixed list of options.";
3129
+ readonly examples: readonly [{
3130
+ readonly label: "Search mode";
3131
+ readonly name: "mode";
3132
+ readonly options: readonly [{
3133
+ readonly label: "Fast";
3134
+ readonly selected: true;
3135
+ readonly value: "fast";
3136
+ }, {
3137
+ readonly label: "Sensitive";
3138
+ readonly selected: false;
3139
+ readonly value: "sensitive";
3140
+ }];
3141
+ readonly type: "select";
3142
+ }];
2239
3143
  readonly properties: {
2240
3144
  readonly help: {
2241
3145
  readonly anyOf: readonly [{
@@ -2244,6 +3148,7 @@ export declare const userToolSourceSchema: {
2244
3148
  readonly type: "null";
2245
3149
  }];
2246
3150
  readonly default: null;
3151
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
2247
3152
  readonly title: "Help";
2248
3153
  };
2249
3154
  readonly label: {
@@ -2253,23 +3158,28 @@ export declare const userToolSourceSchema: {
2253
3158
  readonly type: "null";
2254
3159
  }];
2255
3160
  readonly default: null;
3161
+ readonly description: "Label shown for the input on the tool form.";
2256
3162
  readonly title: "Label";
2257
3163
  };
2258
3164
  readonly multiple: {
2259
3165
  readonly default: false;
3166
+ readonly description: "Set true to let the user select and supply several option values instead of one.";
2260
3167
  readonly title: "Multiple";
2261
3168
  readonly type: "boolean";
2262
3169
  };
2263
3170
  readonly name: {
3171
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
2264
3172
  readonly title: "Name";
2265
3173
  readonly type: "string";
2266
3174
  };
2267
3175
  readonly optional: {
2268
3176
  readonly default: false;
3177
+ readonly description: "Set true when the command can run without the user supplying this input.";
2269
3178
  readonly title: "Optional";
2270
3179
  readonly type: "boolean";
2271
3180
  };
2272
3181
  readonly options: {
3182
+ readonly description: "Choices presented on the tool form, each with a display label and value.";
2273
3183
  readonly items: {
2274
3184
  readonly $ref: "#/$defs/YamlLabelValue";
2275
3185
  };
@@ -2279,11 +3189,13 @@ export declare const userToolSourceSchema: {
2279
3189
  };
2280
3190
  readonly type: {
2281
3191
  readonly const: "select";
3192
+ readonly description: "Lets the user choose from the declared `options` and supplies the selected value.";
2282
3193
  readonly title: "Type";
2283
3194
  readonly type: "string";
2284
3195
  };
2285
3196
  readonly validators: {
2286
3197
  readonly default: readonly [];
3198
+ readonly description: "Additional validation rules; supports `no_options`.";
2287
3199
  readonly items: {
2288
3200
  readonly $ref: "#/$defs/NoOptionsParameterValidatorModel";
2289
3201
  };
@@ -2294,8 +3206,10 @@ export declare const userToolSourceSchema: {
2294
3206
  readonly required: readonly ["name", "type", "options"];
2295
3207
  readonly title: "YamlSelectParameter";
2296
3208
  readonly type: "object";
3209
+ readonly "x-shell-command": "mode=\"$(inputs.mode)\"";
2297
3210
  };
2298
3211
  readonly YamlTemplateConfigFile: {
3212
+ readonly additionalProperties: false;
2299
3213
  readonly properties: {
2300
3214
  readonly content: {
2301
3215
  readonly title: "Content";
@@ -2391,9 +3305,18 @@ export declare const userToolSourceSchema: {
2391
3305
  };
2392
3306
  readonly YamlTextParameter: {
2393
3307
  readonly additionalProperties: false;
3308
+ readonly description: "A single-line or multiline text input.";
3309
+ readonly examples: readonly [{
3310
+ readonly area: false;
3311
+ readonly label: "Sequence motif";
3312
+ readonly name: "motif";
3313
+ readonly type: "text";
3314
+ readonly value: "ACGT";
3315
+ }];
2394
3316
  readonly properties: {
2395
3317
  readonly area: {
2396
3318
  readonly default: false;
3319
+ readonly description: "Set true to use a multiline editor instead of a single-line text box.";
2397
3320
  readonly title: "Area";
2398
3321
  readonly type: "boolean";
2399
3322
  };
@@ -2404,6 +3327,7 @@ export declare const userToolSourceSchema: {
2404
3327
  readonly type: "null";
2405
3328
  }];
2406
3329
  readonly default: null;
3330
+ readonly description: "Additional guidance shown on the tool form to help users choose a value.";
2407
3331
  readonly title: "Help";
2408
3332
  };
2409
3333
  readonly label: {
@@ -2413,24 +3337,29 @@ export declare const userToolSourceSchema: {
2413
3337
  readonly type: "null";
2414
3338
  }];
2415
3339
  readonly default: null;
3340
+ readonly description: "Label shown for the input on the tool form.";
2416
3341
  readonly title: "Label";
2417
3342
  };
2418
3343
  readonly name: {
3344
+ readonly description: "Identifier used to read this input from `shell_command` and other expressions.";
2419
3345
  readonly title: "Name";
2420
3346
  readonly type: "string";
2421
3347
  };
2422
3348
  readonly optional: {
2423
3349
  readonly default: false;
3350
+ readonly description: "Set true when the command can run without the user supplying this input.";
2424
3351
  readonly title: "Optional";
2425
3352
  readonly type: "boolean";
2426
3353
  };
2427
3354
  readonly type: {
2428
3355
  readonly const: "text";
3356
+ readonly description: "Accepts user-entered text and supplies the resulting string to expressions.";
2429
3357
  readonly title: "Type";
2430
3358
  readonly type: "string";
2431
3359
  };
2432
3360
  readonly validators: {
2433
3361
  readonly default: readonly [];
3362
+ readonly description: "Additional validation rules; supports `length`, `regex`, and `empty_field`.";
2434
3363
  readonly items: {
2435
3364
  readonly anyOf: readonly [{
2436
3365
  readonly $ref: "#/$defs/LengthParameterValidatorModel";
@@ -2450,12 +3379,14 @@ export declare const userToolSourceSchema: {
2450
3379
  readonly type: "null";
2451
3380
  }];
2452
3381
  readonly default: null;
3382
+ readonly description: "Text prefilled when the user first opens the tool form.";
2453
3383
  readonly title: "Value";
2454
3384
  };
2455
3385
  };
2456
3386
  readonly required: readonly ["name", "type"];
2457
3387
  readonly title: "YamlTextParameter";
2458
3388
  readonly type: "object";
3389
+ readonly "x-shell-command": "motif=\"$(inputs.motif)\"";
2459
3390
  };
2460
3391
  readonly YamlToolSource: {
2461
3392
  readonly additionalProperties: false;
@@ -2470,6 +3401,7 @@ export declare const userToolSourceSchema: {
2470
3401
  readonly type: "null";
2471
3402
  }];
2472
3403
  readonly default: null;
3404
+ readonly description: "DOI or BibTeX references for publications describing the wrapped tool.";
2473
3405
  readonly title: "citations";
2474
3406
  };
2475
3407
  readonly class: {
@@ -2487,7 +3419,7 @@ export declare const userToolSourceSchema: {
2487
3419
  readonly type: "null";
2488
3420
  }];
2489
3421
  readonly default: null;
2490
- readonly description: "A list of config files for this tool.";
3422
+ readonly description: "Files Galaxy writes into the job working directory before running the command. Their content is evaluated with the same sandboxed ECMAScript expressions as `shell_command`. Put scripts and other substantial command logic here, then keep `shell_command` to a short invocation.";
2491
3423
  readonly title: "configfiles";
2492
3424
  };
2493
3425
  readonly container: {
@@ -2521,6 +3453,7 @@ export declare const userToolSourceSchema: {
2521
3453
  readonly type: "null";
2522
3454
  }];
2523
3455
  readonly default: null;
3456
+ readonly description: "EDAM operation identifiers such as `operation_0308`.";
2524
3457
  readonly title: "edam_operations";
2525
3458
  };
2526
3459
  readonly edam_topics: {
@@ -2533,6 +3466,7 @@ export declare const userToolSourceSchema: {
2533
3466
  readonly type: "null";
2534
3467
  }];
2535
3468
  readonly default: null;
3469
+ readonly description: "EDAM topic identifiers such as `topic_0102`.";
2536
3470
  readonly title: "edam_topics";
2537
3471
  };
2538
3472
  readonly help: {
@@ -2542,7 +3476,7 @@ export declare const userToolSourceSchema: {
2542
3476
  readonly type: "null";
2543
3477
  }];
2544
3478
  readonly default: null;
2545
- readonly description: "Help text shown below the tool interface.";
3479
+ readonly description: "Help shown below the tool form. Set `format` to `markdown`, `restructuredtext`, or `plain_text`, and put the documentation in `content`.";
2546
3480
  readonly title: "help";
2547
3481
  };
2548
3482
  readonly id: {
@@ -2561,6 +3495,7 @@ export declare const userToolSourceSchema: {
2561
3495
  };
2562
3496
  readonly inputs: {
2563
3497
  readonly default: readonly [];
3498
+ readonly description: "Parameters displayed on the tool form. Each item needs a unique `name` and a supported `type`. Reference scalar values as `$(inputs.input_name)` and data inputs as `$(inputs.input_name.path)` in `shell_command` or config files. Conditional, repeat, and section inputs contain nested parameters.";
2564
3499
  readonly items: {
2565
3500
  readonly $ref: "#/$defs/YamlGalaxyToolParameter";
2566
3501
  };
@@ -2586,15 +3521,16 @@ export declare const userToolSourceSchema: {
2586
3521
  };
2587
3522
  readonly outputs: {
2588
3523
  readonly default: readonly [];
3524
+ readonly description: "Results Galaxy collects after the command finishes. A data output identifies its produced file with `from_work_dir` or `discover_datasets`; a collection output uses `discover_datasets`. Scalar output types are `text`, `integer`, `float`, and `boolean`.";
2589
3525
  readonly items: {
2590
3526
  readonly discriminator: {
2591
3527
  readonly mapping: {
2592
- readonly boolean: "#/$defs/ToolOutputBoolean";
3528
+ readonly boolean: "#/$defs/IncomingToolOutputBoolean";
2593
3529
  readonly collection: "#/$defs/IncomingToolOutputCollection";
2594
3530
  readonly data: "#/$defs/IncomingToolOutputDataset";
2595
- readonly float: "#/$defs/ToolOutputFloat";
2596
- readonly integer: "#/$defs/ToolOutputInteger";
2597
- readonly text: "#/$defs/ToolOutputText";
3531
+ readonly float: "#/$defs/IncomingToolOutputFloat";
3532
+ readonly integer: "#/$defs/IncomingToolOutputInteger";
3533
+ readonly text: "#/$defs/IncomingToolOutputText";
2598
3534
  };
2599
3535
  readonly propertyName: "type";
2600
3536
  };
@@ -2603,13 +3539,13 @@ export declare const userToolSourceSchema: {
2603
3539
  }, {
2604
3540
  readonly $ref: "#/$defs/IncomingToolOutputCollection";
2605
3541
  }, {
2606
- readonly $ref: "#/$defs/ToolOutputText";
3542
+ readonly $ref: "#/$defs/IncomingToolOutputText";
2607
3543
  }, {
2608
- readonly $ref: "#/$defs/ToolOutputInteger";
3544
+ readonly $ref: "#/$defs/IncomingToolOutputInteger";
2609
3545
  }, {
2610
- readonly $ref: "#/$defs/ToolOutputFloat";
3546
+ readonly $ref: "#/$defs/IncomingToolOutputFloat";
2611
3547
  }, {
2612
- readonly $ref: "#/$defs/ToolOutputBoolean";
3548
+ readonly $ref: "#/$defs/IncomingToolOutputBoolean";
2613
3549
  }];
2614
3550
  };
2615
3551
  readonly title: "outputs";
@@ -2640,12 +3576,12 @@ export declare const userToolSourceSchema: {
2640
3576
  readonly type: "null";
2641
3577
  }];
2642
3578
  readonly default: readonly [];
2643
- readonly description: "A list of requirements needed to execute this tool. These can be javascript expressions, resource requirements or container images.";
3579
+ readonly description: "JavaScript helpers and compute resource requests needed to execute this tool.";
2644
3580
  readonly title: "requirements";
2645
3581
  };
2646
3582
  readonly shell_command: {
2647
- readonly description: "A string that contains the command to be executed. Parameters can be referenced inside $().";
2648
- readonly examples: readonly ["head -n '$(inputs.n_lines)' '$(inputs.data_input.path)'"];
3583
+ readonly description: "A string that contains the command to be executed. Reference inputs inside `$()` as `$(inputs.input_name)` for scalar values and `$(inputs.input_name.path)` for files; `${ ... }` evaluates a JavaScript function body that must return a value. Substituted values are not shell-quoted, so quote them yourself. Because `$(` and `${` are consumed by the expression evaluator, shell command substitution and braced parameter expansion do not reach the shell: escape them as `\\$(` and `\\${`, and prefer unbraced variables such as `$GALAXY_SLOTS`.";
3584
+ readonly examples: readonly ["head -n '$(inputs.num_lines)' '$(inputs.input_file.path)' > output.txt"];
2649
3585
  readonly title: "shell_command";
2650
3586
  readonly type: "string";
2651
3587
  };
@@ -2682,6 +3618,7 @@ export declare const userToolSourceSchema: {
2682
3618
  readonly type: "null";
2683
3619
  }];
2684
3620
  readonly default: null;
3621
+ readonly description: "External registry identifiers, each with a registry `type` and identifier `value`.";
2685
3622
  readonly title: "xrefs";
2686
3623
  };
2687
3624
  };