Skip to content

fix/code-monitoring: Document webhook result truncation #1817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
keegancsmith wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −1
Draft

fix/code-monitoring: Document webhook result truncation #1817

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/code-monitoring/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,9 @@ The HTTP POST request sent to the receiver will have a JSON-encoded body with th
- `monitorDescription`: The description of the monitor as configured in the UI
- `monitorURL`: A link to the monitor configuration page
- `query`: The query that generated `results`
- `results`: The list of results that triggered this notification. Contains the following sub-fields
- `resultCount`: The exact number of matches that triggered the notification. A single result entry can contain multiple matches, so this can be greater than the length of `results`.
- `resultsTruncated`: Whether Sourcegraph omitted result details after reaching its payload storage limit.
- `results`: An ordered prefix of the results that triggered this notification, when including result contents is enabled. When `resultsTruncated` is `true`, use `resultCount` to determine the complete match count. Contains the following sub-fields:
- `repository`: The name of the repository the commit belongs to
- `commit`: The commit hash for the matched commit.
- `diff`: The matching diff in unified diff format. Only set if the result is a diff match.
Expand All @@ -142,6 +144,8 @@ The HTTP POST request sent to the receiver will have a JSON-encoded body with th
"monitorDescription": "My test monitor",
"monitorURL": "https://sourcegraph.com/code-monitoring/Q29kZU1vbml0b3I6NDI=?utm_source=",
"query": "repo:camdentest -file:id_rsa.pub BEGIN",
"resultCount": 3,
"resultsTruncated": false,
"results": [
{
"repository": "github.com/test/test",
Expand Down