📝 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 {
|
||||
default = { };
|
||||
example = {
|
||||
github = {
|
||||
url = "https://github.com";
|
||||
expectedContent = "GitHub";
|
||||
};
|
||||
};
|
||||
description = ''
|
||||
Verify that ports the defined ports are closed for a specific interface.
|
||||
Verification is done by rustscan.
|
||||
Run curl commands to verify if response code is as expected and expectedContent is part of the body.
|
||||
'';
|
||||
type = attrsOf (submodule {
|
||||
options = {
|
||||
|
@ -25,13 +30,13 @@ with types;
|
|||
type = int;
|
||||
default = 200;
|
||||
description = ''
|
||||
expected response code
|
||||
Expected response code
|
||||
'';
|
||||
};
|
||||
expectedContent = mkOption {
|
||||
type = nullOr str;
|
||||
description = ''
|
||||
expected string in the response
|
||||
Expected string in the response
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
@ -84,13 +89,6 @@ with types;
|
|||
|
||||
) config.verify.http;
|
||||
|
||||
# verify.localCommands.taskchampion =
|
||||
# let
|
||||
# domain = "http://orbi.private:10222";
|
||||
# grepString = "TaskChampion sync server";
|
||||
# in
|
||||
#
|
||||
|
||||
};
|
||||
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue