Skip to content

feat(web-api): add webapi response changes as of 2026-11-20 - #2878

Merged
zimeg merged 10 commits into
mainfrom
zimeg-feat-web-api-response-types
Nov 20, 2026
Merged

zimeg merged 10 commits into
mainfrom
zimeg-feat-web-api-response-types

Conversation

@zimeg

@zimeg zimeg commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Summary

This pull request regenerates the @slack/web-api response types with scripts/generate-web-api-types.sh from the latest json-logs samples on main of slackapi/java-slack-sdk, which includes slackapi/java-slack-sdk#1636 ("add webapi response changes as of 2026-11-20") and slackapi/java-slack-sdk#1718. It stacks on #2879, which keeps the sample placeholders from narrowing the generated types. The response index is unchanged, so every method keeps its export, and the hand-added admin.apps.mcp.servers.permissions.*, apps.managed.permissions.set and assistant.search.* types come out the same.

  1. fix(web-api): blank sample placeholders before generating response types #2879 generator placeholders
  2. feat(web-api): add webapi response changes as of 2026-11-20 #2878 response types from the latest java samples 👈 this pull request

Changes by method family:

  • chat (postMessage, scheduleMessage, stopStream, update), conversations (history, replies, open), files (info, list, remote.*), pins.list, reactions (get, list) and search.messages: file objects gain the ai_skill_*, ai_summary, is_skill, skill_description, canvas_agent_creator_id and canvas_default_agent_id fields, block accessories gain agent_prompt, agent_prompt_display and visible_to_user_ids, and attachment metadata gains the larger thumb_* sizes. pins.list messages also gain agent_session and language.
  • conversations: list channels gain latest (with agent_session and language), channel_email_addresses, connected_team_ids, is_open, unread_count and related fields. create, invite, rename, setPurpose and setTopic gain properties, and info gains is_file.
  • views (open, publish, push, update): block accessories gain agent_prompt, agent_prompt_display and visible_to_user_ids.
  • search (all, files): file matches gain canvas_creator_id, canvas_readtime, is_ai_suggested, show_badge and private shares.
  • admin.apps.activities.list: trigger configs gain function_inputs as { [key: string]: FunctionInput }, plus trigger_type_app_id and trigger_type_id.
  • agents.conversations.listViews: adds session_views.
  • apps: manifest.export gains user_connections, auth_hosts and app_level_token_rotation_enabled, and icon.set gains response_metadata.
  • canvases.getContent gains response_metadata, and users.list gains is_seamless_enabled_app_bot.

No property is removed or narrowed. With #2879, the search.all and search.files ID fields stay string, and function_inputs is a map instead of having the literal keys '0000000000' and '0000000000_'.

Some new fields are typed as empty objects, because their samples hold {}. These are properties on conversations.create, invite, rename, setPurpose and setTopic, response_metadata on canvases.getContent, and knocks on conversations.list. conversations.info already has the full properties shape, and a follow-up can fill these in.

Testing

  • npm run build, npm test (157 tests, the same as main) and npm run lint pass for packages/web-api.
  • A tsc --strict check assigns each of the 39 changed response types from main to its regenerated type and back. Only the search.all and rtm.start enum widenings from fix(web-api): blank sample placeholders before generating response types #2879 fail.
  • npx tsd reports the same 6 errors here as on main, all for the removed files.upload and rtm.start methods.

Requirements

🤖 Generated with Claude Code

zimeg and others added 2 commits November 19, 2026 17:46
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg requested a review from a team as a code owner November 20, 2026 01:47
@zimeg zimeg added this to the web-api@next milestone Nov 20, 2026
@zimeg zimeg added semver:minor enhancement M-T: A feature request for new functionality area:typescript issues that specifically impact using the package from typescript projects pkg:web-api applies to `@slack/web-api` labels Nov 20, 2026
@zimeg zimeg self-assigned this Nov 20, 2026
@changeset-bot

changeset-bot Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 86e0da2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@slack/web-api Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov

codecov Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.52%. Comparing base (7946a88) to head (86e0da2).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2878      +/-   ##
==========================================
+ Coverage   94.34%   94.52%   +0.18%     
==========================================
  Files          68       68              
  Lines       10942    10942              
  Branches      697      697              
==========================================
+ Hits        10323    10343      +20     
+ Misses        588      572      -16     
+ Partials       31       27       -4     
Flag Coverage Δ
cli-hooks 94.40% <ø> (+0.08%) ⬆️
cli-test 94.40% <ø> (+0.08%) ⬆️
logger 94.40% <ø> (+0.08%) ⬆️
oauth 94.40% <ø> (+0.08%) ⬆️
socket-mode 94.40% <ø> (+0.08%) ⬆️
web-api 94.40% <ø> (+0.08%) ⬆️
webhook 94.40% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mwbrooks mwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The placeholder enums in search.all and search.files narrow fields that were string on main, so I'd like those fixed before this lands. The rest of the regeneration looks great!

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg requested a review from mwbrooks November 20, 2026 03:28
@zimeg
zimeg marked this pull request as draft November 20, 2026 03:32

@mwbrooks mwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Thanks @zimeg! Going back to empty strings in the samples keeps the search IDs as plain strings, and checking every type against main makes this an easy one to trust.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

@mwbrooks mwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Looked deeper and it holds up @zimeg! Rerunning the generator against java main reproduces these types exactly, and every change in the new commit widens a type.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…egen

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg changed the base branch from main to zimeg-fix-web-api-generator-placeholders November 20, 2026 04:04
@zimeg zimeg changed the title feat(web-api): update web api response types from java samples feat(web-api): add webapi response changes as of 2026-11-20 Nov 20, 2026
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg marked this pull request as ready for review November 20, 2026 04:06
zimeg and others added 2 commits November 19, 2026 20:07
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg changed the base branch from zimeg-fix-web-api-generator-placeholders to main November 20, 2026 04:22
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg

zimeg commented Nov 20, 2026

Copy link
Copy Markdown
Member Author

🌟 Thanks for the kind review @mwbrooks!

@zimeg
zimeg merged commit 6330ef4 into main Nov 20, 2026
22 checks passed
@zimeg
zimeg deleted the zimeg-feat-web-api-response-types branch November 20, 2026 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:typescript issues that specifically impact using the package from typescript projects enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` semver:minor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants