Skip to content
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

Improve Type/Method/Field links in descriptions in ConfigurationSchemaGenerator #1428

Closed
eerhardt opened this issue Dec 16, 2023 · 1 comment
Labels
area-integrations Issues pertaining to Aspire Integrations packages

Comments

@eerhardt
Copy link
Member

When the ConfigurationSchemaGenerator encounters XML docs like

/// A <see cref="Uri"/> to the vault on which the client operates. Appears as "DNS Name" in the Azure portal.
/// If you have a secret <see cref="Uri"/>, use <see cref="KeyVaultSecretIdentifier"/> to parse the <see cref="KeyVaultSecretIdentifier.VaultUri"/> and other information.

It generates a description node like:

"description": "A T:System.Uri to the vault on which the client operates. Appears as \"DNS Name\" in the Azure portal.\nIf you have a secret T:System.Uri , use T:Azure.Security.KeyVault.Secrets.KeyVaultSecretIdentifier to parse the P:Azure.Security.KeyVault.Secrets.KeyVaultSecretIdentifier.VaultUri and other information.\nYou should validate that this URI references a valid Key Vault resource. See https://aka.ms/azsdk/blog/vault-uri for details."

We should see if we can do something better here, at least dropping the T: and maybe quoting the type name.

"description": "A 'System.Uri' to the vault on which the client operates

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-integrations Issues pertaining to Aspire Integrations packages label Dec 16, 2023
@kiapanahi
Copy link
Contributor

This issue is closed by #1473. I just forgot to mention it as "Closes #1428" in that PR's description.

@eerhardt eerhardt closed this as completed Jan 2, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Apr 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-integrations Issues pertaining to Aspire Integrations packages
Projects
None yet
Development

No branches or pull requests

2 participants