fix(docs): fix management API docs generation and regenerate files by kristof-siket · Pull Request #7593 · prisma/web

kristof-siket · 2026-03-06T10:00:56Z

Problem

The docs sync workflow pushes generated MDX files directly to main, but the generation produces files that break three CI workflows:

Workflow	Failure
Links	Missing required frontmatter (`url`, `metaTitle`, `metaDescription`)
Docs Tests	27 build errors from invalid frontmatter
Spellcheck	Corrupted content from filename collisions

Root causes in generate-docs.ts:

Missing frontmatter: beforeWrite only injected _openapi.path, not the three SEO fields required by source.config.ts.
Filename collisions: /By[A-Z][a-z]*/g strips ById entirely, so GET /v1/projects and GET /v1/projects/{id} both produce get-projects.mdx. The second write corrupts the first.
Unsafe replacement: String.replace(frontmatter, ...) matches content body text, causing further corruption.

Changes

`apps/docs/scripts/generate-docs.ts`

Derive and inject url, metaTitle, metaDescription from operation metadata in beforeWrite
Fix naming regex: By[A-Z][a-z]* → By[A-Z][a-z]{2,} — preserves ById as -by-id, preventing collisions
Use slice-based content replacement instead of String.replace
Add guard to skip SEO metadata when required fields are missing, with fallback to extract apiPath from _openapi.path frontmatter
Scope _openapi.path injection to the _openapi YAML block only

`.github/workflows/sync-management-api-docs.yml`

Clean stale files: delete all *.mdx before generation so renamed endpoints don't accumulate
Full validation before commit: lint:links + lint:spellcheck + next build — if any check fails, nothing is pushed to main
Gate all post-generation steps on changes detected (skip validation, commit, push, and Vercel deploy when the spec hasn't changed)

`apps/docs/src/app/og/[...slug]/route.tsx`

Add PATCH and PUT to HTTP_METHOD_COLORS — previously only GET/POST/DELETE were mapped, causing Satori to crash on "3px solid undefined" CSS when rendering OG images for PATCH endpoints
Add fallback color (#a0aec0) for any unknown HTTP methods
Widen method type from union to string for future-proofing

Regenerated MDX files & meta.json

Since main is currently in a broken state, this PR also includes the correctly regenerated output so that merging immediately restores CI:

31 regenerated endpoint MDX files with correct frontmatter
New meta.json for connections, regions, workspaces directories
Updated meta.json for databases, integrations, projects, databases-connections, and top-level endpoints
Removed stale files from old naming conventions (e.g. delete-connections.mdx → delete-connections-by-id.mdx)

Test plan

CI passes on this PR (links, spellcheck, docs build, Vercel preview, Playwright)
Merge and trigger sync workflow via workflow_dispatch
Verify all validation steps pass (lint:links, lint:spellcheck, build)
Verify the commit to main has correct frontmatter and no stale files
Verify docs site deploys and renders all endpoint pages
Verify OG images render correctly for PATCH endpoints

vercel · 2026-03-06T10:01:01Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
blog	Ready	Preview, Comment	Mar 6, 2026 11:44am
docs	Ready	Preview, Comment	Mar 6, 2026 11:44am
eclipse	Ready	Preview, Comment	Mar 6, 2026 11:44am

coderabbitai · 2026-03-06T10:01:43Z

Walkthrough

Two files updated: CI workflow adds cleanup and validation steps for generated documentation, and generation script refines operation name parsing, enhances frontmatter handling with title/method/path extraction, and implements metadata computation with content rewriting for MDX files.

Changes

Cohort / File(s)	Summary
CI/CD Workflow `.github/workflows/sync-management-api-docs.yml`	Adds a cleanup step to delete stale MDX files in `apps/docs/content/docs/management-api/endpoints`, introduces post-generation validation steps (link checking, spellcheck, build), and gates Vercel deployment on change detection.
Docs Generation Script `apps/docs/scripts/generate-docs.ts`	Tightens operation name cleanup regex, adds early validation for missing frontmatter, improves frontmatter field injection (path/method only when `_openapi` exists), extracts title/method/apiPath from multiple sources, derives description from post-frontmatter content, generates slug-based URL metadata, and rewrites files with updated frontmatter while preserving original content.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title accurately reflects the main objective: fixing docs generation issues and injecting required frontmatter fields into generated API docs.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

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

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

argos-ci · 2026-03-06T10:03:52Z

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

Build	Status	Details	Updated (UTC)
default (Inspect)	⚠️ Changes detected (Review)	1 removed	Mar 6, 2026, 11:52 AM

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/sync-management-api-docs.yml:
- Around line 44-57: The current check loop (variable missing, the for field in
url metaTitle metaDescription; do ... grep -q "^${field}:" "$1") inspects the
whole MDX file and allows matches in body content; change it to first extract
only the YAML frontmatter block (between the leading and trailing ---) for each
file and then assert each key exists with a non-empty value (e.g., test for a
pattern like '^field: .+' inside that extracted block rather than '^field:' in
the whole file). Update the shell snippet that sets missing to extract
frontmatter (using awk/sed or a YAML tool) and run the per-field grep/regex
against that extracted content, preserving the same variable names (missing,
field) and exit/error behavior when any required frontmatter key is absent or
empty.

In `@apps/docs/scripts/generate-docs.ts`:
- Around line 49-55: The JSON.parse of operations can fail leaving apiPath empty
which later produces malformed SEO metadata; update the try/catch around the
operations parsing (the block that sets apiPath from operations[0]?.path) to
either (A) throw or return early when parsing fails or operations[0]?.path is
absent, or (B) guard emission of metaTitle/metaDescription so they are only
constructed/written when apiPath is non-empty (use a fallback like _openapi.path
if available before emitting). Concretely, ensure the parsing catch logs the
error and aborts generation for that file (or sets a clear fallback), and wrap
the code that builds/writes metaTitle/metaDescription so it runs only when
apiPath (or an explicit fallback) is present.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: aeec1e50-0811-4e78-915b-83963e9e953f

📥 Commits

Reviewing files that changed from the base of the PR and between cdf8696 and 6850d17.

📒 Files selected for processing (2)

.github/workflows/sync-management-api-docs.yml
apps/docs/scripts/generate-docs.ts

.github/workflows/sync-management-api-docs.yml

apps/docs/scripts/generate-docs.ts

coderabbitai

♻️ Duplicate comments (1)

apps/docs/scripts/generate-docs.ts (1)

47-55: ⚠️ Potential issue | 🟠 Major

Guard SEO metadata emission when API operation parsing fails.

At Line 49–Line 55, parse failures only warn and continue; then Line 79–Line 85 still emit metadata using possibly empty apiPath/method, producing malformed values.

Suggested fix

       let apiPath = "";
       if (apiPageMatch) {
         try {
           const operations = JSON.parse(apiPageMatch[1].replace(/'/g, '"'));
           if (operations[0]?.path) {
             apiPath = operations[0].path;
           }
         } catch (e) {
           console.warn(`Failed to parse operations for ${file.path}:`, e);
         }
       }
+
+      if (!method || !apiPath || !title) {
+        console.warn(
+          `Skipping SEO metadata for ${file.path} (missing method/path/title)`,
+        );
+        file.content =
+          `---\n${frontmatter}\n---` + file.content.slice(frontmatterMatch[0].length);
+        continue;
+      }
 
       const slug = file.path
         .replace(/^.*endpoints\//, "")
         .replace(/\.mdx$/, "");

Also applies to: 79-85

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@apps/docs/scripts/generate-docs.ts` around lines 47 - 55, Parsing of
apiPageMatch into operations can fail but the code still emits SEO metadata
using apiPath/method; update the logic so metadata is only emitted when parsing
succeeded and valid values exist: inside the try/catch, set apiPath and method
only if operations[0]?.path and operations[0]?.method are present, and in the
emission block (the code that uses apiPath/method) add a guard that skips
emitting or continues if apiPath or method are falsy (or set a parseFailed flag
in the catch and check it before emitting). Reference variables/api symbols:
apiPageMatch, operations, apiPath, method, file.path.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@apps/docs/scripts/generate-docs.ts`:
- Around line 47-55: Parsing of apiPageMatch into operations can fail but the
code still emits SEO metadata using apiPath/method; update the logic so metadata
is only emitted when parsing succeeded and valid values exist: inside the
try/catch, set apiPath and method only if operations[0]?.path and
operations[0]?.method are present, and in the emission block (the code that uses
apiPath/method) add a guard that skips emitting or continues if apiPath or
method are falsy (or set a parseFailed flag in the catch and check it before
emitting). Reference variables/api symbols: apiPageMatch, operations, apiPath,
method, file.path.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 12cca744-0f31-41fd-8f8c-5460413478c3

📥 Commits

Reviewing files that changed from the base of the PR and between 6850d17 and 6e7d75f.

📒 Files selected for processing (42)

.github/workflows/sync-management-api-docs.yml
apps/docs/content/docs/management-api/endpoints/connections/delete-connections-by-id.mdx
apps/docs/content/docs/management-api/endpoints/connections/get-connections-by-id.mdx
apps/docs/content/docs/management-api/endpoints/connections/get-connections.mdx
apps/docs/content/docs/management-api/endpoints/connections/meta.json
apps/docs/content/docs/management-api/endpoints/connections/post-connections.mdx
apps/docs/content/docs/management-api/endpoints/database-backups/get-databases-id-backups.mdx
apps/docs/content/docs/management-api/endpoints/database-usage/get-databases-id-usage.mdx
apps/docs/content/docs/management-api/endpoints/databases-connections/delete-connections.mdx
apps/docs/content/docs/management-api/endpoints/databases-connections/get-databases-id-connections.mdx
apps/docs/content/docs/management-api/endpoints/databases-connections/meta.json
apps/docs/content/docs/management-api/endpoints/databases-connections/post-databases-id-connections.mdx
apps/docs/content/docs/management-api/endpoints/databases/delete-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/get-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/get-databases.mdx
apps/docs/content/docs/management-api/endpoints/databases/get-projects-id-databases.mdx
apps/docs/content/docs/management-api/endpoints/databases/meta.json
apps/docs/content/docs/management-api/endpoints/databases/patch-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/post-databases.mdx
apps/docs/content/docs/management-api/endpoints/databases/post-projects-id-databases.mdx
apps/docs/content/docs/management-api/endpoints/integrations/delete-integrations-by-id.mdx
apps/docs/content/docs/management-api/endpoints/integrations/delete-workspaces-id-integrations-id.mdx
apps/docs/content/docs/management-api/endpoints/integrations/get-integrations-by-id.mdx
apps/docs/content/docs/management-api/endpoints/integrations/get-integrations.mdx
apps/docs/content/docs/management-api/endpoints/integrations/get-workspaces-id-integrations.mdx
apps/docs/content/docs/management-api/endpoints/integrations/meta.json
apps/docs/content/docs/management-api/endpoints/meta.json
apps/docs/content/docs/management-api/endpoints/misc/get-regions-accelerate.mdx
apps/docs/content/docs/management-api/endpoints/misc/get-regions-postgres.mdx
apps/docs/content/docs/management-api/endpoints/projects/delete-projects-by-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/get-projects-by-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/get-projects.mdx
apps/docs/content/docs/management-api/endpoints/projects/meta.json
apps/docs/content/docs/management-api/endpoints/projects/patch-projects-by-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/post-projects-by-id-transfer.mdx
apps/docs/content/docs/management-api/endpoints/projects/post-projects.mdx
apps/docs/content/docs/management-api/endpoints/regions/get-regions.mdx
apps/docs/content/docs/management-api/endpoints/regions/meta.json
apps/docs/content/docs/management-api/endpoints/workspaces/get-workspaces-by-id.mdx
apps/docs/content/docs/management-api/endpoints/workspaces/get-workspaces.mdx
apps/docs/content/docs/management-api/endpoints/workspaces/meta.json
apps/docs/scripts/generate-docs.ts

💤 Files with no reviewable changes (1)

apps/docs/content/docs/management-api/endpoints/databases-connections/delete-connections.mdx

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

apps/docs/content/docs/management-api/endpoints/misc/get-regions-postgres.mdx
apps/docs/content/docs/management-api/endpoints/misc/get-regions-accelerate.mdx
apps/docs/content/docs/management-api/endpoints/projects/post-projects-by-id-transfer.mdx
apps/docs/content/docs/management-api/endpoints/databases/delete-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/database-usage/get-databases-id-usage.mdx
apps/docs/content/docs/management-api/endpoints/databases/post-databases.mdx
apps/docs/content/docs/management-api/endpoints/connections/meta.json
apps/docs/content/docs/management-api/endpoints/integrations/get-workspaces-id-integrations.mdx
apps/docs/content/docs/management-api/endpoints/databases/patch-databases-id.mdx

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

.github/workflows/sync-management-api-docs.yml

coderabbitai

♻️ Duplicate comments (1)

apps/docs/scripts/generate-docs.ts (1)

43-55: ⚠️ Potential issue | 🟠 Major

Guard SEO field emission when apiPath cannot be derived.

At Line [79] and Line [81], metadata is generated even if apiPath is empty (e.g., APIPage parse failure at Line [49]-Line [55]). That can produce malformed frontmatter and fail CI validators.

💡 Proposed hardening diff

       const apiPageMatch = file.content.match(
         /<APIPage[^>]*operations=\{(\[.*?\])\}/s,
       );
-      let apiPath = "";
-      if (apiPageMatch) {
+      const openapiPathMatch = frontmatter.match(
+        /^\s*path:\s*["']?([^"'\n]+)["']?\s*$/m,
+      );
+      let apiPath = openapiPathMatch?.[1] ?? "";
+
+      if (!apiPath && apiPageMatch) {
         try {
           const operations = JSON.parse(apiPageMatch[1].replace(/'/g, '"'));
           if (operations[0]?.path) {
             apiPath = operations[0].path;
           }
         } catch (e) {
           console.warn(`Failed to parse operations for ${file.path}:`, e);
         }
       }
+
+      if (!method || !title || !apiPath) {
+        console.warn(
+          `Skipping SEO metadata for ${file.path}: missing method/title/path.`,
+        );
+        continue;
+      }
@@
       const metaTitle = `${method} ${apiPath} | ${title} - Prisma Postgres`;
       const descriptionClean = description.replace(/\.$/, "");
       const metaDescription = `Management API: ${descriptionClean}. ${method} ${apiPath}.`;

Also applies to: 79-85

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@apps/docs/scripts/generate-docs.ts` around lines 43 - 55, The
metadata/frontmatter emission currently unconditionally includes SEO fields even
when apiPath is empty (apiPageMatch / operations parsing may fail and leave
apiPath === ""), so update the generation logic to guard emission: where
frontmatter/metadata is assembled (around the code that uses apiPath at the
metadata generation section), check that apiPath is non-empty before adding
SEO-related entries (or skip emitting the whole SEO block) to avoid producing
malformed frontmatter; locate the variables apiPageMatch, operations and apiPath
in generate-docs.ts and conditionally include the metadata only when apiPath is
truthy (or provide a safe default/omit the keys) so CI validators won’t fail.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@apps/docs/scripts/generate-docs.ts`:
- Around line 43-55: The metadata/frontmatter emission currently unconditionally
includes SEO fields even when apiPath is empty (apiPageMatch / operations
parsing may fail and leave apiPath === ""), so update the generation logic to
guard emission: where frontmatter/metadata is assembled (around the code that
uses apiPath at the metadata generation section), check that apiPath is
non-empty before adding SEO-related entries (or skip emitting the whole SEO
block) to avoid producing malformed frontmatter; locate the variables
apiPageMatch, operations and apiPath in generate-docs.ts and conditionally
include the metadata only when apiPath is truthy (or provide a safe default/omit
the keys) so CI validators won’t fail.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 145a5fab-e90e-4348-947c-db4fb8f67b99

📥 Commits

Reviewing files that changed from the base of the PR and between 6e7d75f and 831c448.

📒 Files selected for processing (42)

.github/workflows/sync-management-api-docs.yml
apps/docs/content/docs/management-api/endpoints/connections/delete-connections-by-id.mdx
apps/docs/content/docs/management-api/endpoints/connections/get-connections-by-id.mdx
apps/docs/content/docs/management-api/endpoints/connections/get-connections.mdx
apps/docs/content/docs/management-api/endpoints/connections/meta.json
apps/docs/content/docs/management-api/endpoints/connections/post-connections.mdx
apps/docs/content/docs/management-api/endpoints/database-backups/get-databases-id-backups.mdx
apps/docs/content/docs/management-api/endpoints/database-usage/get-databases-id-usage.mdx
apps/docs/content/docs/management-api/endpoints/databases-connections/delete-connections.mdx
apps/docs/content/docs/management-api/endpoints/databases-connections/get-databases-id-connections.mdx
apps/docs/content/docs/management-api/endpoints/databases-connections/meta.json
apps/docs/content/docs/management-api/endpoints/databases-connections/post-databases-id-connections.mdx
apps/docs/content/docs/management-api/endpoints/databases/delete-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/get-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/get-databases.mdx
apps/docs/content/docs/management-api/endpoints/databases/get-projects-id-databases.mdx
apps/docs/content/docs/management-api/endpoints/databases/meta.json
apps/docs/content/docs/management-api/endpoints/databases/patch-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/post-databases.mdx
apps/docs/content/docs/management-api/endpoints/databases/post-projects-id-databases.mdx
apps/docs/content/docs/management-api/endpoints/integrations/delete-integrations-by-id.mdx
apps/docs/content/docs/management-api/endpoints/integrations/delete-workspaces-id-integrations-id.mdx
apps/docs/content/docs/management-api/endpoints/integrations/get-integrations-by-id.mdx
apps/docs/content/docs/management-api/endpoints/integrations/get-integrations.mdx
apps/docs/content/docs/management-api/endpoints/integrations/get-workspaces-id-integrations.mdx
apps/docs/content/docs/management-api/endpoints/integrations/meta.json
apps/docs/content/docs/management-api/endpoints/meta.json
apps/docs/content/docs/management-api/endpoints/misc/get-regions-accelerate.mdx
apps/docs/content/docs/management-api/endpoints/misc/get-regions-postgres.mdx
apps/docs/content/docs/management-api/endpoints/projects/delete-projects-by-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/get-projects-by-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/get-projects.mdx
apps/docs/content/docs/management-api/endpoints/projects/meta.json
apps/docs/content/docs/management-api/endpoints/projects/patch-projects-by-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/post-projects-by-id-transfer.mdx
apps/docs/content/docs/management-api/endpoints/projects/post-projects.mdx
apps/docs/content/docs/management-api/endpoints/regions/get-regions.mdx
apps/docs/content/docs/management-api/endpoints/regions/meta.json
apps/docs/content/docs/management-api/endpoints/workspaces/get-workspaces-by-id.mdx
apps/docs/content/docs/management-api/endpoints/workspaces/get-workspaces.mdx
apps/docs/content/docs/management-api/endpoints/workspaces/meta.json
apps/docs/scripts/generate-docs.ts

💤 Files with no reviewable changes (1)

apps/docs/content/docs/management-api/endpoints/databases-connections/delete-connections.mdx

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

apps/docs/content/docs/management-api/endpoints/databases-connections/get-databases-id-connections.mdx

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

apps/docs/content/docs/management-api/endpoints/projects/post-projects.mdx
.github/workflows/sync-management-api-docs.yml
apps/docs/content/docs/management-api/endpoints/projects/post-projects-by-id-transfer.mdx
apps/docs/content/docs/management-api/endpoints/workspaces/meta.json
apps/docs/content/docs/management-api/endpoints/database-usage/get-databases-id-usage.mdx
apps/docs/content/docs/management-api/endpoints/databases/patch-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/database-backups/get-databases-id-backups.mdx
apps/docs/content/docs/management-api/endpoints/workspaces/get-workspaces-by-id.mdx
apps/docs/content/docs/management-api/endpoints/misc/get-regions-accelerate.mdx
apps/docs/content/docs/management-api/endpoints/integrations/get-workspaces-id-integrations.mdx
apps/docs/content/docs/management-api/endpoints/databases-connections/meta.json
apps/docs/content/docs/management-api/endpoints/misc/get-regions-postgres.mdx
apps/docs/content/docs/management-api/endpoints/connections/post-connections.mdx
apps/docs/content/docs/management-api/endpoints/regions/get-regions.mdx
apps/docs/content/docs/management-api/endpoints/connections/delete-connections-by-id.mdx
apps/docs/content/docs/management-api/endpoints/workspaces/get-workspaces.mdx
apps/docs/content/docs/management-api/endpoints/integrations/delete-integrations-by-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/delete-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/delete-projects-by-id.mdx
apps/docs/content/docs/management-api/endpoints/connections/meta.json
apps/docs/content/docs/management-api/endpoints/databases/post-databases.mdx
apps/docs/content/docs/management-api/endpoints/databases/get-databases-id.mdx
apps/docs/content/docs/management-api/endpoints/databases/meta.json
apps/docs/content/docs/management-api/endpoints/integrations/get-integrations-by-id.mdx
apps/docs/content/docs/management-api/endpoints/projects/get-projects.mdx
apps/docs/content/docs/management-api/endpoints/regions/meta.json
apps/docs/content/docs/management-api/endpoints/meta.json

.github/workflows/sync-management-api-docs.yml

… files - Fix generate-docs.ts: inject required frontmatter (url, metaTitle, metaDescription), fix filename collisions for ById endpoints, use slice-based content replacement to prevent corruption, add SEO guard - Update sync workflow: add stale file cleanup, comprehensive validation (lint:links, lint:spellcheck, next build) before committing - Include regenerated MDX files and updated meta.json to restore CI on main

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@apps/docs/scripts/generate-docs.ts`:
- Around line 65-74: The current check uses !frontmatter.includes("path:") which
scans the whole frontmatter and can miss injecting _openapi.path when another
top-level path exists; update the logic to detect the _openapi block and only
test that block for a missing "path:" before injecting. Concretely, locate the
code manipulating frontmatter (the frontmatter variable and the replace call),
extract the _openapi block (e.g., with a regex that captures
/_openapi:\s*\n([\s\S]*?)(\n\S|$)/), check whether that captured block contains
"path:" and only when it does not, perform the replace/injection of `path:
"${apiPath}"` into the _openapi block; ensure you still require apiPath and
preserve the existing replace call on the _openapi section.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0bc75038-855a-4319-9e2a-86f15aaa80e4

📥 Commits

Reviewing files that changed from the base of the PR and between 831c448 and 825633e.

📒 Files selected for processing (2)

.github/workflows/sync-management-api-docs.yml
apps/docs/scripts/generate-docs.ts

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

.github/workflows/sync-management-api-docs.yml

apps/docs/scripts/generate-docs.ts

Address CodeRabbit review: the previous `frontmatter.includes("path:")` check scanned the entire frontmatter. Now we extract the `_openapi:` block first and only check/inject `path:` within that block.

kristof-siket · 2026-03-06T11:36:43Z

@coderabbitai review

The OG image route only had GET, POST, DELETE in HTTP_METHOD_COLORS. PATCH endpoints (now valid with correct frontmatter) caused Satori to crash on "3px solid undefined" CSS. Add PATCH/PUT colors and a fallback for any future unknown methods.

vercel bot deployed to Preview – eclipse March 6, 2026 10:01 View deployment

vercel bot had a problem deploying to Preview – docs March 6, 2026 10:01 Failure

vercel bot deployed to Preview – blog March 6, 2026 10:05 View deployment

coderabbitai bot requested changes Mar 6, 2026

View reviewed changes

.github/workflows/sync-management-api-docs.yml Outdated Show resolved Hide resolved

apps/docs/scripts/generate-docs.ts Show resolved Hide resolved

kristof-siket force-pushed the fix/generate-docs-frontmatter branch from 6850d17 to 6e7d75f Compare March 6, 2026 10:13

vercel bot deployed to Preview – eclipse March 6, 2026 10:14 View deployment

vercel bot deployed to Preview – blog March 6, 2026 10:14 View deployment

vercel bot had a problem deploying to Preview – docs March 6, 2026 10:16 Failure

coderabbitai bot reviewed Mar 6, 2026

View reviewed changes

kristof-siket force-pushed the fix/generate-docs-frontmatter branch from 6e7d75f to 831c448 Compare March 6, 2026 10:41

vercel bot deployed to Preview – eclipse March 6, 2026 10:42 View deployment

vercel bot deployed to Preview – blog March 6, 2026 10:43 View deployment

vercel bot had a problem deploying to Preview – docs March 6, 2026 10:46 Failure

coderabbitai bot reviewed Mar 6, 2026

View reviewed changes

kristof-siket force-pushed the fix/generate-docs-frontmatter branch from 831c448 to d4b7354 Compare March 6, 2026 11:01

vercel bot deployed to Preview – eclipse March 6, 2026 11:02 View deployment

vercel bot had a problem deploying to Preview – docs March 6, 2026 11:02 Failure

vercel bot deployed to Preview – blog March 6, 2026 11:02 View deployment

kristof-siket commented Mar 6, 2026

View reviewed changes

.github/workflows/sync-management-api-docs.yml Show resolved Hide resolved

kristof-siket force-pushed the fix/generate-docs-frontmatter branch from d4b7354 to 825633e Compare March 6, 2026 11:13

vercel bot deployed to Preview – eclipse March 6, 2026 11:14 View deployment

vercel bot deployed to Preview – blog March 6, 2026 11:14 View deployment

vercel bot had a problem deploying to Preview – docs March 6, 2026 11:16 Failure

kristof-siket force-pushed the fix/generate-docs-frontmatter branch from 825633e to d098090 Compare March 6, 2026 11:18

coderabbitai bot requested changes Mar 6, 2026

View reviewed changes

apps/docs/scripts/generate-docs.ts Outdated Show resolved Hide resolved

kristof-siket changed the title ~~fix(docs): inject required frontmatter in generated API docs~~ fix(docs): fix management API docs generation and regenerate files Mar 6, 2026

vercel bot deployed to Preview – eclipse March 6, 2026 11:19 View deployment

vercel bot deployed to Preview – blog March 6, 2026 11:19 View deployment

vercel bot had a problem deploying to Preview – docs March 6, 2026 11:22 Failure

fix(docs): scope _openapi path detection to its YAML block

923026e

Address CodeRabbit review: the previous `frontmatter.includes("path:")` check scanned the entire frontmatter. Now we extract the `_openapi:` block first and only check/inject `path:` within that block.

vercel bot deployed to Preview – eclipse March 6, 2026 11:25 View deployment

vercel bot deployed to Preview – blog March 6, 2026 11:25 View deployment

vercel bot had a problem deploying to Preview – docs March 6, 2026 11:26 Failure

vercel bot deployed to Preview – eclipse March 6, 2026 11:42 View deployment

vercel bot deployed to Preview – blog March 6, 2026 11:42 View deployment

vercel bot deployed to Preview – docs March 6, 2026 11:44 View deployment

coderabbitai bot approved these changes Mar 6, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs): fix management API docs generation and regenerate files#7593

fix(docs): fix management API docs generation and regenerate files#7593
kristof-siket wants to merge 3 commits intomainfrom
fix/generate-docs-frontmatter

kristof-siket commented Mar 6, 2026 •

edited

Loading

Uh oh!

vercel bot commented Mar 6, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 6, 2026 •

edited

Loading

Uh oh!

argos-ci bot commented Mar 6, 2026 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

kristof-siket commented Mar 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

kristof-siket commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Changes

apps/docs/scripts/generate-docs.ts

.github/workflows/sync-management-api-docs.yml

apps/docs/src/app/og/[...slug]/route.tsx

Regenerated MDX files & meta.json

Test plan

Uh oh!

vercel bot commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

argos-ci bot commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kristof-siket commented Mar 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

kristof-siket commented Mar 6, 2026 •

edited

Loading

`apps/docs/scripts/generate-docs.ts`

`.github/workflows/sync-management-api-docs.yml`

`apps/docs/src/app/og/[...slug]/route.tsx`

vercel bot commented Mar 6, 2026 •

edited

Loading

coderabbitai bot commented Mar 6, 2026 •

edited

Loading

argos-ci bot commented Mar 6, 2026 •

edited

Loading