Skip to content

docs(config): document platform-name defaults for card tokenization 2FA copy #927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DhruvPareek merged 1 commit into from
Sep 9, 2026
+33 −15
Merged

docs(config): document platform-name defaults for card tokenization 2FA copy #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 11 additions & 5 deletions openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion openapi/components/schemas/config/CardTokenization2FAConfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ properties:
displayName:
type: string
maxLength: 255
description: Platform name displayed in authentication messages.
description: |
Name shown in authentication messages and used to build the default
subject, body, and sender name. Defaults to the platform's name.
example: Acme
logoUrl:
type: string
Expand Down
9 changes: 6 additions & 3 deletions openapi/components/schemas/config/CardTokenization2FAEmailConfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ properties:
fromName:
type: string
maxLength: 255
description: Sender display name.
description: Sender display name. Defaults to `displayName`.
example: Acme Cards
replyToAddress:
type: string
Expand All @@ -23,13 +23,16 @@ properties:
subject:
type: string
maxLength: 255
description: Subject for the authentication email.
description: |
Subject for the authentication email. Defaults to
"Your {displayName} verification code".
example: Your Acme card verification code
bodyText:
type: string
maxLength: 2000
description: |
Plain-text message content. Lightspark inserts the authentication code into
a controlled text and HTML template; arbitrary HTML and template variables
are not supported.
are not supported. Defaults to "Use this code to finish adding your
{displayName} card to your wallet."
Comment on lines 35 to +37

@greptile-apps greptile-apps Bot Sep 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Ambiguous displayName placeholder

The description says template variables are unsupported, then expresses the default using {displayName}. The subject and SMS descriptions use the same unexplained notation. This makes it unclear whether integrators may include {displayName} in configured copy or whether it only illustrates a value substituted by the service. Please clarify the substitution and its fallback to the platform name.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/components/schemas/config/CardTokenization2FAEmailConfig.yaml
Line: 35-37

Comment:
**Ambiguous displayName placeholder**

The description says template variables are unsupported, then expresses the default using `{displayName}`. The subject and SMS descriptions use the same unexplained notation. This makes it unclear whether integrators may include `{displayName}` in configured copy or whether it only illustrates a value substituted by the service. Please clarify the substitution and its fallback to the platform name.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

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!

example: Use this code to finish adding your Acme card to your digital wallet.
3 changes: 2 additions & 1 deletion openapi/components/schemas/config/CardTokenization2FASmsConfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ properties:
maxLength: 480
description: |
Plain-text fallback message used when Twilio Verify is unavailable for the
authentication code. Lightspark appends the code to this text.
authentication code. Lightspark appends the code to this text. Defaults to
"Your {displayName} verification code is:".
example: Use this code to finish adding your Acme card to your digital wallet.
Loading