[docs] Expand 13.2 Connection property suffix breaking change with migration guidance#944
Draft
IEvangelist wants to merge 1 commit into
Draft
[docs] Expand 13.2 Connection property suffix breaking change with migration guidance#944IEvangelist wants to merge 1 commit into
IEvangelist wants to merge 1 commit into
Conversation
…gration guidance The 13.2 `Connection property suffix` breaking change was only a single sentence on the live changelog, which left readers without enough detail to confidently migrate apps upgrading directly from 13.0 to 13.2. Expand the section with: - A short explanation of the rename pattern (properties whose value is the name of a sub-entity now end with `Name`). - A canonical table covering all 15 affected resource types grouped by rename (`Database` -> `DatabaseName`, `Model` -> `ModelName`, `ConsumerGroup` -> `ConsumerGroupName`). - Before/after environment-variable examples showing the impact on consuming apps that read connection properties through `WithReference`. - Before/after C# examples for `GetConnectionProperty` callers in the AppHost. - A migration checklist for searching solutions, including a clear note that C# apps consuming the standard Aspire client integrations do not need source changes. - Cross-link to the partial 13.1 changelog entry, with the 13.2 entry as the canonical reference. Anchor `#connection-property-suffix` is preserved so external links keep working. Fixes #413 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Fixes #413.
The
Connection property suffixbreaking change in the Aspire 13.2 release notes currently reads, in its entirety:That leaves readers — particularly anyone upgrading directly from 13.0 to 13.2 — without enough detail to actually migrate. This PR expands the section into a full migration guide.
Changes
In
src/frontend/src/content/docs/whats-new/aspire-13-2.mdx(### Connection property suffix):Name.Database→DatabaseNameacross the 10 SQL/NoSQL/Azure database resources.Model→ModelNameforAzureOpenAIDeploymentResource,OpenAIModelResource,GitHubModelResource, andFoundryDeploymentResource.ConsumerGroup→ConsumerGroupNameforAzureEventHubConsumerGroupResource.APPDB_DATABASE→APPDB_DATABASENAME, OpenAICHAT_MODEL→CHAT_MODELNAME, Event HubsORDERS_CG_CONSUMERGROUP→ORDERS_CG_CONSUMERGROUPNAME).GetConnectionProperty(...)callers.<Aside type="note">that cross-links to the partial table on the 13.1 page and clarifies that apps already on13.1.xuse the new names today.The heading text is unchanged so the anchor
#connection-property-suffixremains stable for external links.Evidence the issue still reproduces
Verified against the live site at https://aspire.dev/whats-new/aspire-13-2/#connection-property-suffix on the day this PR was opened. The
Connection property suffixsection under⚠️ Breaking changesrenders only the single sentence quoted in the Summary, with no table, no code samples, and no migration steps — in contrast to theAIFoundry to Foundry transitionsection immediately below it, which has prose, an XML snippet, and a C# migration example.The screenshot used for verification is in the session workspace (
live-stub.png) and shows the rendered section.Sources for the rename table
The renames in the table are confirmed against the current
microsoft/aspiremain:Database → DatabaseNameis yielded fromGetConnectionProperties()insrc/Aspire.Hosting.PostgreSQL/PostgresDatabaseResource.cs,src/Aspire.Hosting.MySql/MySqlDatabaseResource.cs,src/Aspire.Hosting.SqlServer/SqlServerDatabaseResource.cs,src/Aspire.Hosting.Oracle/OracleDatabaseResource.cs,src/Aspire.Hosting.MongoDB/MongoDBDatabaseResource.cs,src/Aspire.Hosting.Milvus/MilvusDatabaseResource.cs,src/Aspire.Hosting.Azure.Sql/AzureSqlDatabaseResource.cs,src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBDatabaseResource.cs,src/Aspire.Hosting.Azure.PostgreSQL/AzurePostgresFlexibleServerDatabaseResource.cs, andsrc/Aspire.Hosting.Azure.Kusto/AzureKustoReadWriteDatabaseResource.cs.Model → ModelNameinsrc/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIDeploymentResource.cs,src/Aspire.Hosting.OpenAI/OpenAIModelResource.cs,src/Aspire.Hosting.GitHub.Models/GitHubModelResource.cs, andsrc/Aspire.Hosting.Foundry/FoundryDeploymentResource.cs.ConsumerGroup → ConsumerGroupNameinsrc/Aspire.Hosting.Azure.EventHubs/AzureEventHubConsumerGroupResource.cs.The rename first shipped in
13.1.0via microsoft/aspire#13471 (commitff437b1f7onmain, backportd6668f526torelease/13.1). The 13.2 changelog calls it out separately for the benefit of apps that skip 13.1.The environment-variable projection rule (
[RESOURCE]_[PROPERTY]uppercased, hyphens and dots replaced with underscores) is implemented inSplatConnectionPropertiesandEnvironmentVariableNameEncoder.Encodeinmicrosoft/aspire.The
AuthenticationDatabase → AuthenticationDatabaseNameandOrganization → OrganizationNamerenames mentioned in PR #13471's description are intentionally not listed in the table — those keys are still emitted unchanged onmain(MongoDBServerResource.csstill yields"AuthenticationDatabase";GitHubModelResource.csstill yields"Organization").How I verified
whats-new/aspire-13-2page with Playwright to confirm the breaking-change section is still a stub.microsoft/aspiremainfor every"DatabaseName","ModelName", and"ConsumerGroupName"GetConnectionProperties()yield site to confirm the rename table.WithEnvironment(string, ReferenceExpression),GetConnectionProperty(IResourceWithConnectionString, string), andReferenceEnvironmentInjectionFlags.ConnectionPropertiesAPI surface used in the new code samples is still public onmain./whats-new/aspire-13-1/#connection-properties-renameresolves: the heading exists atsrc/frontend/src/content/docs/whats-new/aspire-13-1.mdx:579(### Connection Properties rename) and slugifies to that anchor.Connection property suffixunchanged so#connection-property-suffixcontinues to resolve.To reproduce locally:
Scope and out-of-scope
src/frontend/src/content/docs/whats-new/aspire-13-2.mdx.whats-new/aspire-13-1.mdxis intentionally left as-is; the 13.2 page is now the canonical reference. A follow-up could optionally cross-link or expand the 13.1 table — happy to do that in this PR if reviewers prefer.ja/whats-new/aspire-13-2.mdx) is left to the regular translation workflow.docs/specs/connection-properties.mdinmicrosoft/aspirestill uses the old key names. That's outside this docs PR's scope.