Rename new experimental KeyPair API to WithServerAuthenticationCertificate#13104
Merged
Conversation
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 13104Or
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 13104" |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request renames the experimental CertificateKeyPair API to WithServerAuthenticationCertificate to clarify that this API is specifically designed for managing server authentication certificates used in TLS endpoint configuration. The renaming affects method names, annotation classes, and all related documentation.
Key Changes
- Renamed all
*CertificateKeyPair*methods to*ServerAuthenticationCertificate* - Updated annotation classes from
CertificateKeyPairAnnotationtoServerAuthenticationCertificateAnnotation - Updated callback annotation classes to match the new naming convention
- Modified all usages across tests, integrations, and playground examples
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/TestingAppHost1/TestingAppHost1.AppHost/Program.cs | Updated test usage from WithoutCertificateKeyPair() to WithoutServerAuthenticationCertificate() |
| tests/Aspire.Hosting.Tests/DistributedApplicationTests.cs | Updated test method calls to use new API names |
| tests/Aspire.Hosting.Redis.Tests/AddRedisTests.cs | Updated all test methods and annotation references to new naming |
| src/Aspire.Hosting/ResourceBuilderExtensions.cs | Renamed public API methods and updated XML documentation |
| src/Aspire.Hosting/ApplicationModel/ServerAuthenticationCertificateConfigurationCallbackAnnotaion.cs | Renamed classes and updated XML documentation examples |
| src/Aspire.Hosting/ApplicationModel/ServerAuthenticationCertificateAnnotation.cs | Renamed annotation class |
| src/Aspire.Hosting/ApplicationModel/ResourceExtensions.cs | Updated internal annotation type references |
| src/Aspire.Hosting.Yarp/YarpResourceExtensions.cs | Updated annotation references and method calls |
| src/Aspire.Hosting.Redis/RedisBuilderExtensions.cs | Updated method calls and annotation type checks |
| src/Aspire.Hosting.Python/PythonAppResourceBuilderExtensions.cs | Updated method calls and annotation type checks |
| src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs | Updated method calls and annotation type checks |
| playground/AspireWithNode/AspireWithNode.AppHost/AppHost.cs | Updated playground example to use new API |
| playground/publishers/aspire-output/docker-compose.yaml | New generated file (unrelated to this PR) |
| playground/AspireWithNode/NodeFrontend/pnpm-lock.yaml | New generated lock file (unrelated to this PR) |
DamianEdwards
approved these changes
Nov 22, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Renames the new CertificateKeyPair APIs for endpoint TLS configuration to
WithServerAuthenticationCertificateto make it clear the API is specifically intended to manage server auth certificates.Fixes #13037