docs(api): publish only the sandbox base URL#18
Merged
marioalvial merged 2 commits intomainfrom May 5, 2026
Merged
Conversation
Drop the internal service segment (/account, /payment, /webhook) from every published server URL and switch the public host: - production: https://api.tracefinance.com - sandbox: https://api.sandbox.tracefinance.com Updated all three OpenAPI specs, docs.json (api.baseUrl + Mintlify variables), and the matching authoring rule in .claude/rules/openapi.md. Removed a redundant hardcoded literal in webhooks/test-in-sandbox.mdx that duplicated {{sandboxUrl}} and would have drifted on the next host change.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
leonisandes
approved these changes
May 5, 2026
Only sandbox is published. The production base URL is shared with each customer at go-live, after their integration is validated in sandbox — exposing it ahead of that gives the wrong contract and risks pointing partners at a host that may not be routed yet. - removed the production servers: entry from all three OpenAPI specs - collapsed docs.json api.baseUrl to a single sandbox string and deleted the productionUrl Mintlify variable - rewrote guides/environments.mdx URL table as a one-liner naming sandbox and explaining how production access is granted - updated .claude/rules/openapi.md to forbid production URL entries in specs, docs.json, or MDX
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
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.
Description
Two related changes to the published base URL:
/account,/payment,/webhook) from every server URL. The oldfaas.tracefinance.io/<service>form leaked the per-service routing of the gateway; partners only need the bare host plus the/apisource channel that already prefixes every documented path.Net result: sandbox is
https://api.sandbox.tracefinance.com; production is no longer present anywhere in the published surface.The matching authoring rule in
.claude/rules/openapi.mdis also tightened so future spec changes cannot reintroduce either the service segment or a production URL.Key Changes
apis/fx-account,apis/fx-payment,apis/fx-webhook):servers:reduced to a single sandbox entry on the bare host.docs.json:api.baseUrlcollapsed to a single sandbox string;sandboxUrlupdated;productionUrlvariable removed.guides/environments.mdx: URL table replaced with a one-liner naming sandbox and explaining that the production URL is shared at go-live.webhooks/test-in-sandbox.mdx: removed a hardcoded URL literal that duplicated{{sandboxUrl}}and would have drifted on the next host change..claude/rules/openapi.md: rule now (a) mandates the bare host with no service segment, and (b) forbids any production URL entry in specs,docs.json, or MDX.Type of change
How Has This Been Tested?
Validated locally with
mint validate(passes) andmint broken-links(passes). Confirmed viagrepthat nofaas.hostname remains and thatapi.tracefinance.comonly survives inside the rule that forbids it.Checklist:
Backend / infra follow-up
The new public sandbox host must resolve and route to the gateway before this is announced to partners:
api.sandbox.tracefinance.compointing at the FaaS gateway./api/...on the bare sandbox host must reach the same handlers that previously sat behind/account/api/...,/payment/api/...,/webhook/api/...onfaas.sandbox.tracefinance.io.faas.sandbox.tracefinance.io/<service>host serving for a deprecation window; announce the cutover only after step 3 is verified end-to-end.