docs(drift): draft from internal source - #434
Conversation
Requested by @Frizellle via /publish-docs-pr
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @pedromcunha's task in 3m 2s —— View job Code review — PR #434
The new content is well-organized and the Two things I verified as fine, so you don't need to chase them:
Findings1. This path appears nowhere else in the repo: no MDX page, no entry in 2. Self-contradicting sentence in the parameter definition —
Under full coverage there is no remainder for the user to pay. The second clause belongs to the partial case, not the default. This is the first line a reader hits for the new parameter, so it's worth getting exactly right. 3. Deposit-address behavior is described two different ways — Line 56 says deposit addresses "do not support 4. "bucket" isn't this page's term — The new section uses "fee bucket" / "bucket" nine times and never defines it. The reader-facing term everywhere else is fee component: that's the parameter's own name ( 5. No link to where the component values are defined — The section tells readers the share applies to "every bucket named in 6. The table cell duplicates the entire section — Six sentences, where every other row in that table is one or two. §2.7 is explicit: "Keep cell descriptions concise; move long explanations into prose below the table." Everything in this cell after "Requires 7. That section is the other place sponsorship parameters are documented, and it currently asserts "setting Nits
I reviewed only; no changes pushed. Happy to apply any subset of the above if you want — just say which. |
|
|
|
||
| **Added** — `POST /quote` and `POST /quote/v2`: the new optional `subsidizationBps` request field lets sponsors cover a fixed share of each selected sponsorable fee bucket instead of covering it in full. Values are integer basis points in the range `0`–`10000` (`10000` = 100%). Requires `subsidizeFees: true`. Applied per bucket **before** `maxSubsidizationAmount`, which continues to cap the sponsor's total contribution. Currently supported only on swap execution flows — bridge and deposit-address flows return `400` when set. Omitting the field preserves the previous full-coverage behavior. See [Fee Sponsorship](/features/fee-sponsorship#how-subsidizationbps-works). | ||
|
|
||
| **Added** — `GET /requests/v2`, `GET /requests/v3`, and `GET /integrators/quote-data`: the `feeSponsorship` object now includes `subsidizationBps` on both the quoted and actual phases, reflecting the share configured at quote time when one was set. Absent when the field was not configured on the request. |
There was a problem hiding this comment.
Response field lacks reference coverage
This announces feeSponsorship.subsidizationBps for the v2, v3, and quote-data responses, but the detailed Requests references, v2-to-v3 migration examples and field reference, and a quote-data endpoint reference do not document the field. Add the optional quoted and actual phase fields, including their nesting and omission-when-unset behavior, so integrators can consume the announced API addition.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Artifacts
Fee sponsorship documentation coverage checker source
- Authored Python checker that reads the changelog, detailed request references, migration guide, and all MDX files to verify coverage of the announced response field; it provides the reproducible validation path.
Baseline documentation coverage check before the changelog addition
- Executed checker against commit `506e2ca881f866c82c13e9053e498f6189d03f70`; it shows no announcement existed and records the same documentation baseline.
Current documentation coverage check after the changelog addition
- Executed checker against commit `9a2eb3286055d0924a35a6f5f9cba34fa392c43c`; it finds the announcement but zero matching response-field references and reports `UNDOCUMENTED_RESPONSE_ADDITION`, confirming the finding.
Drafted from an internal source repo, requested by @Frizellle.
This PR was auto-generated by the
reusable-docs-draft-prworkflow from a Claude-drafted update in the source repo. It is opened as a draft — please review, edit as needed, and mark ready for review before merging.Review checklist
CLAUDE.mdstyle rulesNeeds human inputitems from the source comment are addressedGenerated by
reusable-docs-draft-pr.ymlinrelayprotocol/agents-config.