feat: Replace Swagger with Microsoft OpenAPI #251
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hhvrc
added
enhancement
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Contributor
Author
|
Currently waiting on Npgsql.EntityFrameworkCore.PostgreSQL to release the .NET 10 version |
This reverts commit 89dadb9.
* fix: dotnet 10 openapi * fix: use same Title * fix: use better operationId transform * fix: break operationId "DevicePair" into separate endpoints
Contributor
There was a problem hiding this comment.
Pull request overview
This PR upgrades the project from .NET 9 to .NET 10, scheduled for release after November 11th, 2025. The upgrade includes updating the SDK, runtime, packages, and migrating from Swashbuckle/Swagger to the native Microsoft.AspNetCore.OpenApi implementation.
- Updated .NET SDK and runtime to version 10.0
- Migrated from Swashbuckle to Microsoft.AspNetCore.OpenApi with new document generation and Scalar API viewer integration
- Updated NuGet packages to their .NET 10 compatible versions
- Applied code refactorings leveraging C# 13 features (field keyword) and API improvements
Reviewed changes
Copilot reviewed 43 out of 43 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| global.json | Updated SDK version to 10.0.0 and added Microsoft.Testing.Platform test runner configuration |
| docker/*.Dockerfile | Updated base images from dotnet 9.0-alpine to 10.0-alpine |
| Directory.Packages.props | Updated all Microsoft packages and dependencies to version 10.0.0, removed Swashbuckle package |
| Directory.Build.props | Updated target framework to net10.0 and added OpenAPI interceptors namespace |
| LiveControlGateway/Program.cs, Cron/Program.cs, API/Program.cs | Replaced AddSwaggerExt with AddOpenApiExt and updated namespace imports |
| LiveControlGateway/Controllers/HubControllerBase.cs | Refactored property to use C# 13 field keyword for cleaner auto-property backing field access |
| Common/Utils/TrustedProxiesFetcher.cs | Simplified lambda expression removing unnecessary parameter specification |
| Common/Utils/ConfigureSwaggerOptions.cs | Removed - functionality migrated to new OpenAPI implementation |
| Common/Swagger/* | Removed Swashbuckle-specific files including SwaggerGenExtensions.cs and AttributeFilter.cs |
| Common/OpenAPI/OpenApiExtensions.cs | New OpenAPI document configuration with output caching and custom operation ID generation |
| Common/OpenAPI/DocumentDefaults.cs | New document transformer defining API info, servers, and security schemes |
| Common/OpenShockServiceHelper.cs | Updated API versioning configuration for compatibility with new OpenAPI generation |
| Common/OpenShockMiddlewareHelper.cs | Replaced UseSwagger with MapOpenApi, updated Scalar viewer configuration, changed KnownNetworks to KnownIPNetworks |
| Common/Services/Session/SessionService.cs | Changed ToArrayAsync to ToListAsync and updated Length to Count for consistency |
| Common/Hubs/UserHub.cs | Changed ToArrayAsync to ToListAsync for consistency with EF Core best practices |
| Common/DataAnnotations/*.cs | Removed IParameterAttribute interface implementations and OpenAPI-specific Apply methods |
| Common/DataAnnotations/OpenApiSchemas.cs | Removed - schemas now handled through native OpenAPI mechanisms |
| Common/DataAnnotations/Interfaces/* | Removed custom attribute interfaces as they're replaced by native OpenAPI extensibility |
| Common/Common.csproj | Added Microsoft.AspNetCore.OpenApi package, removed Swashbuckle.AspNetCore.SwaggerGen |
| API/Services/LCGNodeProvisioner/LCGNodeProvisioner.cs | Changed ToArrayAsync to ToListAsync and Length to Count |
| API/Controller/Sessions/ListSessions.cs | Refactored to return IAsyncEnumerable directly with Select instead of manual yield |
| API/Controller/OAuth/_ApiController.cs | Added EndpointGroupName attribute for API grouping, consolidated ApiVersion attribute |
| API/Controller/OAuth/*.cs | Removed ApiExplorerSettings(IgnoreApi = true) to include OAuth endpoints in OpenAPI docs |
| API/Controller/Device/Pair.cs | Split endpoint into two methods (Pair and PairDeprecated) with separate EndpointName attributes and shared PairInternal helper |
| API/Controller/Admin/_ApiController.cs | Added EndpointGroupName attribute for admin API grouping |
| API/Controller/Admin/GetOnlineDevices.cs | Changed ToArrayAsync to ToListAsync |
| API.IntegrationTests/Tests/LcgAssignmentTests.cs | Changed ToArrayAsync to ToListAsync in test cleanup |
| .github/workflows/*.yml | Updated DOTNET_VERSION to 10.x.x and 10.0.x, modified test command syntax |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Also attempted to get XML recognition to work here but that failed...
hhvrc
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This card was originally a WIP targeting the .NET 10 release.
Due to significant difficulties with Swagger, the .NET 10 migration was expedited, and this PR has been repurposed to move away from Swagger in favor of Microsoft OpenAPI.
This change is expected to bring several long-term improvements.