Class SyntheticsAPITestConfig

Configuration object for a Synthetic API test.

Hierarchy

  • SyntheticsAPITestConfig

Constructors

constructor

Properties

additionalProperties? assertions? configVariables? request? steps? variablesFromScript?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional assertions

assertions?: SyntheticsAssertion[]

Array of assertions used for the test. Required for single API tests.

Optional configVariables

configVariables?: SyntheticsConfigVariable[]

Array of variables used for the test.

Optional request

request?: SyntheticsTestRequest

Object describing the Synthetic test request.

Optional steps

steps?: SyntheticsAPIStep[]

When the test subtype is multi, the steps of the test.

Optional variablesFromScript

variablesFromScript?: string

Variables defined from JavaScript code.

Settings

Member Visibility

Theme

Generated using TypeDoc