API client Management API guides added #7416
Conversation
WalkthroughAdds a new Management API guide for using API clients (Postman, Insomnia, Yaak) with OAuth2 setup and example requests; updates sidebar navigation to include the new guide; updates spellcheck dictionary with "Yaak" and "Yaak's". No runtime code changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Pre-merge checks✅ Passed checks (3 passed)
Comment |
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
🍈 Lychee Link Check Report
📊 Results Overview
Errors per inputErrors in 200-orm/200-prisma-client/300-client-extensions/140-shared-extensions/100-permit-rbac.mdx
Errors in 800-guides/380-vercel-app-deployment.mdx
|
Deploying docs with
|
| Latest commit: |
98ec9fd
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d77a8c6b.docs-51g.pages.dev |
| Branch Preview URL: | https://dr-4560-postman-api-guide.docs-51g.pages.dev |
🍈 Lychee Link Check Report
📊 Results Overview
Errors per inputErrors in 800-guides/380-vercel-app-deployment.mdx
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
sidebars.ts (1)
436-436: LGTM: Formatting improvements.The formatting changes improve code consistency by reflowing arrays and labels to single lines. No functional changes—just cleaner, more maintainable code.
Also applies to: 500-500, 550-550, 568-568, 573-573
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/800-guides/450-management-api-api-clients.mdxsidebars.ts
🧰 Additional context used
🪛 GitHub Actions: Documentation Checks
content/800-guides/450-management-api-api-clients.mdx
[error] 154-154: cspell: Unknown word (Yaak).
[error] 156-156: cspell: Unknown word (Yaak).
[error] 162-162: cspell: Unknown word (Yaak).
[error] 174-174: cspell: Unknown word (Yaak).
[error] 176-176: cspell: Unknown word (Yaak).
[error] 190-190: cspell: Unknown word (Yaak's).
🪛 LanguageTool
content/800-guides/450-management-api-api-clients.mdx
[grammar] ~154-~154: Ensure spelling is correct
Context: ...e confirming your project creation. ## Yaak Yaak is a lightweight, native API client...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (4)
content/800-guides/450-management-api-api-clients.mdx (3)
1-208: Excellent documentation structure and clarity!The guide is well-organized with consistent structure across all three API clients (Postman, Insomnia, Yaak). Each section follows a clear pattern with prerequisites, setup steps, and example requests. The step-by-step instructions are detailed and easy to follow.
20-64: Appropriate authentication methods for each client.The documentation correctly uses different authentication approaches suited to each API client:
- OAuth2 Authorization Code flow for Postman and Insomnia (with browser-based authorization)
- Service token approach for Yaak (simpler Bearer token)
This demonstrates good understanding of each tool's strengths and provides the most user-friendly approach for each.
Also applies to: 93-135, 164-191
44-44: API endpoints and region configuration are correct and current.All values used in the documentation have been verified against official Prisma Management API documentation:
- API endpoint
https://api.prisma.io/v1/projects✓- Auth endpoints
https://auth.prisma.io/authorizeand/token✓- Region
us-east-1(US East, N. Virginia) is a valid Prisma Postgres region ✓- OAuth scope
workspace:adminis the correct scope for workspace-level operations ✓No changes needed.
sidebars.ts (1)
387-387: Correct sidebar integration for new documentation.The new path
"guides/management-api-api-clients"correctly references the new documentation file and is appropriately placed in the "Development Tools" category. The path matches the file atcontent/800-guides/450-management-api-api-clients.mdx(after Docusaurus strips the numeric prefix and extension).
aidankmcalister
dismissed stale reviews from ArthurGamby and coderabbitai[bot]
via
98ec9fd
🍈 Lychee Link Check Report
📊 Results Overview
Errors per inputErrors in 800-guides/380-vercel-app-deployment.mdx
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
content/800-guides/450-management-api-api-clients.mdx (3)
10-208: Consider adding example responses to help users validate success.All three sections show the request payload but don't include an example of a successful response. Adding a sample response (e.g., showing the created project object with its ID, status, etc.) would help users:
- Verify their request succeeded
- Understand the API's response structure
- Recognize if something went wrong
Example response to add after each "Click **Send**" instruction
{ "id": "project_abc123xyz", "name": "My Postman Database", "region": "us-east-1", "status": "active", "createdAt": "2025-12-30T18:00:00Z" }Note: Adjust the response structure to match your actual API response format.
164-173: Explain why Yaak uses service tokens instead of OAuth2.The Postman and Insomnia sections use OAuth2 authentication, while Yaak uses service tokens. This difference isn't explained, which may confuse users comparing the approaches.
Consider adding a brief note explaining:
- Whether Yaak supports OAuth2 (and if not, why service tokens are the alternative)
- Any permission or security differences between OAuth2 tokens and service tokens
- Whether users should prefer one authentication method over another for their use case
1-9: Consider adding an introductory section about the Management API.The document jumps directly into tool-specific instructions without explaining what the Management API is or linking to comprehensive API documentation. Users landing on this page might lack context about:
- What the Management API offers
- Where to find the complete API reference
- What other endpoints are available beyond the example project creation
Adding a brief introduction with links to broader documentation would improve discoverability and user understanding.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/800-guides/450-management-api-api-clients.mdx
🧰 Additional context used
🪛 LanguageTool
content/800-guides/450-management-api-api-clients.mdx
[grammar] ~154-~154: Ensure spelling is correct
Context: ...e confirming your project creation. ## Yaak Yaak is a lightweight, native API client...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Check internal links
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
content/800-guides/450-management-api-api-clients.mdx (1)
154-154: Static analysis false positive: "Yaak" spelling is correct.The LanguageTool hint flagging "Yaak" as a spelling error is a false positive. Based on the past review comments, this was already addressed by adding "Yaak" to the cspell dictionary in commit ad37e6e.
Added a page with guides for using the management api in Postman, Insomnia, and Yaak
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.