Merge pull request #3 from craftersmine/dev

Marked few properties as obsolete

Author: craftersmine

craftersmine.SteamGridDB.Net/SteamGridDbObject.cs

@@ -21,9 +21,9 @@ public class SteamGridDbObject
         [JsonProperty("id")]
         public int Id { get; private set; }
         /// <summary>
-        /// Gets item Score. No official documentation
+        /// Gets item Score. Obsolete by SteamGridDB API and will be always 0
         /// </summary>
-        [JsonProperty("score")]
+        [JsonProperty("score"), Obsolete("This property is marked as obsolete by API developer and left only for backwards compatibility. This property will always return false")]
         public int Score { get; private set; }
         /// <summary>
         /// Gets an item style
@@ -76,24 +76,24 @@ public class SteamGridDbObject
         [JsonProperty("thumb")]
         public string ThumbnailImageUrl { get; private set; }
         /// <summary>
-        /// Gets <see langword="true"/> if item is locked by user, otherwise <see langword="false"/>. No official documentation
+        /// Gets <see langword="true"/> if item is locked by user, otherwise <see langword="false"/>. Obsolete by SteamGridDB API and will be always <see langword="false"/>
         /// </summary>
-        [JsonProperty("lock")]
+        [JsonProperty("lock"), Obsolete("This property is marked as obsolete by API developer and left only for backwards compatibility. This property will always return false")]
         public bool IsLocked { get; private set; }
         /// <summary>
         /// Gets <see langword="true"/> if contains content that can cause seizures or epilepsy, otherwise <see langword="false"/>
         /// </summary>
         [JsonProperty("epilepsy")]
         public bool CanCauseEpilepsy { get; private set; }
         /// <summary>
-        /// Gets a number of upvotes for item. No official documentation
+        /// Gets a number of upvotes for item. Obsolete by SteamGridDB API and will be always 0
         /// </summary>
-        [JsonProperty("upvotes")]
+        [JsonProperty("upvotes"), Obsolete("This property is marked as obsolete by API developer and left only for backwards compatibility. This property will always return 0")]
         public int Upvotes { get; private set; }
         /// <summary>
-        /// Gets a number of downvotes for item. No official documentation
+        /// Gets a number of downvotes for item. Obsolete by SteamGridDB API and will be always 0
         /// </summary>
-        [JsonProperty("downvotes")]
+        [JsonProperty("downvotes"), Obsolete("This property is marked as obsolete by API developer and left only for backwards compatibility. This property will always return 0")]
         public int Downvotes { get; private set; }
         /// <summary>
         /// Gets a <see cref="SteamAuthor"/> object that created that item

craftersmine.SteamGridDB.Net/craftersmine.SteamGridDB.Net.csproj

@@ -4,7 +4,7 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <RootNamespace>craftersmine.SteamGridDBNet</RootNamespace>
-    <Version>1.1.1</Version>
+    <Version>1.1.2</Version>
     <Authors>craftersmine</Authors>
     <Description>A .NET implementation of SteamGridDB API</Description>
     <Copyright>Copyright © craftersmine 2022</Copyright>