Mark required method keys on four SWML reference pages - #593
Merged
Conversation
Contributor
Devon-White
approved these changes
Aug 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This was a fix that came up during my review of #361, but didn't make it in before we merged that PR.
The SWML schema declares every method key as required.
SWMLObject.jsonlistsrequired: ["answer"],["stop_stream"],["transcribe"], and["transcribe_stop"], matching the?-free declarations in the TypeSpecsources under
specs/swml/calling/Methods/.These four reference pages rendered the top-level
ParamFieldwithoutrequired={true}, so the method key incorrectly appeared to be optional.A sweep of all 113 schema-required top-level keys against the SWML reference found these four pages and no others. One line changes on each;
yarn fern-md-checkpasses.Type of Change
Related Issues
Testing
Checklist