Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 19, 2025

Adds connection properties documentation to 16 hosting integrations per the connection properties spec. Each integration's README in the Aspire repository defines the connection properties exposed via WithReference() - this PR documents them in the corresponding integration pages.

Changes

  • Automated extraction: Built script to fetch connection properties from Aspire repo READMEs and convert to MDX format
  • 16 integrations updated: PostgreSQL, MySQL, SQL Server, MongoDB, Oracle, Redis, Garnet, Valkey, RabbitMQ, Kafka, NATS, Milvus, Qdrant, Seq, OpenAI, GitHub Models
  • Consistent placement: Added new "Connection properties" subsection before "Hosting integration health checks" in each hosting integration section
  • Proper structure: Connection properties use ### heading with #### for resource-specific subsections (e.g., server vs database properties)

Example

The PostgreSQL integration now documents both server and database connection properties:

Connection Properties Section

Each property table shows the property name, description, and format (e.g., Uri with format postgresql://{Username}:{Password}@{Host}:{Port}). An aside notes that properties are exposed as environment variables with [RESOURCE]_[PROPERTY] naming.

Coverage

Verified all 48 Aspire.Hosting.* packages in aspire-integration-names.json - only 16 define connection properties in their READMEs. All are now documented.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/CommunityToolkit/Aspire
    • Triggering command: node ./scripts/update-github-stats.js (http block)
  • https://api.github.com/repos/dotnet/aspire
    • Triggering command: node ./scripts/update-github-stats.js (http block)
  • https://api.github.com/repos/dotnet/aspire-samples
    • Triggering command: node ./scripts/update-github-stats.js (http block)
  • https://api.github.com/repos/microsoft/aspire.dev
    • Triggering command: node ./scripts/update-github-stats.js (http block)
  • telemetry.astro.build
    • Triggering command: node /home/REDACTED/work/aspire.dev/aspire.dev/src/frontend/node_modules/.bin/astro build (dns block)
    • Triggering command: node /home/REDACTED/work/aspire.dev/aspire.dev/src/frontend/node_modules/.bin/astro dev (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Add Connection Properties details to integration content</issue_title>
<issue_description>Based on this spec: https://github.com/dotnet/aspire/blob/main/docs/specs/connection-properties.md

Find all /integrations/**/*.mdx that exist, that define connection properties and add content for them. For each integration name defined in src/frontend/src/data/aspire-integration-names.json try fetching the
https://raw.githubusercontent.com/dotnet/aspire/refs/heads/main/src/{integration-name}/README.md and looking for Connection Properties, and then using that info to add to the corresponding article's hosting integration section.</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Add connection properties details to integration content Add connection properties documentation to hosting integrations Nov 19, 2025
Copilot finished work on behalf of IEvangelist November 19, 2025 20:10
Copilot AI requested a review from IEvangelist November 19, 2025 20:10
@IEvangelist IEvangelist marked this pull request as ready for review November 19, 2025 20:19
Copilot AI review requested due to automatic review settings November 19, 2025 20:19
Copilot finished reviewing on behalf of IEvangelist November 19, 2025 20:22
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 PR adds comprehensive connection properties documentation to 16 hosting integrations in the Aspire documentation, based on the connection properties specification. The documentation was extracted from Aspire repository READMEs using an automated script and consistently formatted for the integration pages.

Key changes:

  • Added "Connection properties" sections to 16 integration pages with detailed property tables
  • Consistent placement before "Hosting integration health checks" sections across all files
  • Each section includes resource-specific subsections with property names, descriptions, and format examples

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
aspire-integrations.json Download count updates for NuGet packages (automated statistics update)
postgres.mdx Documents PostgreSQL server and database connection properties including Uri, Host, Port, Username, Password, DatabaseName, and JDBC connection strings
mysql.mdx Documents MySQL server and database connection properties including connection URIs and JDBC strings, using Database property name
sql-server.mdx Documents SQL Server server and database connection properties with mssql:// URI format and JDBC connection strings, using DatabaseName property
mongodb.mdx Documents MongoDB server and database connection properties including authentication parameters and connection URI format
oracle.mdx Documents Oracle server and database connection properties with oracle:// URI format and JDBC strings, using Database property name
redis.mdx Documents Redis connection properties including Host, Port, Password, and URI in redis:// format
garnet.mdx Documents Garnet connection properties similar to Redis, with optional password parameter
valkey.mdx Documents Valkey connection properties including Host, Port, Password, and valkey:// URI format
rabbitmq.mdx Documents RabbitMQ server connection properties with AMQP URI format and authentication credentials
apache-kafka.mdx Documents Kafka server connection properties exposing Host and Port (note: has documentation issue with Uri reference)
nats.mdx Documents NATS server connection properties including nats:// URI format with authentication
milvus.mdx Documents Milvus server and database connection properties with gRPC endpoints and token authentication
qdrant.mdx Documents Qdrant server connection properties including both gRPC and HTTP endpoints with API key authentication
seq.mdx Documents Seq connection properties including HTTP URI format for the observability server
openai.mdx Documents OpenAI resource and model connection properties including endpoint URI and API key
github-models.mdx Documents GitHub Models connection properties including inference endpoint, API key, model identifier, and optional organization

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sebastienros
Copy link

I updated the connection properties with meaningful names, will do the same in aspire main

@davidfowl
Copy link
Contributor

Let’s also document the format of the connection string with examples

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.

Add Connection Properties details to integration content

4 participants