Skip to content

docs(sdk): clarify OAuth vs bearer token auth for frontend vs backend#13958

Merged
rickyrombo merged 4 commits intomainfrom
docs/sdk-oauth-auth-guidance
Mar 18, 2026
Merged

docs(sdk): clarify OAuth vs bearer token auth for frontend vs backend#13958
rickyrombo merged 4 commits intomainfrom
docs/sdk-oauth-auth-guidance

Conversation

@rickyrombo
Copy link
Contributor

Summary

  • Removes the misleading HTML+JS initialization example that showed bearerToken in browser code (directly contradicting the warning below it)
  • Splits the "Initialize the SDK" section into clearly labeled backend vs. frontend examples
  • Adds a new "Log In with Audius (OAuth)" section with a concrete code example for the PKCE flow
  • Updates the security warning to be more explicit and link to the OAuth section
  • Clarifies in the "Direct API Access" section that bearer token curl/gRPC examples are backend-only

Test plan

  • Verify Node.js example still shows apiKey + bearerToken
  • Verify HTML+JS example shows apiKey only (no bearer token)
  • Verify OAuth section code example is syntactically correct
  • Verify all links resolve correctly in docs site

🤖 Generated with Claude Code

Removes the misleading HTML+JS example that showed a bearer token in
browser code, adds an explicit OAuth section with code example, and
clearly documents that bearer tokens must never appear in frontend code.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@changeset-bot
Copy link

changeset-bot bot commented Mar 18, 2026

⚠️ No Changeset found

Latest commit: 27b032d

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

rickyrombo and others added 2 commits March 18, 2026 13:50
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…r token

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

🌐 Web preview ready

Preview URL: https://audius-web-preview-pr-13958.audius.workers.dev

Unique preview for this PR (deployed from this branch).
Workflow run

Applies the same OAuth vs bearer token clarifications from the README
to the docs site overview page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@pull-request-size pull-request-size bot added size/L and removed size/M labels Mar 18, 2026
@rickyrombo rickyrombo merged commit de5f8ba into main Mar 18, 2026
9 checks passed
@rickyrombo rickyrombo deleted the docs/sdk-oauth-auth-guidance branch March 18, 2026 21:03
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.

1 participant