From 4b0f66477d6b9926c0f5c9c221ed58e9a2ff3b63 Mon Sep 17 00:00:00 2001 From: Michael Robertson Date: Tue, 2 Jul 2024 10:19:00 -0400 Subject: [PATCH] Forwarded Header Transforms Doc Comments (#2530) * Add contextual doc commnets indicating that using Forwarded or XForwarded header transforms will remove the other when enabled. * Tweak comments --------- Co-authored-by: Miha Zupan --- src/ReverseProxy/Transforms/ForwardedTransformExtensions.cs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/ReverseProxy/Transforms/ForwardedTransformExtensions.cs b/src/ReverseProxy/Transforms/ForwardedTransformExtensions.cs index 5a856a27b..0a0cf9869 100644 --- a/src/ReverseProxy/Transforms/ForwardedTransformExtensions.cs +++ b/src/ReverseProxy/Transforms/ForwardedTransformExtensions.cs @@ -113,6 +113,9 @@ public static TransformBuilderContext AddXForwardedPrefix(this TransformBuilderC /// /// Adds the transform which will add X-Forwarded-* request headers. /// + /// + /// Also removes the Forwarded header when enabled. + /// public static TransformBuilderContext AddXForwarded(this TransformBuilderContext context, ForwardedTransformActions action = ForwardedTransformActions.Set) { context.AddXForwardedFor(action: action); @@ -173,6 +176,9 @@ public static RouteConfig WithTransformForwarded(this RouteConfig route, bool us /// /// Adds the transform which will add the Forwarded header as defined by [RFC 7239](https://tools.ietf.org/html/rfc7239). /// + /// + /// Also removes the X-Forwarded headers when enabled. + /// public static TransformBuilderContext AddForwarded(this TransformBuilderContext context, bool useHost = true, bool useProto = true, NodeFormat forFormat = NodeFormat.Random, NodeFormat byFormat = NodeFormat.Random, ForwardedTransformActions action = ForwardedTransformActions.Set)