Skip to main content

Schemas

JSON schemas for configs, test specs, and actions. These schemas validate the structure of your test specs and configurations and apply to both JSON and YAML files.

📄️ Browser Viewport

Viewport dimensions.

📄️ Browser Window

Browser dimensions.

📄️ Browser

Browser configuration.

📄️ Capture screenshot (detailed)

Referenced In

📄️ Check link (detailed)

Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.

📄️ checkLink

Referenced In

📄️ Click element (detailed)

Referenced In

📄️ click

Referenced In

📄️ Common

Referenced In

📄️ config

Configuration options for Doc Detective operations.

📄️ context

A context in which to perform tests. If no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. For example, if a browser isn't specified but is required by steps in the test, Doc Detective will search for and use a supported browser available in the current environment.

📄️ Crop by element (detailed)

Crop the screenshot to a specific element.

📄️ Environment details

Environment information for the system running Doc Detective.

📄️ File type (custom)

Referenced In

📄️ File type (executable)

Referenced In

📄️ Find element and click

Referenced In

📄️ Find element (detailed)

Referenced In

📄️ find

Referenced In

📄️ Go to URL (detailed)

Navigate to an HTTP or HTTPS URL.

📄️ goTo

Referenced In

📄️ HTTP request (detailed)

Referenced In

📄️ httpRequest

Referenced In

📄️ Inline statement definition

Statements to include tests and steps inside the content of the file, such as within Markdown.

📄️ Integrations options

Options for connecting to external services.

📄️ loadVariables

Referenced In

📄️ Markup definition

Referenced In

📄️ openApi

OpenAPI description and configuration.

📄️ Padding (detailed)

Padding in pixels to add to the bounds of the element.

📄️ Record (detailed)

Referenced In

📄️ record

Referenced In

📄️ Request body (object)

JSON object to include as the body of the HTTP request.

📄️ Request headers (object)

Headers to include in the HTTP request, in key/value format.

📄️ Request parameters

URL parameters to include in the HTTP request, in key/value format.

📄️ Request

Referenced In

📄️ Resolved context

Referenced In

📄️ Response body object

JSON key/value pairs expected in the response.

📄️ Response headers

Headers expected in the response, in key/value format. If one or more responseHeaders entries aren't present in the response, the step fails.

📄️ Response

Referenced In

📄️ Run code (detailed)

Referenced In

📄️ Run shell command (detailed)

Referenced In

📄️ runCode

Referenced In

📄️ runShell

Referenced In

📄️ screenshot

Referenced In

📄️ specification

Fields

📄️ stopRecord

Referenced In

📄️ Telemetry options

Options around sending telemetry for Doc Detective usage.

📄️ test

A Doc Detective test.

📄️ Type keys (detailed)

Referenced In

📄️ type

Referenced In

📄️ wait

Referenced In