Skip to content

feat(methods): add canvases.create and canvases.getContent examples - #336

Merged
zimeg merged 4 commits into
mainfrom
clack/canvases-method-examples
Nov 2, 2026
Merged

zimeg merged 4 commits into
mainfrom
clack/canvases-method-examples

Conversation

@zimeg

@zimeg zimeg commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Summary

This pull request adds a canvases family of Web API method examples under methods/src/canvases/.

  • canvases.create creates a canvas with a title and document_content.
  • canvases.getContent reads a canvas as markdown.
  • The manifest requests only the canvases:read and canvases:write bot scopes.
  • The methods README lists the new family.

Arguments and values follow the canvases.create and canvases.getContent reference pages.

Dependency

The canvases_getContent method shipped in slack_sdk 3.46.0 (slackapi/python-slack-sdk#1999). main pins that release (#346), and this branch merges it in.

Testing

  1. cd methods/src/canvases and run slack install --environment local.
  2. Export a bot token as SLACK_TOKEN.
  3. Run slack run canvases_create.py and confirm the response is ok with a canvas_id.
  4. Replace F1234ABCD in canvases_get_content.py with the returned canvas_id, run slack run canvases_get_content.py, and confirm the content is the canvas markdown.

🤖 Generated with Claude Code

@zimeg zimeg added the enhancement New feature or request label Oct 28, 2026
@zimeg zimeg self-assigned this Oct 28, 2026
zimeg and others added 3 commits October 28, 2026 09:47
Brings in the slack_sdk 3.46.0 bump from main (#346), which adds
canvases_getContent to the client, so the methods typecheck passes.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg marked this pull request as ready for review November 2, 2026 19:39
@zimeg
zimeg requested a review from a team as a code owner November 2, 2026 19:39
@zimeg
zimeg merged commit b6e6406 into main Nov 2, 2026
16 checks passed
@zimeg
zimeg deleted the clack/canvases-method-examples branch November 2, 2026 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant