Skip to content

Latest commit

 

History

History
393 lines (308 loc) · 11 KB

util.rst

File metadata and controls

393 lines (308 loc) · 11 KB

Util

Test paths or URLs

Data model

Path test result

Name Multiplicity Type Description
path 1 string The path that was tested.
exists 1 bool true if the path exists, false otherwise.
typeok 1 bool true if a type check was not requested or it passed, false otherwise
access 1 bool true if a permission check was not requested or it passed, false otherwise
result 1 bool true if the overall check passed, false otherwise

URL test result

Name Multiplicity Type Description
url 1 string The URL that was tested.
status 1 int The status code returned by the URL, 0 in case of a timeout.
result 1 bool true if the check passed.
response 0..1 string or object If response in the request was set to bytes: The base64 encoded body of the checked URL's response. If response in the request was set to json: The json decoded body of the checked URL's response. Not present if response in the request was not set.
headers 0..1 object A dictionary with all headers of the checked URL's response. Only present if response in the request was set.

Server test result

Name Multiplicity Type Description
host 1 string The host that was tested.
port 1 int The port that was tested
protocol 1 string The protocol that was tested, tcp or udp
result 1 bool true if the check passed.