From 8a9f0a245e67c73f81dd21521d285ede360b10c0 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Tue, 8 Oct 2024 16:30:00 +0200 Subject: [PATCH] chore(api): improve --api-body-limit flag description to include examples --- pkg/modules/api/api.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/modules/api/api.go b/pkg/modules/api/api.go index e352ea56..3d6cb459 100644 --- a/pkg/modules/api/api.go +++ b/pkg/modules/api/api.go @@ -178,7 +178,7 @@ func (a *Api) Descriptor() gotenberg.ModuleDescriptor { fs.String("api-tls-key-file", "", "Path to the TLS/SSL key file - for HTTPS support") fs.Duration("api-start-timeout", time.Duration(30)*time.Second, "Set the time limit for the API to start") fs.Duration("api-timeout", time.Duration(30)*time.Second, "Set the time limit for requests") - fs.String("api-body-limit", "", "Set the body limit for multipart/form-data requests") + fs.String("api-body-limit", "", "Set the body limit for multipart/form-data requests - it accepts values like 5MB, 1GB, etc") fs.String("api-root-path", "/", "Set the root path of the API - for service discovery via URL paths") fs.String("api-trace-header", "Gotenberg-Trace", "Set the header name to use for identifying requests") fs.Bool("api-enable-basic-auth", false, "Enable basic authentication - will look for the GOTENBERG_API_BASIC_AUTH_USERNAME and GOTENBERG_API_BASIC_AUTH_PASSWORD environment variables")