clarify Certificate Source descriptions

Frends.HTTP.DownloadFile/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.0.1] - 2024-12-30
+### Changed
+- Descriptions of ClientCertificate suboptions includes clearer information about usage in terms of different types of ClientCertificate.
+
 ## [1.0.0] - 2023-01-27
 ### Added
 - Initial implementation.

Frends.HTTP.DownloadFile/Frends.HTTP.DownloadFile/Definitions/Options.cs

@@ -47,30 +47,34 @@ public class Options
     public CertificateSource ClientCertificateSource { get; set; }
 
     /// <summary>
-    /// Path to the Client Certificate when using a file as the Certificate Source, pfx (pkcs12) files are recommended. For other supported formats, see
+    /// Applicable only when Certificate Source is "File".
+    /// Path to the Client Certificate, pfx (pkcs12) files are recommended. For other supported formats, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateFilePath { get; set; }
 
     /// <summary>
-    /// Client certificate bytes as a base64 encoded string when using a string as the Certificate Source , pfx (pkcs12) format is recommended. For other supported formates, see
+    /// Applicable only when Certificate Source is "String".
+    /// Client certificate bytes as a base64 encoded string, pfx (pkcs12) format is recommended. For other supported formates, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateInBase64 { get; set; }
 
     /// <summary>
-    /// Key phrase (password) to access the certificate data when using a string or file as the Certificate Source
+    /// Applicable only when Certificate Source is "File" or "String".
+    /// Key phrase (password) to access the certificate data
     /// </summary>
     /// <example>string value</example>
     [PasswordPropertyText]
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateKeyPhrase { get; set; }
 
     /// <summary>
+    /// Applicable only when Certificate Source is "CertificateStore".
     /// Thumbprint for using client certificate authentication.
     /// </summary>
     /// <example>thumbprint</example>

Frends.HTTP.DownloadFile/Frends.HTTP.DownloadFile/Frends.HTTP.DownloadFile.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>net6.0</TargetFrameworks>
-    <Version>1.0.0</Version>
+    <Version>1.0.1</Version>
     <Authors>Frends</Authors>
 	<Copyright>Frends</Copyright>
 	<Company>Frends</Company>

Frends.HTTP.Request/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.2.1] - 2024-12-30
+### Changed
+- Descriptions of ClientCertificate suboptions includes clearer information about usage in terms of different types of ClientCertificate.
+
 ## [1.2.0] - 2024-08-19
 ### Changed
 - Removed handling where only PATCH, PUT, POST and DELETE requests were allowed to have the Content-Type header and content, due to HttpClient failing if e.g., a GET request had content. HttpClient has since been updated to tolerate such requests.

Frends.HTTP.Request/Frends.HTTP.Request/Definitions/Options.cs

@@ -46,30 +46,34 @@ public class Options
     public CertificateSource ClientCertificateSource { get; set; }
 
     /// <summary>
-    /// Path to the Client Certificate when using a file as the Certificate Source, pfx (pkcs12) files are recommended. For other supported formats, see
+    /// Applicable only when Certificate Source is "File".
+    /// Path to the Client Certificate, pfx (pkcs12) files are recommended. For other supported formats, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateFilePath { get; set; }
 
     /// <summary>
-    /// Client certificate bytes as a base64 encoded string when using a string as the Certificate Source , pfx (pkcs12) format is recommended. For other supported formates, see
+    /// Applicable only when Certificate Source is "String".
+    /// Client certificate bytes as a base64 encoded string, pfx (pkcs12) format is recommended. For other supported formates, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateInBase64 { get; set; }
 
     /// <summary>
-    /// Key phrase (password) to access the certificate data when using a string or file as the Certificate Source
+    /// Applicable only when Certificate Source is "File" or "String".
+    /// Key phrase (password) to access the certificate data
     /// </summary>
     /// <example>string value</example>
     [PasswordPropertyText]
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateKeyPhrase { get; set; }
 
     /// <summary>
+    /// Applicable only when Certificate Source is "CertificateStore".
     /// Thumbprint for using client certificate authentication.
     /// </summary>
     /// <example>thumbprint</example>

Frends.HTTP.Request/Frends.HTTP.Request/Frends.HTTP.Request.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>net6.0</TargetFrameworks>
-    <Version>1.2.0</Version>
+    <Version>1.2.1</Version>
     <Authors>Frends</Authors>
 	<Copyright>Frends</Copyright>
 	<Company>Frends</Company>

Frends.HTTP.RequestBytes/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.0.2] - 2024-12-30
+### Changed
+- Descriptions of ClientCertificate suboptions includes clearer information about usage in terms of different types of ClientCertificate.
+
 ## [1.0.1] - 2024-01-17
 ### Fixed
 - Fixed issues which CodeQL found in the codebase.

Frends.HTTP.RequestBytes/Frends.HTTP.RequestBytes/Definitions/Options.cs

@@ -46,30 +46,34 @@ public class Options
     public CertificateSource ClientCertificateSource { get; set; }
 
     /// <summary>
-    /// Path to the Client Certificate when using a file as the Certificate Source, pfx (pkcs12) files are recommended. For other supported formats, see
+    /// Applicable only when Certificate Source is "File".
+    /// Path to the Client Certificate, pfx (pkcs12) files are recommended. For other supported formats, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateFilePath { get; set; }
 
     /// <summary>
-    /// Client certificate bytes as a base64 encoded string when using a string as the Certificate Source , pfx (pkcs12) format is recommended. For other supported formates, see
+    /// Applicable only when Certificate Source is "String".
+    /// Client certificate bytes as a base64 encoded string, pfx (pkcs12) format is recommended. For other supported formates, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateInBase64 { get; set; }
 
     /// <summary>
-    /// Key phrase (password) to access the certificate data when using a string or file as the Certificate Source
+    /// Applicable only when Certificate Source is "File" or "String".
+    /// Key phrase (password) to access the certificate data
     /// </summary>
     /// <example>string value</example>
     [PasswordPropertyText]
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateKeyPhrase { get; set; }
 
     /// <summary>
+    /// Applicable only when Certificate Source is "CertificateStore".
     /// Thumbprint for using client certificate authentication.
     /// </summary>
     /// <example>thumbprint</example>

Frends.HTTP.RequestBytes/Frends.HTTP.RequestBytes/Frends.HTTP.RequestBytes.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>net6.0</TargetFrameworks>
-    <Version>1.0.1</Version>
+    <Version>1.0.2</Version>
     <Authors>Frends</Authors>
 	<Copyright>Frends</Copyright>
 	<Company>Frends</Company>

Frends.HTTP.SendAndReceiveBytes/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.0.1] - 2024-12-30
+### Changed
+- Descriptions of ClientCertificate suboptions includes clearer information about usage in terms of different types of ClientCertificate.
+
 ## [1.0.0] - 2023-06-01
 ### Added
 - Initial implementation.

Frends.HTTP.SendAndReceiveBytes/Frends.HTTP.SendAndReceiveBytes/Definitions/Options.cs

@@ -48,23 +48,26 @@ public class Options
     public CertificateSource ClientCertificateSource { get; set; }
 
     /// <summary>
-    /// Path to the Client Certificate when using a file as the Certificate Source, pfx (pkcs12) files are recommended. For other supported formats, see
+    /// Applicable only when Certificate Source is "File".
+    /// Path to the Client Certificate, pfx (pkcs12) files are recommended. For other supported formats, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateFilePath { get; set; }
 
     /// <summary>
-    /// Client certificate bytes as a base64 encoded string when using a string as the Certificate Source , pfx (pkcs12) format is recommended. For other supported formates, see
+    /// Applicable only when Certificate Source is "String".
+    /// Client certificate bytes as a base64 encoded string, pfx (pkcs12) format is recommended. For other supported formates, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateInBase64 { get; set; }
 
     /// <summary>
-    /// Key phrase (password) to access the certificate data when using a string or file as the Certificate Source
+    /// Applicable only when Certificate Source is "File" or "String".
+    /// Key phrase (password) to access the certificate data
     /// </summary>
     /// <example>string value</example>
     [DisplayFormat(DataFormatString = "Text")]
@@ -73,6 +76,7 @@ public class Options
     public string ClientCertificateKeyPhrase { get; set; }
 
     /// <summary>
+    /// Applicable only when Certificate Source is "CertificateStore".
     /// Thumbprint for using client certificate authentication.
     /// </summary>
     /// <example>thumbprint</example>

Frends.HTTP.SendAndReceiveBytes/Frends.HTTP.SendAndReceiveBytes/Frends.HTTP.SendAndReceiveBytes.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>net6.0</TargetFrameworks>
-    <Version>1.0.0</Version>
+    <Version>1.0.1</Version>
     <Authors>Frends</Authors>
 	<Copyright>Frends</Copyright>
 	<Company>Frends</Company>

Frends.HTTP.SendBytes/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.0.1] - 2024-12-30
+### Changed
+- Descriptions of ClientCertificate suboptions includes clearer information about usage in terms of different types of ClientCertificate.
+
 ## [1.0.0] - 2023-05-30
 ### Added
 - Initial implementation.

Frends.HTTP.SendBytes/Frends.HTTP.SendBytes/Definitions/Options.cs

@@ -46,30 +46,34 @@ public class Options
     public CertificateSource ClientCertificateSource { get; set; }
 
     /// <summary>
-    /// Path to the Client Certificate when using a file as the Certificate Source, pfx (pkcs12) files are recommended. For other supported formats, see
+    /// Applicable only when Certificate Source is "File".
+    /// Path to the Client Certificate, pfx (pkcs12) files are recommended. For other supported formats, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateFilePath { get; set; }
 
     /// <summary>
-    /// Client certificate bytes as a base64 encoded string when using a string as the Certificate Source , pfx (pkcs12) format is recommended. For other supported formates, see
+    /// Applicable only when Certificate Source is "String".
+    /// Client certificate bytes as a base64 encoded string, pfx (pkcs12) format is recommended. For other supported formates, see
     /// https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x509certificate2collection.import?view=netframework-4.7.1
     /// </summary>
     /// <example>domain\path</example>
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateInBase64 { get; set; }
 
     /// <summary>
-    /// Key phrase (password) to access the certificate data when using a string or file as the Certificate Source
+    /// Applicable only when Certificate Source is "File" or "String".
+    /// Key phrase (password) to access the certificate data
     /// </summary>
     /// <example>string value</example>
     [PasswordPropertyText]
     [UIHint(nameof(Authentication), "", Authentication.ClientCertificate)]
     public string ClientCertificateKeyPhrase { get; set; }
 
     /// <summary>
+    /// Applicable only when Certificate Source is "CertificateStore".
     /// Thumbprint for using client certificate authentication.
     /// </summary>
     /// <example>thumbprint</example>

Frends.HTTP.SendBytes/Frends.HTTP.SendBytes/Frends.HTTP.SendBytes.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>net6.0</TargetFrameworks>
-    <Version>1.0.0</Version>
+    <Version>1.0.1</Version>
     <Authors>Frends</Authors>
 	<Copyright>Frends</Copyright>
 	<Company>Frends</Company>