Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates Swagger/OpenAPI documentation references in Blazor security documentation to clarify version-specific implementation differences. The change addresses that Swashbuckle is not suitable for .NET 9.0 and later versions, recommending OpenAPI documentation implementation instead.
Key Changes
- Add version-specific moniker ranges to differentiate OpenAPI documentation approaches between .NET versions
- Replace specific Swagger UI references with generic OpenAPI documentation references for .NET 9.0+
- Remove direct Swagger endpoint reference in favor of generic OpenAPI documentation guidance
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| aspnetcore/blazor/security/webassembly/standalone-with-identity/index.md | Updated OpenAPI documentation references with version-specific guidance |
| aspnetcore/blazor/security/blazor-web-app-with-oidc.md | Added moniker ranges to differentiate Swagger UI availability by .NET version |
| aspnetcore/blazor/security/blazor-web-app-with-entra.md | Applied consistent version-specific OpenAPI documentation messaging |
| aspnetcore/blazor/hybrid/security/maui-blazor-web-identity.md | Replaced direct Swagger endpoint reference with generic OpenAPI documentation guidance |
wadepickett
left a comment
wadepickett
left a comment
There was a problem hiding this comment.
Looks good! I don't see any issues.
@guardrex, consider updating the ms.date, even if it makes a difference of just a few months if you think the file is up to date.
"Tell Dexeter we've come full circle!" - First Decider Draith (Leonard Maguire), Dr. Who: Full Circle, ©1980 BBC 😄We've had some shifting sediments over the years on the policy for updating the Originally, it was updated for every change, no matter how small (e.g., misspelled word). Later, it was updated when significant article changes occurred with the author deciding what level of change would trigger it, including if they felt the entire article should be considered or if it was more narrowly based on a set of major section changes. If the policy is to change the date if we think the whole article is current, then we're just about back to updating it for every change, no matter how small. Blazor docs for the last several years have had all of their article dates updated every release for that reason. I'm implying that everything is current every release. Therefore under my usual maintenance, the date is kept current (for the year) without my having to be bothered with it on every PR. What is the current policy? |
Fixes #35837
Swashbuckle is no good for 9.0 or later. We'll just implement OpenAPI documentation for the time being. The samples work was performed on dotnet/blazor-samples#565 and dotnet/blazor-samples#566. I've placed a long-range tracking item to consider adding a visualization UI/endpoint tester at #34434.
Wade, Tom ... I only need one review, so I'll merge this after either you take a look.
Internal previews