Repository navigation
docs: Stops claiming webhook signature verification that does not exist - #23
Merged
Merged
Conversation
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.
Summary
#22 removed the signature v2 parts from the docs, but a few places still said the webhook is signed and verified,
and the only warning that it is not was gone. A reader who saw "Ingress verifies it" and then opened
TeamtailorWebhookEndpointwould find no verification. This PR makes the docs match the code.webhookinstead ofsigned webhook. Known limitations again says thatIngress does not verify the Teamtailor webhook signature (v2) yet and accepts unsigned webhooks.
docs/architecture.md: key flow step 1 no longer says the webhook is signed and verified. The samelimitation is listed under Known limitations, so the README link points to it.
docs/diagrams.md: the sequence diagram drops(signed)andverifyfrom the Ingress step..claude/rules/teamtailor.md: the Signature v2 section, which holds Teamtailor's format, is marked"Not implemented yet: the next step after the MVP", and "Verification lives in" is now "belongs in".
Docs only, no code change.