Skip to content

docs(api-checks): document image response previews - #459

Merged
thebiglabasky merged 2 commits into
mainfrom
herve/docs-api-check-image-responses
Jul 28, 2026
Merged

docs(api-checks): document image response previews#459
thebiglabasky merged 2 commits into
mainfrom
herve/docs-api-check-image-responses

Conversation

@thebiglabasky

Copy link
Copy Markdown
Contributor

Summary

  • document image preview and download support in API check results
  • list the supported raster Content-Type values
  • spell out the 50 KB raw-response limit and unsupported-result caveats
  • clarify that Slack alerts omit image response-body previews

Why

checkly/monorepo#3276 added preview and download support for supported image responses. This documents the shipped behavior and its current boundaries where users already look for response-body and binary-response guidance.

User impact

Users can tell which image responses Checkly can preview, how the Content-Type header affects detection, and why oversized, older, SVG, TIFF, or otherwise unsupported responses do not render inline.

Validation

  • git diff --check
  • python3 .github/scripts/check_frontmatter.py
  • python3 .github/scripts/check_redirect_destinations.py
  • npm run generate-sitemap (no diff)
  • npx mint broken-links

@mintlify

mintlify Bot commented Jul 28, 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 28, 2026, 5:54 PM

@thebiglabasky
thebiglabasky marked this pull request as ready for review July 28, 2026 18:01
@thebiglabasky
thebiglabasky enabled auto-merge (squash) July 28, 2026 18:04
@thebiglabasky
thebiglabasky merged commit d7ce3a9 into main Jul 28, 2026
5 of 6 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