docs(inbound): keep upstream infrastructure out of the verdicts field doc - #102
Merged
Conversation
The published `InboundMessage.verdicts` JSDoc named the underlying
receiving infrastructure ("SES scanning verdicts"). That detail ships
in the package types and adds nothing for consumers, so describe the
field provider-neutrally ("Scanning verdicts …, as reported") to match
the wording already used on the inbound MCP tool descriptions
("spam/auth verdicts"). Type and runtime shape are unchanged.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NHdu2Fgj7HNau9eLPTrKzy
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
2 participants
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
The published
InboundMessage.verdictsfield carried a JSDoc comment that named the underlying receiving infrastructure. That detail ships inside the package's type declarations but adds nothing for SDK consumers, so this makes the doc provider-neutral — consistent with the wording already used on the inbound MCP tool descriptions ("spam/auth verdicts").Inbound (SDK)
InboundMessage.verdictsdoc reworded to "Scanning verdicts (e.g. spam/virus/SPF/DKIM), as reported." — no provider name.Cross-SDK parity
The PHP and Python SDKs already describe the inbound
verdictsdata without naming any provider, so no changes are needed there — this brings the TypeScript SDK in line with them.Notes
.d.tsoutput.🤖 Generated with Claude Code
Generated by Claude Code