Skip to content

Commit 36181ff

Browse files
authored
Merge pull request #173 from ga4gh/develop-1.1
Develop 1.1
2 parents 04a6abb + 61558fd commit 36181ff

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

openapi/task_execution_service.openapi.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,40 @@ components:
525525
items:
526526
type: string
527527
example: us-west-1
528+
backend_parameters:
529+
type: object
530+
additionalProperties:
531+
type: string
532+
description: |-
533+
Key/value pairs for backend configuration.
534+
ServiceInfo shall return a list of keys that a backend supports.
535+
Keys are case insensitive.
536+
It is expected that clients pass all runtime or hardware requirement key/values
537+
that are not mapped to existing tesResources properties to backend_parameters.
538+
Backends shall log system warnings if a key is passed that is unsupported.
539+
Backends shall not store or return unsupported keys if included in a task.
540+
If backend_parameters_strict equals true,
541+
backends should fail the task if any key/values are unsupported, otherwise,
542+
backends should attempt to run the task
543+
Intended uses include VM size selection, coprocessor configuration, etc.
544+
Example:
545+
```
546+
{
547+
"backend_parameters" : {
548+
"VmSize" : "Standard_D64_v3"
549+
}
550+
}
551+
```
552+
example:
553+
"VmSize" : "Standard_D64_v3"
554+
backend_parameters_strict:
555+
type: boolean
556+
description: |-
557+
If set to true, backends should fail the task if any backend_parameters
558+
key/values are unsupported, otherwise, backends should attempt to run the task
559+
format: boolean
560+
default: false
561+
example: false
528562
description: Resources describes the resources requested by a task.
529563
tesServiceType:
530564
allOf:
@@ -552,6 +586,14 @@ components:
552586
example:
553587
- file:///path/to/local/funnel-storage
554588
- s3://ohsu-compbio-funnel/storage
589+
tesResources_backend_parameters:
590+
type: array
591+
description: |-
592+
Lists all tesResources.backend_parameters keys supported
593+
by the service
594+
items:
595+
type: string
596+
example: ["VmSize"]
555597
type:
556598
$ref: '#/components/schemas/tesServiceType'
557599
tesState:

0 commit comments

Comments
 (0)