From b5aeac1ab6d392714723311b269a71c5177e3810 Mon Sep 17 00:00:00 2001 From: Leonid Bugaev Date: Mon, 11 May 2026 13:07:02 +0000 Subject: [PATCH] docs: update configuration struct comments --- pumps/elasticsearch.go | 6 +++--- pumps/hybrid.go | 3 +-- pumps/mongo.go | 2 ++ pumps/stdout.go | 3 +-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/pumps/elasticsearch.go b/pumps/elasticsearch.go index 9c5526ca6..2515289e1 100644 --- a/pumps/elasticsearch.go +++ b/pumps/elasticsearch.go @@ -92,9 +92,9 @@ type ElasticsearchConf struct { SSLKeyFile string `json:"ssl_key_file" mapstructure:"ssl_key_file"` // Path to the PEM file with trusted CA certificates that will be used to verify the Elasticsearch server's certificate. SSLCAFile string `json:"ssl_ca_file" mapstructure:"ssl_ca_file"` - // When set, MCP records are written to this index instead of the default IndexName. - // Supports the same rolling-index date suffix as IndexName when RollingIndex is enabled. - // Defaults to "" (empty), which means all records are written to IndexName as before. + // When set, Model Context Protocol (MCP) records are written to this index instead of the default `IndexName`. + // Supports the same rolling-index date suffix as `IndexName` when `RollingIndex` is enabled. + // Defaults to `""` (empty string), meaning all records go to `IndexName`. MCPIndexName string `json:"mcp_index_name" mapstructure:"mcp_index_name"` } diff --git a/pumps/hybrid.go b/pumps/hybrid.go index 64e45e771..e37523712 100644 --- a/pumps/hybrid.go +++ b/pumps/hybrid.go @@ -94,8 +94,7 @@ type HybridPumpConf struct { TrackAllPaths bool `mapstructure:"track_all_paths"` // Determines if the aggregations should be made per minute (true) or per hour (false) if `aggregated` is set to `true`. StoreAnalyticsPerMinute bool `json:"store_analytics_per_minute" mapstructure:"store_analytics_per_minute"` - // EnableMCPAggregation controls whether MCP analytics are aggregated and sent - // to MDCB via a separate RPC call. Only applies when `aggregated` is `true`. + // Controls whether MCP (Model Context Protocol) analytics are aggregated and sent to MDCB via a separate RPC call. Only applies when `aggregated` is `true`. EnableMCPAggregation bool `json:"enable_mcp_aggregation" mapstructure:"enable_mcp_aggregation"` // Use SSL to connect to Tyk MDCB diff --git a/pumps/mongo.go b/pumps/mongo.go index 995683f3a..6a680aa1d 100644 --- a/pumps/mongo.go +++ b/pumps/mongo.go @@ -78,6 +78,8 @@ type BaseMongoConf struct { // Path to the PEM file which contains both client certificate and private key. This is // required for Mutual TLS. MongoSSLPEMKeyfile string `json:"mongo_ssl_pem_keyfile" mapstructure:"mongo_ssl_pem_keyfile"` + // ENV: TYK_PMP_PUMPS_MONGO_META_MONGODBTYPE + // Type: int // Specifies the mongo DB Type. If it's 0, it means that you are using standard mongo db. If it's 1 it means you are using AWS Document DB. If it's 2, it means you are using CosmosDB. // Defaults to Standard mongo (0). MongoDBType MongoType `json:"mongo_db_type" mapstructure:"mongo_db_type"` diff --git a/pumps/stdout.go b/pumps/stdout.go index 4598e91a0..9dd23ac65 100644 --- a/pumps/stdout.go +++ b/pumps/stdout.go @@ -33,8 +33,7 @@ type StdOutConf struct { Format string `json:"format" mapstructure:"format"` // Root name of the JSON object the analytics record is nested in. LogFieldName string `json:"log_field_name" mapstructure:"log_field_name"` - // UseLegacyPayloadFormat skips formatting of raw_request and raw_response as valid JSON objects instead of escaped strings. - // This config variable exists for backward compatibility. + // Use the legacy formatting of raw_request and raw_response as escaped strings rather than JSON formatting. UseLegacyPayloadFormat bool `json:"use_legacy_payload_format" mapstructure:"use_legacy_payload_format"` }