-
Notifications
You must be signed in to change notification settings - Fork 42
Add encoded parameters documentation to manifest format #212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Remove deprecated APISERVICE_HTTP and APISERVICE_HTTPS environment variables - Update environment variable keys to include protocol in the path (services__apiservice__http__0 and services__apiservice__https__0) - Add documentation for encoded parameters with annotated.string type and filter support - Add example showing URI-encoded password projection Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
IEvangelist
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please address my feedback
Per feedback, kept APISERVICE_HTTP/APISERVICE_HTTPS variables. Only added new documentation for annotated.string type with filter support. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Addressed all feedback in commit b5f0344. Reverted socials.config.ts and kept the APISERVICE_HTTP/APISERVICE_HTTPS variables while adding only the new encoded parameters documentation. |
Addresses feedback to undo the unintended formatting change. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
There was a problem hiding this 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 documentation for encoded parameter resources in the Aspire deployment manifest format, syncing with changes from dotnet/docs-aspire#5317. The documentation explains how filtered/encoded parameter values are represented in the manifest using the new annotated.string resource type.
Key changes:
- Documents the
annotated.stringresource type for representing filtered parameter projections - Explains the naming convention for encoded parameters (
{parameter}-{format}-encoded) - Provides an example of URI-encoded password projection
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - The resource type is `"annotated.string"`. | ||
| - `value` references the raw parameter value (`{parameter-name.value}`). | ||
| - `filter` names the formatter (e.g., `"uri"`, ...). | ||
| - The resource name is derived from the parameter name and format (`{parameter}-{format}-encoded`). Names are deduplicated if multiple projections share the same base. |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "Names are deduplicated if multiple projections share the same base" is ambiguous and could confuse readers. It's unclear what happens during deduplication (e.g., are suffixes added like -1, -2?) and when this scenario would occur. Consider either removing this sentence if it's an edge case that rarely happens, or providing a concrete example showing how names are deduplicated.
| - The resource name is derived from the parameter name and format (`{parameter}-{format}-encoded`). Names are deduplicated if multiple projections share the same base. | |
| - The resource name is derived from the parameter name and format (`{parameter}-{format}-encoded`). |
|
|
||
| The preceding JSON snippet shows the `inputs` field for a resource that has a `connectionString` field. The `password` input parameter is a string type and is marked as a secret. The `default` field is used to specify a default value for the input parameter. In this case, the default value is generated using the `generate` field, with random string of a minimum length. | ||
|
|
||
| When a parameter is using a filter (for example `uri`), the manifest contains an additional resource that represents the filtered projection. |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two clarity issues in this sentence:
- The term "projection" is introduced without explanation. Readers may not understand what "filtered projection" means in this context. Consider using simpler terminology like "filtered version" or "encoded representation", or add a brief explanation.
- The phrase "When a parameter is using a filter" could be clearer. Consider rephrasing to "When a filter is applied to a parameter" to more accurately describe the relationship.
Syncs manifest-format.mdx with changes from dotnet/docs-aspire#5317.
Changes
annotated.stringtype with filter support{parameter}-{format}-encodedfilter: "uri"Note: Both environment variable formats are present in the documentation:
APISERVICE_HTTP/APISERVICE_HTTPSservices__apiservice__http__0/services__apiservice__https__0Example
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.