Skip to content

Api docs for ResponseCaching #26531

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

Merged
4 commits merged into from
Oct 2, 2020
Merged

Api docs for ResponseCaching #26531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dedee4b
Api docs for ResponseCaching
Oct 2, 2020
7e90363
Enable warnings for HostFiltering, HttpsPolicy and StaticFiles
Oct 2, 2020
6d40038
Update src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs
Oct 2, 2020
42e8b03
Add more details
Oct 2, 2020
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
1 change: 1 addition & 0 deletions src/Middleware/HostFiltering/src/Microsoft.AspNetCore.HostFiltering.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
</Description>
<TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
<IsAspNetCoreApp>true</IsAspNetCoreApp>
<NoWarn>$(NoWarn.Replace('1591', ''))</NoWarn>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageTags>aspnetcore</PackageTags>
<IsPackable>false</IsPackable>
Expand Down
2 changes: 1 addition & 1 deletion src/Middleware/HttpsPolicy/src/Microsoft.AspNetCore.HttpsPolicy.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</Description>
<TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
<IsAspNetCoreApp>true</IsAspNetCoreApp>
<NoWarn>$(NoWarn);CS1591</NoWarn>
<NoWarn>$(NoWarn.Replace('1591', ''))</NoWarn>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageTags>aspnetcore;https;hsts</PackageTags>
<IsPackable>false</IsPackable>
Expand Down
1 change: 1 addition & 0 deletions ...ResponseCaching.Abstractions/src/Microsoft.AspNetCore.ResponseCaching.Abstractions.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
<IsAspNetCoreApp>true</IsAspNetCoreApp>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn.Replace('1591', ''))</NoWarn>
<PackageTags>aspnetcore;cache;caching</PackageTags>
<IsPackable>false</IsPackable>
</PropertyGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/Middleware/ResponseCaching/src/Microsoft.AspNetCore.ResponseCaching.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<Description>ASP.NET Core middleware for caching HTTP responses on the server.</Description>
<TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
<IsAspNetCoreApp>true</IsAspNetCoreApp>
<NoWarn>$(NoWarn);CS1591</NoWarn>
<NoWarn>$(NoWarn.Replace('1591', ''))</NoWarn>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageTags>aspnetcore;cache;caching</PackageTags>
Expand Down
2 changes: 2 additions & 0 deletions src/Middleware/ResponseCaching/src/ResponseCachingFeature.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@

namespace Microsoft.AspNetCore.ResponseCaching
{
/// Default implementation for <see cref="IResponseCachingFeature" />
public class ResponseCachingFeature : IResponseCachingFeature
{
private string[] _varyByQueryKeys;

/// <inheritdoc />
public string[] VaryByQueryKeys
{
get
Expand Down
8 changes: 7 additions & 1 deletion src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
// 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;

namespace Microsoft.AspNetCore.ResponseCaching
{
/// <summary>
/// Options for configuring the <see cref="ResponseCachingMiddleware"/>.
/// </summary>
public class ResponseCachingOptions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • For the SizeLimit property below, do you think it's valuable to explain what happens once the limit is hit?
  • For MaximumBodySize should we add what happens if the limit is exceeded?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

{
/// <summary>
/// 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.
/// </summary>
public long SizeLimit { get; set; } = 100 * 1024 * 1024;

/// <summary>
/// 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 <see cref="ResponseCachingMiddleware"/>.
/// </summary>
public long MaximumBodySize { get; set; } = 64 * 1024 * 1024;

Expand Down
2 changes: 1 addition & 1 deletion src/Middleware/StaticFiles/src/Microsoft.AspNetCore.StaticFiles.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<Description>ASP.NET Core static files middleware. Includes middleware for serving static files, directory browsing, and default files.</Description>
<TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
<IsAspNetCoreApp>true</IsAspNetCoreApp>
<NoWarn>$(NoWarn);CS1591</NoWarn>
<NoWarn>$(NoWarn.Replace('1591', ''))</NoWarn>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageTags>aspnetcore;staticfiles</PackageTags>
<IsPackable>false</IsPackable>
Expand Down