From 1594ba997e72a5040813ac1449f78234a05e6c41 Mon Sep 17 00:00:00 2001
From: searKing <471030698@qq.com>
Date: Thu, 20 Jun 2024 00:08:47 +0800
Subject: [PATCH] doc(webserver/healthz): comment for URL query: verbose and
 exclude

---
 pkg/webserver/healthz/handler.go | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/pkg/webserver/healthz/handler.go b/pkg/webserver/healthz/handler.go
index 0630668f..4dda6187 100644
--- a/pkg/webserver/healthz/handler.go
+++ b/pkg/webserver/healthz/handler.go
@@ -77,6 +77,11 @@ type Muxer interface {
 }
 
 // handleRootHealth returns an http.HandlerFunc that serves the provided checks.
+//
+// URL query:
+//
+//	verbose responds with detailed check output.
+//	exclude=foo&exclude=bar&exclude=baz will bypass checking "foo", "bar" and "baz".
 func handleRootHealth(name string, firstTimeHealthy func(), checks ...HealthChecker) http.HandlerFunc {
 	var notifyOnce sync.Once
 	return func(w http.ResponseWriter, r *http.Request) {