Skip to content

Conversation

@talagluck
Copy link
Contributor

Problem: Our generated code samples use confusing placeholders like {organizationId} that look like template syntax but aren't, and inconsistent token names like
YOUR_SECRET_TOKEN.

Solution: Standardize all placeholders to use clear YOUR_PARAM_NAME format across all languages.

Changes:

  • {organizationId}YOUR_ORGANIZATION_ID
  • {siteId}YOUR_SITE_ID
  • YOUR_SECRET_TOKENYOUR_API_TOKEN
  • Improved Python formatting (multi-line headers, json={} parameter)

Before:

response = requests.get(
    "https://api.gitbook.com/v1/orgs/{organizationId}/members",
    headers={"Authorization":"Bearer YOUR_SECRET_TOKEN"}
)

After:

  response = requests.get(
      "https://api.gitbook.com/v1/orgs/YOUR_ORGANIZATION_ID/members",
      headers={
          "Authorization": "Bearer YOUR_API_TOKEN"
      }
  )

This makes the code samples clearer and eliminates confusion about what needs to be replaced.

@changeset-bot
Copy link

changeset-bot bot commented Dec 3, 2025

⚠️ No Changeset found

Latest commit: 50cafe9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@argos-ci
Copy link

argos-ci bot commented Dec 3, 2025

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
customers-v2 (Inspect) ⚠️ Changes detected (Review) 29 changed Dec 3, 2025, 1:31 PM
v2-cloudflare (Inspect) ⚠️ Changes detected (Review) 13 changed Dec 3, 2025, 1:36 PM
v2-vercel (Inspect) ⚠️ Changes detected (Review) 18 changed, 4 removed, 1 failure Dec 3, 2025, 1:36 PM

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.

2 participants