From 1ad6345e61deaa079fea47740e325acd9caa923c Mon Sep 17 00:00:00 2001 From: Alexander Batishchev Date: Fri, 12 Dec 2025 10:29:34 -0800 Subject: [PATCH 1/4] Fix summary formatting for HTTP status code property --- src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs index 02a002451c4f..20f0aabeea03 100644 --- a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs +++ b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs @@ -32,7 +32,7 @@ public class ProblemDetails public string? Title { get; set; } /// - /// The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. + /// The HTTP status code (as defined by RFC 7231) generated by the origin server for this occurrence of the problem. /// [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyOrder(-3)] From 6aac78d49dff714463178372bb7b355af5c05847 Mon Sep 17 00:00:00 2001 From: Alexander Batishchev Date: Mon, 15 Dec 2025 09:08:29 -0800 Subject: [PATCH 2/4] Update ProblemDetails.cs --- .../src/ProblemDetails/ProblemDetails.cs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs index 20f0aabeea03..08e6f0d71e6b 100644 --- a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs +++ b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs @@ -6,15 +6,14 @@ namespace Microsoft.AspNetCore.Mvc; /// -/// A machine-readable format for specifying errors in HTTP API responses based on . +/// A machine-readable format for specifying errors in HTTP API responses based on . /// public class ProblemDetails { /// /// A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when - /// dereferenced, it provide human-readable documentation for the problem type - /// (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be - /// "about:blank". + /// dereferenced, it provide human-readable documentation for the problem type, e.g. using HTML. + // When this member is not present, its value is assumed to be "about:blank". /// [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyOrder(-5)] @@ -23,8 +22,8 @@ public class ProblemDetails /// /// A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence - /// of the problem, except for purposes of localization(e.g., using proactive content negotiation; - /// see[RFC7231], Section 3.4). + /// of the problem, except for purposes of localization, e.g. using proactive content negotiation; + /// see RFC 9110, Section 12. /// [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyOrder(-4)] @@ -32,7 +31,8 @@ public class ProblemDetails public string? Title { get; set; } /// - /// The HTTP status code (as defined by RFC 7231) generated by the origin server for this occurrence of the problem. + /// The HTTP status code generated by the origin server for this occurrence of the problem; + /// see RFC 9110, Section 15. /// [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyOrder(-3)] @@ -63,7 +63,7 @@ public class ProblemDetails /// /// /// - /// The round-tripping behavior for is determined by the implementation of the Input \ Output formatters. + /// The round-tripping behavior for is determined by the implementation of the Input/Output formatters. /// In particular, complex types or collection types may not round-trip to the original type when using the built-in JSON or XML formatters. /// [JsonExtensionData] From f415862bc736913fc8a026bc5cb7c574a74efe5f Mon Sep 17 00:00:00 2001 From: Alexander Batishchev Date: Mon, 15 Dec 2025 09:18:46 -0800 Subject: [PATCH 3/4] Fix comment formatting in ProblemDetails.cs --- src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs index 08e6f0d71e6b..a2f03fdb0a2f 100644 --- a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs +++ b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs @@ -13,7 +13,7 @@ public class ProblemDetails /// /// A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when /// dereferenced, it provide human-readable documentation for the problem type, e.g. using HTML. - // When this member is not present, its value is assumed to be "about:blank". + /// When this member is not present, its value is assumed to be "about:blank". /// [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyOrder(-5)] From 807cb791e41b705dc462f74a9c685600b6a66ffe Mon Sep 17 00:00:00 2001 From: Alexander Batishchev Date: Mon, 15 Dec 2025 09:19:45 -0800 Subject: [PATCH 4/4] Refactor ProblemDetails class documentation --- .../Http.Abstractions/src/ProblemDetails/ProblemDetails.cs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs index a2f03fdb0a2f..93b73790fee2 100644 --- a/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs +++ b/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs @@ -11,9 +11,10 @@ namespace Microsoft.AspNetCore.Mvc; public class ProblemDetails { /// - /// A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when + /// A URI reference that identifies the problem type. This specification encourages that, when /// dereferenced, it provide human-readable documentation for the problem type, e.g. using HTML. - /// When this member is not present, its value is assumed to be "about:blank". + /// When this member is not present, its value is assumed to be "about:blank"; + /// see RFC 3986. /// [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] [JsonPropertyOrder(-5)]