Skip to content

Resource fields

This page is generated from bddkit resource fields --json. Plugin groups are not listed here; bddkit resource fields --config <suite> lists them for a suite.

Source: host

Key Required Type Does
base_url yes string root URL every request is resolved against
timeout_secs no number per-request timeout in seconds (default 20)
default_headers no nonscalar headers sent with every request until a scenario replaces them
sensitive_headers no nonscalar header names masked in failure dumps and reports, added to authorization, cookie, set-cookie
sensitive_headers_only no nonscalar header names masked instead of authorization, cookie, set-cookie; an empty list masks no header
options no nonscalar polling.timeout_secs / polling.interval_ms for eventual assertions against this API

Source: host

Key Required Type Does
dsn yes string connection string; its scheme selects the engine (postgres://, mysql://)
search_path no nonscalar Postgres schema search path; refused on MySQL and MariaDB, which have no session equivalent
options no nonscalar polling.timeout_secs / polling.interval_ms for eventual assertions against this connection

Source: host

Key Required Type Does
variant yes string hex-string or rfc5054
prime no string group prime in hexadecimal (default: the RFC 5054 4096-bit group)
generator no string generator as a decimal number (default 5)
hash no string sha-1, sha-256 or sha-512 (default sha-256)
options no nonscalar polling.timeout_secs / polling.interval_ms for eventual assertions using this configuration