From dedee4b8701e1984519366bfd2f4793892f88e48 Mon Sep 17 00:00:00 2001 From: John Luo Date: Thu, 1 Oct 2020 17:35:22 -0700 Subject: [PATCH 1/4] Api docs for ResponseCaching --- .../Microsoft.AspNetCore.ResponseCaching.Abstractions.csproj | 1 + .../src/Microsoft.AspNetCore.ResponseCaching.csproj | 2 +- src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs | 2 ++ src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs | 3 +++ 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/Middleware/ResponseCaching.Abstractions/src/Microsoft.AspNetCore.ResponseCaching.Abstractions.csproj b/src/Middleware/ResponseCaching.Abstractions/src/Microsoft.AspNetCore.ResponseCaching.Abstractions.csproj index 226e595816e1..cc89dafbfd7d 100644 --- a/src/Middleware/ResponseCaching.Abstractions/src/Microsoft.AspNetCore.ResponseCaching.Abstractions.csproj +++ b/src/Middleware/ResponseCaching.Abstractions/src/Microsoft.AspNetCore.ResponseCaching.Abstractions.csproj @@ -5,6 +5,7 @@ $(DefaultNetCoreTargetFramework) true true + $(NoWarn.Replace('1591', '')) aspnetcore;cache;caching false diff --git a/src/Middleware/ResponseCaching/src/Microsoft.AspNetCore.ResponseCaching.csproj b/src/Middleware/ResponseCaching/src/Microsoft.AspNetCore.ResponseCaching.csproj index 2846ee5907c0..322b16048f66 100644 --- a/src/Middleware/ResponseCaching/src/Microsoft.AspNetCore.ResponseCaching.csproj +++ b/src/Middleware/ResponseCaching/src/Microsoft.AspNetCore.ResponseCaching.csproj @@ -4,7 +4,7 @@ ASP.NET Core middleware for caching HTTP responses on the server. $(DefaultNetCoreTargetFramework) true - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true true aspnetcore;cache;caching diff --git a/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs b/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs index 14232b97de8e..91154b0d924c 100644 --- a/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs +++ b/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs @@ -5,10 +5,12 @@ namespace Microsoft.AspNetCore.ResponseCaching { + /// public class ResponseCachingFeature : IResponseCachingFeature { private string[] _varyByQueryKeys; + /// public string[] VaryByQueryKeys { get diff --git a/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs b/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs index 0a97efa7e396..3e67fa2732b7 100644 --- a/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs +++ b/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs @@ -5,6 +5,9 @@ namespace Microsoft.AspNetCore.ResponseCaching { + /// + /// Options for configuring the response caching middleware. + /// public class ResponseCachingOptions { /// From 7e903639533aa7c3179bbc2f237f1cc371580fc6 Mon Sep 17 00:00:00 2001 From: John Luo Date: Fri, 2 Oct 2020 01:59:45 -0700 Subject: [PATCH 2/4] Enable warnings for HostFiltering, HttpsPolicy and StaticFiles --- .../src/Microsoft.AspNetCore.HostFiltering.csproj | 1 + .../HttpsPolicy/src/Microsoft.AspNetCore.HttpsPolicy.csproj | 2 +- src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs | 4 ++-- .../StaticFiles/src/Microsoft.AspNetCore.StaticFiles.csproj | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/Middleware/HostFiltering/src/Microsoft.AspNetCore.HostFiltering.csproj b/src/Middleware/HostFiltering/src/Microsoft.AspNetCore.HostFiltering.csproj index b1098f3cea32..4b18e922f171 100644 --- a/src/Middleware/HostFiltering/src/Microsoft.AspNetCore.HostFiltering.csproj +++ b/src/Middleware/HostFiltering/src/Microsoft.AspNetCore.HostFiltering.csproj @@ -6,6 +6,7 @@ $(DefaultNetCoreTargetFramework) true + $(NoWarn.Replace('1591', '')) true aspnetcore false diff --git a/src/Middleware/HttpsPolicy/src/Microsoft.AspNetCore.HttpsPolicy.csproj b/src/Middleware/HttpsPolicy/src/Microsoft.AspNetCore.HttpsPolicy.csproj index c6c14dd30dad..e0f30c4b9170 100644 --- a/src/Middleware/HttpsPolicy/src/Microsoft.AspNetCore.HttpsPolicy.csproj +++ b/src/Middleware/HttpsPolicy/src/Microsoft.AspNetCore.HttpsPolicy.csproj @@ -6,7 +6,7 @@ $(DefaultNetCoreTargetFramework) true - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true aspnetcore;https;hsts false diff --git a/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs b/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs index 3e67fa2732b7..0597d77cf74f 100644 --- a/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs +++ b/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs @@ -1,4 +1,4 @@ -// Copyright (c) .NET Foundation. All rights reserved. +// Copyright (c) .NET Foundation. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. using System.ComponentModel; @@ -6,7 +6,7 @@ namespace Microsoft.AspNetCore.ResponseCaching { /// - /// Options for configuring the response caching middleware. + /// Options for configuring the . /// public class ResponseCachingOptions { diff --git a/src/Middleware/StaticFiles/src/Microsoft.AspNetCore.StaticFiles.csproj b/src/Middleware/StaticFiles/src/Microsoft.AspNetCore.StaticFiles.csproj index 52f563a36bbb..7aa80a85f333 100644 --- a/src/Middleware/StaticFiles/src/Microsoft.AspNetCore.StaticFiles.csproj +++ b/src/Middleware/StaticFiles/src/Microsoft.AspNetCore.StaticFiles.csproj @@ -4,7 +4,7 @@ ASP.NET Core static files middleware. Includes middleware for serving static files, directory browsing, and default files. $(DefaultNetCoreTargetFramework) true - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true aspnetcore;staticfiles false From 6d4003848b084f7c207d1e2cd8ca612b6be1a4a7 Mon Sep 17 00:00:00 2001 From: John Luo Date: Fri, 2 Oct 2020 10:15:04 -0700 Subject: [PATCH 3/4] Update src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs Co-authored-by: Pranav K --- src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs b/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs index 91154b0d924c..68c7b5e70bf1 100644 --- a/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs +++ b/src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs @@ -5,7 +5,7 @@ namespace Microsoft.AspNetCore.ResponseCaching { - /// + /// Default implementation for public class ResponseCachingFeature : IResponseCachingFeature { private string[] _varyByQueryKeys; From 42e8b03471c14454b9b3fc5cb3677fe0b3aaa9cf Mon Sep 17 00:00:00 2001 From: John Luo Date: Fri, 2 Oct 2020 10:30:07 -0700 Subject: [PATCH 4/4] Add more details --- src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs b/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs index 0597d77cf74f..8f27d8c5f72b 100644 --- a/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs +++ b/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs @@ -12,11 +12,14 @@ public class ResponseCachingOptions { /// /// The size limit for the response cache middleware in bytes. The default is set to 100 MB. + /// When this limit is exceeded, no new responses will be cached until older entries are + /// evicted. /// public long SizeLimit { get; set; } = 100 * 1024 * 1024; /// /// The largest cacheable size for the response body in bytes. The default is set to 64 MB. + /// If the response body exceeds this limit, it will not be cached by the . /// public long MaximumBodySize { get; set; } = 64 * 1024 * 1024;