Skip to content

Updated comments on Microsoft.AspNetCore.Mvc.ProblemDetails #64756

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

Open
abatishchev wants to merge 4 commits into
base: main
Choose a base branch
from
+10 −9
Open

Updated comments on Microsoft.AspNetCore.Mvc.ProblemDetails #64756

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ad6345
Fix summary formatting for HTTP status code property
abatishchev Dec 12, 2025
6aac78d
Update ProblemDetails.cs
abatishchev Dec 15, 2025
f415862
Fix comment formatting in ProblemDetails.cs
abatishchev Dec 15, 2025
807cb79
Refactor ProblemDetails class documentation
abatishchev Dec 15, 2025
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
19 changes: 10 additions & 9 deletions src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
namespace Microsoft.AspNetCore.Mvc;

/// <summary>
/// A machine-readable format for specifying errors in HTTP API responses based on <see href="https://tools.ietf.org/html/rfc7807"/>.
/// A machine-readable format for specifying errors in HTTP API responses based on <see href="https://tools.ietf.org/html/rfc9110"/>.
/// </summary>
public class ProblemDetails
{
/// <summary>
/// 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".
/// 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";
/// see RFC 3986.
/// </summary>
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyOrder(-5)]
Expand All @@ -23,16 +23,17 @@ public class ProblemDetails

/// <summary>
/// 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.
/// </summary>
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyOrder(-4)]
[JsonPropertyName("title")]
public string? Title { get; set; }

/// <summary>
/// The HTTP status code([RFC7231], Section 6) 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.
/// </summary>
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyOrder(-3)]
Expand Down Expand Up @@ -63,7 +64,7 @@ public class ProblemDetails
/// </para>
/// </summary>
/// <remarks>
/// The round-tripping behavior for <see cref="Extensions"/> is determined by the implementation of the Input \ Output formatters.
/// The round-tripping behavior for <see cref="Extensions"/> 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.
/// </remarks>
[JsonExtensionData]
Expand Down
Loading