Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(plugins): say the instance row rule covers the host keys the row leaves unset
Yudhi Armyndharis113ef8bf9461
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex db37d9be0..b4e99a2fa 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -372,7 +372,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0- `GET /api/sessions/{sessionId}/contacts/profile-pictures` leaves out an id it skipped after another lookup timed out, where an id without a picture or with a failed lookup stays `null`; a client that indexes the answer by every requested id must handle a missing key.- A plugin catalog with an entry whose `id`, `name`, `version` or text field is not text is refused with `400`, naming the entry; the default catalog is unaffected, and a private `PLUGIN_CATALOG_URL` catalog must correct the entry.- `POST /api/integration/instances/{pluginId}/{instanceId}/redrive` replays and counts only the dead letters written under the instance's current session binding; rows of an earlier binding stay in the dead-letter table.-- A per-session plugin config or an integration instance that sets a `net.allowConfigHosts` key (for example `baseUrl`) to another origin than the layer beneath no longer inherits that layer's `secret` fields, and a list holding one is not inherited either; put the secret in that config or instance, or the plugin reaches the new host without it. A deployment that shared one token across per-session hosts must copy the token to each. A host key that holds a list, an object or a number counts as another origin, and a write to an override or an instance that moves a host key to another origin no longer gets the stored secret back for `***` or an empty string; send the secret with it. An instance row that names no host key loses its own secrets while a per-session override has moved a host key away from the base config, and a config `PATCH` of an instance whose plugin is not loaded answers `409`.+- A per-session plugin config or an integration instance that sets a `net.allowConfigHosts` key (for example `baseUrl`) to another origin than the layer beneath no longer inherits that layer's `secret` fields, and a list holding one is not inherited either; put the secret in that config or instance, or the plugin reaches the new host without it. A deployment that shared one token across per-session hosts must copy the token to each. A host key that holds a list, an object or a number counts as another origin, and a write to an override or an instance that moves a host key to another origin no longer gets the stored secret back for `***` or an empty string; send the secret with it. An instance row loses its own secrets while a per-session override has moved a host key the row leaves unset away from the base config, and a config `PATCH` of an instance whose plugin is not loaded answers `409`.- A send or message-action body whose `chatId`, `fromChatId` or `toChatId` has no domain (`6281234567890` instead of `[email protected]`), or is a JSON number, answers `400`; it answered `500` before and never sent.### Securitydiff --git a/docs/19-plugin-architecture.md b/docs/19-plugin-architecture.mdindex 986a35066..1b0af330f 100644--- a/docs/19-plugin-architecture.md+++ b/docs/19-plugin-architecture.md@@ -210,8 +210,8 @@ one is dropped whole) and must bring its own. A host key that holds no text (a las another origin. The same rule applies on write: a write to an override or an instance that points a host keyat another origin than the stored layer is bound to (its own host key, or the host of the layer beneath itwhen it names none) gets no stored secret back for the mask or an empty string, so the secret has to be sent-with it. An instance row that names no host key loses its own secrets while a per-session override beneath it-has moved a host key away from the base config.+with it. An instance row loses its own secrets while a per-session override beneath it has moved a host key the+row leaves unset away from the base config.### Plugin Entry Pointdiff --git a/docs/25-integration-fabric.md b/docs/25-integration-fabric.mdindex 583b970bb..a636f13f1 100644--- a/docs/25-integration-fabric.md+++ b/docs/25-integration-fabric.md@@ -133,8 +133,8 @@ Alongside this async pipeline, a route may additionally declare a `response` conthat keeps the same origin, or sets no host key, inherits them. A host key that holds no text counts asanother origin, and a write that moves a host key to another origin than the stored layer is bound to (its ownhost key, or the host of the layer beneath it when it names none) gets no stored secret back for the mask, so- the secret has to be sent with it. An instance row that names no host key loses its own secrets while a- per-session override has moved a host key away from the base config, and a config `PATCH` of an instance+ the secret has to be sent with it. An instance row loses its own secrets while a per-session override+ has moved a host key the row leaves unset away from the base config, and a config `PATCH` of an instancewhose plugin is not loaded answers `409`. A plugin that reaches its destinationthrough a key outside `net.allowConfigHosts` (for example under `net.allow: ['*']`) is not covered, sokeep such a secret on the instance that uses it. Capability calls are not confined to the dispatching instance's