STC-994: Document the Fastly Connect-API backend in the README - #62
Merged
Merged
Conversation
The README never named stc-backend at all, and its Fastly examples passed event.request where the handler takes the event — copying them gives a broken integration.
filias
marked this pull request as ready for review
September 21, 2026 12:10
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
1 participant
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.
The README never mentioned
stc-backendanywhere, so the one setup step most likely to break a Fastly integration was undocumented in the SDK's own docs. It now describes both backends where a reader first meets the handler, and documentsconnectBackend(added in #61) in the API reference.While in that section, two things were stale and one of them is a real trap: the Fastly examples passed
event.requestwhere the handler takes the wholeevent. Anyone copying them gets a broken integration — the SDK readsevent.clientfor viewer IP/geo/JA3 andevent.waitUntilto keep post-response analytics alive, and neither exists on a bareRequest. The demo atdemos/fastly/src/index.jshas always passedevent; only the README was wrong. The signature line in the API reference saidrequesttoo.No behaviour change — documentation only.
Part of STC-793, after #60 and #61. The same option still needs documenting in connect-public-docs and in the dashboard instruction templates; those are separate repos and separate PRs.