Skip to content

docs: document API response text override#416

Open
checkly-rca-bot-angie[bot] wants to merge 1 commit into
mainfrom
angie/api-response-text-override-docs
Open

docs: document API response text override#416
checkly-rca-bot-angie[bot] wants to merge 1 commit into
mainfrom
angie/api-response-text-override-docs

Conversation

@checkly-rca-bot-angie

Copy link
Copy Markdown

Summary

  • Document how API checks handle binary-labelled response bodies before text body assertions.
  • Add a guarded note for the feature-flagged Treat response body as text override.
  • Add the ApiCheck construct request option reference and MaC snippet for known text responses served with binary Content-Type headers.

Context

Companion implementation PRs:

This docs PR is intentionally separate because the feature is behind API_RESPONSE_BODY_TEXT_OVERRIDE and may stay support-enabled rather than publicly promoted.

Validation

  • Passed: git diff --check.
  • Passed: npm exec -- mint broken-links.
  • Ran: npm exec -- mint validate; strict validation failed on two existing warnings in /snippets/copy-prompt-button.jsx and /snippets/setup-flow.jsx importing react. No new warning/error was reported for the changed MDX files.

@mintlify

mintlify Bot commented Jul 3, 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 3, 2026, 10:58 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@braxtonj

braxtonj commented Jul 3, 2026

Copy link
Copy Markdown

🚩 Do not approve till validation and work on code is complete. This is an Angie generated PR, didn't realize she would push to docs

Slack context: https://checklyhq.slack.com/archives/C024ZAJ938S/p1783116243756079

Palo Alto req on Datadog migration

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