Clarify StatusCodePages ProblemDetails docs#66172
Merged
mikekistler merged 7 commits intodotnet:mainfrom Apr 16, 2026
Merged
Conversation
github-actions
Bot
added
the
area-middleware
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the XML documentation for Status Code Pages to clarify that the default handler prefers emitting ProblemDetails (via IProblemDetailsService) and otherwise falls back to a plain-text response.
Changes:
- Updated
StatusCodePagesOptionsXML docs to describe theProblemDetails-first behavior and fallback conditions. - Updated
UseStatusCodePages()XML docs to describe default handler behavior (ProblemDetails vs plain text).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Middleware/Diagnostics/src/StatusCodePage/StatusCodePagesOptions.cs | Clarifies the default HandleAsync behavior: try IProblemDetailsService, then fall back to plain text. |
| src/Middleware/Diagnostics/src/StatusCodePage/StatusCodePagesExtensions.cs | Updates UseStatusCodePages() docs to describe default handler behavior (needs a small accuracy tweak re: fallback). |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
mikekistler
force-pushed
the
docs/clarify-statuscodepages-problemdetails
branch
from
8ad25af to
4200e32
Compare
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Apr 14, 2026
BrennanConroy
approved these changes
Apr 15, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Apr 16, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
UseStatusCodePages()and the default options handler prefer Problem Details whenIProblemDetailsServiceis available