Skip to content

Standardize SWAIG webhook auth: use canonical web_hook_auth_password param - #615

Open
hey-august wants to merge 4 commits into
mainfrom
august-20260819-standardize-web_hook_auth_password
Open

Standardize SWAIG webhook auth: use canonical web_hook_auth_password param#615
hey-august wants to merge 4 commits into
mainfrom
august-20260819-standardize-web_hook_auth_password

Conversation

@hey-august

Copy link
Copy Markdown
Collaborator

Description

Problem

Previously, the SWAIG reference pages disagreed on the webhook basic-auth password key. Examples used web_hook_auth_pass while the sidecar and includes pages used web_hook_auth_password, and neither was formally documented on the ai verb.

Solution

Looking at the parser in source code revealed that web_hook_auth_password is the canonical parameter, and web_hook_auth_pass is a back-compatibility alias that's currently broken. (issue filed)

This PR does 3 things:

  1. Document web_hook_auth_user/web_hook_auth_password with proper ParamFields at both defaults and function level on the ai SWAIG pages
  2. Mark web_hook_auth_pass as a deprecated function-level-only alias
  3. Fix the examples (including the includes block, which used incorrect user/pass keys instead of auth_user/auth_password)
  4. Update the ai SWAIG models and the fabric AI Agent REST models in TypeSpec so the published schema stops rejecting the canonical names
    • Bedrock is deliberately excluded. Its parser reads no auth keys, so BedrockSWAIG now gets its own defaults model instead of inheriting the ai one.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Code cleanup / refactor

Related Issues

#521
signalwire/cloud-product#20511

Testing

Verified with yarn build:specs, yarn fern-check, and yarn fern-md-check.

  • Added/updated unit tests
  • Tested manually
  • Tested with live SignalWire credentials (if applicable)

Checklist

  • I have read the CONTRIBUTING guidelines
  • My code follows the project's style guidelines
  • I have added tests for my changes (if applicable)
  • I have updated documentation (if applicable)
  • All existing tests pass

@github-actions

github-actions Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

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.

1 participant