Skip to content

fix api endpoint documentation sync#283

Merged
thebiglabasky merged 2 commits into
mainfrom
herve/fix-api-doc-sync
May 5, 2026
Merged

fix api endpoint documentation sync#283
thebiglabasky merged 2 commits into
mainfrom
herve/fix-api-doc-sync

Conversation

@thebiglabasky
Copy link
Copy Markdown
Contributor

@thebiglabasky thebiglabasky commented May 5, 2026

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

Notes for the Reviewer

Fixes the generated API endpoint PR workflow so new endpoint stubs are added to the API Reference tab in docs.json instead of silently skipping navigation.

Also:

  • fails the workflow if docs.json cannot be updated
  • avoids overwriting existing endpoint pages when summaries collide, such as /v1/check-sessions/* and /v2/check-sessions/*
  • allows regeneration after a stale generated PR is closed by using a suffixed branch when the old remote branch still exists
  • writes the PR body through --body-file so Markdown code spans are preserved
  • adds the closed bulk status-page subscription endpoint to .api-doc-ignore so it does not immediately regenerate

Validation:

  • node --check .github/scripts/detect-new-endpoints.mjs
  • DRY_RUN=1 node .github/scripts/detect-new-endpoints.mjs

New Dependency Submission

None.

Screenshots

No visual changes.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview May 5, 2026, 5:13 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@thebiglabasky thebiglabasky marked this pull request as ready for review May 5, 2026 17:14
@thebiglabasky thebiglabasky merged commit 88f2275 into main May 5, 2026
3 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.

1 participant