Skip to content

Commit 5f1f2ce

Browse files
authored
Updated comments on Microsoft.AspNetCore.Mvc.ProblemDetails (#64756)
* Fix summary formatting for HTTP status code property * Update ProblemDetails.cs * Fix comment formatting in ProblemDetails.cs * Refactor ProblemDetails class documentation
1 parent 5b06d1d commit 5f1f2ce

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
namespace Microsoft.AspNetCore.Mvc;
77

88
/// <summary>
9-
/// A machine-readable format for specifying errors in HTTP API responses based on <see href="https://tools.ietf.org/html/rfc7807"/>.
9+
/// A machine-readable format for specifying errors in HTTP API responses based on <see href="https://tools.ietf.org/html/rfc9110"/>.
1010
/// </summary>
1111
public class ProblemDetails
1212
{
1313
/// <summary>
14-
/// A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when
15-
/// dereferenced, it provide human-readable documentation for the problem type
16-
/// (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be
17-
/// "about:blank".
14+
/// A URI reference that identifies the problem type. This specification encourages that, when
15+
/// dereferenced, it provide human-readable documentation for the problem type, e.g. using HTML.
16+
/// When this member is not present, its value is assumed to be "about:blank";
17+
/// see RFC 3986.
1818
/// </summary>
1919
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
2020
[JsonPropertyOrder(-5)]
@@ -23,16 +23,17 @@ public class ProblemDetails
2323

2424
/// <summary>
2525
/// A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence
26-
/// of the problem, except for purposes of localization(e.g., using proactive content negotiation;
27-
/// see[RFC7231], Section 3.4).
26+
/// of the problem, except for purposes of localization, e.g. using proactive content negotiation;
27+
/// see RFC 9110, Section 12.
2828
/// </summary>
2929
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
3030
[JsonPropertyOrder(-4)]
3131
[JsonPropertyName("title")]
3232
public string? Title { get; set; }
3333

3434
/// <summary>
35-
/// The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
35+
/// The HTTP status code generated by the origin server for this occurrence of the problem;
36+
/// see RFC 9110, Section 15.
3637
/// </summary>
3738
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
3839
[JsonPropertyOrder(-3)]
@@ -63,7 +64,7 @@ public class ProblemDetails
6364
/// </para>
6465
/// </summary>
6566
/// <remarks>
66-
/// The round-tripping behavior for <see cref="Extensions"/> is determined by the implementation of the Input \ Output formatters.
67+
/// The round-tripping behavior for <see cref="Extensions"/> is determined by the implementation of the Input/Output formatters.
6768
/// In particular, complex types or collection types may not round-trip to the original type when using the built-in JSON or XML formatters.
6869
/// </remarks>
6970
[JsonExtensionData]

0 commit comments

Comments
 (0)