From dc17aaf5f6964fdf833baa4ca8ccebd5c5ca538c Mon Sep 17 00:00:00 2001 From: August L-R Date: Wed, 19 Aug 2026 17:17:58 +0000 Subject: [PATCH 1/2] docs(swml): standardize SWAIG webhook auth on web_hook_auth_password --- fern/apis/signalwire-rest/openapi.yaml | 117 +++++++++++++-- fern/docs.yml | 6 + .../calling/ai/ai_swaig/functions/index.mdx | 27 +++- .../methods/calling/ai/ai_swaig/index.mdx | 10 ++ .../ai-agent/models/ai/swaig/defaults.tsp | 10 +- .../models/ai/swaig/functions/main.tsp | 10 +- .../ai-agent/models/ai/swaig/includes.tsp | 10 +- .../calling/Methods/ai/swaig/defaults.tsp | 10 +- .../Methods/ai/swaig/functions/main.tsp | 17 ++- .../calling/Methods/ai/swaig/includes.tsp | 10 +- .../Methods/amazon_bedrock/swaig/main.tsp | 17 ++- .../@typespec/json-schema/SWMLObject.json | 142 ++++++++++++++++-- 12 files changed, 348 insertions(+), 38 deletions(-) diff --git a/fern/apis/signalwire-rest/openapi.yaml b/fern/apis/signalwire-rest/openapi.yaml index 68fc630f8e..8a97888a74 100644 --- a/fern/apis/signalwire-rest/openapi.yaml +++ b/fern/apis/signalwire-rest/openapi.yaml @@ -33850,10 +33850,21 @@ components: The fields of this object are the six following. defaults: allOf: - - $ref: '#/components/schemas/SWML.Calling.SWAIGDefaults' + - $ref: '#/components/schemas/SWML.Calling.BedrockSWAIGDefaults' description: Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set. unevaluatedProperties: not: {} + SWML.Calling.BedrockSWAIGDefaults: + type: object + properties: + web_hook_url: + type: string + description: Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.` + examples: + - https://username:password@example.com + unevaluatedProperties: + not: {} + title: defaults SWML.Calling.BedrockSWAIGFunction: anyOf: - type: object @@ -33893,7 +33904,7 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com function: type: string description: A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. @@ -33943,7 +33954,7 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com function: type: string enum: @@ -33993,7 +34004,7 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com function: type: string enum: @@ -34043,7 +34054,7 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com function: type: string enum: @@ -37551,7 +37562,23 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com + web_hook_auth_user: + type: string + description: Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`. + examples: + - username + web_hook_auth_password: + type: string + description: Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`. + examples: + - password + web_hook_auth_pass: + type: string + description: |- + Deprecated. Use `web_hook_auth_password` instead. + This alias is accepted on individual functions only, not in `defaults`. + deprecated: true wait_file: type: string format: uri @@ -39714,7 +39741,17 @@ components: type: string description: Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password@https://example.com + - https://username:password@example.com + web_hook_auth_user: + type: string + description: Default username for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_user`. + examples: + - username + web_hook_auth_password: + type: string + description: Default password for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_password`. + examples: + - password unevaluatedProperties: not: {} title: defaults @@ -39742,7 +39779,17 @@ components: type: string description: URL to fetch remote functions and include in your AI application. Authentication can also be set in the url in the format of `username:password@url`. examples: - - username:password@https://example.com + - https://username:password@example.com + auth_user: + type: string + description: Username for basic auth on the signature request to `url`. + examples: + - username + auth_password: + type: string + description: Password for basic auth on the signature request to `url`. + examples: + - password meta_data: type: object unevaluatedProperties: {} @@ -40350,7 +40397,23 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com + web_hook_auth_user: + type: string + description: Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`. + examples: + - username + web_hook_auth_password: + type: string + description: Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`. + examples: + - password + web_hook_auth_pass: + type: string + description: |- + Deprecated. Use `web_hook_auth_password` instead. + This alias is accepted on individual functions only, not in `defaults`. + deprecated: true wait_file: type: string format: uri @@ -40744,7 +40807,23 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com + web_hook_auth_user: + type: string + description: Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`. + examples: + - username + web_hook_auth_password: + type: string + description: Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`. + examples: + - password + web_hook_auth_pass: + type: string + description: |- + Deprecated. Use `web_hook_auth_password` instead. + This alias is accepted on individual functions only, not in `defaults`. + deprecated: true wait_file: type: string format: uri @@ -41368,7 +41447,23 @@ components: type: string description: Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` examples: - - username:password:https://statuscallback.com + - https://username:password@example.com + web_hook_auth_user: + type: string + description: Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`. + examples: + - username + web_hook_auth_password: + type: string + description: Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`. + examples: + - password + web_hook_auth_pass: + type: string + description: |- + Deprecated. Use `web_hook_auth_password` instead. + This alias is accepted on individual functions only, not in `defaults`. + deprecated: true wait_file: type: string format: uri diff --git a/fern/docs.yml b/fern/docs.yml index e0dceab668..16c7caccc3 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -240,6 +240,12 @@ redirects: - source: /docs/swml/reference/calling/amazon-bedrock/swaig/includes destination: /docs/swml/reference/calling/amazon-bedrock/swaig + # The ai SWAIG defaults object has never had its own page on this site, but the + # legacy site had one and the sibling functions/includes subpages invite guessed + # URLs. The defaults properties live inline on the SWAIG page. + - source: /docs/swml/reference/calling/ai/swaig/defaults + destination: /docs/swml/reference/calling/ai/swaig + # Top-level calling method slugs (one redirect per method — a blanket # /docs/swml/reference/:slug wildcard would incorrectly catch /messaging/* too). - source: /docs/swml/reference/answer diff --git a/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/functions/index.mdx b/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/functions/index.mdx index 6cab483165..9efa1b7273 100644 --- a/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/functions/index.mdx +++ b/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/functions/index.mdx @@ -89,6 +89,16 @@ An array of JSON objects to define functions that can be executed during the int + + Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`. + + + + + Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`. + + + Deprecated. Use `description` instead. @@ -99,6 +109,11 @@ An array of JSON objects to define functions that can be executed during the int + + Deprecated. Use `web_hook_auth_password` instead. This alias is accepted on individual functions only, not in `defaults`. + + + ## Tool webhook @@ -261,12 +276,12 @@ sections: - get_phone_number - get_address url: https://example.com/functions - user: me - pass: secret + auth_user: me + auth_password: secret defaults: web_hook_url: https://example.com/my-webhook web_hook_auth_user: me - web_hook_auth_pass: secret + web_hook_auth_password: secret functions: - function: get_weather description: To determine what the current weather is in a provided location. @@ -309,14 +324,14 @@ sections: "get_address" ], "url": "https://example.com/functions", - "user": "me", - "pass": "secret" + "auth_user": "me", + "auth_password": "secret" } ], "defaults": { "web_hook_url": "https://example.com/my-webhook", "web_hook_auth_user": "me", - "web_hook_auth_pass": "secret" + "web_hook_auth_password": "secret" }, "functions": [ { diff --git a/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/index.mdx b/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/index.mdx index 2cc22122af..acc5d10b3b 100644 --- a/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/index.mdx +++ b/fern/products/swml/pages/reference/methods/calling/ai/ai_swaig/index.mdx @@ -29,6 +29,16 @@ The SignalWire AI Gateway Interface. Allows you to create user-defined functions [tool webhook](/docs/swml/reference/calling/ai/swaig/functions#tool-webhook). + + + The default username for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_user`. + + + + + The default password for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_password`. + + diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/defaults.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/defaults.tsp index 903caa2daf..46e6ed31e1 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/defaults.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/defaults.tsp @@ -1,6 +1,14 @@ @summary("defaults") model SWAIGDefaults { @doc("Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.`") - @example("username:password@https://example.com") + @example("https://username:password@example.com") web_hook_url?: string; + + @doc("Default username for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_user`.") + @example("username") + web_hook_auth_user?: string; + + @doc("Default password for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_password`.") + @example("password") + web_hook_auth_password?: string; } diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp index fedb5ed678..ac7fb0c377 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp @@ -38,9 +38,17 @@ model SWAIGFunction { data_map?: DataMap; @doc("Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`") - @example("username:password:https://statuscallback.com") + @example("https://username:password@example.com") web_hook_url?: string; + @doc("Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`.") + @example("username") + web_hook_auth_user?: string; + + @doc("Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`.") + @example("password") + web_hook_auth_password?: string; + @doc("A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continuously play. Default is not set.") @example("https://cdn.signalwire.com/default-music/welcome.mp3") wait_file?: url; diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/includes.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/includes.tsp index 3fbd317c59..d7da5d3cb7 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/includes.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/includes.tsp @@ -5,9 +5,17 @@ model SWAIGIncludes { functions: string[]; @doc("URL to fetch remote functions and include in your AI application. Authentication can also be set in the url in the format of `username:password@url`.") - @example("username:password@https://example.com") + @example("https://username:password@example.com") url: string; + @doc("Username for basic auth on the signature request to `url`.") + @example("username") + auth_user?: string; + + @doc("Password for basic auth on the signature request to `url`.") + @example("password") + auth_password?: string; + @doc("") meta_data?: { ...TypeSpec.Record; diff --git a/specs/swml/calling/Methods/ai/swaig/defaults.tsp b/specs/swml/calling/Methods/ai/swaig/defaults.tsp index 5c5ac28908..276f0ace6f 100644 --- a/specs/swml/calling/Methods/ai/swaig/defaults.tsp +++ b/specs/swml/calling/Methods/ai/swaig/defaults.tsp @@ -7,6 +7,14 @@ namespace SWML.Calling; @summary("defaults") model SWAIGDefaults { @doc("Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.`") - @example("username:password@https://example.com") + @example("https://username:password@example.com") web_hook_url?: string; + + @doc("Default username for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_user`.") + @example("username") + web_hook_auth_user?: string; + + @doc("Default password for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_password`.") + @example("password") + web_hook_auth_password?: string; } diff --git a/specs/swml/calling/Methods/ai/swaig/functions/main.tsp b/specs/swml/calling/Methods/ai/swaig/functions/main.tsp index 09cb08a1fe..bb6429f217 100644 --- a/specs/swml/calling/Methods/ai/swaig/functions/main.tsp +++ b/specs/swml/calling/Methods/ai/swaig/functions/main.tsp @@ -80,9 +80,24 @@ model SWAIGFunctionBase { skip_fillers?: boolean | SWMLVar = false; @doc("Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`") - @example("username:password:https://statuscallback.com") + @example("https://username:password@example.com") web_hook_url?: string; + @doc("Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`.") + @example("username") + web_hook_auth_user?: string; + + @doc("Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`.") + @example("password") + web_hook_auth_password?: string; + + #deprecated "Use `web_hook_auth_password` instead." + @doc(""" + Deprecated. Use `web_hook_auth_password` instead. + This alias is accepted on individual functions only, not in `defaults`. + """) + web_hook_auth_pass?: string; + @doc("A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continously play. Default is not set.") @example("https://cdn.signalwire.com/default-music/welcome.mp3") wait_file?: url; diff --git a/specs/swml/calling/Methods/ai/swaig/includes.tsp b/specs/swml/calling/Methods/ai/swaig/includes.tsp index b657708efe..1df6651609 100644 --- a/specs/swml/calling/Methods/ai/swaig/includes.tsp +++ b/specs/swml/calling/Methods/ai/swaig/includes.tsp @@ -11,9 +11,17 @@ model SWAIGIncludes { functions: string[]; @doc("URL to fetch remote functions and include in your AI application. Authentication can also be set in the url in the format of `username:password@url`.") - @example("username:password@https://example.com") + @example("https://username:password@example.com") url: string; + @doc("Username for basic auth on the signature request to `url`.") + @example("username") + auth_user?: string; + + @doc("Password for basic auth on the signature request to `url`.") + @example("password") + auth_password?: string; + @doc("User-defined metadata to pass with the remote function request.") @example(#{ customer_id: "cust_123", session_type: "support" }) meta_data?: { diff --git a/specs/swml/calling/Methods/amazon_bedrock/swaig/main.tsp b/specs/swml/calling/Methods/amazon_bedrock/swaig/main.tsp index 66d493f7d6..13d27d1ae7 100644 --- a/specs/swml/calling/Methods/amazon_bedrock/swaig/main.tsp +++ b/specs/swml/calling/Methods/amazon_bedrock/swaig/main.tsp @@ -6,9 +6,17 @@ namespace SWML.Calling; // Bedrock has its own SWAIG parser rather than sharing the `ai` verb's, and reads // only `functions` and `defaults.web_hook_url`. `native_functions`, `includes`, // `internal_fillers`, and `mcp_servers` are parsed on the `ai` path only, so they -// must not be picked in here — bedrock ignores them without raising an error. -union PickedBedrockSWAIG { - "defaults", +// must not be picked in here — bedrock ignores them without raising an error. The +// same goes for the `ai` defaults' `web_hook_auth_user`/`web_hook_auth_password`: +// bedrock reads no auth keys from `defaults`, so it picks `web_hook_url` alone. +// Credentials go in the URL itself (`username:password@url`). +union PickedBedrockSWAIGDefaults { + "web_hook_url", +} + +@summary("defaults") +model BedrockSWAIGDefaults { + ...PickProperties; } model BedrockSWAIG { @@ -18,5 +26,6 @@ model BedrockSWAIG { """) functions?: BedrockSWAIGFunction[]; - ...PickProperties; + @doc("Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set.") + defaults?: BedrockSWAIGDefaults; } diff --git a/specs/swml/calling/tsp-output/@typespec/json-schema/SWMLObject.json b/specs/swml/calling/tsp-output/@typespec/json-schema/SWMLObject.json index 4dd587e5bf..c929dea44a 100644 --- a/specs/swml/calling/tsp-output/@typespec/json-schema/SWMLObject.json +++ b/specs/swml/calling/tsp-output/@typespec/json-schema/SWMLObject.json @@ -6955,7 +6955,7 @@ "description": "An array of JSON objects to define functions that can be executed during the interaction with the Bedrock AI. Default is not set.\nThe fields of this object are the six following." }, "defaults": { - "$ref": "#/$defs/SWAIGDefaults", + "$ref": "#/$defs/BedrockSWAIGDefaults", "description": "Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set." } }, @@ -8575,9 +8575,23 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password@https://example.com" + "https://username:password@example.com" ], "description": "Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.`" + }, + "web_hook_auth_user": { + "type": "string", + "examples": [ + "username" + ], + "description": "Default username for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_user`." + }, + "web_hook_auth_password": { + "type": "string", + "examples": [ + "password" + ], + "description": "Default password for basic auth on the function webhook, for functions that don't set their own `web_hook_auth_password`." } }, "unevaluatedProperties": { @@ -8674,10 +8688,24 @@ "url": { "type": "string", "examples": [ - "username:password@https://example.com" + "https://username:password@example.com" ], "description": "URL to fetch remote functions and include in your AI application. Authentication can also be set in the url in the format of `username:password@url`." }, + "auth_user": { + "type": "string", + "examples": [ + "username" + ], + "description": "Username for basic auth on the signature request to `url`." + }, + "auth_password": { + "type": "string", + "examples": [ + "password" + ], + "description": "Password for basic auth on the signature request to `url`." + }, "meta_data": { "type": "object", "properties": {}, @@ -9481,7 +9509,7 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, @@ -9555,7 +9583,7 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, @@ -9627,7 +9655,7 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, @@ -9699,7 +9727,7 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, @@ -9722,6 +9750,22 @@ } ] }, + "BedrockSWAIGDefaults": { + "type": "object", + "properties": { + "web_hook_url": { + "type": "string", + "examples": [ + "https://username:password@example.com" + ], + "description": "Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.`" + } + }, + "unevaluatedProperties": { + "not": {} + }, + "title": "defaults" + }, "TranscribeSummarizeAction": { "type": "object", "properties": { @@ -10137,10 +10181,29 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, + "web_hook_auth_user": { + "type": "string", + "examples": [ + "username" + ], + "description": "Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`." + }, + "web_hook_auth_password": { + "type": "string", + "examples": [ + "password" + ], + "description": "Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`." + }, + "web_hook_auth_pass": { + "type": "string", + "description": "Deprecated. Use `web_hook_auth_password` instead.\nThis alias is accepted on individual functions only, not in `defaults`.", + "deprecated": true + }, "wait_file": { "type": "string", "format": "uri", @@ -10283,10 +10346,29 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, + "web_hook_auth_user": { + "type": "string", + "examples": [ + "username" + ], + "description": "Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`." + }, + "web_hook_auth_password": { + "type": "string", + "examples": [ + "password" + ], + "description": "Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`." + }, + "web_hook_auth_pass": { + "type": "string", + "description": "Deprecated. Use `web_hook_auth_password` instead.\nThis alias is accepted on individual functions only, not in `defaults`.", + "deprecated": true + }, "wait_file": { "type": "string", "format": "uri", @@ -10427,10 +10509,29 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, + "web_hook_auth_user": { + "type": "string", + "examples": [ + "username" + ], + "description": "Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`." + }, + "web_hook_auth_password": { + "type": "string", + "examples": [ + "password" + ], + "description": "Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`." + }, + "web_hook_auth_pass": { + "type": "string", + "description": "Deprecated. Use `web_hook_auth_password` instead.\nThis alias is accepted on individual functions only, not in `defaults`.", + "deprecated": true + }, "wait_file": { "type": "string", "format": "uri", @@ -10571,10 +10672,29 @@ "web_hook_url": { "type": "string", "examples": [ - "username:password:https://statuscallback.com" + "https://username:password@example.com" ], "description": "Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`" }, + "web_hook_auth_user": { + "type": "string", + "examples": [ + "username" + ], + "description": "Username for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_user`." + }, + "web_hook_auth_password": { + "type": "string", + "examples": [ + "password" + ], + "description": "Password for basic auth on this function's webhook. Falls back to `defaults.web_hook_auth_password`." + }, + "web_hook_auth_pass": { + "type": "string", + "description": "Deprecated. Use `web_hook_auth_password` instead.\nThis alias is accepted on individual functions only, not in `defaults`.", + "deprecated": true + }, "wait_file": { "type": "string", "format": "uri", From 25f29f9f1b6909e72a678be8edb5759cec734940 Mon Sep 17 00:00:00 2001 From: August L-R Date: Wed, 19 Aug 2026 17:32:12 +0000 Subject: [PATCH 2/2] docs: remove redirect claude made up for guessed URL --- fern/docs.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/fern/docs.yml b/fern/docs.yml index 16c7caccc3..e0dceab668 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -240,12 +240,6 @@ redirects: - source: /docs/swml/reference/calling/amazon-bedrock/swaig/includes destination: /docs/swml/reference/calling/amazon-bedrock/swaig - # The ai SWAIG defaults object has never had its own page on this site, but the - # legacy site had one and the sibling functions/includes subpages invite guessed - # URLs. The defaults properties live inline on the SWAIG page. - - source: /docs/swml/reference/calling/ai/swaig/defaults - destination: /docs/swml/reference/calling/ai/swaig - # Top-level calling method slugs (one redirect per method — a blanket # /docs/swml/reference/:slug wildcard would incorrectly catch /messaging/* too). - source: /docs/swml/reference/answer