DEV-1815: stop apiUrl example from leaking Fliplet auth headers to third parties - #289
Merged
Merged
Conversation
…ird parties The "Using Custom API URL" example showed Fliplet.API.request() with apiUrl pointed at an external service. Fliplet's Auth-token/Authorization headers are attached unconditionally regardless of apiUrl, so following that example leaks the user's Fliplet session credentials to whatever third-party host is set. Replaces the example with a legitimate Fliplet-owned-host use case, adds an explicit warning against pointing apiUrl at third parties, and points readers to fetch() with the third party's own credentials instead. Follow-up from fliplet-studio PR #8851 (DEV-1802) review, where this doc example was found to contradict the fix being made to the V3 AI builder prompt.
Deploying fliplet-cli with
|
| Latest commit: |
b4c95f2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e9a37cf4.fliplet-cli.pages.dev |
| Branch Preview URL: | https://feature-dev-1815.fliplet-cli.pages.dev |
zeryabkhan91
approved these changes
Aug 18, 2026
1 task
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
3 participants
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.
What does this PR do?
The "Using Custom API URL" example in
docs/API/core/api.mdshowedFliplet.API.request()withapiUrlpointed at an external/third-party host.Fliplet.API.request()always attaches the current user's FlipletAuth-token/Authorizationheaders regardless of theapiUrloverride, so following that example as written leaks the user's Fliplet session credentials to whatever third-party host is set.This PR:
apiUrlat third parties, with afetch()-based alternative for genuine third-party callsapiUrltable row and the Authentication section to state the auth headers are attached unconditionally, even whenapiUrloverrides the hostJIRA ticket
https://weboo.atlassian.net/browse/DEV-1815
Background
Found as a follow-up during review of fliplet-studio#8851 (DEV-1802), which stops the V3 AI App Action builder from generating this same dangerous
apiUrl-to-third-party pattern. The builder's prompt now explicitly overrides this doc example for the AI builder, but the underlying public doc was still wrong and could mislead any developer (or another AI) reading it directly — the builder's own doc-lookup flow fetches this exact page.Testing instructions
cd docs && node bin/build-agent-indexes.mjs --strict— passes (confirmed locally, no generated index files changed by this wording fix).Deployment instructions
None — docs-only change, published automatically by Cloudflare Pages on merge to
master(viaprojects/DEV-1815→master).🤖 Generated with Claude Code