fix docs

Author: 20agbekodo

src/common/http/server_auth.rs

@@ -56,10 +56,8 @@ pub enum HttpServerAuthConfig {
     /// Custom authentication using VRL code.
     ///
     /// Takes in request and validates it using VRL code. The VRL program must return a boolean.
-    /// Metadata fields written via `%field = value` in the VRL program are extracted and injected
-    /// into the log's body if log namespacing is enabled.
     Custom {
-        /// The VRL boolean expression. May write `%field = value` to enrich events.
+        /// The VRL boolean expression.
         source: String,
     },
 }

src/sources/http_server.rs

@@ -117,6 +117,11 @@ pub struct SimpleHttpConfig {
     #[configurable(metadata(docs::examples = "*"))]
     query_parameters: Vec<String>,
 
+    /// HTTP authentication configuration.
+    ///
+    /// When using the `custom` strategy, the VRL program may write `%field = value` to enrich
+    /// authenticated events. These metadata fields are injected into the event body (legacy
+    /// namespace) or under `http_server.<field>` in event metadata (Vector namespace).
     #[configurable(derived)]
     auth: Option<HttpServerAuthConfig>,
 

website/cue/reference/components/sinks/generated/websocket_server.cue

@@ -52,7 +52,7 @@ generated: components: sinks: websocket_server: configuration: {
 				type: string: examples: ["${PASSWORD}", "password"]
 			}
 			source: {
-				description:   "The VRL boolean expression. May write `%field = value` to enrich events."
+				description:   "The VRL boolean expression."
 				relevant_when: "strategy = \"custom\""
 				required:      true
 				type: string: {}
@@ -72,8 +72,6 @@ generated: components: sinks: websocket_server: configuration: {
 						Custom authentication using VRL code.
 
 						Takes in request and validates it using VRL code. The VRL program must return a boolean.
-						Metadata fields written via `%field = value` in the VRL program are extracted and injected
-						into the log's body if log namespacing is enabled.
 						"""
 				}
 			}

website/cue/reference/components/sources/generated/heroku_logs.cue

@@ -43,7 +43,7 @@ generated: components: sources: heroku_logs: configuration: {
 				type: string: examples: ["${PASSWORD}", "password"]
 			}
 			source: {
-				description:   "The VRL boolean expression. May write `%field = value` to enrich events."
+				description:   "The VRL boolean expression."
 				relevant_when: "strategy = \"custom\""
 				required:      true
 				type: string: {}
@@ -63,8 +63,6 @@ generated: components: sources: heroku_logs: configuration: {
 						Custom authentication using VRL code.
 
 						Takes in request and validates it using VRL code. The VRL program must return a boolean.
-						Metadata fields written via `%field = value` in the VRL program are extracted and injected
-						into the log's body if log namespacing is enabled.
 						"""
 				}
 			}

website/cue/reference/components/sources/generated/http.cue

@@ -33,10 +33,11 @@ generated: components: sources: http: configuration: {
 	}
 	auth: {
 		description: """
-			Configuration of the authentication strategy for server mode sinks and sources.
+			HTTP authentication configuration.
 
-			Use the HTTP authentication with HTTPS only. The authentication credentials are passed as an
-			HTTP header without any additional encryption beyond what is provided by the transport itself.
+			When using the `custom` strategy, the VRL program may write `%field = value` to enrich
+			authenticated events. These metadata fields are injected into the event body (legacy
+			namespace) or under `http_server.<field>` in event metadata (Vector namespace).
 			"""
 		required: false
 		type: object: options: {
@@ -47,7 +48,7 @@ generated: components: sources: http: configuration: {
 				type: string: examples: ["${PASSWORD}", "password"]
 			}
 			source: {
-				description:   "The VRL boolean expression. May write `%field = value` to enrich events."
+				description:   "The VRL boolean expression."
 				relevant_when: "strategy = \"custom\""
 				required:      true
 				type: string: {}
@@ -67,8 +68,6 @@ generated: components: sources: http: configuration: {
 						Custom authentication using VRL code.
 
 						Takes in request and validates it using VRL code. The VRL program must return a boolean.
-						Metadata fields written via `%field = value` in the VRL program are extracted and injected
-						into the log's body if log namespacing is enabled.
 						"""
 				}
 			}

website/cue/reference/components/sources/generated/http_server.cue

@@ -33,10 +33,11 @@ generated: components: sources: http_server: configuration: {
 	}
 	auth: {
 		description: """
-			Configuration of the authentication strategy for server mode sinks and sources.
+			HTTP authentication configuration.
 
-			Use the HTTP authentication with HTTPS only. The authentication credentials are passed as an
-			HTTP header without any additional encryption beyond what is provided by the transport itself.
+			When using the `custom` strategy, the VRL program may write `%field = value` to enrich
+			authenticated events. These metadata fields are injected into the event body (legacy
+			namespace) or under `http_server.<field>` in event metadata (Vector namespace).
 			"""
 		required: false
 		type: object: options: {
@@ -47,7 +48,7 @@ generated: components: sources: http_server: configuration: {
 				type: string: examples: ["${PASSWORD}", "password"]
 			}
 			source: {
-				description:   "The VRL boolean expression. May write `%field = value` to enrich events."
+				description:   "The VRL boolean expression."
 				relevant_when: "strategy = \"custom\""
 				required:      true
 				type: string: {}
@@ -67,8 +68,6 @@ generated: components: sources: http_server: configuration: {
 						Custom authentication using VRL code.
 
 						Takes in request and validates it using VRL code. The VRL program must return a boolean.
-						Metadata fields written via `%field = value` in the VRL program are extracted and injected
-						into the log's body if log namespacing is enabled.
 						"""
 				}
 			}

website/cue/reference/components/sources/generated/prometheus_pushgateway.cue

@@ -57,7 +57,7 @@ generated: components: sources: prometheus_pushgateway: configuration: {
 				type: string: examples: ["${PASSWORD}", "password"]
 			}
 			source: {
-				description:   "The VRL boolean expression. May write `%field = value` to enrich events."
+				description:   "The VRL boolean expression."
 				relevant_when: "strategy = \"custom\""
 				required:      true
 				type: string: {}
@@ -77,8 +77,6 @@ generated: components: sources: prometheus_pushgateway: configuration: {
 						Custom authentication using VRL code.
 
 						Takes in request and validates it using VRL code. The VRL program must return a boolean.
-						Metadata fields written via `%field = value` in the VRL program are extracted and injected
-						into the log's body if log namespacing is enabled.
 						"""
 				}
 			}

website/cue/reference/components/sources/generated/prometheus_remote_write.cue

@@ -47,7 +47,7 @@ generated: components: sources: prometheus_remote_write: configuration: {
 				type: string: examples: ["${PASSWORD}", "password"]
 			}
 			source: {
-				description:   "The VRL boolean expression. May write `%field = value` to enrich events."
+				description:   "The VRL boolean expression."
 				relevant_when: "strategy = \"custom\""
 				required:      true
 				type: string: {}
@@ -67,8 +67,6 @@ generated: components: sources: prometheus_remote_write: configuration: {
 						Custom authentication using VRL code.
 
 						Takes in request and validates it using VRL code. The VRL program must return a boolean.
-						Metadata fields written via `%field = value` in the VRL program are extracted and injected
-						into the log's body if log namespacing is enabled.
 						"""
 				}
 			}