Merge pull request #5 from astar-development/features/remove-defunct-health-check

Remove defunct Health Check message

Author: jaybarden1

src/AStar.Dev.Api.HealthChecks/AStar.Dev.Api.HealthChecks.csproj

@@ -21,15 +21,15 @@
         <PackageLicenseFile>LICENSE</PackageLicenseFile>
         <PackageProjectUrl>https://github.com/astar-development/astar-dev-api-health-checks</PackageProjectUrl>
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
-        <PackageReleaseNotes>This version cleans up the HealthCheck code without affecting the public API.</PackageReleaseNotes>
+        <PackageReleaseNotes>Removes the defunct Health Check, leaving the 'Result' object-based version.</PackageReleaseNotes>
         <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
         <PackageTags>ASP.Core HealthChecks;HealthChecks</PackageTags>
         <RepositoryType>git</RepositoryType>
         <RepositoryUrl>https://github.com/astar-development/astar-dev-api-health-checks.git</RepositoryUrl>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <TargetFramework>net9.0</TargetFramework>
         <Title>AStar API HealthChecks</Title>
-        <Version>0.4.0</Version>
+        <Version>0.4.1</Version>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

src/AStar.Dev.Api.HealthChecks/AStar.Dev.Api.HealthChecks.xml

@@ -7,16 +7,6 @@ namespace AStar.Dev.Api.HealthChecks;
 /// </summary>
 public interface IApiClient
 {
-    /// <summary>
-    ///     The GetHealthAsync method will return the basic Health Status of the API.
-    /// </summary>
-    /// <param name="cancellationToken">The token to optionally use to cancel the operation</param>
-    /// <returns>
-    ///     An instance of the <see href="HealthStatusResponse"></see> class containing the text representation of the API
-    ///     Health Status.
-    /// </returns>
-    public Task<HealthStatusResponse> GetHealthAsync(CancellationToken cancellationToken = default);
-
     /// <summary>
     ///     The GetHealthAsync method will return the basic Health Status of the API.
     /// </summary>