fix(web-api): use json content type for chat stream methods (#1749)

zimeg · web-flow · commit 16741f824fee · 2025-09-22T21:51:12.000-07:00
diff --git a/slack_sdk/web/async_client.py b/slack_sdk/web/async_client.py
@@ -2641,7 +2641,8 @@ async def chat_appendStream(
                 "markdown_text": markdown_text,
             }
         )
-        return await self.api_call("chat.appendStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return await self.api_call("chat.appendStream", json=kwargs)
 
     async def chat_delete(
         self,
@@ -2895,7 +2896,8 @@ async def chat_startStream(
                 "unfurl_media": unfurl_media,
             }
         )
-        return await self.api_call("chat.startStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return await self.api_call("chat.startStream", json=kwargs)
 
     async def chat_stopStream(
         self,
@@ -2920,7 +2922,8 @@ async def chat_stopStream(
             }
         )
         _parse_web_class_objects(kwargs)
-        return await self.api_call("chat.stopStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return await self.api_call("chat.stopStream", json=kwargs)
 
     async def chat_unfurl(
         self,
diff --git a/slack_sdk/web/client.py b/slack_sdk/web/client.py
@@ -2631,7 +2631,8 @@ def chat_appendStream(
                 "markdown_text": markdown_text,
             }
         )
-        return self.api_call("chat.appendStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return self.api_call("chat.appendStream", json=kwargs)
 
     def chat_delete(
         self,
@@ -2885,7 +2886,8 @@ def chat_startStream(
                 "unfurl_media": unfurl_media,
             }
         )
-        return self.api_call("chat.startStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return self.api_call("chat.startStream", json=kwargs)
 
     def chat_stopStream(
         self,
@@ -2910,7 +2912,8 @@ def chat_stopStream(
             }
         )
         _parse_web_class_objects(kwargs)
-        return self.api_call("chat.stopStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return self.api_call("chat.stopStream", json=kwargs)
 
     def chat_unfurl(
         self,
diff --git a/slack_sdk/web/legacy_client.py b/slack_sdk/web/legacy_client.py
@@ -2643,7 +2643,8 @@ def chat_appendStream(
                 "markdown_text": markdown_text,
             }
         )
-        return self.api_call("chat.appendStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return self.api_call("chat.appendStream", json=kwargs)
 
     def chat_delete(
         self,
@@ -2897,7 +2898,8 @@ def chat_startStream(
                 "unfurl_media": unfurl_media,
             }
         )
-        return self.api_call("chat.startStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return self.api_call("chat.startStream", json=kwargs)
 
     def chat_stopStream(
         self,
@@ -2922,7 +2924,8 @@ def chat_stopStream(
             }
         )
         _parse_web_class_objects(kwargs)
-        return self.api_call("chat.stopStream", params=kwargs)
+        kwargs = _remove_none_values(kwargs)
+        return self.api_call("chat.stopStream", json=kwargs)
 
     def chat_unfurl(
         self,
diff --git a/tests/slack_sdk_async/web/test_web_client_coverage.py b/tests/slack_sdk_async/web/test_web_client_coverage.py
@@ -571,8 +571,10 @@ async def run_method(self, method_name, method, async_method):
                 self.api_methods_to_call.remove(method(channel="C123")["method"])
                 await async_method(channel="C123")
             elif method_name == "chat_stopStream":
-                self.api_methods_to_call.remove(method(channel="C123", ts="123.123")["method"])
-                await async_method(channel="C123", ts="123.123")
+                self.api_methods_to_call.remove(
+                    method(channel="C123", ts="123.123", blocks=[{"type": "markdown", "text": "**twelve**"}])["method"]
+                )
+                await async_method(channel="C123", ts="123.123", blocks=[{"type": "markdown", "text": "**twelve**"}])
             elif method_name == "chat_unfurl":
                 self.api_methods_to_call.remove(
                     method(

Original file line number	Diff line number	Diff line change
`@@ -2641,7 +2641,8 @@ async def chat_appendStream(`
`2641`	`2641`	`"markdown_text": markdown_text,`
`2642`	`2642`	`}`
`2643`	`2643`	`)`
`2644`		`- return await self.api_call("chat.appendStream", params=kwargs)`
	`2644`	`+ kwargs = _remove_none_values(kwargs)`
	`2645`	`+ return await self.api_call("chat.appendStream", json=kwargs)`
`2645`	`2646`
`2646`	`2647`	`async def chat_delete(`
`2647`	`2648`	`self,`
`@@ -2895,7 +2896,8 @@ async def chat_startStream(`
`2895`	`2896`	`"unfurl_media": unfurl_media,`
`2896`	`2897`	`}`
`2897`	`2898`	`)`
`2898`		`- return await self.api_call("chat.startStream", params=kwargs)`
	`2899`	`+ kwargs = _remove_none_values(kwargs)`
	`2900`	`+ return await self.api_call("chat.startStream", json=kwargs)`
`2899`	`2901`
`2900`	`2902`	`async def chat_stopStream(`
`2901`	`2903`	`self,`
`@@ -2920,7 +2922,8 @@ async def chat_stopStream(`
`2920`	`2922`	`}`
`2921`	`2923`	`)`
`2922`	`2924`	`_parse_web_class_objects(kwargs)`
`2923`		`- return await self.api_call("chat.stopStream", params=kwargs)`
	`2925`	`+ kwargs = _remove_none_values(kwargs)`
	`2926`	`+ return await self.api_call("chat.stopStream", json=kwargs)`
`2924`	`2927`
`2925`	`2928`	`async def chat_unfurl(`
`2926`	`2929`	`self,`
Original file line number	Diff line number	Diff line change
`@@ -2631,7 +2631,8 @@ def chat_appendStream(`
`2631`	`2631`	`"markdown_text": markdown_text,`
`2632`	`2632`	`}`
`2633`	`2633`	`)`
`2634`		`- return self.api_call("chat.appendStream", params=kwargs)`
	`2634`	`+ kwargs = _remove_none_values(kwargs)`
	`2635`	`+ return self.api_call("chat.appendStream", json=kwargs)`
`2635`	`2636`
`2636`	`2637`	`def chat_delete(`
`2637`	`2638`	`self,`
`@@ -2885,7 +2886,8 @@ def chat_startStream(`
`2885`	`2886`	`"unfurl_media": unfurl_media,`
`2886`	`2887`	`}`
`2887`	`2888`	`)`
`2888`		`- return self.api_call("chat.startStream", params=kwargs)`
	`2889`	`+ kwargs = _remove_none_values(kwargs)`
	`2890`	`+ return self.api_call("chat.startStream", json=kwargs)`
`2889`	`2891`
`2890`	`2892`	`def chat_stopStream(`
`2891`	`2893`	`self,`
`@@ -2910,7 +2912,8 @@ def chat_stopStream(`
`2910`	`2912`	`}`
`2911`	`2913`	`)`
`2912`	`2914`	`_parse_web_class_objects(kwargs)`
`2913`		`- return self.api_call("chat.stopStream", params=kwargs)`
	`2915`	`+ kwargs = _remove_none_values(kwargs)`
	`2916`	`+ return self.api_call("chat.stopStream", json=kwargs)`
`2914`	`2917`
`2915`	`2918`	`def chat_unfurl(`
`2916`	`2919`	`self,`
Original file line number	Diff line number	Diff line change
`@@ -2643,7 +2643,8 @@ def chat_appendStream(`
`2643`	`2643`	`"markdown_text": markdown_text,`
`2644`	`2644`	`}`
`2645`	`2645`	`)`
`2646`		`- return self.api_call("chat.appendStream", params=kwargs)`
	`2646`	`+ kwargs = _remove_none_values(kwargs)`
	`2647`	`+ return self.api_call("chat.appendStream", json=kwargs)`
`2647`	`2648`
`2648`	`2649`	`def chat_delete(`
`2649`	`2650`	`self,`
`@@ -2897,7 +2898,8 @@ def chat_startStream(`
`2897`	`2898`	`"unfurl_media": unfurl_media,`
`2898`	`2899`	`}`
`2899`	`2900`	`)`
`2900`		`- return self.api_call("chat.startStream", params=kwargs)`
	`2901`	`+ kwargs = _remove_none_values(kwargs)`
	`2902`	`+ return self.api_call("chat.startStream", json=kwargs)`
`2901`	`2903`
`2902`	`2904`	`def chat_stopStream(`
`2903`	`2905`	`self,`
`@@ -2922,7 +2924,8 @@ def chat_stopStream(`
`2922`	`2924`	`}`
`2923`	`2925`	`)`
`2924`	`2926`	`_parse_web_class_objects(kwargs)`
`2925`		`- return self.api_call("chat.stopStream", params=kwargs)`
	`2927`	`+ kwargs = _remove_none_values(kwargs)`
	`2928`	`+ return self.api_call("chat.stopStream", json=kwargs)`
`2926`	`2929`
`2927`	`2930`	`def chat_unfurl(`
`2928`	`2931`	`self,`