updated xml info

Muljin · Sep 26, 2023 · 0d379cb · 0d379cb
1 parent 5b90494
commit 0d379cb
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/example/Muljin.B2CMagicLink.Example/Muljin.B2CMagicLink.Example.csproj b/example/Muljin.B2CMagicLink.Example/Muljin.B2CMagicLink.Example.csproj
@@ -10,9 +10,9 @@
   <PropertyGroup Condition=" '$(RunConfiguration)' == 'https' " />
   <PropertyGroup Condition=" '$(RunConfiguration)' == 'http' " />
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="7.0.5" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.4.0" />
-    <PackageReference Include="Microsoft.Graph" Version="5.18.0" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="7.0.11" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Microsoft.Graph" Version="5.26.0" />
     <PackageReference Include="SendGrid" Version="9.28.1" />
     <PackageReference Include="Muljin.B2CMagicLink.AzureKeyVault" Version="0.0.2" />
     <PackageReference Include="Muljin.B2CMagicLink" Version="0.0.2" />

diff --git a/src/Muljin.B2CMagicLink/Muljin.B2CMagicLink.Abstractions/ICertificateProvider.cs b/src/Muljin.B2CMagicLink/Muljin.B2CMagicLink.Abstractions/ICertificateProvider.cs
@@ -13,8 +13,8 @@ public interface ICertificateProvider
         /// <summary>
         /// Sign data and return as base64 encoded string
         /// </summary>
-        /// <param name="data"></param>
-        /// <returns></returns>
+        /// <param name="data">Arbitrary byte[] of data to be signed</param>
+        /// <returns>base64 ecoded signature</returns>
         Task<string> SignDataAsync(byte[] data);
     }
 }

diff --git a/src/Muljin.B2CMagicLink/Muljin.B2CMagicLink.Abstractions/IOidcService.cs b/src/Muljin.B2CMagicLink/Muljin.B2CMagicLink.Abstractions/IOidcService.cs
@@ -21,28 +21,28 @@ public interface IOidcService
     /// <summary>
     /// Build a serialised JWT token with a list of claims
     /// </summary>
-    /// <param name="audience"></param>
-    /// <param name="duration"></param>
-    /// <param name="claims"></param>
-    /// <returns></returns>
+    /// <param name="audience">The clientid of the frontend application which will be completing the login journey</param>
+    /// <param name="duration">Duration in minutes for validity of token</param>
+    /// <param name="claims">List of claims to include in token</param>
+    /// <returns>JWT token</returns>
     public Task<string> BuildSerializedIdTokenAsync(string audience, int duration, List<System.Security.Claims.Claim> claims);
 
     /// <summary>
     /// Build a serialized JWT token with the user email as a claim
     /// </summary>
-    /// <param name="audience"></param>
-    /// <param name="duration"></param>
-    /// <param name="email"></param>
-    /// <returns></returns>
+    /// <param name="audience">The clientid of the frontend application which will be completing the login journey</param>
+    /// <param name="duration">Duration in minutes for validity of token</param>
+    /// <param name="email">Email of the user, added as a cliam in the JWT token to exchange</param>
+    /// <returns>JWT token</returns>
     public Task<string> BuildSerializedIdTokenByEmailAsync(string audience, int duration, string email);
 
     /// <summary>
     /// Build a serialized JWT token with the user object ID as a claim
     /// </summary>
-    /// <param name="audience"></param>
-    /// <param name="duration"></param>
-    /// <param name="objectId"></param>
-    /// <returns></returns>
+    /// <param name="audience">The clientid of the frontend application which will be completing the login journey</param>
+    /// <param name="duration">Duration in minutes for validity of token</param>
+    /// <param name="objectId">ObjectId of the user, added as a claim in the jwt token to exchange</param>
+    /// <returns>JWT token</returns>
     public Task<string> BuildSerializedIdTokenByObjectIdAsync(string audience, int duration, string objectId);
 
 }
diff --git a/...jin.B2CMagicLink/Muljin.B2CMagicLink.Abstractions/Muljin.B2CMagicLink.Abstractions.csproj b/...jin.B2CMagicLink/Muljin.B2CMagicLink.Abstractions/Muljin.B2CMagicLink.Abstractions.csproj
@@ -14,7 +14,7 @@
     <Copyright>Muljin Pte. Ltd.</Copyright>
     <PackageProjectUrl>https://www.muljin.com/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/Muljin/B2CMagicLink</RepositoryUrl>
-    <Version>0.0.2</Version>
+    <Version>0.0.3</Version>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
   </PropertyGroup>
    <ItemGroup>