/
descriptor.schema.json
754 lines (753 loc) · 37.4 KB
/
descriptor.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://github.com/boutiques/boutiques-schema",
"type": "object",
"title": "Tool",
"properties": {
"name": {
"id": "http://github.com/boutiques/boutiques-schema/name",
"minLength": 1,
"description": "Tool name.",
"type": "string"
},
"tool-version": {
"id": "http://github.com/boutiques/boutiques-schema/description",
"minLength": 1,
"description": "Tool version.",
"type": "string"
},
"description": {
"id": "http://github.com/boutiques/boutiques-schema/description",
"minLength": 1,
"description": "Tool description.",
"type": "string"
},
"deprecated-by-doi": {
"id": "http://github.com/boutiques/boutiques-schema/deprecated-by-doi",
"minLength": 1,
"description": "doi of the tool that deprecates the current one. May be set to 'true' if the current tool is deprecated but no specific tool deprecates it.",
"type": ["string", "boolean"]
},
"author": {
"id": "http://github.com/boutiques/boutiques-schema/author",
"minLength": 1,
"description": "Tool author name(s).",
"type": "string"
},
"url": {
"id": "http://github.com/boutiques/boutiques-schema/url",
"minLength": 1,
"description": "Tool URL.",
"type": "string"
},
"descriptor-url": {
"id": "http://github.com/boutiques/boutiques-schema/descriptor-url",
"minLength": 1,
"description": "Link to the descriptor itself (e.g. the GitHub repo where it is hosted).",
"type": "string"
},
"doi": {
"id": "http://github.com/boutiques/boutiques-schema/doi",
"minLength": 1,
"description": "DOI of the descriptor (not of the tool itself).",
"type": "string"
},
"shell": {
"id": "http://github.com/boutiques/boutiques-schema/shell",
"minLength": 1,
"description": "Absolute path of the shell interpreter to use in the container (defaults to /bin/sh).",
"type": "string"
},
"tool-doi": {
"id": "http://github.com/boutiques/boutiques-schema/tool-doi",
"minLength": 1,
"description": "DOI of the tool (not of the descriptor).",
"type": "string"
},
"command-line": {
"id": "http://github.com/boutiques/boutiques-schema/command-line",
"minLength": 1,
"description": "A string that describes the tool command line, where input and output values are identified by \"keys\". At runtime, command-line keys are substituted with flags and values.",
"type": "string"
},
"container-image": {
"id": "http://github.com/boutiques/boutiques-schema/container-image",
"type": "object",
"allOf": [{
"properties": {
"working-directory": {
"id": "http://github.com/boutiques/boutiques-schema/container/working-directory",
"minLength": 1,
"description": "Location from which this task must be launched within the container.",
"type": "string"
},
"container-hash": {
"id": "http://github.com/boutiques/boutiques-schema/container/container-hash",
"minLength": 1,
"description": "Hash for the given container.",
"type": "string"
}
}
},{
"oneOf": [{
"properties": {
"type": { "enum": ["docker", "singularity"] },
"image": {
"id": "http://github.com/boutiques/boutiques-schema/container/image",
"minLength": 1,
"description": "Name of an image where the tool is installed and configured. Example: bids/mriqc.",
"type": "string"
},
"entrypoint": {
"id": "http://github.com/boutiques/boutiques-schema/container/entrypoint",
"description": "Flag indicating whether or not the container uses an entrypoint.",
"type": "boolean"
},
"index": {
"id": "http://github.com/boutiques/boutiques-schema/container/index",
"minLength": 1,
"description": "Optional index where the image is available, if not the standard location. Example: docker.io",
"type": "string"
},
"container-opts": {
"id": "http://github.com/boutiques/boutiques-schema/container/container-opts",
"description": "Container-level arguments for the application. Example: --privileged",
"type": "array",
"items": {
"type": "string"
}
},
"working-directory": {},
"container-hash": {}
},
"required": ["type", "image"],
"additionalProperties": false,
"description": "Object representing a docker or singularity container for the tool."
}, {
"properties": {
"type": { "enum": ["rootfs"] },
"url": {
"id": "http://github.com/boutiques/boutiques-schema/container/url",
"minLength": 1,
"description": "URL where the image is available.",
"type": "string"
},
"working-directory": {},
"container-hash": {}
},
"required": ["type", "url"],
"additionalProperties": false,
"description": "Object representing a rootfs container for the tool."
}]
}]
},
"schema-version": {
"id": "http://github.com/boutiques/boutiques-schema/schema-version",
"type": "string",
"description": "Version of the schema used.",
"enum": ["0.5"]
},
"environment-variables": {
"id": "http://github.com/boutiques/boutiques-schema/environment-variables",
"type": "array",
"description": "An array of key-value pairs specifying environment variable names and their values to be used in the execution environment.",
"items": {
"id": "http://github.com/boutiques/boutiques-schema/environment-variable",
"type": "object",
"properties": {
"name": {
"id": "http://github.com/boutiques/boutiques-schema/environment-variable/name",
"minLength": 1,
"description": "The environment variable name (identifier) containing only alphanumeric characters and underscores. Example: \"PROGRAM_PATH\".",
"type": "string",
"pattern": "^[a-z,A-Z][0-9,_,a-z,A-Z]*$"
},
"value": {
"id": "http://github.com/boutiques/boutiques-schema/environment-variable/value",
"description": "The value of the environment variable.",
"type": "string"
},
"description": {
"id": "http://github.com/boutiques/boutiques-schema/environment-variable/description",
"description": "Description of the environment variable.",
"type": "string"
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"groups": {
"id": "http://github.com/boutiques/boutiques-schema/groups",
"description": "Sets of identifiers of inputs, each specifying an input group.",
"type": "array",
"items": {
"id": "http://github.com/boutiques/boutiques-schema/group",
"type": "object",
"properties": {
"id": {
"id": "http://github.com/boutiques/boutiques-schema/group/id",
"minLength": 1,
"description": "A short, unique, informative identifier containing only alphanumeric characters and underscores. Typically used to generate variable names. Example: \"outfile_group\".",
"type": "string",
"pattern": "^[0-9,_,a-z,A-Z]*$"
},
"name": {
"id": "http://github.com/boutiques/boutiques-schema/group/name",
"minLength": 1,
"description": "A human-readable name for the input group.",
"type": "string"
},
"description": {
"id": "http://github.com/boutiques/boutiques-schema/group/description",
"description": "Description of the input group.",
"type": "string"
},
"members": {
"id": "http://github.com/boutiques/boutiques-schema/group/members",
"description": "IDs of the inputs belonging to this group.",
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9,_,a-z,A-Z]*$"
}
},
"mutually-exclusive": {
"id": "http://github.com/boutiques/boutiques-schema/group/mutually-exclusive",
"description": "True if only one input in the group may be active at runtime.",
"type": "boolean"
},
"one-is-required": {
"id": "http://github.com/boutiques/boutiques-schema/group/one-is-required",
"description": "True if at least one of the inputs in the group must be active at runtime.",
"type": "boolean"
},
"all-or-none": {
"id": "http://github.com/boutiques/boutiques-schema/group/all-or-none",
"description": "True if members of the group need to be toggled together",
"type": "boolean"
}
},
"required": [
"name",
"id",
"members"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"inputs": {
"id": "http://github.com/boutiques/boutiques-schema/inputs",
"type": "array",
"items": {
"id": "http://github.com/boutiques/boutiques-schema/input",
"type": "object",
"properties": {
"id": {
"id": "http://github.com/boutiques/boutiques-schema/input/id",
"minLength": 1,
"description": "A short, unique, informative identifier containing only alphanumeric characters and underscores. Typically used to generate variable names. Example: \"data_file\".",
"type": "string",
"pattern": "^[0-9,_,a-z,A-Z]*$"
},
"name": {
"id": "http://github.com/boutiques/boutiques-schema/input/name",
"minLength": 1,
"description": "A human-readable input name. Example: 'Data file'.",
"type": "string"
},
"type": {
"id": "http://github.com/boutiques/boutiques-schema/input/type",
"type": "string",
"description": "Input type.",
"enum": ["String", "File", "Flag", "Number"]
},
"description": {
"id": "http://github.com/boutiques/boutiques-schema/input/description",
"description": "Input description.",
"type": "string"
},
"value-key": {
"id": "http://github.com/boutiques/boutiques-schema/input/value-key",
"description": "A string contained in command-line, substituted by the input value and/or flag at runtime.",
"type": "string"
},
"list": {
"id": "http://github.com/boutiques/boutiques-schema/input/list",
"description":"True if input is a list of value. An input of type \"Flag\" cannot be a list.",
"type": "boolean"
},
"list-separator": {
"id": "http://github.com/boutiques/boutiques-schema/input/list-separator",
"description": "Separator used between list items. Defaults to a single space.",
"type": "string"
},
"optional": {
"id": "http://github.com/boutiques/boutiques-schema/input/optional",
"description": "True if input is optional.",
"type": "boolean"
},
"command-line-flag": {
"id": "http://github.com/boutiques/boutiques-schema/input/command-line-flag",
"description": "Option flag of the input, involved in the value-key substitution. Inputs of type \"Flag\" have to have a command-line flag. Examples: -v, --force.",
"type": "string"
},
"requires-inputs": {
"id": "http://github.com/boutiques/boutiques-schema/output/required-inputs",
"description": "Ids of the inputs or ids of groups whose members must be active for this input to be available.",
"type": "array",
"items": {
"type": "string"
}
},
"disables-inputs": {
"id": "http://github.com/boutiques/boutiques-schema/output/disabled-by-inputs",
"description": "Ids of the inputs that are disabled when this input is active.",
"type": "array",
"items": {
"type": "string"
}
},
"command-line-flag-separator": {
"id": "http://github.com/boutiques/boutiques-schema/input/command-line-flag-separator",
"description": "Separator used between flags and their arguments. Defaults to a single space.",
"type": "string"
},
"default-value": {
"id": "http://github.com/boutiques/boutiques-schema/input/default-value",
"description": "Default value of the input. The default value is set when no value is specified, even when the input is optional. If the desired behavior is to omit the input from the command line when no value is specified, then no default value should be used. In this case, the tool might still use a default value internally, but this will remain undocumented in the Boutiques interface."
},
"value-choices": {
"id": "http://github.com/boutiques/boutiques-schema/input/value-choices",
"description": "Permitted choices for input value. May not be used with the Flag type.",
"type": "array",
"items": {
"oneOf": [
{ "type": "string" },
{ "type": "number" }
]
}
},
"value-requires": {
"id": "http://github.com/boutiques/boutiques-schema/input/value-requires",
"description": "Ids of the inputs that are required when the corresponding value choice is selected.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"value-disables": {
"id": "http://github.com/boutiques/boutiques-schema/input/value-disables",
"description": "Ids of the inputs that are disabled when the corresponding value choice is selected.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"integer": {
"id": "http://github.com/boutiques/boutiques-schema/input/integer",
"description": "Specify whether the input should be an integer. May only be used with Number type inputs.",
"type": "boolean"
},
"minimum": {
"id": "http://github.com/boutiques/boutiques-schema/input/minimum",
"description": "Specify the minimum value of the input (inclusive). May only be used with Number type inputs.",
"type": "number"
},
"maximum": {
"id": "http://github.com/boutiques/boutiques-schema/input/maximum",
"description": "Specify the maximum value of the input (inclusive). May only be used with Number type inputs.",
"type": "number"
},
"exclusive-minimum": {
"id": "http://github.com/boutiques/boutiques-schema/input/exclusive-minimum",
"description": "Specify whether the minimum is exclusive or not. May only be used with Number type inputs.",
"type": "boolean"
},
"exclusive-maximum": {
"id": "http://github.com/boutiques/boutiques-schema/input/exclusive-maximum",
"description": "Specify whether the maximum is exclusive or not. May only be used with Number type inputs.",
"type": "boolean"
},
"min-list-entries": {
"id": "http://github.com/boutiques/boutiques-schema/input/min-list-entries",
"description": "Specify the minimum number of entries in the list. May only be used with List type inputs.",
"type": "number"
},
"max-list-entries": {
"id": "http://github.com/boutiques/boutiques-schema/input/max-list-entries",
"description": "Specify the maximum number of entries in the list. May only be used with List type inputs.",
"type": "number"
},
"uses-absolute-path": {
"id": "http://github.com/boutiques/boutiques-schema/input/uses-absolute-path",
"description": "Specifies that this input must be given as an absolute path. Only specifiable for File type inputs.",
"type": "boolean"
}
},
"required": [
"name",
"id",
"type"
],
"anyOf": [{
"properties": {
"type": { "enum": ["Flag"] },
"list": { "enum": [false] }
}
}, {
"properties": {
"type": { "enum": ["String", "File", "Number"] }
}
}],
"dependencies": {
"command-line-flag-separator": ["command-line-flag"],
"min-list-entries": ["list"],
"max-list-entries": ["list"],
"list-separator": ["list"],
"value-choices": {
"properties": {
"type": {"enum": ["String", "Number"]}
}
},
"integer": {
"properties": {
"type": {"enum": ["Number"]}
}
},
"minimum": {
"properties": {
"type": {"enum": ["Number"]}
}
},
"maximum": {
"properties": {
"type": {"enum": ["Number"]}
}
},
"uses-absolute-path": {
"properties": {
"type": {"enum": ["File"]}
}
},
"exclusive-minimum": ["minimum"],
"exclusive-maximum": ["maximum"],
"value-disables": ["value-choices"],
"value-enables": ["value-choices"]
},
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"tests": {
"id": "http://github.com/boutiques/boutiques-schema/tests",
"type": "array",
"minItems": 1,
"items": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case",
"type": "object",
"properties": {
"name": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case/name",
"minLength": 1,
"description": "Name of the test-case",
"type": "string"
},
"invocation": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case/invocation",
"type": "object"
},
"assertions": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case/assertions",
"type": "object",
"properties": {
"exit-code": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case/assertions/exit-code",
"description": "Expected code returned by the program.",
"type": "integer"
},
"output-files": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case/assertions/out-files",
"type": "array",
"minItems": 1,
"items": {
"id": "http://github.com/boutiques/boutiques-schema/test-case/assertions/out-files/output",
"type": "object",
"properties": {
"id": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case/assertions/out-files/output/id",
"description": "Id referring to an output-file",
"minLength": 1,
"pattern": "^[0-9,_,a-z,A-Z]*$",
"type": "string"
},
"md5-reference": {
"id": "http://github.com/boutiques/boutiques-schema/tests/test-case/assertions/out-files/output/reference",
"description": "MD5 checksum string to match against the MD5 checksum of the output-file specified by the id object",
"minLength": 1,
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"anyOf": [
{
"required": [
"exit-code"
]
},
{
"required": [
"output-files"
]
}
]
}
},
"required": [
"name",
"assertions",
"invocation"
]
}
},
"online-platform-urls": {
"id": "http://github.com/boutiques/boutiques-schema/online-platforms",
"type": "array",
"description": "Online platform URLs from which the tool can be executed.",
"items": {
"type": "string",
"pattern": "^https?://"
}
},
"output-files": {
"id": "http://github.com/boutiques/boutiques-schema/output-files",
"type": "array",
"items": {
"id": "http://github.com/boutiques/boutiques-schema/output",
"type": "object",
"properties": {
"id": {
"id": "http://github.com/boutiques/boutiques-schema/output/id",
"minLength": 1,
"description": "A short, unique, informative identifier containing only alphanumeric characters and underscores. Typically used to generate variable names. Example: \"data_file\"",
"pattern": "^[0-9,_,a-z,A-Z]*$",
"type": "string"
},
"name": {
"id": "http://github.com/boutiques/boutiques-schema/output/name",
"description": "A human-readable output name. Example: 'Data file'",
"minLength": 1,
"type": "string"
},
"description": {
"id": "http://github.com/boutiques/boutiques-schema/output/description",
"description": "Output description.",
"type": "string"
},
"value-key": {
"id": "http://github.com/boutiques/boutiques-schema/output/value-key",
"description": "A string contained in command-line, substituted by the output value and/or flag at runtime.",
"type": "string"
},
"path-template": {
"id": "http://github.com/boutiques/boutiques-schema/output/path-template",
"description": "Describes the output file path relatively to the execution directory. May contain input value keys and wildcards. Example: \"results/[INPUT1]_brain*.mnc\".",
"minLength": 1,
"type": "string"
},
"conditional-path-template": {
"id": "http://github.com/boutiques/boutiques-schema/output/conditional-path-template",
"description": "List of objects containing boolean statement (Limited python syntax: ==, !=, <, >, <=, >=, and, or) and output file paths relative to the execution directory, assign path of first true boolean statement. May contain input value keys, \"default\" object required if \"optional\" set to True . Example list: \"[{\"[PARAM1] > 8\": \"outputs/[INPUT1].txt\"}, {\"default\": \"outputs/default.txt\"}]\".",
"minLength": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"propertyNames": {
"pattern": "^[A-Za-z0-9_><=!)( ]*$"
}
}
}
},
"path-template-stripped-extensions": {
"id": "http://github.com/boutiques/boutiques-schema/output/path-template-stripped-extensions",
"description": "List of file extensions that will be stripped from the input values before being substituted in the path template. Example: [\".nii\",\".nii.gz\"].",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"id": "http://github.com/boutiques/boutiques-schema/output/list",
"description": "True if output is a list of value.",
"type": "boolean"
},
"optional": {
"id": "http://github.com/boutiques/boutiques-schema/output/optional",
"description": "True if output may not be produced by the tool.",
"type": "boolean"
},
"command-line-flag": {
"id": "http://github.com/boutiques/boutiques-schema/output/command-line-flag",
"description": "Option flag of the output, involved in the value-key substitution. Examples: -o, --output",
"type": "string"
},
"command-line-flag-separator": {
"id": "http://github.com/boutiques/boutiques-schema/output/command-line-flag-separator",
"description": "Separator used between flags and their arguments. Defaults to a single space.",
"type": "string"
},
"uses-absolute-path": {
"id": "http://github.com/boutiques/boutiques-schema/output-files/uses-absolute-path",
"description": "Specifies that this output filepath will be given as an absolute path.",
"type": "boolean"
},
"file-template": {
"id": "http://github.com/boutiques/boutiques-schema/input/file-template",
"description": "An array of strings that may contain value keys. Each item will be a line in the configuration file.",
"type": "array",
"minItems": 1,
"items": { "type": "string" }
}
},
"required": [
"id",
"name"
],
"oneOf":[{
"properties": {
"path-template": {"enum": [true]}
}
}, {
"properties": {
"conditional-path-template": {"enum": [true]}
}
}],
"anyOf": [{
"properties": {
"file-template": {
"type": "array",
"minItems": 1,
"items": { "type": "string" }
},
"list": { "enum": [false] }
}
}, {
"properties": {
"file-template": { "enum": [false]} }
}],
"dependencies": {
"command-line-flag-separator": ["command-line-flag"]
},
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"invocation-schema": {
"id": "http://github.com/boutiques/boutiques-schema/invocation-schema",
"type": "object"
},
"suggested-resources": {
"id": "http://github.com/boutiques/boutiques-schema/suggested-resources",
"type": "object",
"properties": {
"cpu-cores": {
"id": "http://github.com/boutiques/boutiques-schema/suggested-resources/cpu-cores",
"description": "The requested number of cpu cores to run the described application",
"type": "integer",
"minimum": 1
},
"ram": {
"id": "http://github.com/boutiques/boutiques-schema/suggested-resources/ram",
"description": "The requested number of GB RAM to run the described application",
"type": "number",
"minimum": 0
},
"disk-space": {
"id": "http://github.com/boutiques/boutiques-schema/suggested-resources/disk-space",
"description": "The requested number of GB of storage to run the described application",
"type": "number",
"minimum": 0
},
"nodes": {
"id": "http://github.com/boutiques/boutiques-schema/suggested-resources/nodes",
"description": "The requested number of nodes to spread the described application across",
"type": "integer",
"minimum": 1
},
"walltime-estimate": {
"id": "http://github.com/boutiques/boutiques-schema/suggested-resources/walltime-estimate",
"type": "number",
"description": "Estimated wall time of a task in seconds.",
"minimum": 0
}
}
},
"tags": {
"id": "http://github.com/boutiques/boutiques-schema/tags",
"type": "object",
"description": "A set of key-value pairs specifying tags describing the pipeline. The tag names are open, they might be more constrained in the future.",
"additionalProperties": {
"type": ["string", "array", "boolean"],
"items": {
"type": "string"
},
"description": "Tag values"
}
},
"error-codes": {
"id": "http://github.com/boutiques/boutiques-schema/error-codes",
"type": "array",
"description": "An array of key-value pairs specifying exit codes and their description. Can be used for tools to specify the meaning of particular exit codes. Exit code 0 is assumed to indicate a successful execution.",
"items": {
"id": "http://github.com/boutiques/boutiques-schema/error-codes",
"type": "object",
"properties": {
"code": {
"id": "http://github.com/boutiques/boutiques-schema/error-codes/code",
"description": "Value of the exit code",
"type": "integer"
},
"description": {
"id": "http://github.com/boutiques/boutiques-schema/error-codes/description",
"description": "Description of the error code.",
"type": "string"
}
},
"required": [
"code",
"description"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"custom": {
"id": "http://github.com/boutiques/boutiques-schema/custom",
"type": "object"
}
},
"required": [
"name",
"description",
"command-line",
"schema-version",
"inputs",
"tool-version"
],
"additionalProperties": false
}