Skip to content

feat: add webapi response changes as of 2026-11-20 - #1636

Merged
zimeg merged 273 commits into
mainfrom
api
Nov 20, 2026
Merged

zimeg merged 273 commits into
mainfrom
api

Conversation

@slackapi

@slackapi slackapi Bot commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

This PR updates the web API client and model based on the production E2E test results.

Category

  • slack-api-model (Slack API Data Models)

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you agree to those rules.

@slackapi
slackapi Bot requested a review from a team as a code owner August 22, 2026 00:54
@slackapi slackapi Bot added project:slack-api-model project:slack-api-model semver:patch labels Aug 22, 2026
@codecov

codecov Bot commented Aug 22, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.90%. Comparing base (fa37703) to head (5e606f3).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1636      +/-   ##
============================================
- Coverage     73.91%   73.90%   -0.01%     
+ Complexity     4797     4796       -1     
============================================
  Files           489      489              
  Lines         14959    14959              
  Branches       1562     1562              
============================================
- Hits          11057    11056       -1     
- Misses         2977     2978       +1     
  Partials        925      925              
Flag Coverage Δ
jdk-14 73.90% <ø> (-0.01%) ⬇️

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

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@zimeg

zimeg commented Aug 25, 2026 •

Copy link
Copy Markdown
Member

✅ Update (2026-11-19): reverted, not part of this pull request

The experimental MessageRef change below was reverted in efc98f9 and 5aeb98a, so ListRecord.Field.message on this branch matches main and nothing here blocks the merge. The request and response typing question stays open for a later change.

Original comment (2026-08-25)

⚠️ EXPERIMENTAL — Slack Lists message field re-typed as List<MessageRef> (388afd370)

Pushed an experimental change to how ListRecord.Field.message is modeled. Not final — do not merge as-is. Flagging it here with full context for review.

What changed

ListRecord.Field.message is now List<ListRecord.MessageRef> where MessageRef = { value, channel_id, ts, thread_ts? }. The prior Message-typed modeling (#1590) is replaced; the test-tree GsonListRecordFieldFactory is reduced to a pass-through and its tests rewritten against the new shape.

Why — verified against the live API

The response shape was confirmed empirically on two surfaces, across single/threaded/multi-reference scenarios:

Both return the message field as [{ "value": "<permalink>", "channel_id": "C…", "ts": "…", "thread_ts"?: "…" }] — always an array, with thread_ts present only when the referenced message is a threaded reply. No single-object form was observed on either endpoint. Element is a message reference, not a chat message. Field-type reference: slackLists.items.create#field-types.

This means the earlier Message element type did not match the payload, and the single-object↔array normalization added in #1590 handled a shape the API does not actually return on these endpoints.

Open question (the reason this is experimental)

This fixes the response only. The request side of the field takes an array of permalink URL strings (List<String>) — verified: the API rejects object form with must provide a string [json-pointer:/initial_fields/0/message/0]. A single Field.message type cannot serve both directions. The request/response split still needs a design decision (direction-aware types, or bring Lists types under codegen). This is the same request-vs-response tension previously seen on the Node side.

Related / for later reference

  • #1590 — the earlier Java array-deserialization fix (runtime crash) that this supersedes on the model side.
  • java-slack-sdk ListRecord.Field.message` deserialization fails when Slack returns an array #1587 — the runtime JsonSyntaxException on array-shaped message; fixed (that was a crash; distinct from this typing question).
  • node-slack-sdk #2598 — the analogous Node bug: the generated response type is wrong for this field. This model fix is the upstream half of resolving it (Node response types generate from Java samples).
  • node-slack-sdk #2599 / #2600 — hand-split attempts at #2598 that modeled Message | Message[]; obsolete — they used the wrong element type and an unnecessary union (the field is array-only, and the element is a reference, not a Message).

Verification was done against a test workspace; a few throwaway probe lists (clack probe …) were created there and can be cleaned up.

zimeg added a commit that referenced this pull request Aug 25, 2026
An ad-hoc runner run merged a full rich Message object into the
response_metadata.messages field of every slackLists.* sample (~516 lines
each: attachments, bot_profile, wibblr, nested recursion). That field on a
slackLists response carries warning strings, not a chat message — the content
is bogus and broke PR #1636's diff. Restore all 10 slackLists samples to their
main-branch state (clean, empty response_metadata.messages).

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
zimeg and others added 24 commits August 26, 2026 10:50
…ect)

The live API returns ai_summary as an object when populated but an empty
string when absent, so the earlier String typing failed with
"Expected STRING but was BEGIN_OBJECT at path $.ai_summary". Object
tolerates both shapes.

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Replaces the Object stopgap. Verified against a live files.info call:
ai_summary is a structured object {id, unfurl_enabled, status, content},
or omitted when absent — the live API never returns the empty-string form
(that only appears in generated sample fixtures, which no test parses into
a File), so no custom deserializer is needed: Gson maps omitted -> null and
the object -> AiSummary natively.

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

The audit test getActions_detectingNewOnes checks each live action against
the SDK constants in its matching category class. team_ip_allowlist_range_added
was mistakenly placed in Actions.User (next to team_ip_allowlist_access_denied),
but the raw audit actions fixture categorizes it under workspace_or_org, so the
WorkspaceOrOrg check failed. Moved it there and added the rest of the family the
fixture lists (range_removed, enabled, disabled) to pre-empt the same red on
subsequent runs. team_ip_allowlist_access_denied correctly stays in User (the
fixture lists it under /actions/user).

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Add the pref.alt_text_reminders action constant to Actions.WorkspaceOrOrg
and a typed condition field (AAARuleCondition) to LogsResponse.Details for
the app_allowlist_rule_* actions.

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Add the pref.canvas_printing_enabled action constant to
Actions.WorkspaceOrOrg and a Boolean is_enabled field to
LogsResponse.Details.

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

Add the pref.canvas_restricted_sharing_enabled action constant to
Actions.WorkspaceOrOrg and a String title field to LogsResponse.Details.

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Add the pref.disable_email_ingestion action constant to
Actions.WorkspaceOrOrg and a List<String> changed_fields field to
LogsResponse.Details.

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Add the pref.display_email_addresses action constant to
Actions.WorkspaceOrOrg.

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Add the pref.display_pronouns action constant to Actions.WorkspaceOrOrg.

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
zimeg and others added 3 commits November 18, 2026 10:02
Co-authored-by: Cheng Chen <35309699+cchensh@users.noreply.github.com>

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 details-action to main November 18, 2026 21:57
zimeg and others added 7 commits November 18, 2026 13:58
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…box, search developer samples, slackbot feedback and traces listed actions to Actions

❤️
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
The function_inputs map is keyed by each workflow's input names, so the generator now keeps one string input and one credential input under placeholder keys.

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

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
zimeg and others added 2 commits November 19, 2026 15:28
The Luna test app now has two MCP servers, so the first page at limit 1 always has a next cursor.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg zimeg changed the title feat: add webapi response changes as of 2026-11-17 feat: add webapi response changes as of 2026-11-19 Nov 19, 2026
slackapi Bot and others added 4 commits November 20, 2026 00:33
The generator replaced every files array with the File model, which dropped the search result fields.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…published and deleted actions to Actions

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
The recorder now skips them, as it does for audit logs, so live runs no longer overwrite the generated files.

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

@zimeg zimeg 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.

☕ LGTM! The samples keep every property main has, the live values are masked in the generator so they stay out, and the audit gaps from the latest runs are covered.

@zimeg zimeg changed the title feat: add webapi response changes as of 2026-11-19 feat: add webapi response changes as of 2026-11-20 Nov 20, 2026
@zimeg
zimeg merged commit dfaeca7 into main Nov 20, 2026
7 checks passed
@zimeg
zimeg deleted the api branch November 20, 2026 01:17
@zimeg
zimeg restored the api branch November 20, 2026 01:17
@zimeg
zimeg deleted the api branch November 20, 2026 01:18
@zimeg zimeg added the enhancement M-T: A feature request for new functionality label Nov 20, 2026
@zimeg zimeg mentioned this pull request Nov 20, 2026
9 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement M-T: A feature request for new functionality project:slack-api-client project:slack-api-client project:slack-api-model project:slack-api-model semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant