Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Forwarded Header Transforms Doc Comments #2530

Merged
merged 2 commits into from
Jul 2, 2024
Merged

Forwarded Header Transforms Doc Comments #2530

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07a107c
Add contextual doc commnets indicating that using Forwarded or XForwa…
mroberts91 Jun 24, 2024
c0581be
Tweak comments
MihaZupan Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/ReverseProxy/Transforms/ForwardedTransformExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ public static TransformBuilderContext AddXForwardedPrefix(this TransformBuilderC
/// <summary>
/// Adds the transform which will add X-Forwarded-* request headers.
/// </summary>
/// <remarks>
/// Removes the Forwarded header when an X-Forwarded transform is enabled
MihaZupan marked this conversation as resolved.
Show resolved Hide resolved
/// </remarks>
public static TransformBuilderContext AddXForwarded(this TransformBuilderContext context, ForwardedTransformActions action = ForwardedTransformActions.Set)
{
context.AddXForwardedFor(action: action);
Expand Down Expand Up @@ -173,6 +176,9 @@ public static RouteConfig WithTransformForwarded(this RouteConfig route, bool us
/// <summary>
/// Adds the transform which will add the Forwarded header as defined by [RFC 7239](https://tools.ietf.org/html/rfc7239).
/// </summary>
/// <remarks>
/// Removes the X-Forwarded headers when an Forwarded transform is enabled
MihaZupan marked this conversation as resolved.
Show resolved Hide resolved
/// </remarks>
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)
Expand Down
Loading