Skip to content

Docs: Add instructions for viewing build-time OpenAPI logs with Terminal Logger #63251

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Add instructions for viewing build-time OpenAPI logs with Terminal Logger #63251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions src/Tools/Extensions.ApiDescription.Server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,17 @@ MSBuild glue for OpenAPI document generation.

See partner packages such as [NSwag.AspNetCore](https://www.nuget.org/packages/NSwag.AspNetCore/) or
[Swashbuckle.AspNetCore](https://www.nuget.org/packages/Swashbuckle.AspNetCore/) for intended use.

## Viewing build-time OpenAPI logs (Terminal Logger)

When `Microsoft.Extensions.ApiDescription.Server` runs the **GetDocument** step during `dotnet build`, its progress messages may not appear with the .NET **Terminal Logger** at default verbosity (the default in .NET 8+).
To surface these messages while building:


```powershell
dotnet build -tlp:v=d # Detailed terminal logger verbosity
# or
dotnet build --tl:off # Disable terminal logger and use legacy-style logs
```

This will display messages like Generating document named 'v1' which are hidden at normal verbosity and can be useful for diagnosing document generation issues.