Remove remittanceInformation from the Quote response schema - #757
Remove remittanceInformation from the Quote response schema#757ls-bolt[bot] wants to merge 1 commit into
Conversation
remittanceInformation is an input on QuoteRequest only; the Quote response no longer echoes it back.
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
|
@greptileai review |
✱ Stainless preview builds for gridThis PR will update the cli feat(api): remove remittanceInformation from quote model openapi python typescript ⏳ grid-kotlin studio⏳ grid-python studio⏳ grid-php studio⏳ grid-cli studio⏳ These are partial results; builds are still running. 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 aligns the documented Quote response with the API’s actual response shape.
Confidence Score: 5/5The PR appears safe to merge because the response-only schema correction is consistently reflected across the source and generated specifications. The removed field has no in-repository Quote response consumers, remains available on the request schemas that accept it, and is removed consistently from both generated bundles.
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/quotes/Quote.yaml | Removes the response-only remittanceInformation property while leaving the Quote request contract unchanged. |
| openapi.yaml | Regenerated root bundle accurately reflects the source schema removal. |
| mintlify/openapi.yaml | Regenerated Mintlify bundle remains synchronized with the root OpenAPI bundle. |
Reviews (1): Last reviewed commit: "Remove remittanceInformation from the Qu..." | Re-trigger Greptile
## Summary `remittanceInformation` is an input field only — callers set it on `POST /quotes` and it travels with the payment on the rail. The `Quote` response schema was also echoing it back, which documented a field the API does not return. This removes it from `Quote` (the response) and leaves it in place on `QuoteRequest`. ## Changes: 3 files - `openapi/components/schemas/quotes/Quote.yaml` — drop the `remittanceInformation` property - `openapi.yaml`, `mintlify/openapi.yaml` — regenerated bundles (`make build`) No version bump: the field was never a documented, relied-upon part of the response, and no `servers.url` path change is involved. ## Test plan - `make build` — bundles regenerate cleanly - `make lint` — 0 errors (630 pre-existing warnings/infos, unchanged by this diff) - Confirmed no other reference to the field on the response side: request-side usages in the CLI (`cli/src/commands/quotes.ts`, `cli/src/commands/transfers.ts`), the visualizer code generator, the docs snippets, `TransferOutRequest`, and `RealtimeFundingTransactionSource` are all untouched Requested by @shreyav Original PR: #757

Summary
remittanceInformationis an input field only — callers set it onPOST /quotesand it travels with the payment on the rail. TheQuoteresponse schema was also echoing it back, which documented a field the API does not return.This removes it from
Quote(the response) and leaves it in place onQuoteRequest.Changes: 3 files
openapi/components/schemas/quotes/Quote.yaml— drop theremittanceInformationpropertyopenapi.yaml,mintlify/openapi.yaml— regenerated bundles (make build)No version bump: the field was never a documented, relied-upon part of the response, and no
servers.urlpath change is involved.Test plan
make build— bundles regenerate cleanlymake lint— 0 errors (630 pre-existing warnings/infos, unchanged by this diff)cli/src/commands/quotes.ts,cli/src/commands/transfers.ts), the visualizer code generator, the docs snippets,TransferOutRequest, andRealtimeFundingTransactionSourceare all untouchedRequested by @shreyav