Standardize SWAIG webhook auth: use canonical web_hook_auth_password param - #615
Open
hey-august wants to merge 4 commits into
Open
Standardize SWAIG webhook auth: use canonical web_hook_auth_password param#615hey-august wants to merge 4 commits into
web_hook_auth_password param#615hey-august wants to merge 4 commits into
Conversation
Contributor
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
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
Problem
Previously, the SWAIG reference pages disagreed on the webhook basic-auth password key. Examples used
web_hook_auth_passwhile the sidecar and includes pages usedweb_hook_auth_password, and neither was formally documented on theaiverb.Solution
Looking at the parser in source code revealed that
web_hook_auth_passwordis the canonical parameter, andweb_hook_auth_passis a back-compatibility alias that's currently broken. (issue filed)This PR does 3 things:
web_hook_auth_user/web_hook_auth_passwordwith proper ParamFields at bothdefaultsand function level on the ai SWAIG pagesweb_hook_auth_passas a deprecated function-level-only aliasuser/passkeys instead ofauth_user/auth_password)aiSWAIG models and the fabric AI Agent REST models in TypeSpec so the published schema stops rejecting the canonical namesBedrockSWAIGnow gets its own defaults model instead of inheriting theaione.Type of Change
Related Issues
#521
signalwire/cloud-product#20511
Testing
Verified with
yarn build:specs,yarn fern-check, andyarn fern-md-check.Checklist