Skip to content

Rewrite maxSpendPerTransaction descriptions in plain language - #956

Draft
AaryamanBhute wants to merge 2 commits into
mainfrom
09-11-simplify-max-spend-per-transaction-descriptions
Draft

Rewrite maxSpendPerTransaction descriptions in plain language#956
AaryamanBhute wants to merge 2 commits into
mainfrom
09-11-simplify-max-spend-per-transaction-descriptions

Conversation

@AaryamanBhute

@AaryamanBhute AaryamanBhute commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrites every maxSpendPerTransaction description in plain language. The old text
read like an internal spec — "card-specific cap", "the effective limit", "Grid enforces
the lower of the two values without replacing this configured value". The new text says
what the field does in the second-person voice the rest of the docs use, and spells out
"smallest unit of the currency" with a concrete example (cents for USD) so a reader does
not have to infer it.

No schema constraints, types, examples, or field names changed — description strings only.

Changes: 7 source files (+ 2 regenerated bundles)

  • openapi/components/schemas/cards/Card.yaml — the field on the card resource
  • openapi/components/schemas/cards/CardCreateRequest.yamlPOST /cards
  • openapi/components/schemas/cards/CardUpdateRequest.yamlPATCH /cards/{id}
  • openapi/components/schemas/config/CardConfig.yaml — the platform-wide cap
  • openapi/paths/cards/cards_{id}.yaml — the bullet in the PATCH operation description
  • mintlify/snippets/cards/issuing-cards.mdx — the field table row
  • mintlify/snippets/cards/freezing-and-closing.mdx — the per-transaction limit section
  • openapi.yaml, mintlify/openapi.yaml — regenerated by make build

Facts preserved in every rewrite: the value is in the currency's smallest unit; null /
omitted means no limit; the lower of the card and platform values applies; the
supportsSpendLimits capability gate; and that it cannot be sent alongside
state: CLOSED. The "a transaction for exactly the effective limit is allowed" sentence
was dropped in a follow-up commit — it was the fiddliest part of the old text, and cutting
it removes the ambiguity rather than wording around it.

The sibling maxSpendPerDay and maxTransactionsPerDay descriptions were left alone —
the request named maxSpendPerTransaction. They can get the same treatment in a
follow-up if you want the whole limits family to read consistently.

Rebased onto main

main picked up #934, which renames fundingSources (array) → fundingSource (single
string) and rewrites prose in the same description blocks this PR touches — so the two
conflicted. Resolved by keeping main's singular fundingSource wording everywhere and
re-applying only the maxSpendPerTransaction rewrites on top. The conflicted bundles were
regenerated with make build rather than hand-merged.

Test plan

  • make build — bundles cleanly, and a second run after the rebase produces zero drift,
    so the committed bundles match the sources
  • make lint — "Your API description is valid", 2 warnings / 14 ignored, identical to
    the pre-change baseline on main (verified by stashing and re-running)
  • Verified mechanically that the bundle is unchanged from current origin/main once
    description keys are stripped, so nothing but prose moved
  • Confirmed no plural fundingSources crept back in during the rebase; Detect breaking changes passes
  • CI green; Greptile 5/5 with no unresolved comments

Original PR: #950

@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated
grid-flow-builder Ignored Ignored Preview Sep 12, 2026 6:24am UTC
grid-wallet-demo Ignored Ignored Preview Sep 12, 2026 6:24am UTC

Request Review

Copy link
Copy Markdown

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions

github-actions Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

✱ Stainless preview builds for grid

This PR will update the grid SDKs with the following commit messages.

cli

docs(api): update max-spend-per-transaction parameter descriptions in card/config

go

docs(api): update maxSpendPerTransaction documentation in card and config

kotlin

docs(api): update maxSpendPerTransaction docs in cards and platform config

openapi

docs(api): clarify maxSpendPerTransaction descriptions across card models

php

docs(api): clarify maxSpendPerTransaction descriptions in cards and config

python

docs(api): clarify max_spend_per_transaction parameter descriptions

ruby

docs(api): clarify max_spend_per_transaction descriptions in card and platform_config models

typescript

docs(api): update maxSpendPerTransaction parameter descriptions in cards and config

Edit this comment to update them. They will appear in their respective SDK's changelogs.

grid-typescript studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ⏭️lint ⏭️test ⏭️

grid-openapi studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗

grid-ruby studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ⏭️lint ⏭️test ⏭️

grid-kotlin studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ⏭️lint ⏭️test ⏭️

grid-go studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ⏭️lint ⏭️test ⏭️

go get github.com/stainless-sdks/grid-go@6374d0c4b9797bcb534d917b16c92076181ffb3f
grid-python studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ⏭️lint ⏭️test ⏭️

grid-php studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗lint ⏭️test ⏭️

grid-cli studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ⏭️lint ⏭️test ⏭️


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-09-12 06:27:50 UTC

@ls-bolt

ls-bolt Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

📌 Bolt Status

2026-09-12 01:47:00 UTC — ⚡ Agent shimmering-avalanche-2(#2) started
2026-09-12 06:21:25 UTC — ⚡ Agent shimmering-avalanche-3(#3) started


Feedback

@mintlify

mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Grid 🟢 Ready View Preview Sep 12, 2026, 6:25 AM

Copy link
Copy Markdown
Contributor Author

@bolt fix merge conflicts

@ls-bolt
ls-bolt Bot force-pushed the 09-11-simplify-max-spend-per-transaction-descriptions branch from 0a56042 to 3a6f822 Compare September 12, 2026 06:24
@ls-bolt

ls-bolt Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Revision log — updated in place, latest first.

Revision 1

  • Rebased onto main to clear the merge conflicts. main picked up feat(cards): bind one funding source per card #934, which renames fundingSources (array) → fundingSource (single string) and rewrites the surrounding prose in the same description blocks this PR touches
  • Resolved by keeping main's singular fundingSource wording everywhere and re-applying only the maxSpendPerTransaction description rewrites on top, in CardCreateRequest.yaml and the issuing-cards.mdx field table
  • Regenerated openapi.yaml and mintlify/openapi.yaml rather than hand-merging the conflicted bundles; a follow-up make build produces zero drift, so they match the sources
  • Verified no plural fundingSources crept back in, the diff vs main is now only the description rewrites, and Detect breaking changes passes. make lint still matches the main baseline (2 warnings, 14 ignored)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants