test_syntax.yml

description: <Job Description>    # Optional
service: <GA4GH Service Name>   # enum - [TES]
versions:
  - <Version>
tags:
  - <Tag Name>                # Logical - No Polling needed, Functional - Polling needed. Always add 3 tags - Individual tag based on test name, TES endpoint tag and "All" tag
jobs:
  - name: <Sub job 1 to be run>   # enum - [service_info, list_tasks, create_task, get_task, cancel_task
    description: <individual job description>       # Optional
    endpoint: <API endpoint>    # enum - [/service-info, /tasks, /tasks/{id}, /tasks/{id}:cancel]
    operation: <HTTP operation>
    path_parameters:                                # Required when path parameter present in endpoint
      <Path Param name>: <value>
    query_parameters:                               # Optional
      <Query Param name> : <value>
    polling:                                        # Optional
      interval: <Polling Interval Value in seconds>
      timeout: <Polling Timeout Value in seconds>
    env_vars:           							# Optional
      <Key>: <Value>
    request_body: |                                 # Optional
      <request body to be sent in request>
    storage_vars:       # Optional
      <Key>: <Value>    # Value should start with "$response" and comply with "dot" notation
    filter:             # Optional
      - path: <Path to filter>
        type: <Type>                    # enum - [string, array, object]
        regex: <Boolean value>          # Optional, to be used with "string" only
        value: <Value to be filtered>   # Optional
        size: <Size>                    # Optional
    response:
      <response status>: |
        <data to be matched against the response>
  - $ref: <Path to template file>
    args:               # Optional
      <Key>: <Value>