adds http docs + fixes generate history json

SSW.Rules.AzFuncs/Functions/History/GenerateHistoryFileFunction.cs

@@ -38,7 +38,6 @@ public async Task<HttpResponseData> Run(
         }));
 
         var responseMessage = JsonConvert.SerializeObject(ruleHistory);
-
-        return req.CreateJsonResponse(responseMessage);
+        return await req.SendJsonResponse(responseMessage);
     }
 }

SSW.Rules.AzFuncs/Functions/Widget/GetLatestRules.cs

@@ -34,7 +34,7 @@ public async Task<HttpResponseData> Run(
 
         var filteredRulesList = filteredRules.ToList();
         return filteredRulesList.Count == 0
-            ? req.CreateJsonErrorResponse(HttpStatusCode.NotFound)
+            ? req.CreateJsonErrorResponse(HttpStatusCode.NotFound, "Not Found")
             : req.CreateJsonResponse(filteredRules);
     }
 }

SSW.Rules.AzFuncs/helpers/Utils.cs

@@ -57,6 +57,24 @@ public static HttpResponseData CreateJsonResponse(this HttpRequestData req, obje
         return response;
     }
 
+
+    /// <summary>
+    /// Create a JSON object response 
+    /// </summary>
+    /// <param name="req"></param>
+    /// <param name="statusCode">Default 200</param>
+    /// <param name="message">Default empty</param>
+    /// <returns></returns>
+    public static async Task<HttpResponseData> SendJsonResponse(this HttpRequestData req, string message, HttpStatusCode statusCode = HttpStatusCode.OK)
+    {
+
+        var response = req.CreateResponse(statusCode);
+        response.Headers.Add("Content-Type", "application/json");
+        response.StatusCode = statusCode;
+        await response.WriteStringAsync(message);
+        return response;
+    }
+
     public static async Task<NameValueCollection> ReadFormDataAsync(this HttpRequestData req)
     {
         using var reader = new StreamReader(req.Body);

docs/Functions/Functions.http

@@ -0,0 +1,35 @@
+@BaseApiUrl = http://localhost:7071/api
+
+# Health
+GET {{BaseApiUrl}}/HealthCheckFunction
+Content-Type: application/json
+
+###
+# History - Generate
+GET {{BaseApiUrl}}/GenerateHistoryFileFunction
+Content-Type: application/json
+
+###
+# History - SyncCommitHash
+GET {{BaseApiUrl}}/GetHistorySyncCommitHash
+Content-Type: application/json
+
+
+###
+# Widget - Get LatestRules (with GitHub)
+@skip = 0
+@take = 10
+@githubUsername = ""
+
+GET {{BaseApiUrl}}/GetLatestRules?skip={{skip}}&take={{take}}&githubUsername={{githubUsername}}
+Content-Type: application/json
+
+###
+# Widget - Get LatestRules (No GitHub)
+
+GET {{BaseApiUrl}}/GetLatestRules?skip={{skip}}&take={{take}}
+Content-Type: application/json
+
+
+###
+# Widget - Update LatestRules