run.md

Runfile

Run configuration file for creating a test run with specified checks.

Quick Reference

{
    "type": "run",
    "checks": [
        {
            "check_id": 0,
            "test_case": "https.TestHTTPAvailable",
            "config": {
                "request_info": {
                    "url": "http://api.example.com",
                    "path": "/user",
                    "operation": "get",
                    "kwargs": {
                        "allow_redirects": false
                    }
                },
                "auth_info": {
                    "scheme_ids": null,
                    "scopes": null,
                    "policy": "DEFAULT"
                }
            }
        }
    ]
}

Attributes

Parameter	Type	Optional
type	String	No
[checks]	Array[Object]	No

checks

type
Run configuration type. Value must be run.

checks
Configuration parameters for the individual checks (see here for more details).

checks Object

Check definitions for the test run.

Parameter	Type	Optional
check_id	Number	No
test_case	String	No
config	Object	Yes

check_id
(Unique) reference ID of the check.

test_case
ID of the test case of the check.

config
Serialized configuration of the check. The format of this object depends on the test case.