Skip to content

Conversation

@gschier
Copy link
Contributor

@gschier gschier commented Jan 22, 2026

Hey! I just saw Prisma post on X about using Yaak with the Prisma Postgres Management API.

I noticed the Yaak instructions, however, used a Bearer token while the Postman and Insomnia instructions used OAuth 2.0.

Since Yaak also supports OAuth 2.0, I figured I'd update the docs to match, so here's the edit!

I also gave it a test to ensure everything worked:

CleanShot 2026-01-22 at 13 47 11

Summary by CodeRabbit

  • Documentation
    • Replaced service-token guidance with a full OAuth 2.0 application workflow and registration steps.
    • Added detailed OAuth configuration and UI steps (authorization/token URLs, grant type, client ID/secret, redirect handling, token retrieval).
    • Updated Yaak client description, usage notes, and example payloads/region names to reflect the OAuth-based flow.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 22, 2026

Walkthrough

Updated Yaak client docs: replaced service-token header workflow with an OAuth 2.0 application registration and browser-based token retrieval flow, revised Yaak description and example payloads/regions to reflect OAuth usage.

Changes

Cohort / File(s) Summary
Yaak docs (single file)
content/800-guides/450-management-api-api-clients.mdx
Rewrote Yaak description to emphasize offline/Git usage; replaced service token workflow with OAuth 2.0 app registration (Client ID/Secret, redirect URI); moved auth config from header-based token to Auth tab OAuth fields (Grant Type, Auth URL, Token URL, Client ID/Secret, Redirect, Scope); added browser Get Token flow and updated example names/regions; removed prior service-token notes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Update Yaak instructions to use OAuth 2.0' directly and clearly summarizes the main change—migrating the Yaak API client documentation from service token authentication to OAuth 2.0, which is the primary focus of all modifications in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 22, 2026
@AmanVarshney01
Copy link
Member

Looks good! Thanks @gschier 😃

@AmanVarshney01 AmanVarshney01 merged commit 5c3378b into prisma:main Jan 23, 2026
6 of 7 checks passed
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