From 62315ee2c21bbcbfad02733523da9f711b9d7cc0 Mon Sep 17 00:00:00 2001
From: Ingolf Wagner <contact@ingolf-wagner.de>
Date: Mon, 16 Sep 2024 08:53:03 +0700
Subject: [PATCH] :memo: update module documentation

---
 nix/verify/modules/http.nix | 20 +++++++++-----------
 1 file changed, 9 insertions(+), 11 deletions(-)

diff --git a/nix/verify/modules/http.nix b/nix/verify/modules/http.nix
index 37d8a0c..0f0ae8d 100644
--- a/nix/verify/modules/http.nix
+++ b/nix/verify/modules/http.nix
@@ -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
-    #
-
   };
 
 }