Skip to content

Removing the OpenAPI package version override - #1581

Open
aaronpowell wants to merge 1 commit into
mainfrom
issue-1514
Open

Removing the OpenAPI package version override#1581
aaronpowell wants to merge 1 commit into
mainfrom
issue-1514

Conversation

@aaronpowell

@aaronpowell aaronpowell commented Sep 9, 2026

Copy link
Copy Markdown
Member

Closes #1514

PR Checklist

  • Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
  • Based off latest main branch of toolkit
  • PR doesn't include merge commits (always rebase on top of our main, if needed)
  • New integration
    • Docs are written
    • Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
  • Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Contains NO breaking changes
  • Every new API (including internal ones) has full XML docs
  • Code follows all style conventions

Other information

Copilot AI lite review requested due to automatic review settings September 9, 2026 02:19
@aaronpowell

aaronpowell commented Sep 9, 2026

Copy link
Copy Markdown
Member Author

Replaces #1515

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.OpenApi package version to 10.0.11 and removed the central Microsoft.OpenApi version entry.
  • Removed VersionOverride (and the explicit Microsoft.OpenApi reference) from the SurrealDb example so it follows central package management.
  • Removed .WithOpenApi() usage from two example Minimal API endpoints and added launchSettings.json to 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.

@Odonno Odonno left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update OpenAPI NuGet package globally

3 participants