microsoft / microsoft/aspire

Implement parameter descriptions in all relevant locations

Open
#10,492 3 comments 1 reaction 0 assignees View on GitHub
area-cli area-deployment
Dominant language
C#
Stars
6.3k
Forks
991
Avg merge
2d 15h
Merged PRs (30d)
196

Description

This issue is a follow-up to PR #10440, which added support for parameter descriptions and custom input rendering. The next step is to implement parameter descriptions in various places throughout the codebase and UI.

**Tasks:**
- [ ] - In the app host, support parameter descriptions via the `PublishingPromptInput` type ([src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs](https://github.com/dotnet/aspire/blob/main/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs)). Ensure this flows all the way to the CLI implementation.
- [ ] - For Bicep, update logic in `AsProvisioningParameter` ([src/Aspire.Hosting.Azure/AzureProvisioningResourceExtensions.cs](https://github.com/dotnet/aspire/blob/main/src/Aspire.Hosting.Azure/AzureProvisioningResourceExtensions.cs)) to set the description on parameters.
- [ ] - Update Docker Compose parameter translation ([src/Aspire.Hosting.Docker/DockerComposeServiceExtensions.cs](https://github.com/dotnet/aspire/blob/main/src/Aspire.Hosting.Docker/DockerComposeServiceExtensions.cs)) to support and understand parameter descriptions.

Reference: https://github.com/dotnet/aspire/pull/10440

Contributor guide

Open the contributing guide

Research direction

Start by reviewing PR #10440, then trace parameter handling through PublishingPromptInput in src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs and the CLI flow. Inspect AsProvisioningParameter in src/Aspire.Hosting.Azure/AzureProvisioningResourceExtensions.cs and parameter translation in src/Aspire.Hosting.Docker/DockerComposeServiceExtensions.cs. Done means descriptions are preserved for the app host, Bicep, and Docker Compose outputs.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, docker-compose
Domain
cli, cloud, infrastructure
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.