fix/code-monitoring: Document webhook result truncation#1817
Draft
keegancsmith wants to merge 1 commit into
Draft
fix/code-monitoring: Document webhook result truncation#1817keegancsmith wants to merge 1 commit into
keegancsmith wants to merge 1 commit into
Conversation
Large code monitor notifications can retain only a bounded prefix of result details. Document the exact count and truncation fields so webhook consumers can distinguish a complete result list from a retained prefix.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Large code monitor webhook payloads can now contain an ordered prefix rather than every result detail, so integrations need a documented way to detect that condition.
This documents the additive
resultCountandresultsTruncatedfields introduced by sourcegraph/sourcegraph#14113, clarifies that one result entry can represent multiple matches, and updates the example payload.Related: CPL-287