Fix JSON deserialization errors in C# 'REST Client' tutorial. Closes … (dotnet#49442)

* Fix JSON deserialization errors in C# 'REST Client' tutorial. Closes dotnet#49387

Fix the deserialization issue in the Repository model.

* Refactor Repository class to use record definition

Updated the Repository class definition to use a record type with additional properties for JSON deserialization.

* Add JSON property names to Repository record

* Remove LastPush property from model

Removed LastPush property and its implementation.

* Update console-webapiclient.md

* Update documentation text for Repository section

* Change step numbers

* Update console-webapiclient.md for JSON deserialization

Clarified JSON property name handling and added note on case insensitivity of GetFromJsonAsync.

* Update docs/csharp/tutorials/console-webapiclient.md

Co-authored-by: Bill Wagner <[email protected]>

* Update docs/csharp/tutorials/console-webapiclient.md

Co-authored-by: Bill Wagner <[email protected]>

---------

Co-authored-by: Bill Wagner <[email protected]>

Author: mozhganEtaati

docs/csharp/tutorials/console-webapiclient.md

@@ -209,26 +209,29 @@ The `ProcessRepositoriesAsync` method can do the async work and return a collect
 
 ## Deserialize more properties
 
-The following steps add code to process more of the properties in the received JSON packet. You probably won't want to process every property, but adding a few more demonstrates other features of C#.
+In the following steps, we extend the code to process more properties from the JSON payload returned by the GitHub API. You probably won't need to process every property, but adding a few demonstrates additional C# features.
 
-1. Replace the contents of `Repository` class, with the following `record` definition:
+1. Replace the contents of the `Repository` class with the following `record` definition. Make sure to import the `System.Text.Json.Serialization` namespace and apply the `[JsonPropertyName]` attribute to map JSON fields to C# properties explicitly.
+
+   ```csharp
+    using System.Text.Json.Serialization;
 
-    ```csharp
     public record class Repository(
-        string Name,
-        string Description,
-        Uri GitHubHomeUrl,
-        Uri Homepage,
-        int Watchers,
-        DateTime LastPushUtc
-    );
-    ```
+      string Name,
+      string Description,
+      [property: JsonPropertyName("html_url")] Uri GitHubHomeUrl,
+      Uri Homepage,
+      int Watchers,
+      [property: JsonPropertyName("pushed_at")] DateTime LastPushUtc
+     );
+   ```
 
    The <xref:System.Uri> and `int` types have built-in functionality to convert to and from string representation. No extra code is needed to deserialize from JSON string format to those target types. If the JSON packet contains data that doesn't convert to a target type, the serialization action throws an exception.
 
-   JSON most often uses lowercase for names of it's objects, however we don't need to make any conversion and can keep the uppercase of the fields names, because, like mentioned in one of previous points, the `GetFromJsonAsync` extension method is case-insensitive when it comes to property names.
+   JSON often uses `lowercase` or `snake_case` for property names. Fields like `html_url` and `pushed_at` do not follow C# PascalCase naming conventions. Using `[JsonPropertyName]` ensures that these JSON keys are correctly bound to their corresponding C# properties, even when their names differ in case or contain underscores. This approach guarantees predictable and stable deserialization while allowing PascalCase property names in C#.
+Additionally, the `GetFromJsonAsync` method is `case-insensitive` when matching property names, so no further conversion is necessary.
 
-1. Update the `foreach` loop in the *Program.cs* file to display the property values:
+2. Update the `foreach` loop in the *Program.cs* file to display the property values:
 
     ```csharp
     foreach (var repo in repositories)
@@ -242,7 +245,7 @@ The following steps add code to process more of the properties in the received J
     }
     ```
 
-1. Run the app.
+3. Run the app.
 
    The list now includes the additional properties.
 

docs/csharp/tutorials/snippets/WebAPIClient/Repository.cs

@@ -1,11 +1,13 @@
-public record class Repository(
+using System.Text.Json.Serialization;
+
+public record class Repository(
     string Name,
     string Description,
-    Uri GitHubHomeUrl,
+    [property: JsonPropertyName("html_url")] Uri GitHubHomeUrl,
     Uri Homepage,
     int Watchers,
-    DateTime LastPushUtc
-)
+    [property: JsonPropertyName("pushed_at")] DateTime LastPushUtc
+    )
 {
     public DateTime LastPush => LastPushUtc.ToLocalTime();
 }