Skip to content

fix(swml): remove unsupported result input from join_conference - #866

Closed
Manny-r31 wants to merge 2 commits into
mainfrom
fix/swml-join-conference-result-input
Closed

Manny-r31 wants to merge 2 commits into
mainfrom
fix/swml-join-conference-result-input

Conversation

@Manny-r31

Copy link
Copy Markdown
Collaborator

Summary

  • Remove the result input from the SWML join_conference reference and the TypeSpec model.
  • Regenerate the SWML calling schema, which now rejects join_conference.result as an unknown property.
  • Keep the join_conference_result output variable documented. It is a separate part of the method.

Closes #821

Notes for reviewers

  • The platform rejects result as an unknown join_conference parameter, so this removes it outright rather than marking it as having no effect.
  • Both Server SDKs still accept a result argument on FunctionResult.join_conference (Python and TypeScript reference pages). This PR leaves those pages unchanged because they describe the current SDK API. If the SDKs pass that argument through into the SWML, the platform will reject it. That needs an SDK fix first, then a docs update.
  • The openapi.yaml diff comes from the REST tree importing the SWML models. It only touches join_conference.result.

Verification

  • yarn build:specs succeeds.
  • yarn fern-md-check passes.
  • Checked that JoinConferenceObject in the generated schema no longer lists result and still disallows unevaluated properties.
  • No other page links to the removed parameter.

Preview

  • /docs/swml/reference/calling/join-conference

🤖 Generated with Claude Code

join_conference rejects result as an unknown parameter, yet the
reference and generated schema advertised it as a switch/cond action.
Drop it from the page and the TypeSpec model so the schema rejects it
too. The join_conference_result output variable is unchanged.

Closes #821

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

@Devon-White

Copy link
Copy Markdown
Collaborator

@Manny-r31 closing this as already covered by #852, the SWML reference alignment PR. Its commit bc00401 removes the join_conference.result input from join_conference/main.tsp and the reference page, so the regenerated schema no longer accepts it. The join_conference_result output variable stays documented, limited to joined and failed. I've added Closes #821 to #852 so the issue closes when it merges.

Your note about FunctionResult.join_conference still taking a result argument in both Server SDKs isn't addressed in #852 and still needs an SDK-side fix. Thanks for catching this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SWML join_conference: remove unsupported result input from reference and schema

2 participants