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

fix see href links - Part 1 #12883

Merged
merged 1 commit into from
Jun 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace Azure.Data.AppConfiguration
/// configuration store, and optionally allows indicating which fields of
/// each setting to retrieve.</para>
/// <para>Literals or filters may be specified for keys and labels.</para>
/// <para>For more information, <see href="/Azure/AppConfiguration/blob/master/docs/REST/kv.md#filtering"/>.</para>
/// <para>For more information, <see href="/Azure/AppConfiguration/blob/master/docs/REST/kv.md#filtering">Filtering</see>.</para>
/// </summary>
public class SettingSelector
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class KeyVaultAccessControlClientOptions : ClientOptions
/// <summary>
/// The latest service version supported by this client library.
/// For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

wasn't sure if I should just remove this or if there's a better replacement. There's no such article.

Copy link
Member

Choose a reason for hiding this comment

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

Seems it used to exist, and is still referenced in the REST API docs:

image

I'll contact the service PM about this, but probably leave it for now. I'll ask they keep the existing URL. In the worst case, at least it goes to the KV home page.

/// </summary>
internal const ServiceVersion LatestVersion = ServiceVersion.V7_2_Preview;

Expand All @@ -35,7 +35,7 @@ public enum ServiceVersion
/// <summary>
/// Gets the <see cref="ServiceVersion"/> of the service API used when
/// making requests. For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
public ServiceVersion Version { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class KeyVaultBackupClientOptions : ClientOptions
/// <summary>
/// The latest service version supported by this client library.
/// For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
internal const ServiceVersion LatestVersion = ServiceVersion.V7_2_Preview;

Expand All @@ -35,7 +35,7 @@ public enum ServiceVersion
/// <summary>
/// Gets the <see cref="ServiceVersion"/> of the service API used when
/// making requests. For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
public ServiceVersion Version { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class CertificateClientOptions : ClientOptions
/// <summary>
/// The latest service version supported by this client library.
/// For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
internal const ServiceVersion LatestVersion = ServiceVersion.V7_1_Preview;

Expand All @@ -40,7 +40,7 @@ public enum ServiceVersion
/// <summary>
/// Gets the <see cref="ServiceVersion"/> of the service API used when
/// making requests. For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
public ServiceVersion Version { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,25 @@ public CertificateKeyCurveName(string value)

/// <summary>
/// Gets the NIST P-256 elliptic curve, AKA SECG curve SECP256R1
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static CertificateKeyCurveName P256 { get; } = new CertificateKeyCurveName("P-256");

/// <summary>
/// Gets the NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static CertificateKeyCurveName P384 { get; } = new CertificateKeyCurveName("P-384");

/// <summary>
/// Gets the NIST P-521 elliptic curve, AKA SECG curve SECP521R1.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static CertificateKeyCurveName P521 { get; } = new CertificateKeyCurveName("P-521");

/// <summary>
/// Gets the SECG SECP256K1 elliptic curve.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static CertificateKeyCurveName P256K { get; } = new CertificateKeyCurveName("P-256K");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class CryptographyClientOptions : ClientOptions
/// <summary>
/// The latest service version supported by this client library.
/// For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
internal const ServiceVersion LatestVersion = ServiceVersion.V7_1_Preview;

Expand All @@ -40,7 +40,7 @@ public enum ServiceVersion
/// <summary>
/// Gets the <see cref="ServiceVersion"/> of the service API used when
/// making requests. For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
public ServiceVersion Version { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class KeyClientOptions : ClientOptions
/// <summary>
/// The latest service version supported by this client library.
/// For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
internal const ServiceVersion LatestVersion = ServiceVersion.V7_1_Preview;

Expand All @@ -40,7 +40,7 @@ public enum ServiceVersion
/// <summary>
/// Gets the <see cref="ServiceVersion"/> of the service API used when
/// making requests. For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
public ServiceVersion Version { get; }

Expand Down
8 changes: 4 additions & 4 deletions sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyCurveName.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,25 +35,25 @@ public KeyCurveName(string value)

/// <summary>
/// Gets the NIST P-256 elliptic curve, AKA SECG curve SECP256R1
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static KeyCurveName P256 { get; } = new KeyCurveName(P256Value);

/// <summary>
/// Gets the SECG SECP256K1 elliptic curve.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static KeyCurveName P256K { get; } = new KeyCurveName(P256KValue);

/// <summary>
/// Gets the NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static KeyCurveName P384 { get; } = new KeyCurveName(P384Value);

/// <summary>
/// Gets the NIST P-521 elliptic curve, AKA SECG curve SECP521R1.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#curve-types"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/key-vault/keys/about-keys#curve-types">Curve types</see>.
/// </summary>
public static KeyCurveName P521 { get; } = new KeyCurveName(P521Value);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class SecretClientOptions : ClientOptions
/// <summary>
/// The latest service version supported by this client library.
/// For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
internal const ServiceVersion LatestVersion = ServiceVersion.V7_1_Preview;

Expand All @@ -40,7 +40,7 @@ public enum ServiceVersion
/// <summary>
/// Gets the <see cref="ServiceVersion"/> of the service API used when
/// making requests. For more information, see
/// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>.
/// <see href="https://docs.microsoft.com/rest/api/keyvault/key-vault-versions">Key Vault versions</see>.
/// </summary>
public ServiceVersion Version { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ protected SearchIndexClient() { }
/// <param name="credential">
/// Required. The API key credential used to authenticate requests against the Search service.
/// You need to use an admin key to perform any operations on the SearchIndexClient.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys"/> for more information about API keys in Azure Cognitive Search.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys">Create and manage api-keys for an Azure Cognitive Search service</see> for more information about API keys in Azure Cognitive Search.
/// </param>
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="endpoint"/> or <paramref name="credential"/> is null.</exception>
/// <exception cref="ArgumentException">Thrown when the <paramref name="endpoint"/> is not using HTTPS.</exception>
Expand All @@ -57,7 +57,7 @@ public SearchIndexClient(Uri endpoint, AzureKeyCredential credential) :
/// <param name="credential">
/// Required. The API key credential used to authenticate requests against the Search service.
/// You need to use an admin key to perform any operations on the SearchIndexClient.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys"/> for more information about API keys in Azure Cognitive Search.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys">Create and manage api-keys for an Azure Cognitive Search service</see> for more information about API keys in Azure Cognitive Search.
/// </param>
/// <param name="options">Client configuration options for connecting to Azure Cognitive Search.</param>
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="endpoint"/> or <paramref name="credential"/> is null.</exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ protected SearchIndexerClient() { }
/// <param name="credential">
/// Required. The API key credential used to authenticate requests against the Search service.
/// You need to use an admin key to perform any operations on the SearchIndexerClient.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys"/> for more information about API keys in Azure Cognitive Search.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys">Create and manage api-keys for an Azure Cognitive Search service</see> for more information about API keys in Azure Cognitive Search.
/// </param>
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="endpoint"/> or <paramref name="credential"/> is null.</exception>
/// <exception cref="ArgumentException">Thrown when the <paramref name="endpoint"/> is not using HTTPS.</exception>
Expand All @@ -57,7 +57,7 @@ public SearchIndexerClient(Uri endpoint, AzureKeyCredential credential) :
/// <param name="credential">
/// Required. The API key credential used to authenticate requests against the Search service.
/// You need to use an admin key to perform any operations on the SearchIndexerClient.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys"/> for more information about API keys in Azure Cognitive Search.
/// See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys">Create and manage api-keys for an Azure Cognitive Search service</see> for more information about API keys in Azure Cognitive Search.
/// </param>
/// <param name="options">Client configuration options for connecting to Azure Cognitive Search.</param>
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="endpoint"/> or <paramref name="credential"/> is null.</exception>
Expand Down
Loading