Add root request

Author: LucHeart

SDK.CSharp/IOpenShockApiClient.cs

@@ -11,15 +11,25 @@ public interface IOpenShockApiClient
     /// </summary>
     /// <param name="cancellationToken"></param>
     /// <returns></returns>
-    public Task<OneOf<Success<IReadOnlyCollection<ResponseDeviceWithShockers>>, UnauthenticatedError>> GetOwnShockers(CancellationToken cancellationToken = default);
+    public Task<OneOf<Success<IReadOnlyCollection<ResponseDeviceWithShockers>>, UnauthenticatedError>> GetOwnShockers(
+        CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Get the gateway a device is connected to
     /// </summary>
     /// <param name="deviceId"></param>
     /// <param name="cancellationToken"></param>
     /// <returns></returns>
-    public Task<OneOf<Success<LcgResponse>, NotFound, DeviceOffline, DeviceNotConnectedToGateway, UnauthenticatedError>> GetDeviceGateway(Guid deviceId, CancellationToken cancellationToken = default);
+    public Task<OneOf<Success<LcgResponse>, NotFound, DeviceOffline, DeviceNotConnectedToGateway, UnauthenticatedError>>
+        GetDeviceGateway(Guid deviceId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Gets the root for the API, this has some useful information and can be used to check if the API is reachable
+    /// </summary>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
+    public Task<RootResponse> GetRoot(CancellationToken cancellationToken = default);
+
 }
 
 public struct DeviceOffline;

SDK.CSharp/Models/RootResponse.cs

@@ -0,0 +1,10 @@
+namespace OpenShock.SDK.CSharp.Models;
+
+public sealed class RootResponse
+{
+    public required string Version { get; set; }
+    public required string Commit { get; set; }
+    public required DateTimeOffset CurrentTime { get; set; }
+    public required Uri FrontendUrl { get; set; }
+    public required Uri ShortLinkUrl { get; set; }
+}

SDK.CSharp/OpenShockApiClient.cs

@@ -92,6 +92,13 @@ await gatewayResponse.Content.ReadAsJsonAsync<ProblemDetails>(cancellationToken,
         };
     }
 
+    /// <inheritdoc />
+    public async Task<RootResponse> GetRoot(CancellationToken cancellationToken = default)
+    {
+        using var rootResponse = await _httpClient.GetAsync(OpenShockEndpoints.V1.Root, cancellationToken);
+        return await rootResponse.Content.ReadBaseResponseAsJsonAsync<RootResponse>(cancellationToken, JsonSerializerOptions);
+    }
+
     private string GetUserAgent()
     {
         var liveClientAssembly = GetType().Assembly;

SDK.CSharp/OpenShockEndpoints.cs

@@ -5,6 +5,8 @@ public static class OpenShockEndpoints
 
     public static class V1
     {
+        public const string Root = "1";
+        
         public static class Shockers
         {
             public const string OwnShockers = "1/shockers/own";

SDK.CSharp/SDK.CSharp.csproj

@@ -8,9 +8,9 @@
         <AssemblyName>OpenShock.SDK.CSharp</AssemblyName>
         <RootNamespace>OpenShock.SDK.CSharp</RootNamespace>
         <Company>OpenShock</Company>
-        <AssemblyVersion>0.0.19</AssemblyVersion>
-        <Version>0.0.19</Version>
-        <Title>SDK.DotNet</Title>
+        <AssemblyVersion>0.0.20</AssemblyVersion>
+        <Version>0.0.20</Version>
+        <Title>OpenShock.SDK.DotNet</Title>
         <Authors>OpenShock</Authors>
         <Description>.NET / C# SDK for developing OpenShock applications. Used to interact with a OpenShock backend.</Description>
         <PackageProjectUrl>https://openshock.org</PackageProjectUrl>
@@ -21,7 +21,6 @@
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <IncludeSymbols>true</IncludeSymbols>
         <PackageLicenseExpression>AGPL-3.0-or-later</PackageLicenseExpression>
-        <RepositoryType>git</RepositoryType>
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageId>OpenShock.SDK.CSharp</PackageId>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>