Skip to content

Conversation

@sebastienros
Copy link
Member

Description

Refines existing connection properties and docs.

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?
    • Yes
    • No

Copilot AI review requested due to automatic review settings November 1, 2025 01:50
@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2025

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12583

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12583"

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request adds comprehensive Connection Properties documentation sections to multiple Aspire hosting README files and implements URI connection properties for SQL Server and Oracle database resources. The changes improve documentation consistency across Aspire hosting integrations and enhance the resource API with standardized URI expressions.

Key Changes

  • Added URI expressions (UriExpression properties) to SQL Server and Oracle server/database resources to provide standardized connection URIs
  • Added comprehensive "Connection Properties" sections to 14 README files documenting available connection properties when using WithReference
  • Fixed PostgreSQL JDBC connection string to include user and password query parameters
  • Removed obsolete .vscode/mcp.json MCP server configuration
  • Added a new agent configuration file (.github/agents/connectionproperties.agent.md) documenting connection properties standards

Reviewed Changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
src/Aspire.Hosting.SqlServer/SqlServerServerResource.cs Added UriExpression property, added CombineProperties helper method, and included Uri in connection properties
src/Aspire.Hosting.SqlServer/SqlServerDatabaseResource.cs Added database-specific UriExpression property and included Uri in connection properties
src/Aspire.Hosting.Oracle/OracleDatabaseServerResource.cs Added UriExpression property and included Uri in connection properties
src/Aspire.Hosting.Oracle/OracleDatabaseResource.cs Added database-specific UriExpression property and included Uri in connection properties
src/Aspire.Hosting.PostgreSQL/PostgresServerResource.cs Fixed JDBC connection string to include authentication parameters
src/Aspire.Hosting.SqlServer/README.md Added "Connection Properties" section documenting server and database properties
src/Aspire.Hosting.PostgreSQL/README.md Added "Connection Properties" section documenting server and database properties
src/Aspire.Hosting.Oracle/README.md Added "Connection Properties" section documenting server and database properties
src/Aspire.Hosting.Valkey/README.md Improved structure with "Getting started" section and added "Connection Properties" table
src/Aspire.Hosting.Redis/README.md Added "Connection Properties" section documenting Redis connection properties
src/Aspire.Hosting.Garnet/README.md Improved structure and added "Connection Properties" section
src/Aspire.Hosting.RabbitMQ/README.md Added "Connection Properties" section documenting RabbitMQ server properties
src/Aspire.Hosting.Seq/README.md Added "Connection Properties" section documenting Seq server properties
src/Aspire.Hosting.Nats/README.md Added "Connection Properties" section documenting NATS server properties
src/Aspire.Hosting.Kafka/README.md Added "Connection Properties" section documenting Kafka server properties
src/Aspire.Hosting.MongoDB/README.md Added "Connection Properties" section documenting MongoDB server and database properties
src/Aspire.Hosting.MySql/README.md Added "Connection Properties" section documenting MySQL server and database properties
src/Aspire.Hosting.Milvus/README.md Added "Connection Properties" section documenting Milvus server and database properties
src/Aspire.Hosting.Qdrant/README.md Added "Connection Properties" section documenting Qdrant server properties
src/Aspire.Hosting.OpenAI/README.md Added "Connection Properties" section documenting OpenAI resource and model properties
src/Aspire.Hosting.GitHub.Models/README.md Added "Connection Properties" section documenting GitHub Model properties
.vscode/mcp.json Removed obsolete MCP server configuration
.github/agents/connectionproperties.agent.md Added agent documentation defining connection properties implementation standards

@sebastienros sebastienros merged commit 48011da into main Nov 1, 2025
296 checks passed
@sebastienros sebastienros deleted the sebros/resproperties branch November 1, 2025 05:35
@dotnet-policy-service dotnet-policy-service bot added this to the 13.1 milestone Nov 1, 2025
@sebastienros
Copy link
Member Author

/backport to release/13.0

@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2025

Started backporting to release/13.0: https://github.com/dotnet/aspire/actions/runs/18992334804

@github-actions github-actions bot locked and limited conversation to collaborators Dec 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants