Skip to content

Rewrite maxSpendPerTransaction descriptions in plain language - #950

Closed
ls-bolt[bot] wants to merge 1 commit into
mainfrom
09-11-simplify-max-spend-per-transaction-descriptions
Closed

Rewrite maxSpendPerTransaction descriptions in plain language#950
ls-bolt[bot] wants to merge 1 commit into
mainfrom
09-11-simplify-max-spend-per-transaction-descriptions

Conversation

@ls-bolt

@ls-bolt ls-bolt Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

This PR has been claimed. The active PR is now #956.

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; a
transaction for exactly whichever limit applies is allowed; 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 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.

Test plan

  • make build — bundles cleanly
  • 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 origin/main once description
    keys are stripped, so nothing but prose moved
  • CI green; Greptile 5/5 with no unresolved comments

@mintlify

mintlify Bot commented Sep 11, 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 11, 2026, 9:36 PM

@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 11, 2026 9:35pm UTC
grid-wallet-demo Ignored Ignored Preview Sep 11, 2026 9:35pm UTC

Request Review

@ls-bolt ls-bolt Bot added the bolt label Sep 11, 2026

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 descriptions in cards/config

go

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

kotlin

docs(api): clarify maxSpendPerTransaction documentation across card models

openapi

docs(api): clarify maxSpendPerTransaction field description

php

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

python

docs(api): update max_spend_per_transaction documentation in cards

ruby

docs(api): clarify max_spend_per_transaction parameter descriptions

typescript

docs(api): update maxSpendPerTransaction 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 "note" diagnostic, but this did not represent a regression.
generate ✅build ⏭️lint ⏭️test ⏭️

grid-openapi studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️

grid-ruby studio · code · diff

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

grid-kotlin studio · code · diff

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

grid-go studio · code · diff

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

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

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

grid-php studio · code · diff

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

grid-cli studio · code · diff

Your SDK build had at least one "warning" 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-11 21:44:56 UTC

@ls-bolt

ls-bolt Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

@greptile review

@greptile-apps

greptile-apps Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

This documentation-only PR appears safe to merge, with no outstanding findings.

Summary

  • Adds a concrete currency-unit example: cents for USD.
  • Retains the lower-of-card-and-platform limit behavior, capability requirements, and update restrictions.
  • Changes documentation only; schema constraints, types, field names, and examples remain unchanged.
  • The previous exact-amount wording issue is fixed consistently in the card, create, and update descriptions and both bundles. No new changes were made since the previous review.

Reviews (3) · Last reviewed commit: "Rewrite maxSpendPerTransaction descripti..."

Comment thread openapi/components/schemas/cards/Card.yaml Outdated
@ls-bolt
ls-bolt Bot force-pushed the 09-11-simplify-max-spend-per-transaction-descriptions branch from 44064df to 54108ed Compare September 11, 2026 21:35
@ls-bolt

ls-bolt Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

Revision log — updated in place, latest first.

Revision 1

  • Reworded the exact-amount sentence to "A transaction for exactly whichever limit applies is allowed" and moved it below the platform-limit clause in Card.yaml, CardCreateRequest.yaml, and CardUpdateRequest.yaml — the original text said "the effective limit" and my first pass lost that, making it read as the card's own value even when a lower platform cap applies (per @greptile-apps)
  • Regenerated openapi.yaml and mintlify/openapi.yaml via make build; make lint still matches the main baseline (2 warnings, 14 ignored)

@ls-bolt

ls-bolt Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

⚡ Review ledger

Round 1

  1. Exact-amount claim contradicts the platform limit (P2, Card.yaml:78-79) → FIXED: reworded to "A transaction for exactly whichever limit applies is allowed" and moved below the platform-limit clause in Card.yaml, CardCreateRequest.yaml, and CardUpdateRequest.yaml; bundles regenerated

@ls-bolt

ls-bolt Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

@greptile review

@greptile-apps

greptile-apps Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

The revision resolves my concern. “Whichever limit applies” correctly refers to the effective lower of the card and platform limits, and moving the sentence after that clause makes the relationship clear. I have no further issues with these description-only changes.

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.

2 participants