docs(quotes): document that quote create and execute require TRANSACT - #842
docs(quotes): document that quote create and execute require TRANSACT#842ls-bolt[bot] wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Neither endpoint stated which permission it needs. Execute in particular reads as though the Grid-Wallet-Signature header is the whole authorization story on an EMBEDDED_WALLET source, so spell out that the signature and the token permission answer two different questions. Co-Authored-By: dhruvpareek <dhruvpareek@users.noreply.github.com>
ccb618c to
ccff1a6
Compare
This stack of pull requests is managed by Graphite. Learn more about stacking. |
✱ 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. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Greptile SummaryThis PR clarifies that creating and executing quotes requires the
Confidence Score: 5/5The documentation-only changes appear safe to merge. The source path updates are internally consistent with the token permission and shared error schemas, and both generated OpenAPI bundles contain the corresponding changes without unrelated drift.
|
| Filename | Overview |
|---|---|
| openapi/paths/quotes/quotes.yaml | Documents the TRANSACT requirement for quote creation and accurately expands the existing Error403 response description. |
| openapi/paths/quotes/quotes_{quoteId}_execute.yaml | Documents the distinct integration-token and wallet-holder authorization requirements and adds a schema-consistent Error403 response. |
| openapi.yaml | Regenerated root bundle matches the quote path source changes. |
| mintlify/openapi.yaml | Regenerated Mintlify bundle remains synchronized with the root OpenAPI bundle. |
Reviews (1): Last reviewed commit: "docs(quotes): document that quote create..." | Re-trigger Greptile
…#843) ## Summary Neither `POST /quotes` nor `POST /quotes/{quoteId}/execute` stated which token permission it requires, and neither documented a `403` for a permission refusal on execute. Execute is the one worth spelling out. Its description covers `Grid-Wallet-Signature` in detail for `EMBEDDED_WALLET` sources, which reads as though the signature is the whole authorization story. It isn't: the signature proves the **wallet holder** approved the payment, while `TRANSACT` is what authorizes **your integration** to release it. An integrator building a read-only service could reasonably conclude a `VIEW` token plus a signature was a supported way to execute. ## Changes - `openapi/paths/quotes/quotes_{quoteId}_execute.yaml` — state the `TRANSACT` requirement and how it relates to `Grid-Wallet-Signature`; add the `403` - `openapi/paths/quotes/quotes.yaml` — state the `TRANSACT` requirement (a quote is the instrument execute draws on, and `immediatelyExecute` moves funds in the same request); extend the existing `403` description, which previously named only the End User Terms case - Regenerated bundles via `make build`: `openapi.yaml`, `mintlify/openapi.yaml` ## Verification - `make build` — bundles regenerate cleanly; the bundle diff is exactly these four additions, no reformatting of unrelated paths - `make lint` — *"Woohoo! Your API description is valid."*, **0 errors** (pre-existing warnings/infos on unrelated beneficiary schemas only) Original PR: #842

Summary
Neither
POST /quotesnorPOST /quotes/{quoteId}/executestated which token permission it requires, and neither documented a403for a permission refusal on execute.Execute is the one worth spelling out. Its description covers
Grid-Wallet-Signaturein detail forEMBEDDED_WALLETsources, which reads as though the signature is the whole authorization story. It isn't: the signature proves the wallet holder approved the payment, whileTRANSACTis what authorizes your integration to release it. An integrator building a read-only service could reasonably conclude aVIEWtoken plus a signature was a supported way to execute.Changes
openapi/paths/quotes/quotes_{quoteId}_execute.yaml— state theTRANSACTrequirement and how it relates toGrid-Wallet-Signature; add the403openapi/paths/quotes/quotes.yaml— state theTRANSACTrequirement (a quote is the instrument execute draws on, andimmediatelyExecutemoves funds in the same request); extend the existing403description, which previously named only the End User Terms casemake build:openapi.yaml,mintlify/openapi.yamlVerification
make build— bundles regenerate cleanly; the bundle diff is exactly these four additions, no reformatting of unrelated pathsmake lint— "Woohoo! Your API description is valid.", 0 errors (pre-existing warnings/infos on unrelated beneficiary schemas only)