Mark types used for Identity Search as obsolete (#98)

faluapp · Jul 13, 2022 · 9cbe95a · 9cbe95a
1 parent c1a7e3b
commit 9cbe95a
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 1 deletion.
diff --git a/src/FaluSdk/FaluClient.cs b/src/FaluSdk/FaluClient.cs
@@ -47,7 +47,9 @@ public FaluClient(HttpClient backChannel, IOptionsSnapshot<TOptions> optionsAcce
         Events = new EventsServiceClient(BackChannel, Options);
         Files = new FilesServiceClient(BackChannel, Options);
         FileLinks = new FileLinksServiceClient(BackChannel, Options);
+#pragma warning disable CS0618 // Type or member is obsolete
         Identity = new IdentityServiceClient(BackChannel, Options);
+#pragma warning restore CS0618 // Type or member is obsolete
         IdentityVerifications = new IdentityVerificationsServiceClient(BackChannel, Options);
         IdentityVerificationReports = new IdentityVerificationReportsServiceClient(BackChannel, Options);
         Messages = new MessagesServiceClient(BackChannel, Options);
@@ -86,6 +88,7 @@ public FaluClient(HttpClient backChannel, IOptionsSnapshot<TOptions> optionsAcce
     public virtual FileLinksServiceClient FileLinks { get; protected set; }
 
     ///
+    [Obsolete(MessageStrings.IdentitySearchDeprecated)]
     public virtual IdentityServiceClient Identity { get; protected set; }
 
     ///

diff --git a/src/FaluSdk/Identity/IdentityRecord.cs b/src/FaluSdk/Identity/IdentityRecord.cs
@@ -5,6 +5,7 @@ namespace Falu.Identity;
 /// <summary>
 /// The identification record for an entity.
 /// </summary>
+[Obsolete(MessageStrings.IdentitySearchDeprecated)]
 public class IdentityRecord : IHasId, IHasCreated, IHasUpdated, IHasCountry, IHasEtag
 {
     /// <inheritdoc/>

diff --git a/src/FaluSdk/Identity/IdentitySearchModel.cs b/src/FaluSdk/Identity/IdentitySearchModel.cs
@@ -5,6 +5,7 @@ namespace Falu.Identity;
 /// <summary>
 /// Information for searching for an entity's identity.
 /// </summary>
+[Obsolete(MessageStrings.IdentitySearchDeprecated)]
 public class IdentitySearchModel : IHasCountry
 {
     /// <inheritdoc />

diff --git a/src/FaluSdk/Identity/IdentityServiceClient.cs b/src/FaluSdk/Identity/IdentityServiceClient.cs
@@ -3,6 +3,7 @@
 namespace Falu.Identity;
 
 ///
+[Obsolete(MessageStrings.IdentitySearchDeprecated)]
 public class IdentityServiceClient : BaseServiceClient<IdentityRecord>
 {
     ///

diff --git a/src/FaluSdk/MessageStrings.cs b/src/FaluSdk/MessageStrings.cs
@@ -2,5 +2,5 @@
 
 internal class MessageStrings
 {
-    public const string TagsDeprecated = "Tags have been deprecated and scheduled to be removed in a future API update. Migrate to using Metadata.";
+    public const string IdentitySearchDeprecated = "Identity Search has been deprecated and scheduled to be removed in a future API update. Migrate to using Identity Verifications.";
 }
diff --git a/tests/FaluSdk.Tests/Clients/IdentityServiceClientTests.cs b/tests/FaluSdk.Tests/Clients/IdentityServiceClientTests.cs
@@ -8,6 +8,7 @@
 
 namespace Falu.Tests.Clients;
 
+[Obsolete(MessageStrings.IdentitySearchDeprecated)]
 public class IdentityServiceClientTests : BaseServiceClientTests
 {
     private const string BasePath = "/v1/identity";