Skip to content

docs(openapi): add title to CardTransaction so docs render a named chip - #638

Closed
ls-bolt[bot] wants to merge 1 commit into
mainfrom
07-02-card-transaction-title
Closed

docs(openapi): add title to CardTransaction so docs render a named chip#638
ls-bolt[bot] wants to merge 1 commit into
mainfrom
07-02-card-transaction-title

Conversation

@ls-bolt

@ls-boltls-boltBot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Summary

The Grid API docs schema viewer (e.g. get-transaction-by-id) rendered the third TransactionOneOf variant as a generic Option 3 chip. IncomingTransaction and OutgoingTransaction both declare a title, which Mintlify uses for the chip label; CardTransaction (added in #622) did not, so the renderer fell back to "Option 3".

This adds title: Card Transaction to the CardTransaction schema and regenerates the bundled specs (openapi.yaml, mintlify/openapi.yaml) via npm run build:openapi.

Test plan

  • npm run lint:openapi passes (Redocly bundle + lint, Spectral lint — exit 0, only pre-existing warnings)
  • Diff is exactly the one source line plus the same line in the two generated bundles

Requested by Ben in Slack (thread linked below).

Slack thread: https://lightsparkgroup.slack.com/archives/C0A28TVUZ4Z/p1783024275813329


🤖 blazing-photon(#1) | Feedback

@vercel

vercelBot commented Jul 2, 2026

Copy link
Copy Markdown

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

2 Skipped Deployments
ProjectDeploymentActionsUpdated (UTC)
grid-flow-builderIgnoredIgnoredPreviewJul 2, 2026 8:54pm
grid-wallet-demoIgnoredIgnoredPreviewJul 2, 2026 8:54pm

Request Review

@ls-boltls-boltBot added the bolt label Jul 2, 2026
@akanterGraphite App

Copy link
Copy Markdown
Contributor

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

@github-actions

github-actionsBot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

✱ Stainless preview builds for grid

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

cli
⏳ (generating...)```
docs(openapi): add title to CardTransaction so docs render a named chip

**csharp**
⏳ (generating...)```
docs(openapi): add title to CardTransaction so docs render a named chip

go

chore(internal): regenerate SDK with no functional changes

kotlin
⏳ (generating...)```
docs(openapi): add title to CardTransaction so docs render a named chip

**openapi**
⏳ (generating...)```
docs(openapi): add title to CardTransaction so docs render a named chip

php

chore(internal): regenerate SDK with no functional changes

python
⏳ (generating...)```
docs(openapi): add title to CardTransaction so docs render a named chip

**ruby**
⏳ (generating...)```
docs(openapi): add title to CardTransaction so docs render a named chip

typescript
⏳ (generating...)```
docs(openapi): add title to CardTransaction so docs render a named chip


Edit this comment to update them. They will appear in their respective SDK's changelogs.
<details>
<summary>⏳ <b>grid-cli</b> <a href="https://app.stainless.com/lightspark/grid/studio?language=cli&branch=preview%2F07-02-card-transaction-title">studio</a></summary>
<blockquote>
</blockquote>
</details>
<details>
<summary>⏳ <b>grid-ruby</b> <a href="https://app.stainless.com/lightspark/grid/studio?language=ruby&branch=preview%2F07-02-card-transaction-title">studio</a></summary>
<blockquote>
</blockquote>
</details>
<details>
<summary>⏳ <b>grid-openapi</b> <a href="https://app.stainless.com/lightspark/grid/studio?language=openapi&branch=preview%2F07-02-card-transaction-title">studio</a></summary>
<blockquote>
</blockquote>
</details>
<details>
<summary>⏳ <b>grid-kotlin</b> <a href="https://app.stainless.com/lightspark/grid/studio?language=kotlin&branch=preview%2F07-02-card-transaction-title">studio</a></summary>
<blockquote>
</blockquote>
</details>
<details>
<summary>⏳ <b>grid-python</b> <a href="https://app.stainless.com/lightspark/grid/studio?language=python&branch=preview%2F07-02-card-transaction-title">studio</a> · <a href="https://github.com/stainless-sdks/grid-python/tree/preview%2F07-02-card-transaction-title">code</a> · <a href="https://github.com/stainless-sdks/grid-python/compare/preview%2Fbase%2F07-02-card-transaction-title..preview%2F07-02-card-transaction-title">diff</a></summary>
<blockquote>
<code>generate ✅</code> → <code>build ⏳</code> → <code>lint ⏳</code> → <code>test ⏳</code>
</blockquote>
</details>
<details>
<summary>⏳ <b>grid-go</b> <a href="https://app.stainless.com/lightspark/grid/studio?language=go&branch=preview%2F07-02-card-transaction-title">studio</a> · <a href="https://github.com/stainless-sdks/grid-go/tree/preview%2F07-02-card-transaction-title">code</a> · <a href="https://github.com/stainless-sdks/grid-go/compare/preview%2Fbase%2F07-02-card-transaction-title..preview%2F07-02-card-transaction-title">diff</a></summary>
<blockquote>
<code>generate ✅</code> → <code>build ⏳</code> → <a href="https://github.com/stainless-sdks/grid-go/actions/runs/28620988349/job/84876339211"><code>lint ⏳</code></a> → <a href="https://github.com/stainless-sdks/grid-go/actions/runs/28620988349/job/84876339205"><code>test ⏳</code></a>
```bash
go get github.com/stainless-sdks/grid-go@fff693ac66de0c173d1059a5443fe63d6c0f12f1
grid-phpstudio · code · diff

generate ✅lint ⏳test ⏳

grid-csharpstudio
grid-typescriptstudio

⏳ 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.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-07-02 20:55:45 UTC

@benwgoldbenwgold closed this Jul 2, 2026
benwgold added a commit that referenced this pull request Jul 2, 2026
…ip (#639)
## Summary
The Grid API docs schema viewer (e.g. [get-transaction-by-id](https://docs.lightspark.com/api-reference/transactions/get-transaction-by-id)) rendered the third `TransactionOneOf` variant as a generic **Option 3** chip. `IncomingTransaction` and `OutgoingTransaction` both declare a `title`, which Mintlify uses for the chip label; `CardTransaction` (added in #622) did not, so the renderer fell back to "Option 3".
This adds `title: Card Transaction` to the `CardTransaction` schema and regenerates the bundled specs (`openapi.yaml`, `mintlify/openapi.yaml`) via `npm run build:openapi`.
## Test plan
- `npm run lint:openapi` passes (Redocly bundle + lint, Spectral lint — exit 0, only pre-existing warnings)
- Diff is exactly the one source line plus the same line in the two generated bundles
Requested by Ben in Slack (thread linked below).
Slack thread: https://lightsparkgroup.slack.com/archives/C0A28TVUZ4Z/p1783024275813329
---
🤖 [blazing-photon](https://zeus.dev.dev.sparkinfra.net/#/arc?id=blazing-photon)[(#1)](https://zeus.dev.dev.sparkinfra.net/#/instance?id=blazing-photon) | [Feedback](https://zeus.dev.dev.sparkinfra.net/feedback)
Original PR: #638
@benwgold
benwgold deleted the 07-02-card-transaction-title branch July 2, 2026 22:27
Sign up for freeto 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.

3 participants

@akanter@benwgold@jklein24