Skip to content

Commit 5ef06f2

Browse files
committed
Add instructions for viewing build-time OpenAPI logs with Terminal Logger
1 parent 4081060 commit 5ef06f2

File tree

1 file changed

+14
-0
lines changed
  • src/Tools/Extensions.ApiDescription.Server

1 file changed

+14
-0
lines changed

src/Tools/Extensions.ApiDescription.Server/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,17 @@ MSBuild glue for OpenAPI document generation.
66

77
See partner packages such as [NSwag.AspNetCore](https://www.nuget.org/packages/NSwag.AspNetCore/) or
88
[Swashbuckle.AspNetCore](https://www.nuget.org/packages/Swashbuckle.AspNetCore/) for intended use.
9+
10+
## Viewing build-time OpenAPI logs (Terminal Logger)
11+
12+
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+).
13+
To surface these messages while building:
14+
15+
16+
```powershell
17+
dotnet build -tlp:v=d # Detailed terminal logger verbosity
18+
# or
19+
dotnet build --tl:off # Disable terminal logger and use legacy-style logs
20+
```
21+
22+
This will display messages like Generating document named 'v1' which are hidden at normal verbosity and can be useful for diagnosing document generation issues.

0 commit comments

Comments
 (0)