Skip to content

[13.2 Docs] Add migration guidance for Connection Property Suffix#947

Draft
IEvangelist wants to merge 1 commit into
mainfrom
dapine/connection-property-suffix-migration-413
Draft

[13.2 Docs] Add migration guidance for Connection Property Suffix#947
IEvangelist wants to merge 1 commit into
mainfrom
dapine/connection-property-suffix-migration-413

Conversation

@IEvangelist
Copy link
Copy Markdown
Member

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 suffix section with:

  • One-paragraph explanation of what the suffix is and why (named-entity properties gained an explicit Name suffix for consistency).
  • Note that a subset shipped in 13.1 and 13.2 completes the rollout (so 13.0 → 13.2 readers get the full picture).
  • A property-rename table:
    • DatabaseDatabaseName (Postgres, AzurePostgresFlexibleServer, MySql, SqlServer, AzureSql, Oracle, MongoDB, Milvus, AzureCosmosDB, AzureKusto)
    • ModelModelName (OpenAI, AzureOpenAI, Foundry, GitHub Models)
    • ConsumerGroupConsumerGroupName (AzureEventHub)
  • Before/after examples for the [RESOURCE]_[PROPERTY] env var pattern in Bash, C#, Python, TypeScript, and Go.
  • A GetConnectionProperty(...) before/after for AppHost code.
  • Migration guidance (which strings to grep for) and an explicit "what was not renamed" callout for AuthenticationDatabase and Organization.
  • Cross-links to representative integration connect pages so readers can find the full per-resource property catalog.

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_DATABASEMYSQLDB_DATABASENAME (Go, Python, TypeScript, TS pool variant).
  • integrations/databases/sql-server/sql-server-connect.mdx — 2 code sites + property table: SQLDB_DATABASESQLDB_DATABASENAME, table entry DatabaseDatabaseName.
  • integrations/ai/github-models/github-models-connect.mdx — 5 code sites + property table + 2 example connection strings: CHAT_MODELCHAT_MODELNAME, Model=…ModelName=…, table entry ModelModelName.

Verified against current source

I cross-checked every property name in the table against the resource source in microsoft/aspire main:

  • 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's MONGODB_AUTHENTICATIONDATABASE example — it remains correct.

Out of scope (intentionally not touched)

  • mongodb-host.mdx MONGO_DATABASE, mysql-host.mdx MYSQL_DATABASE, postgres-host.mdx POSTGRES_DATABASE, sql-server-host.mdx SQL_DATABASE, seed-database.mdx MYSQL_DATABASE — these are user-defined WithEnvironment(...) 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 of dotnet/aspire#13471.
  • The 13.1 release notes already cover a partial rename list and weren't restructured here. The new 13.2 section explicitly notes the 13.1 → 13.2 split so readers coming from 13.0 still get the full set in one place.

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:

A connection property suffix has been added which may require updates to code that accesses connection properties directly.

(Verified by fetching the rendered HTML of the live page; the entire connection-property-suffix section between BeforeResourceStartedEvent behavior and AIFoundry to Foundry transition is one sentence.)

After — see the diff in whats-new/aspire-13-2.mdx.

How I verified

# From src/frontend
pnpm exec astro sync           # passes (only pre-existing kubernetes duplicate-id warnings)
pnpm test:unit:docs            # 2 passed
pnpm test:unit:components      # 65 passed
pnpm test:unit:structured-data # 14 passed
pnpm build:skip-search         # built 12,226 pages — "All internal links are valid."

ESLint (pnpm lint) was not run as a gate because the repo has pre-existing failures in playwright-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 properties headings exist on azure-cosmos-db-connect.mdx:24, sql-server-connect.mdx:24, and github-models-connect.mdx:25).


Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

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>
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.

[13.2 Docs] Add migration guidance for Connection Property Suffix breaking change

1 participant