[13.2 Docs] Add migration guidance for Connection Property Suffix#947
Draft
IEvangelist wants to merge 1 commit into
Draft
[13.2 Docs] Add migration guidance for Connection Property Suffix#947IEvangelist wants to merge 1 commit into
IEvangelist wants to merge 1 commit into
Conversation
Replace the one-sentence placeholder in the 13.2 release notes with a
full migration guide for the Connection property suffix breaking change,
and update integration *connect* pages whose env-var examples still
referenced the pre-rename names.
In `whats-new/aspire-13-2.mdx`:
- Explain what the suffix is and why ("named entity" properties gained
an explicit `Name` suffix), with a note that 13.2 completes a rollout
that began in 13.1.
- Add a property-rename table covering `Database` -> `DatabaseName`
(Postgres, AzurePostgresFlexibleServer, MySql, SqlServer, AzureSql,
Oracle, MongoDB, Milvus, AzureCosmosDB, AzureKusto), `Model` ->
`ModelName` (OpenAI, AzureOpenAI, Foundry, GitHub Models), and
`ConsumerGroup` -> `ConsumerGroupName` (AzureEventHub).
- Show before/after env-var migration in Bash, C#, Python, TypeScript,
and Go, plus a `GetConnectionProperty` example for AppHost code.
- Call out properties that were *not* renamed
(`AuthenticationDatabase`, `Organization`).
- Cross-link to representative integration *connect* pages for the full
per-resource catalog.
In integration *connect* pages, fix stale env-var references on
resources affected by the rename:
- `mysql-connect.mdx`: `MYSQLDB_DATABASE` -> `MYSQLDB_DATABASENAME` (4
code samples).
- `sql-server-connect.mdx`: `SQLDB_DATABASE` -> `SQLDB_DATABASENAME` (2
code samples) and table entry `Database` -> `DatabaseName`.
- `github-models-connect.mdx`: `CHAT_MODEL` -> `CHAT_MODELNAME` (5 code
samples), `Model=...` -> `ModelName=...` (2 example connection
strings), and table entry `Model` -> `ModelName`.
Property names were verified against the corresponding
`*Resource.cs` files on `microsoft/aspire` `main`.
Verification: `pnpm exec astro sync`, `pnpm test:unit:docs`,
`pnpm test:unit:components`, `pnpm test:unit:structured-data`, and
`pnpm build:skip-search` all pass; the build reports
"All internal links are valid."
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.
Fixes #413
Summary
The Aspire 13.2 release notes' Connection property suffix entry was a single-sentence placeholder that didn't tell readers which properties were renamed, which resources were affected, what the resulting environment variables look like, or how to update existing code. This PR replaces it with a full migration guide and fixes a handful of stale env-var examples in the affected integrations' connect pages.
What changed
whats-new/aspire-13-2.mdx— expanded the### Connection property suffixsection with:Namesuffix for consistency).Database→DatabaseName(Postgres, AzurePostgresFlexibleServer, MySql, SqlServer, AzureSql, Oracle, MongoDB, Milvus, AzureCosmosDB, AzureKusto)Model→ModelName(OpenAI, AzureOpenAI, Foundry, GitHub Models)ConsumerGroup→ConsumerGroupName(AzureEventHub)[RESOURCE]_[PROPERTY]env var pattern in Bash, C#, Python, TypeScript, and Go.GetConnectionProperty(...)before/after for AppHost code.AuthenticationDatabaseandOrganization.Stale env var fixes in integration docs — these are tightly coupled to the rename and were still showing the pre-13.2 names:
integrations/databases/mysql/mysql-connect.mdx— 4 sites:MYSQLDB_DATABASE→MYSQLDB_DATABASENAME(Go, Python, TypeScript, TS pool variant).integrations/databases/sql-server/sql-server-connect.mdx— 2 code sites + property table:SQLDB_DATABASE→SQLDB_DATABASENAME, table entryDatabase→DatabaseName.integrations/ai/github-models/github-models-connect.mdx— 5 code sites + property table + 2 example connection strings:CHAT_MODEL→CHAT_MODELNAME,Model=…→ModelName=…, table entryModel→ModelName.Verified against current source
I cross-checked every property name in the table against the resource source in
microsoft/aspiremain:SqlServerDatabaseResource.cs:74— emits"DatabaseName"MySqlDatabaseResource.cs:73— emits"DatabaseName"MongoDBDatabaseResource.cs:52— emits"DatabaseName"PostgresDatabaseResource.cs:72,AzurePostgresFlexibleServerDatabaseResource.cs:93,OracleDatabaseResource.cs:62,MilvusDatabaseResource.cs:48,AzureCosmosDBDatabaseResource.cs:70,AzureSqlDatabaseResource.cs:109,AzureKustoReadWriteDatabaseResource.cs:79— all emit"DatabaseName"OpenAIModelResource.cs:47,AzureOpenAIDeploymentResource.cs:114,FoundryDeploymentResource.cs:109,GitHubModelResource.cs:91— all emit"ModelName"AzureEventHubConsumerGroupResource.cs:79— emits"ConsumerGroupName"Also verified — these were not renamed (despite earlier mentions in the original PR description):
MongoDBServerResource.cs:146— still emits"AuthenticationDatabase".GitHubModelResource.cs:95— still emits"Organization".That's why no change was made to
mongodb-connect.mdx'sMONGODB_AUTHENTICATIONDATABASEexample — it remains correct.Out of scope (intentionally not touched)
mongodb-host.mdxMONGO_DATABASE,mysql-host.mdxMYSQL_DATABASE,postgres-host.mdxPOSTGRES_DATABASE,sql-server-host.mdxSQL_DATABASE,seed-database.mdxMYSQL_DATABASE— these are user-definedWithEnvironment(...)examples or container image env vars, not Aspire-injected connection property names.ravendb-connect.mdx,surrealdb-connect.mdx,ollama-connect.mdx— these resources live in the CommunityToolkit and weren't part ofdotnet/aspire#13471.Evidence: live site reproduces the issue
Before — current live page at https://aspire.dev/whats-new/aspire-13-2/#connection-property-suffix shows just the single placeholder sentence:
(Verified by fetching the rendered HTML of the live page; the entire
connection-property-suffixsection betweenBeforeResourceStartedEvent behaviorandAIFoundry to Foundry transitionis one sentence.)After — see the diff in
whats-new/aspire-13-2.mdx.How I verified
ESLint (
pnpm lint) was not run as a gate because the repo has pre-existing failures inplaywright-report/trace/assets/*.js(minified Playwright report artifacts) unrelated to MDX content. None of the touched files surface lint errors.Cross-link anchors verified by grep against each target page (
## Connection propertiesheadings exist onazure-cosmos-db-connect.mdx:24,sql-server-connect.mdx:24, andgithub-models-connect.mdx:25).Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com