Repository navigation
feat(OpenApi): surface document generation output in Terminal Logger docs - #66922
Conversation
Documents how to view OpenAPI build-time document generation output when using the .NET 8+ Terminal Logger, which suppresses tool output by default. Adds guidance for using -tlp:v=d (detailed verbosity) or --tl:off to expose generation logs including 'Generating document named' messages. Fixes dotnet#62273 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Thanks for your PR, @EduardF1. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
|
Thanks for the acknowledgment. Happy to adjust the PACKAGE.md wording or add any extra doc context if that would help once someone from the team takes a look. |
mikekistler
left a comment
There was a problem hiding this comment.
Looks good. 👍
I've hit this issue before and didn't realize the underlying cause was the Terminal Logger. I'm sure this information will be helpful to some users.
|
CI is green here and there are no requested changes. Ready to merge whenever convenient. Thanks @mikekistler for the review. |
|
Hi! This PR has been approved — could you merge it when convenient? Thanks! |
|
Friendly ping — could someone from the team merge this? |
|
Hi! This was approved — could you merge when you get a chance? Happy to rebase if needed. Thanks! |
|
Friendly ping — could someone from the team merge this? |
|
Thanks for the review, @mikekistler! This one now looks ready on the contributor side — all checks are green and it's a docs-only change to The only thing outstanding is the |
Summary
Surfaces information about OpenAPI build-time document generation visibility in the NuGet PACKAGE.md, addressing the issue where the new .NET 8 Terminal Logger suppresses the generation tool output by default.
Problem
When running dotnet build with the Terminal Logger (the default in .NET 8+), the Microsoft.Extensions.ApiDescription.Server GetDocument tool output is suppressed. Users see no indication that document generation ran, making it difficult to debug generation issues.
Solution
Documents the available workarounds in the package README:
This approach is noted in the issue as an acceptable solution while the upstream MSBuild/SDK changes (dotnet/msbuild#9810, dotnet/sdk#43293) are tracked.
Changes
Fixes #62273