Skip to content

Commit b535044

Browse files
probelabs[bot]mativm02tbuchaillot
authored
[TT-17415] Address docs review feedback on config doc comments (#1051) (#1056)
Docs-team review of the R3 docs sync PR (tyk-docs#2487) requested wording fixes in the generated Pump config documentation: - Reword the log_format description. - Restore the leading slash in the enable_http_profiler docs link. (cherry picked from commit b348e21) Co-authored-by: Matias <matipvp02@gmail.com> Co-authored-by: Tomas Buchaillot <tombuchaillot89@gmail.com>
1 parent e1981c0 commit b535044

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

config.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,9 @@ type TykPumpConfiguration struct {
206206
// Set the logger details for tyk-pump. The posible values are: `info`,`debug`,`error` and
207207
// `warn`. By default, the log level is `info`.
208208
LogLevel string `json:"log_level"`
209-
// Set the logger format. The possible values are: `text`, `json`, and `legacy`.
210-
// By default, the log format is `text`.
209+
// Configures the output format used for application logs.
210+
// Allowed values are `text`, `json`, or `legacy`.
211+
// If not set or left empty, it defaults to `text`.
211212
LogFormat logger.Format `json:"log_format"`
212213
// TYKCONFIGHEADERSTART
213214
// HEADER Health Check
@@ -248,7 +249,7 @@ type TykPumpConfiguration struct {
248249
OmitDetailedRecording bool `json:"omit_detailed_recording"`
249250
// Defines if tyk-pump should ignore all the values in configuration file. Specially useful when setting all configurations in environment variables.
250251
OmitConfigFile bool `json:"omit_config_file"`
251-
// Expose profiling information to support debugging of Tyk Pump. This operates in the same way as for Tyk Gateway, as explained [here](api-management/troubleshooting-debugging).
252+
// Expose profiling information to support debugging of Tyk Pump. This operates in the same way as for Tyk Gateway, as explained [here](/api-management/troubleshooting-debugging).
252253
HTTPProfile bool `json:"enable_http_profiler"`
253254
// This option was intended to decode raw request payloads from base64 for all Pumps. However, it was never implemented and therefore has no functional effect. It has now been deprecated.
254255
// for all pumps. This is set to false by default.

0 commit comments

Comments
 (0)