Skip to content

Conversation

sebastienros
Copy link
Member

@sebastienros sebastienros commented Oct 20, 2025

Updated environment variable keys for apiservice bindings to use a new naming convention. Add documentation for newly created encoded parameters

Pending code-review in corresponding PR and potential schema changes


Internal previews

📄 File 🔗 Preview link
docs/deployment/manifest-format.md Aspire manifest format for deployment tool builders

Updated environment variable keys for apiservice bindings to use a new naming convention.
Add documentation for newly created encoded parameters
@sebastienros sebastienros added this to the 13.0 milestone Oct 20, 2025
@Copilot Copilot AI review requested due to automatic review settings October 20, 2025 22:41
Copy link
Contributor

@Copilot 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 updates the environment variable naming convention for API service bindings to include the protocol name (http/https) in the key structure, and adds documentation for a new encoded parameters feature.

Key changes:

  • Environment variable keys for apiservice bindings now include the protocol in the path (e.g., services__apiservice__http__0 instead of services__apiservice__0)
  • New documentation section explaining encoded parameter resources using the annotated.string type with filters like uri

- `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.

Copy link

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

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

The documentation states that names are deduplicated but doesn't explain how deduplication works or what the resulting names would look like. Consider adding an example or brief explanation of the deduplication strategy.

Suggested change
For example, if multiple projections would result in the same base name, a numeric suffix is appended to ensure uniqueness (for example, `redis-password-uri-encoded`, `redis-password-uri-encoded-1`, `redis-password-uri-encoded-2`, etc.).

Copilot uses AI. Check for mistakes.

Copy link
Member Author

Choose a reason for hiding this comment

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

@copilot update to mention it's using {format} to deduplicate

@sebastienros
Copy link
Member Author

@IEvangelist just forgot that I should instead target release/13, correct?

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.

2 participants