diff --git a/openapi/task_execution_service.openapi.yaml b/openapi/task_execution_service.openapi.yaml index 2f0858a..6de2f95 100644 --- a/openapi/task_execution_service.openapi.yaml +++ b/openapi/task_execution_service.openapi.yaml @@ -63,6 +63,12 @@ info: servers: - url: /ga4gh/tes/v1 + +security: + - {} + - BasicAuth: [] + - BearerAuth: [] + paths: /service-info: get: @@ -554,7 +560,7 @@ components: backend_parameters_strict: type: boolean description: |- - If set to true, backends should fail the task if any backend_parameters + If set to true, backends should fail the task if any backend_parameters key/values are unsupported, otherwise, backends should attempt to run the task format: boolean default: false @@ -589,7 +595,7 @@ components: tesResources_backend_parameters: type: array description: |- - Lists all tesResources.backend_parameters keys supported + Lists all tesResources.backend_parameters keys supported by the service items: type: string @@ -792,3 +798,24 @@ components: items: type: string description: TaskLog describes logging information related to a Task. + + securitySchemes: + BasicAuth: + type: http + scheme: basic + description: | + A valid authorization token must be passed in the 'Authorization' header, + e.g. "Basic ${token_string}" + BearerAuth: + type: http + scheme: bearer + description: + A valid authorization token must be passed in the 'Authorization' header, + e.g. "Bearer ${token_string}" + PassportAuth: + type: http + scheme: bearer + x-in: body + bearerFormat: JWT + description: + A valid GA4GH Passport must be passed in the body of an HTTP POST request as a tokens[] array.