fix: issue #33 postman request descriptions are strings (#34)

* chore: consider postman description can be object/string/null

Content will be populated, with string value, if not expliclity set.

* chore: bump rel version to 0.6.1

Author: YOU54F

.github/gitversion.yml

@@ -1,4 +1,4 @@
-next-version: 0.6
+next-version: 0.6.1
 assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatchTag
 assembly-informational-format: '{InformationalVersion}'

src/Explore.Cli/Models/Postman/PostmanCollectionContract.cs

@@ -1,5 +1,6 @@
 #nullable enable
 
+using System.Text.Json;
 using System.Text.Json.Serialization;
 
 namespace Explore.Cli.Models.Postman;
@@ -27,7 +28,8 @@ public partial class PostmanCollectionInfo
     public string? Version { get; set; }
 
     [JsonPropertyName("description")]
-    public string? Description { get; set; }
+    [JsonConverter(typeof(DescriptionConverter))]
+    public Description? Description { get; set; }
 }
 
 public class Item
@@ -39,7 +41,8 @@ public class Item
     public string? Name { get; set; }
 
     [JsonPropertyName("description")]
-    public string? Description { get; set; }
+    [JsonConverter(typeof(DescriptionConverter))]
+    public Description? Description { get; set; }
 
     [JsonPropertyName("request")]
     public Request? Request { get; set; }
@@ -64,6 +67,7 @@ public class Request
     public Url? Url { get; set; }
 
     [JsonPropertyName("description")]
+    [JsonConverter(typeof(DescriptionConverter))]
     public Description? Description { get; set; }
 }
 
@@ -76,7 +80,8 @@ public class Header
     public string? Value { get; set; }
 
     [JsonPropertyName("description")]
-    public string? Description { get; set; }
+    [JsonConverter(typeof(DescriptionConverter))]
+    public Description? Description { get; set; }
 }
 
 public class Body
@@ -109,7 +114,8 @@ public class Formdata
     public string? Type { get; set; }
 
     [JsonPropertyName("description")]
-    public string? Description { get; set; }
+    [JsonConverter(typeof(DescriptionConverter))]
+    public Description? Description { get; set; }
 }
 
 public class Urlencoded
@@ -121,7 +127,8 @@ public class Urlencoded
     public string? Value { get; set; }
 
     [JsonPropertyName("description")]
-    public string? Description { get; set; }
+    [JsonConverter(typeof(DescriptionConverter))]
+    public Description? Description { get; set; }
 }
 
 public class Graphql
@@ -165,12 +172,50 @@ public class Query
     [JsonPropertyName("value")]
     public string? Value { get; set; }
 }
-
 public class Description
 {
-    [JsonPropertyName("content")]
     public string? Content { get; set; }
-
-    [JsonPropertyName("type")]
     public string? Type { get; set; }
+    public string? Version { get; set; }
 }
+
+public class DescriptionConverter : JsonConverter<Description>
+{
+    public override Description? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        if (reader.TokenType == JsonTokenType.String)
+        {
+            return new Description { Content = reader.GetString() };
+        }
+        else if (reader.TokenType == JsonTokenType.StartObject)
+        {
+            var description = JsonSerializer.Deserialize<Description>(ref reader, options);
+            return description;
+        }
+        else if (reader.TokenType == JsonTokenType.Null)
+        {
+            return null;
+        }
+        throw new JsonException("Invalid JSON for Description");
+    }
+
+    public override void Write(Utf8JsonWriter writer, Description value, JsonSerializerOptions options)
+    {
+        if (value == null)
+        {
+            writer.WriteNullValue();
+        }
+        else if (value.Content == null)
+        {
+            writer.WriteStringValue(value.Content);
+        }
+        else
+        {
+            writer.WriteStartObject();
+            writer.WriteString("content", value.Content);
+            writer.WriteString("type", value.Type);
+            writer.WriteString("version", value.Version);
+            writer.WriteEndObject();
+        }
+    }
+}

src/Explore.Cli/Program.cs

@@ -180,7 +180,7 @@ internal static async Task ImportPostmanCollection(string exploreCookie, string
 
                             //now let's create an API entry in the space
                             var cleanedAPIName = UtilityHelper.CleanString(item.Name);
-                            var apiContent = new StringContent(JsonSerializer.Serialize(new ApiRequest() { Name = cleanedAPIName, Type = "REST", Description = $"imported from postman on {DateTime.UtcNow.ToShortDateString()}" }), Encoding.UTF8, "application/json");
+                            var apiContent = new StringContent(JsonSerializer.Serialize(new ApiRequest() { Name = cleanedAPIName, Type = "REST", Description = $"{item.Request.Description?.Content + "\n" }imported from postman on {DateTime.UtcNow.ToShortDateString()}" }), Encoding.UTF8, "application/json");
 
                             exploreHttpClient.DefaultRequestHeaders.Clear();
                             exploreHttpClient.DefaultRequestHeaders.Add("Cookie", exploreCookie);

test/Explore.Cli.Tests/PostmanCollectionMappingHelperTests.cs

@@ -90,7 +90,6 @@ public void IsCollectionVersion2_1_ShouldReturnTrue()
         // Assert
         Assert.True(result);
     }
-
     [Fact]
     public void IsCollectionVersion2_1_ShouldReturnFalse()
     {
@@ -110,4 +109,16 @@ public void IsCollectionVersion2_1_ShouldReturnFalse()
         Assert.False(result3);
     }   
 
+    [Fact]
+    public void ProcessesDescriptions()
+    {
+        // Arrange
+        var filePath = "../../../fixtures/API_.documentation_postman_collection.json";
+        var mockCollectionAsJson = File.ReadAllText(filePath);
+        var postmanCollection = JsonSerializer.Deserialize<PostmanCollection>(mockCollectionAsJson);
+        // Act
+        Assert.Equal("Get authenticated user", postmanCollection.Item[0].ItemList[0].Name);
+        Assert.Equal("GET", postmanCollection.Item[0].ItemList[0].Request?.Method?.ToString());
+        Assert.Equal("Gets information about the authenticated user.", postmanCollection.Item[0].ItemList[0].Request?.Description.Content.ToString());
+    }
 }