Skip to content

Update triple slash comments on QueryParameterMatchMode and HeaderMatchMode #3049

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

Closed
Benziza wants to merge 1 commit into from
Closed

Update triple slash comments on QueryParameterMatchMode and HeaderMatchMode #3049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/ReverseProxy/Configuration/HeaderMatchMode.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ public enum HeaderMatchMode
Contains,

/// <summary>
/// The header must exist and the value must be non-empty.
/// None of the headers with the given name may contain any of the match values, subject to case sensitivity settings.
/// The rule also matches if the header is missing or its value is empty.
/// </summary>
NotContains,

Expand All @@ -40,7 +40,7 @@ public enum HeaderMatchMode
Exists,

/// <summary>
/// The header must not exist.
/// The header must not exist, or its value must be empty.
/// </summary>
NotExists,
}
21 changes: 7 additions & 14 deletions src/ReverseProxy/Configuration/QueryParameterMatchMode.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,29 @@ namespace Yarp.ReverseProxy.Configuration;
public enum QueryParameterMatchMode
{
/// <summary>
/// Query string must match in its entirety,
/// Subject to case sensitivity settings.
/// Only single query parameter name supported. If there are multiple query parameters with the same name then the match fails.
/// Any of the values for the given query parameter must match in its entirety, subject to case sensitivity settings.
/// </summary>
Exact,

/// <summary>
/// Query string key must be present and substring must match for each of the respective query string values.
/// Subject to case sensitivity settings.
/// Only single query parameter name supported. If there are multiple query parameters with the same name then the match fails.
/// Any of the values for the given query parameter must contain any of the match values, subject to case sensitivity settings.
/// </summary>
Contains,

/// <summary>
/// Query string key must be present and value must not match for each of the respective query string values.
/// Subject to case sensitivity settings.
/// If there are multiple values then it needs to not contain ANY of the values
/// Only single query parameter name supported. If there are multiple query parameters with the same name then the match fails.
/// None of the values for the given query parameter may contain any of the match values, subject to case sensitivity settings.
/// The rule also matches if the query parameter is missing or its value is empty.
/// </summary>
NotContains,

/// <summary>
/// Query string key must be present and prefix must match for each of the respective query string values.
/// Subject to case sensitivity settings.
/// Only single query parameter name supported. If there are multiple query parameters with the same name then the match fails.
/// Any of the values for the given query parameter must match by prefix, subject to case sensitivity settings.
/// </summary>
Prefix,

/// <summary>
/// Query string key must exist and contain any non-empty value.
/// The query parameter must exist and contain any non-empty value.
/// If the query string contains multiple values for that name, the rule will also match.
/// </summary>
Exists
}
Loading