Switch canvases.* APIs to application/json format for more stability (#1574)

Author: seratch

integration_tests/web/test_canvases.py

@@ -32,10 +32,14 @@ def test_sync(self):
             document_content={
                 "type": "markdown",
                 "markdown": """# My canvas
-                ---
-                ## Hey
-                What's up?
-                """,
+
+## Hey
+
+What's up?
+
+- foo
+- bar
+""",
             },
         )
         self.assertIsNone(channel_canvas.get("error"))
@@ -46,10 +50,14 @@ def test_sync(self):
             document_content={
                 "type": "markdown",
                 "markdown": """# My canvas
-                ---
-                ## Hey
-                What's up?
-                """,
+
+## Hey
+
+What's up?
+
+- foo
+- bar
+""",
             },
         )
         self.assertIsNone(standalone_canvas.get("error"))
@@ -96,10 +104,14 @@ async def test_async(self):
             document_content={
                 "type": "markdown",
                 "markdown": """# My canvas
-                ---
-                ## Hey
-                What's up?
-                """,
+
+## Hey
+
+What's up?
+
+- foo
+- bar
+""",
             },
         )
         self.assertIsNone(channel_canvas.get("error"))
@@ -110,10 +122,14 @@ async def test_async(self):
             document_content={
                 "type": "markdown",
                 "markdown": """# My canvas
-                ---
-                ## Hey
-                What's up?
-                """,
+
+## Hey
+
+What's up?
+
+- foo
+- bar
+""",
             },
         )
         self.assertIsNone(standalone_canvas.get("error"))

slack_sdk/web/async_client.py

@@ -2300,8 +2300,8 @@ async def canvases_create(
         """Create Canvas for a user
         https://api.slack.com/methods/canvases.create
         """
-        kwargs.update({"title": title, "document_content": json.dumps(document_content)})
-        return await self.api_call("canvases.create", params=kwargs)
+        kwargs.update({"title": title, "document_content": document_content})
+        return await self.api_call("canvases.create", json=kwargs)
 
     async def canvases_edit(
         self,
@@ -2313,8 +2313,8 @@ async def canvases_edit(
         """Update an existing canvas
         https://api.slack.com/methods/canvases.edit
         """
-        kwargs.update({"canvas_id": canvas_id, "changes": json.dumps(changes)})
-        return await self.api_call("canvases.edit", params=kwargs)
+        kwargs.update({"canvas_id": canvas_id, "changes": changes})
+        return await self.api_call("canvases.edit", json=kwargs)
 
     async def canvases_delete(
         self,
@@ -3353,8 +3353,8 @@ async def conversations_canvases_create(
         """Create a Channel Canvas for a channel
         https://api.slack.com/methods/conversations.canvases.create
         """
-        kwargs.update({"channel_id": channel_id, "document_content": json.dumps(document_content)})
-        return await self.api_call("conversations.canvases.create", params=kwargs)
+        kwargs.update({"channel_id": channel_id, "document_content": document_content})
+        return await self.api_call("conversations.canvases.create", json=kwargs)
 
     async def dialog_open(
         self,

slack_sdk/web/client.py

@@ -2291,8 +2291,8 @@ def canvases_create(
         """Create Canvas for a user
         https://api.slack.com/methods/canvases.create
         """
-        kwargs.update({"title": title, "document_content": json.dumps(document_content)})
-        return self.api_call("canvases.create", params=kwargs)
+        kwargs.update({"title": title, "document_content": document_content})
+        return self.api_call("canvases.create", json=kwargs)
 
     def canvases_edit(
         self,
@@ -2304,8 +2304,8 @@ def canvases_edit(
         """Update an existing canvas
         https://api.slack.com/methods/canvases.edit
         """
-        kwargs.update({"canvas_id": canvas_id, "changes": json.dumps(changes)})
-        return self.api_call("canvases.edit", params=kwargs)
+        kwargs.update({"canvas_id": canvas_id, "changes": changes})
+        return self.api_call("canvases.edit", json=kwargs)
 
     def canvases_delete(
         self,
@@ -3344,8 +3344,8 @@ def conversations_canvases_create(
         """Create a Channel Canvas for a channel
         https://api.slack.com/methods/conversations.canvases.create
         """
-        kwargs.update({"channel_id": channel_id, "document_content": json.dumps(document_content)})
-        return self.api_call("conversations.canvases.create", params=kwargs)
+        kwargs.update({"channel_id": channel_id, "document_content": document_content})
+        return self.api_call("conversations.canvases.create", json=kwargs)
 
     def dialog_open(
         self,

slack_sdk/web/legacy_client.py

@@ -2302,8 +2302,8 @@ def canvases_create(
         """Create Canvas for a user
         https://api.slack.com/methods/canvases.create
         """
-        kwargs.update({"title": title, "document_content": json.dumps(document_content)})
-        return self.api_call("canvases.create", params=kwargs)
+        kwargs.update({"title": title, "document_content": document_content})
+        return self.api_call("canvases.create", json=kwargs)
 
     def canvases_edit(
         self,
@@ -2315,8 +2315,8 @@ def canvases_edit(
         """Update an existing canvas
         https://api.slack.com/methods/canvases.edit
         """
-        kwargs.update({"canvas_id": canvas_id, "changes": json.dumps(changes)})
-        return self.api_call("canvases.edit", params=kwargs)
+        kwargs.update({"canvas_id": canvas_id, "changes": changes})
+        return self.api_call("canvases.edit", json=kwargs)
 
     def canvases_delete(
         self,
@@ -3355,8 +3355,8 @@ def conversations_canvases_create(
         """Create a Channel Canvas for a channel
         https://api.slack.com/methods/conversations.canvases.create
         """
-        kwargs.update({"channel_id": channel_id, "document_content": json.dumps(document_content)})
-        return self.api_call("conversations.canvases.create", params=kwargs)
+        kwargs.update({"channel_id": channel_id, "document_content": document_content})
+        return self.api_call("conversations.canvases.create", json=kwargs)
 
     def dialog_open(
         self,