refactor: chore make management API docs more visible #7059

ankur-arch · 2025-08-06T08:25:24Z

Summary by CodeRabbit

Documentation
- Improved the Management API documentation with clearer instructions, interactive OpenAPI specification details, and added a new "Guides" section for common scenarios.
- Enhanced step-by-step guidance for creating service tokens in the Prisma Console.
- Updated multiple internal documentation links to reflect new paths for Management API and error reference sections across Postgres and Accelerate guides.
Chores
- Added and updated static and dynamic redirects for Management API and error reference documentation paths to ensure seamless navigation.

coderabbitai · 2025-08-06T08:25:31Z

Walkthrough

The changes update the Prisma Management API documentation with clearer instructions and add a new guides section. Additionally, static redirect rules are introduced and expanded to ensure old documentation paths for the Management API and error references correctly point to their new locations, including support for wildcard subpaths. Multiple internal links in various Postgres and Accelerate docs were updated to reflect the new error-reference URL path.

Changes

Cohort / File(s)	Change Summary
Management API Documentation `content/250-postgres/100-introduction/230-management-api.mdx`	Expanded and clarified documentation for the Prisma Management API, including improved OpenAPI spec explanation, a new guides section, and detailed step-by-step service token creation instructions.
Internal Link Updates to Error Reference `content/250-postgres/1200-more/1000-faq.mdx`, `content/250-postgres/300-database/400-connection-pooling.mdx`, `content/250-postgres/300-database/800-api-reference/100-caching-api.mdx`, `content/300-accelerate/600-faq.mdx`	Updated internal links referencing the error documentation from `/postgres/database/error-reference` to `/postgres/database/api-reference/error-reference`.
Management API Link Corrections in Guides `content/800-guides/240-management-api.mdx`, `content/800-guides/330-management-api-basic.mdx`	Corrected internal links for the Prisma Management API documentation URLs to point to `/postgres/introduction/management-api` instead of `/postgres/database/api-reference/management-api`.
Static Redirects `static/_redirects`	Added and extended redirect rules for Management API and error reference documentation, including explicit and wildcard redirects for legacy paths to their new documentation locations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e20f213 and 057e993.

📒 Files selected for processing (7)

content/250-postgres/1200-more/1000-faq.mdx (1 hunks)
content/250-postgres/300-database/400-connection-pooling.mdx (4 hunks)
content/250-postgres/300-database/800-api-reference/100-caching-api.mdx (1 hunks)
content/300-accelerate/600-faq.mdx (1 hunks)
content/800-guides/240-management-api.mdx (2 hunks)
content/800-guides/330-management-api-basic.mdx (1 hunks)
static/_redirects (2 hunks)

✅ Files skipped from review due to trivial changes (6)

content/300-accelerate/600-faq.mdx
content/250-postgres/300-database/800-api-reference/100-caching-api.mdx
content/800-guides/240-management-api.mdx
content/800-guides/330-management-api-basic.mdx
content/250-postgres/1200-more/1000-faq.mdx
content/250-postgres/300-database/400-connection-pooling.mdx

🚧 Files skipped from review as they are similar to previous changes (1)

static/_redirects

⏰ 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). (3)

GitHub Check: Check internal links
GitHub Check: runner / linkspector
GitHub Check: Lost Pixel

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch DC-4688

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-08-06T08:25:38Z

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

github-actions · 2025-08-06T08:25:43Z

original	preview
content/250-postgres/1200-more/1000-faq.mdx	content/250-postgres/1200-more/1000-faq.mdx
content/250-postgres/300-database/400-connection-pooling.mdx	content/250-postgres/300-database/400-connection-pooling.mdx
content/250-postgres/300-database/800-api-reference/100-caching-api.mdx	content/250-postgres/300-database/800-api-reference/100-caching-api.mdx
content/300-accelerate/600-faq.mdx	content/300-accelerate/600-faq.mdx
content/800-guides/240-management-api.mdx	content/800-guides/240-management-api.mdx
content/800-guides/330-management-api-basic.mdx	content/800-guides/330-management-api-basic.mdx
content/250-postgres/100-introduction/230-management-api.mdx	content/250-postgres/100-introduction/230-management-api.mdx
content/250-postgres/300-database/800-api-reference/200-error-reference.mdx	content/250-postgres/300-database/800-api-reference/200-error-reference.mdx

github-actions · 2025-08-06T08:25:45Z

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

/postgres/database/api-reference/management-api /docs/postgres/introduction/management-api
/postgres/database/error-reference /docs/postgres/database/api-reference/error-reference

cloudflare-workers-and-pages · 2025-08-06T08:27:40Z

Deploying docs with Cloudflare Pages

Latest commit:	`057e993`
Status:	✅ Deploy successful!
Preview URL:	https://f34ed963.docs-51g.pages.dev
Branch Preview URL:	https://dc-4688.docs-51g.pages.dev

View logs

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

static/_redirects (1)
564-565: Redirect covers only the root path – consider adding a wildcard splat

/postgres/database/api-reference/management-api will work, but /postgres/database/api-reference/management-api/<subpage> will 404.
Unless you intend every sub-URL to 404, add a splat redirect similar to the one used for error-reference:
-/postgres/database/api-reference/management-api /docs/postgres/introduction/management-api
+/postgres/database/api-reference/management-api* /docs/postgres/introduction/management-api:splat
content/250-postgres/100-introduction/230-management-api.mdx (1)
53-61: Numbered list renders as one long “1.” list

In MDX/Markdown a blank line is required before a numbered list to restart automatic numbering.
Current output will render all items as 1.. Insert an empty line before the list or use explicit numbers:
You can create a service token to use the Management API like this:

1. Open the …
Also confirm the UI labels (“Integrations”, “New service token”) exactly match the Console; mismatched wording confuses readers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1c125b9 and e20f213.

📒 Files selected for processing (2)

content/250-postgres/100-introduction/230-management-api.mdx (2 hunks)
static/_redirects (2 hunks)

⏰ 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). (4)

GitHub Check: Check internal links
GitHub Check: runner / linkspector
GitHub Check: Lost Pixel
GitHub Check: Cloudflare Pages

🔇 Additional comments (2)

content/250-postgres/100-introduction/230-management-api.mdx (2)

13-14: Verify OpenAPI playground URL

The link now points at https://api.prisma.io/v1/swagger-editor.
Previous docs used /v0/…; make sure the v1 endpoint is publicly reachable and contains the 3.1 spec before publishing.

16-22: Guide slugs may not exist yet

Double-check that the three guide routes resolve:

/guides/management-api-basic

/guides/github-actions

/guides/management-api

If any of these are placeholders or have different slugs (e.g. live at /guides/management-api/overview), users will hit 404s.

static/_redirects

* refactor: chore make management API docs more visible * fix: broken links

refactor: chore make management API docs more visible

e20f213

coderabbitai bot requested changes Aug 6, 2025

View reviewed changes

static/_redirects Outdated Show resolved Hide resolved

fix: broken links

057e993

coderabbitai bot approved these changes Aug 6, 2025

View reviewed changes

ankur-arch self-assigned this Aug 6, 2025

ankur-arch requested a review from nikolasburk August 6, 2025 08:48

ankur-arch merged commit 7f087eb into main Aug 6, 2025
8 of 9 checks passed

ankur-arch deleted the DC-4688 branch August 6, 2025 08:49

This was referenced Aug 13, 2025

fix: updated service token instructions #7071

Merged

fix: add new service token steps #7072

Merged

coderabbitai bot mentioned this pull request Aug 25, 2025

feat: updated docs for 6.15 #7083

Merged

jlecordier pushed a commit to jlecordier/docs-1 that referenced this pull request Sep 3, 2025

refactor: chore make management API docs more visible (prisma#7059)

be52727

* refactor: chore make management API docs more visible * fix: broken links

This was referenced Oct 22, 2025

DC-5694 OAuth Clarification #7205

Merged

fix: content changes for getting started page #7216

Merged

coderabbitai bot mentioned this pull request Nov 5, 2025

docs(): update for the 6.19 release #7232

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: chore make management API docs more visible #7059

refactor: chore make management API docs more visible #7059

Uh oh!

ankur-arch commented Aug 6, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 6, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Aug 6, 2025

Uh oh!

github-actions bot commented Aug 6, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 6, 2025

Uh oh!

cloudflare-workers-and-pages bot commented Aug 6, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

refactor: chore make management API docs more visible #7059

refactor: chore make management API docs more visible #7059

Uh oh!

Conversation

ankur-arch commented Aug 6, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Aug 6, 2025

Dangerous URL check

Uh oh!

github-actions bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 6, 2025

Redirect check

Uh oh!

cloudflare-workers-and-pages bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying docs with Cloudflare Pages

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ankur-arch commented Aug 6, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Aug 6, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Aug 6, 2025 •

edited

Loading