Skip to content

Document Aspire 17 required-parameter migration #2114

Closed

Description

@adamint

Add an Aspire 17 What's New migration note for the required-parameter change introduced by aspire#18108, including the interactive startup recovery in draft aspire#22124. The original report is aspire#21795.

Keep the required null/empty validation; this is migration guidance, not a request to revert it. Parameters are required by default, and an explicit "" no longer satisfies a required value. Cover ordinary, secret, and connection-string parameters.

The note should explain:

  • Supply a nonempty value for required parameters. When Dashboard interaction is available, missing required startup values can be supplied in Parameters; without interaction, initialization fails with a MissingParameterValueException naming the parameter.
  • If an empty or absent value is genuinely valid, use .WithOptional() in C# or .withOptional() in TypeScript. An explicit empty optional value remains ""; an unset optional value resolves to null and is omitted when used as an environment variable. Do not make required credentials optional just to suppress validation.
  • In TypeScript, omitting value or supplying value: null uses parameter configuration; it does not override a configured value with an empty string.
  • The manifest publisher does not currently support optional parameters. Do not present optionality as a workaround for required deployment values.

The draft's troubleshooting guidance has the examples and current behavior. Reconcile this note with the merged implementation before publication.

The website's complete main tree has no Aspire 17 release/migration page as of November 11, 2026. Add this to that page when it is created and link the existing external-parameters guidance; this follow-up does not require creating a standalone Aspire 17 page now. Website publication should not block the code fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions