feat: Add "detail" parameter to CanvasesCreateResponse & CanvasesEditResponse

slack-api-client/src/main/java/com/slack/api/methods/response/canvases/CanvasesCreateResponse.java

@@ -19,6 +19,7 @@ public class CanvasesCreateResponse implements SlackApiTextResponse {
 
     private String canvasId;
 
+    private String detail;
     private ResponseMetadata responseMetadata;
 
 }

slack-api-client/src/main/java/com/slack/api/methods/response/canvases/CanvasesEditResponse.java

@@ -17,6 +17,7 @@ public class CanvasesEditResponse implements SlackApiTextResponse {
     private String provided;
     private transient Map<String, List<String>> httpResponseHeaders;
 
+    private String detail;
     private ResponseMetadata responseMetadata;
 
 }

slack-api-client/src/test/java/test_with_remote_apis/methods/canvases_Test.java

@@ -21,10 +21,12 @@
 import org.junit.BeforeClass;
 import org.junit.Test;
 
-import java.util.Arrays;
 import java.util.List;
 
+import static java.util.Collections.singletonList;
+import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.notNullValue;
 import static org.hamcrest.CoreMatchers.nullValue;
 import static org.hamcrest.MatcherAssert.assertThat;
 
@@ -50,11 +52,7 @@ public static void tearDown() throws InterruptedException {
     public void channel_canvases() throws Exception {
         MethodsClient client = slack.methods(botToken);
 
-        ConversationsCreateResponse newChannel = client.conversationsCreate(r -> r.name("test-" + System.currentTimeMillis()));
-        assertThat(newChannel.getError(), is(nullValue()));
-        String channelId = newChannel.getChannel().getId();
-
-        Thread.sleep(500L); // To avoid occasional 500 errors
+        String channelId = createChannel(client);
 
         ConversationsCanvasesCreateResponse creation = client.conversationsCanvasesCreate(r -> r
                 .channelId(channelId)
@@ -70,9 +68,7 @@ public void channel_canvases() throws Exception {
         );
         assertThat(creation.getError(), is(nullValue()));
 
-        String canvasId = creation.getCanvasId();
-        List<String> userIds = Arrays.asList(client.authTest(r -> r).getUserId());
-        FilesInfoResponse details = verifyCanvasOps(client, canvasId, channelId, userIds);
+        FilesInfoResponse details = verifyCanvasOps(client, creation.getCanvasId());
         ChatPostMessageResponse message = client.chatPostMessage(r -> r
                 .channel(channelId)
                 .text("Here you are: " + details.getFile().getPermalink())
@@ -99,8 +95,8 @@ public void standalone_canvases() throws Exception {
 
         String canvasId = creation.getCanvasId();
         try {
-            List<String> userIds = Arrays.asList(client.authTest(r -> r).getUserId());
-            verifyCanvasOps(client, canvasId, null, userIds);
+            List<String> userIds = singletonList(client.authTest(r -> r).getUserId());
+            verifyCanvasOps(client, canvasId);
 
             CanvasesAccessSetResponse set = client.canvasesAccessSet(r -> r
                     .canvasId(canvasId)
@@ -120,11 +116,11 @@ public void standalone_canvases() throws Exception {
         }
     }
 
-    FilesInfoResponse verifyCanvasOps(MethodsClient client, String canvasId, String channelId, List<String> userIds) throws Exception {
+    FilesInfoResponse verifyCanvasOps(MethodsClient client, String canvasId) throws Exception {
         CanvasesSectionsLookupResponse lookupResult = client.canvasesSectionsLookup(r -> r
                 .canvasId(canvasId)
                 .criteria(CanvasesSectionsLookupRequest.Criteria.builder()
-                        .sectionTypes(Arrays.asList(CanvasDocumentSectionType.H2))
+                        .sectionTypes(singletonList(CanvasDocumentSectionType.H2))
                         .containsText("Before")
                         .build()
                 )
@@ -134,7 +130,7 @@ FilesInfoResponse verifyCanvasOps(MethodsClient client, String canvasId, String
         String sectionId = lookupResult.getSections().get(0).getId();
         CanvasesEditResponse edit = client.canvasesEdit(r -> r
                 .canvasId(canvasId)
-                .changes(Arrays.asList(CanvasDocumentChange.builder()
+                .changes(singletonList(CanvasDocumentChange.builder()
                         .sectionId(sectionId)
                         .operation(CanvasEditOperation.REPLACE)
                         .documentContent(CanvasDocumentContent.builder().markdown("## After").build())
@@ -160,4 +156,51 @@ public void standalone_canvases_error() throws Exception {
         );
         assertThat(creation.getError(), is("invalid_arguments"));
     }
+
+    @Test
+    public void error_detail() throws Exception {
+        MethodsClient client = slack.methods(botToken);
+
+        String channelId = createChannel(client);
+
+        String invalidCanvasContent = "1. Text\n    * Nested"; // mixing of ordered and unordered lists is not supported
+        ConversationsCanvasesCreateResponse failedCreation = client.conversationsCanvasesCreate(r -> r
+                .channelId(channelId)
+                .documentContent(CanvasDocumentContent.builder()
+                        .markdown(invalidCanvasContent)
+                        .build())
+        );
+        assertThat(failedCreation.isOk(), is(false));
+        assertThat(failedCreation.getError(), is("canvas_creation_failed"));
+        assertThat(failedCreation.getDetail(), containsString("Unsupported list type"));
+
+        ConversationsCanvasesCreateResponse successfulCreation = client.conversationsCanvasesCreate(r -> r
+                .channelId(channelId)
+                .documentContent(CanvasDocumentContent.builder()
+                        .markdown("Correct MD")
+                        .build()
+                )
+        );
+        assertThat(successfulCreation.getCanvasId(), is(notNullValue()));
+
+        CanvasesEditResponse editFailingResponse = client.canvasesEdit(r -> r
+                .canvasId(successfulCreation.getCanvasId())
+                .changes(singletonList(CanvasDocumentChange.builder()
+                        .operation(CanvasEditOperation.REPLACE)
+                        .documentContent(CanvasDocumentContent.builder().markdown(invalidCanvasContent).build())
+                        .build()))
+        );
+        assertThat(editFailingResponse.isOk(), is(false));
+        assertThat(editFailingResponse.getError(), is("canvas_editing_failed"));
+        assertThat(editFailingResponse.getDetail(), containsString("Unsupported list type"));
+    }
+
+    private static String createChannel(MethodsClient client) throws Exception {
+        ConversationsCreateResponse newChannel = client.conversationsCreate(r -> r.name("test-" + System.currentTimeMillis()));
+        assertThat(newChannel.getError(), is(nullValue()));
+        String channelId = newChannel.getChannel().getId();
+
+        Thread.sleep(500L); // To avoid occasional 500 errors
+        return channelId;
+    }
 }