📝 update module documentation
This commit is contained in:
parent
e43f4514bc
commit
62315ee2c2
1 changed files with 9 additions and 11 deletions
|
@ -9,9 +9,14 @@ with types;
|
||||||
{
|
{
|
||||||
options.verify.http = mkOption {
|
options.verify.http = mkOption {
|
||||||
default = { };
|
default = { };
|
||||||
|
example = {
|
||||||
|
github = {
|
||||||
|
url = "https://github.com";
|
||||||
|
expectedContent = "GitHub";
|
||||||
|
};
|
||||||
|
};
|
||||||
description = ''
|
description = ''
|
||||||
Verify that ports the defined ports are closed for a specific interface.
|
Run curl commands to verify if response code is as expected and expectedContent is part of the body.
|
||||||
Verification is done by rustscan.
|
|
||||||
'';
|
'';
|
||||||
type = attrsOf (submodule {
|
type = attrsOf (submodule {
|
||||||
options = {
|
options = {
|
||||||
|
@ -25,13 +30,13 @@ with types;
|
||||||
type = int;
|
type = int;
|
||||||
default = 200;
|
default = 200;
|
||||||
description = ''
|
description = ''
|
||||||
expected response code
|
Expected response code
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
expectedContent = mkOption {
|
expectedContent = mkOption {
|
||||||
type = nullOr str;
|
type = nullOr str;
|
||||||
description = ''
|
description = ''
|
||||||
expected string in the response
|
Expected string in the response
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
@ -84,13 +89,6 @@ with types;
|
||||||
|
|
||||||
) config.verify.http;
|
) config.verify.http;
|
||||||
|
|
||||||
# verify.localCommands.taskchampion =
|
|
||||||
# let
|
|
||||||
# domain = "http://orbi.private:10222";
|
|
||||||
# grepString = "TaskChampion sync server";
|
|
||||||
# in
|
|
||||||
#
|
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue