SS-331 Webhook Source Versioning Docs + Test#37820
Open
patrickwwbutler wants to merge 2 commits into
Open
Conversation
Add a how-to under ingest-data/webhooks explaining how to use ALTER SCHEMA ... SWAP WITH to change which request headers a webhook source exposes, since the INCLUDE HEADER / INCLUDE HEADERS configuration cannot be altered in place. Demonstrates the cutover with both the INCLUDE HEADER '...' AS ... and INCLUDE HEADERS ( NOT '...' ) forms, and prominently warns that the replacement source starts empty and only receives webhook calls delivered after the swap. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Exercise the blue/green schema-swap technique for a webhook source: create a source that includes a single header, build a replacement with a different header configuration in a separate schema, and swap the schemas so the original name resolves to the new definition. Verifies the swapped column shapes, that the new source serves the pre-swap data staged under it, and that the retired definition keeps its data. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Adds a how-to under
ingest-data/webhooksexplaining how to change which request headers a webhook source exposes.A webhook source fixes its column shape (including its
INCLUDE HEADER/INCLUDE HEADERSconfiguration) at creation and cannot be altered in place. This guide walks through building a replacement source with the new header configuration in a separate schema and swapping it into place withALTER SCHEMA ... SWAP WITH, so the endpoint URL and downstream references stay the same.INCLUDE HEADER 'foo' AS foo(v1) andINCLUDE HEADERS ( NOT 'bar' )(v2).{{< warning >}}admonition) that a webhook source has no upstream to re-read: the replacement starts empty and only contains webhook calls received after the swap; the original source's events are not copied and are lost once it is dropped.Validated with
hugo(builds clean) and the mz-doc-edit editorial pass (guided-tour tip + admonition padding applied).🤖 Generated with Claude Code