From 08dd34f42bc3419fcc7821af1be0ae0cc931bcd4 Mon Sep 17 00:00:00 2001
From: YoshiRulz <OSSYoshiRulz+git@gmail.com>
Date: Fri, 17 Jan 2025 00:45:30 +1000
Subject: [PATCH] Rename `HttpCommunication.ExecPost` and add docs

---
 src/BizHawk.Client.Common/Api/HttpCommunication.cs    | 11 +++++++++++
 .../lua/CommonLibs/CommLuaLibrary.cs                  |  2 +-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/src/BizHawk.Client.Common/Api/HttpCommunication.cs b/src/BizHawk.Client.Common/Api/HttpCommunication.cs
index 76183c82e6..29bf152017 100644
--- a/src/BizHawk.Client.Common/Api/HttpCommunication.cs
+++ b/src/BizHawk.Client.Common/Api/HttpCommunication.cs
@@ -32,7 +32,17 @@ namespace BizHawk.Client.Common
 
 		public string ExecGet(string url = null) => Get(url ?? GetUrl).Result;
 
+		/// <inheritdoc cref="ExecPostAsForm"/>
+		[Obsolete($"renamed to {nameof(ExecPostAsForm)}")]
 		public string ExecPost(string url = null, string payload = "")
+			=> ExecPostAsForm(url: url, payload: payload);
+
+#pragma warning disable DOC105 // false positive detecting param name in doc comment
+		/// <remarks>
+		/// uses <see cref="FormUrlEncodedContent"/> (<c>application/x-www-form-urlencoded</c>),
+		/// containing a single pair with key <c>payload</c> (literal) and value <paramref name="payload"/> (argument)
+		/// </remarks>
+		public string ExecPostAsForm(string url = null, string payload = "")
 		{
 			return Post(
 				url ?? PostUrl,
@@ -40,6 +50,7 @@ namespace BizHawk.Client.Common
 				sendAdvanceRequest: payload.Length >= ExpectContinueThreshold
 			).Result;
 		}
+#pragma warning restore DOC105
 
 		public async Task<string> Get(string url)
 		{
diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs
index db050266a2..5d30328994 100644
--- a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs
+++ b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs
@@ -200,7 +200,7 @@ namespace BizHawk.Client.Common
 		public string HttpPost(string url, string payload)
 		{
 			CheckHttp();
-			return APIs.Comm.HTTP?.ExecPost(url, payload);
+			return APIs.Comm.HTTP?.ExecPostAsForm(url: url, payload: payload);
 		}
 
 		[LuaMethod("httpPostScreenshot", "HTTP POST screenshot")]