Removing the OpenAPI package version override - #1581
Merged
Merged
Conversation
aaronpowell
requested review from
Odonno,
justinyoo and
tamirdresher
as code owners
September 9, 2026 02:19
Member
Author
|
Replaces #1515 |
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The changes consistently move OpenAPI versioning to central management and the example updates appear coherent and low-risk.
Review tier: Lite
Findings: None
What changed in this PR
This PR updates the repository’s OpenAPI-related dependencies by removing a local version override in the SurrealDb example and centralizing the Microsoft.AspNetCore.OpenApi version in Directory.Packages.props, while also cleaning up example endpoint metadata usage.
Changes:
- Bumped the centrally-managed
Microsoft.AspNetCore.OpenApipackage version to10.0.11and removed the centralMicrosoft.OpenApiversion entry. - Removed
VersionOverride(and the explicitMicrosoft.OpenApireference) from the SurrealDb example so it follows central package management. - Removed
.WithOpenApi()usage from two example Minimal API endpoints and addedlaunchSettings.jsonto two example projects.
| File | Description |
|---|---|
| examples/surrealdb/CommunityToolkit.Aspire.Hosting.SurrealDb.ApiService/CommunityToolkit.Aspire.Hosting.SurrealDb.ApiService.csproj | Removes the per-project OpenAPI version override so the sample follows central package versions. |
| examples/squad/CommunityToolkit.Aspire.Hosting.Squad.ApiApp/Program.cs | Drops .WithOpenApi() on an endpoint (leaving .WithName()), reducing reliance on OpenAPI endpoint metadata extensions. |
| examples/java/CommunityToolkit.Aspire.Hosting.Java.ApiApp/Program.cs | Drops .WithOpenApi() on the weather endpoint (leaving .WithName()). |
| Directory.Packages.props | Centralizes the Microsoft.AspNetCore.OpenApi version bump and removes the central pin for Microsoft.OpenApi. |
| examples/redpanda/CommunityToolkit.Aspire.Hosting.RedPanda.Consumer/Properties/launchSettings.json | Adds launch profile settings for local dev/debug. |
| examples/posta/CommunityToolkit.Aspire.Hosting.Posta.ApiService/Properties/launchSettings.json | Adds launch profile settings for local dev/debug. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Copilot stopped work on behalf of
aaronpowell due to an error
September 14, 2026 00:52
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.sh | bash -s -- 1581Or
iex "& { $(irm https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.ps1) } 1581" |
Contributor
|
This branch was successfully deployed
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
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.
Closes #1514
PR Checklist
Other information