Add comment about QueryString in more places (#43179)

dotnet · Aug 10, 2022 · 579a254 · 579a254
1 parent 0bc9ec5
commit 579a254
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/Middleware/HttpLogging/src/HttpLoggingFields.cs b/src/Middleware/HttpLogging/src/HttpLoggingFields.cs
@@ -138,12 +138,20 @@ public enum HttpLoggingFields : long
     /// including <see cref="RequestPath"/>, <see cref="RequestProtocol"/>,
     /// <see cref="RequestMethod"/>, and <see cref="RequestScheme"/>.
     /// </summary>
+    /// <remarks>
+    /// The HTTP Request <see cref="HttpRequest.QueryString"/> is not included with this flag as it may contain private information.
+    /// If desired, it should be explicitly specified with <see cref="RequestQuery"/>.
+    /// </remarks>
     RequestProperties = RequestPath | RequestProtocol | RequestMethod | RequestScheme,
 
     /// <summary>
     /// Flag for logging HTTP Request properties and headers.
     /// Includes <see cref="RequestProperties"/> and <see cref="RequestHeaders"/>
     /// </summary>
+    /// <remarks>
+    /// The HTTP Request <see cref="HttpRequest.QueryString"/> is not included with this flag as it may contain private information.
+    /// If desired, it should be explicitly specified with <see cref="RequestQuery"/>.
+    /// </remarks>
     RequestPropertiesAndHeaders = RequestProperties | RequestHeaders,
 
     /// <summary>