Skip to content

feat(OpenApi): surface document generation output in Terminal Logger docs - #66922

Merged
BrennanConroy merged 1 commit into
dotnet:mainfrom
EduardF1:feat/openapi-terminal-logger
Jul 1, 2026
Merged

BrennanConroy merged 1 commit into
dotnet:mainfrom
EduardF1:feat/openapi-terminal-logger

Conversation

@EduardF1

Copy link
Copy Markdown
Contributor

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:

  • Use -tlp:v=d for detailed Terminal Logger verbosity to see generation output
  • Use --tl:off to disable the Terminal Logger and fall back to classic logging

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

  • src/OpenApi/src/PACKAGE.md: Added a new section "Build-time Document Generation" documenting the Terminal Logger verbosity options

Fixes #62273

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>
@EduardF1
EduardF1 requested a review from a team as a code owner May 29, 2026 23:14
@github-actions github-actions Bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label May 29, 2026
@dotnet-policy-service dotnet-policy-service Bot added the community-contribution Indicates that the PR has been added by a community member label May 29, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Thanks for your PR, @EduardF1. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@EduardF1

Copy link
Copy Markdown
Contributor Author

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 mikekistler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@EduardF1

EduardF1 commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

CI is green here and there are no requested changes. Ready to merge whenever convenient. Thanks @mikekistler for the review.

@EduardF1

EduardF1 commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

Hi! This PR has been approved — could you merge it when convenient? Thanks!

@EduardF1

EduardF1 commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

Friendly ping — could someone from the team merge this?

@EduardF1

EduardF1 commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

Hi! This was approved — could you merge when you get a chance? Happy to rebase if needed. Thanks!

@EduardF1

EduardF1 commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

Friendly ping — could someone from the team merge this?

@EduardF1

EduardF1 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

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 src/OpenApi/src/PACKAGE.md addressing the help wanted / good first issue #62273.

The only thing outstanding is the needs-area-label triage. The linked issue is labeled area-commandlinetools and feature-openapi — could a maintainer apply the area label here so it can be routed for final review/merge? Happy to make any adjustments if needed.

@BrennanConroy
BrennanConroy merged commit 44eeec3 into dotnet:main Jul 1, 2026
18 checks passed
@dotnet-milestone-bot dotnet-milestone-bot Bot added this to the 11.0-preview7 milestone Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Indicates that the PR has been added by a community member needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Microsoft.Extensions.ApiDescription.Server - Surface Invocation with new TerminalLogger

3 participants