docs: note blob streaming idle-timeout behaviour

Clarify on the ReadTimeout/WriteTimeout config fields that blob transfers extend
the deadline per read/write, so it behaves as an idle timeout for them rather
than a cap on total transfer time.

Signed-off-by: Paul Kennedy <9027062+datadot@users.noreply.github.com>

Author: datadot

pkg/api/config/config.go

@@ -386,11 +386,13 @@ type HTTPConfig struct {
 	AllowOrigin string // comma separated
 	// ReadTimeout controls maximum duration for reading the entire request (including body).
 	// When unset (nil), server-level defaults may apply. When explicitly set to <= 0,
-	// the HTTP server treats it as no timeout.
+	// the HTTP server treats it as no timeout. Blob uploads extend this deadline per read,
+	// so it acts as an idle timeout for them rather than a cap on total upload time.
 	ReadTimeout *time.Duration `mapstructure:"readTimeout,omitempty"`
 	// WriteTimeout controls maximum duration before timing out response writes.
 	// When unset (nil), server-level defaults may apply. When explicitly set to <= 0,
-	// the HTTP server treats it as no timeout.
+	// the HTTP server treats it as no timeout. Blob downloads extend this deadline per write,
+	// so it acts as an idle timeout for them rather than a cap on total download time.
 	WriteTimeout  *time.Duration `mapstructure:"writeTimeout,omitempty"`
 	TLS           *TLSConfig
 	Auth          *AuthConfig