docs: declare the 429 daily-volume response on /sandbox/send - #866
docs: declare the 429 daily-volume response on /sandbox/send#866ls-bolt[bot] wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-typescript studio · code · diff
✅ grid-openapi studio · code · diff
✅ grid-ruby studio · code · diff
✅ grid-go studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-python studio · code · diff
✅ grid-php studio · code · diff
✅ grid-cli studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
/sandbox/send can refuse with DAILY_VOLUME_LIMIT_EXCEEDED when funding a quote would take the customer past the daily withdrawal limit, but its response list did not document a 429, so generated clients had no typed error for it. Also widen the /quotes 429 description: the limit is checked when a quote is created, not only when immediatelyExecute is set. Co-Authored-By: jacklatourette <jacklatourette@users.noreply.github.com>
b1a602c to
c378f97
Compare
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|

Summary
/sandbox/sendcan refuse a request withDAILY_VOLUME_LIMIT_EXCEEDEDwhen funding a quote would take the customer past the daily withdrawal limit, but its response list did not declare a429. Generated clients therefore had no typed error for a status the endpoint really returns.429/Error429response on/sandbox/send./quotes429description: the daily limit is checked when a quote is created, not only whenimmediatelyExecuteis set.Edited in
openapi/(the source) and rebundled withmake build, so the generatedopenapi.yamlandmintlify/openapi.yamlstay in sync.No enum changes —
Error429already carriesDAILY_VOLUME_LIMIT_EXCEEDED, andError400already carriesTRANSACTION_SIZE_LIMIT_EXCEEDED. This only documents the responses on the endpoints that emit them, so/transfer-out,/quotes,/quotes/{quoteId}/execute, and/sandbox/sendnow all declare the429.Compatibility
Additive. A newly documented error response on an endpoint that already returns it — no request or success-response shape changes, and no existing field is removed or renamed.
Test plan
npm run build:openapire-run;git diff --exit-code openapi.yaml mintlify/openapi.yamlis clean, which is the check CI runsnpx spectral lint openapi.yaml --fail-severity=error— passes (exit 0)npx @redocly/cli lint openapi/openapi.yaml— 7 errors, all pre-existing in the card-simulation paths; identical count on a cleanmain429with theError429schema