Skip to content

Clarify binary response handling for API checks - #452

Merged
thebiglabasky merged 1 commit into
mainfrom
herve/eng-154-handling-octet-stream-responses
Jul 27, 2026
Merged

Clarify binary response handling for API checks#452
thebiglabasky merged 1 commit into
mainfrom
herve/eng-154-handling-octet-stream-responses

Conversation

@thebiglabasky

Copy link
Copy Markdown
Contributor

Summary

  • clarify that a Text body assertion disables binary-response scrubbing for the entire API check
  • explain that this supports textual payloads mislabeled as application/octet-stream, but does not decode genuinely binary formats
  • align the documented 25MB response-body behavior and stored-result truncation with the current Go runner

Why

ENG-154 reports that customers cannot assert on health responses served as application/octet-stream. The runner behavior shipped in checkly/monorepo#2883 already preserves the response body when a Text body assertion is configured, so this updates the API Check documentation to match the shipped behavior and its limits.

Validation

  • go test ./check/api -run 'Test(DecideBinaryBodyScrub|ExecuteApiCheckBinaryScrubOptOut|MaxResponseBodySize)$' -count=1
  • python3 .github/scripts/check_redirect_destinations.py
  • python3 .github/scripts/check_frontmatter.py
  • regenerated sitemap with no diff
  • npx mint broken-links
  • git diff --check

@mintlify

mintlify Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Jul 27, 2026, 1:59 PM

@thebiglabasky
thebiglabasky marked this pull request as ready for review July 27, 2026 14:02
@thebiglabasky
thebiglabasky merged commit b79541e into main Jul 27, 2026
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant