Skip to content

docs: Standardize curl env vars to GRID_CLIENT_ID and GRID_CLIENT_SECRET#285

Merged
jklein24 merged 2 commits intomainfrom
claude/slack-fix-curl-env-vars-EMns8
Mar 20, 2026
Merged

docs: Standardize curl env vars to GRID_CLIENT_ID and GRID_CLIENT_SECRET#285
jklein24 merged 2 commits intomainfrom
claude/slack-fix-curl-env-vars-EMns8

Conversation

@jklein24
Copy link
Contributor

Fixes inconsistent environment variable names across curl examples:

  • SANDBOX_CLIENT_ID:SANDBOX_API_SECRET → GRID_CLIENT_ID:GRID_CLIENT_SECRET
  • GRID_API_SECRET → GRID_CLIENT_SECRET
  • YOUR_CLIENT_ID:YOUR_CLIENT_SECRET → $GRID_CLIENT_ID:$GRID_CLIENT_SECRET

https://claude.ai/code/session_01DDmEbZhoeCbMT5n5RJeqhJ

Fixes inconsistent environment variable names across curl examples:
- SANDBOX_CLIENT_ID:SANDBOX_API_SECRET → GRID_CLIENT_ID:GRID_CLIENT_SECRET
- GRID_API_SECRET → GRID_CLIENT_SECRET
- YOUR_CLIENT_ID:YOUR_CLIENT_SECRET → $GRID_CLIENT_ID:$GRID_CLIENT_SECRET

https://claude.ai/code/session_01DDmEbZhoeCbMT5n5RJeqhJ
@jklein24 jklein24 requested review from k15z and pengying March 20, 2026 18:18
@mintlify
Copy link

mintlify bot commented Mar 20, 2026

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

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview Mar 20, 2026, 6:20 PM

@vercel
Copy link

vercel bot commented Mar 20, 2026

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

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment Mar 20, 2026 8:02pm

Request Review

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 20, 2026

Greptile Summary

This PR standardizes environment variable names used in curl examples across all Mintlify documentation files, replacing three inconsistent legacy patterns ($SANDBOX_CLIENT_ID:$SANDBOX_API_SECRET, $GRID_CLIENT_ID:$GRID_API_SECRET, and 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET') with the canonical "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" form.

Key changes across 13 files:

  • SANDBOX_CLIENT_ID / SANDBOX_API_SECRETGRID_CLIENT_ID / GRID_CLIENT_SECRET (primarily in sandbox testing guides)
  • GRID_API_SECRETGRID_CLIENT_SECRET (across quickstart and configuration guides)
  • 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET'"$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" in platform-configuration-non-uma.mdx and platform-configuration-uma.mdx — this also correctly switches from single quotes to double quotes, which is necessary for shell variable expansion to work
  • The previously flagged missing-quotes issue (unquoted $GRID_CLIENT_ID:$GRID_CLIENT_SECRET) has been addressed; all instances in this PR now use proper double-quote wrapping
  • A broad search for remaining legacy names (SANDBOX_API_SECRET, GRID_API_SECRET, YOUR_CLIENT_ID, etc.) across the mintlify/ tree found no leftover occurrences — the cleanup appears complete

Confidence Score: 5/5

  • This PR is safe to merge — it is a documentation-only change with no logic, no code execution path, and no security implications.
  • All 13 files contain purely mechanical find-and-replace changes to env var names in curl examples. The replacements are applied consistently, all use properly double-quoted strings to allow shell variable expansion, and a repo-wide grep confirms no legacy variable names remain in the changed docs. The previously flagged quoting issue has been resolved in this revision.
  • No files require special attention.

Important Files Changed

Filename Overview
mintlify/api-reference/sandbox-testing.mdx 4 curl examples updated from $SANDBOX_CLIENT_ID:$SANDBOX_API_SECRET to $GRID_CLIENT_ID:$GRID_CLIENT_SECRET; all properly double-quoted.
mintlify/ramps/platform-tools/sandbox-testing.mdx 10 curl examples updated from $SANDBOX_CLIENT_ID:$SANDBOX_API_SECRET to $GRID_CLIENT_ID:$GRID_CLIENT_SECRET; all properly double-quoted.
mintlify/snippets/platform-configuration-non-uma.mdx 3 curl examples updated from single-quoted 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' to double-quoted "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET", enabling proper shell variable expansion.
mintlify/snippets/platform-configuration-uma.mdx 3 curl examples updated from single-quoted 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' to double-quoted "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET", enabling proper shell variable expansion.
mintlify/snippets/creating-customers/customers.mdx 8 curl examples updated from $GRID_CLIENT_ID:$GRID_API_SECRET to $GRID_CLIENT_ID:$GRID_CLIENT_SECRET; all properly double-quoted.
mintlify/global-p2p/onboarding-customers/configuring-customers.mdx 7 curl examples updated from $GRID_API_SECRET to $GRID_CLIENT_SECRET; all properly double-quoted.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[curl example in docs] --> B{Legacy variable pattern?}
    B -->|SANDBOX_CLIENT_ID / SANDBOX_API_SECRET| C[sandbox-testing files]
    B -->|GRID_CLIENT_ID / GRID_API_SECRET| D[quickstart and config files]
    B -->|single-quoted YOUR_CLIENT_ID:YOUR_CLIENT_SECRET| E[platform-configuration snippets]
    C --> F["Standardized: -u GRID_CLIENT_ID:GRID_CLIENT_SECRET double-quoted"]
    D --> F
    E --> F
    E --> G[Also: single quotes to double quotes for shell expansion]
    G --> F
Loading

Last reviewed commit: "docs: Fix missing qu..."

```bash cURL
curl -X GET 'https://api.lightspark.com/grid/2025-10-13/config' \
-u 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET'
-u $GRID_CLIENT_ID:$GRID_CLIENT_SECRET
Copy link
Contributor

Choose a reason for hiding this comment

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

P2 Missing quotes around env var expansion

The replacement dropped the surrounding quotes. The updated value uses -u $GRID_CLIENT_ID:$GRID_CLIENT_SECRET (unquoted), while every other file changed in this PR uses -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" (double-quoted). Unquoted variable expansions in bash can break if either variable contains spaces or special characters, and they produce visually inconsistent docs.

The same pattern appears on lines 41 and 110 of this file, and on lines 12, 55, and 190 of mintlify/snippets/platform-configuration-uma.mdx.

Suggested change
-u $GRID_CLIENT_ID:$GRID_CLIENT_SECRET
-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET"
Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/platform-configuration-non-uma.mdx
Line: 11

Comment:
**Missing quotes around env var expansion**

The replacement dropped the surrounding quotes. The updated value uses `-u $GRID_CLIENT_ID:$GRID_CLIENT_SECRET` (unquoted), while every other file changed in this PR uses `-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET"` (double-quoted). Unquoted variable expansions in `bash` can break if either variable contains spaces or special characters, and they produce visually inconsistent docs.

The same pattern appears on lines 41 and 110 of this file, and on lines 12, 55, and 190 of `mintlify/snippets/platform-configuration-uma.mdx`.

```suggestion
  -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET"
```

How can I resolve this? If you propose a fix, please make it concise.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@claude should we address this everywhere?

@jklein24 jklein24 merged commit 11bdd41 into main Mar 20, 2026
8 checks passed
@jklein24 jklein24 deleted the claude/slack-fix-curl-env-vars-EMns8 branch March 20, 2026 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants