From 706159eef5da2a5e2aea55e14f1f5aeb925b1747 Mon Sep 17 00:00:00 2001
From: Julin <142230457+c-julin@users.noreply.github.com>
Date: Wed, 13 Aug 2025 11:48:11 +0100
Subject: [PATCH] docs: add format examples and clarifications for debug bundle
 log options

- Add ISO8601 datetime format examples for WithLogsSince and WithLogsUntil
- Clarify that WithLogsUntil is not used on Kubernetes environments
---
 rpadmin/api_debug.go | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/rpadmin/api_debug.go b/rpadmin/api_debug.go
index 65fd0933..d8270cff 100644
--- a/rpadmin/api_debug.go
+++ b/rpadmin/api_debug.go
@@ -266,14 +266,17 @@ func WithMetricsSamples(v int32) DebugBundleOption {
 	}}
 }
 
-// WithLogsSince sets the logs-since parameter.
+// WithLogsSince sets the logs-since parameter. Accepts an ISO8601 formatted datetime string.
+// For example, "2023-10-20T15:04:05"
 func WithLogsSince(v string) DebugBundleOption {
 	return debugBundleOpt{func(param *debugBundleStartConfigParameters) {
 		param.LogsSince = v
 	}}
 }
 
-// WithLogsUntil sets the logs-until parameter.
+// WithLogsUntil sets the logs-until parameter. This will not be used when generating debug bundles on kuberneetes.
+// Accepts an ISO8601 formatted datetime string.
+// For example, "2023-10-20T15:04:05"
 func WithLogsUntil(v string) DebugBundleOption {
 	return debugBundleOpt{func(param *debugBundleStartConfigParameters) {
 		param.LogsUntil = v