Skip to content

conversations.canvases.create not compliant with API Reference #2258

@viniagostini

Description

@viniagostini

The method conversations.canvases.create is missing the property title from the API Reference.

Packages:

Select all that apply:

  • @slack/web-api
  • @slack/rtm-api
  • @slack/webhooks
  • @slack/oauth
  • @slack/socket-mode
  • @slack/types
  • I don't know

Reproducible in:

The Slack SDK version

"@slack/web-api": "^7.9.2",

Node.js runtime version

# node -v
v20.3.0

OS info

ProductName:		macOS
ProductVersion:		15.2
BuildVersion:		24C101
Darwin Kernel Version 24.2.0: Fri Dec  6 18:56:34 PST 2024; root:xnu-11215.61.5~2/RELEASE_ARM64_T6020

Steps to reproduce:

  1. Try to create a channel canvas using client.conversations.canvases.create with a title
const canvasResponse = await slackClient.conversations.canvases.create({
      channel_id: channelId,
      title: 'My canvas title',
      document_content: {
        type: 'markdown',
        markdown: canvasMd,
      }
    });
  1. Get a type error
Object literal may only specify known properties, and 'title' does not exist in type 'ConversationsCanvasesCreateArguments'.ts(2353)

Expected result:

Title should be an accepted param according to the API Reference

Actual result:

type error

Object literal may only specify known properties, and 'title' does not exist in type 'ConversationsCanvasesCreateArguments'.ts(2353)

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:typescriptissues that specifically impact using the package from typescript projectsbugM-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documentedpkg:web-apiapplies to `@slack/web-api`

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions