Skip to content

docs: add API reference pages for 5 undocumented endpoints#319

Open
miliberlin wants to merge 1 commit into
mainfrom
michelle/document-missing-api-endpoints
Open

docs: add API reference pages for 5 undocumented endpoints#319
miliberlin wants to merge 1 commit into
mainfrom
michelle/document-missing-api-endpoints

Conversation

@miliberlin
Copy link
Copy Markdown
Member

Summary

An audit of api-reference/openapi.json against the rendered public API reference found 5 spec operations with no documentation page — they were defined in the OpenAPI spec but never surfaced in the docs site.

Method Endpoint Nav group
POST /v1/test-sessions/trigger Test Sessions
GET /v1/test-sessions/{testSessionId} Test Sessions
GET /v1/test-sessions/{testSessionId}/completion Test Sessions
GET /v1/error-groups Error Groups
POST /v1/status-pages/{statusPageId}/subscriptions/bulk Status Page Subscribers

3 of the 4 /v1/test-sessions/* endpoints were missing — only cancel-a-test-session existed.

Changes

  • Added an MDX page for each endpoint, using minimal openapi: frontmatter to match the ~160 existing API reference pages.
  • Wired the new pages into the Test Sessions, Error Groups, and Status Page Subscribers nav groups in docs.json. Test Sessions is now ordered trigger → retrieve → completion → cancel, matching the Check Sessions group.

Verification

  • docs.json is valid JSON.
  • Final audit: 167 spec operations / 167 MDX pages / 0 undocumented, no orphaned pages or broken nav links.

🤖 Generated with Claude Code

Audit of api-reference/openapi.json found 5 spec operations with no
documentation page, so they did not appear in the public API reference:

- POST /v1/test-sessions/trigger
- GET  /v1/test-sessions/{testSessionId}
- GET  /v1/test-sessions/{testSessionId}/completion
- GET  /v1/error-groups
- POST /v1/status-pages/{statusPageId}/subscriptions/bulk

Add an MDX page for each and wire them into the Test Sessions, Error
Groups, and Status Page Subscribers nav groups in docs.json. All 167
spec operations now have a documentation page.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 22, 2026

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

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview May 22, 2026, 2:04 PM

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

@miliberlin
Copy link
Copy Markdown
Member Author

miliberlin commented May 22, 2026

@sorccu @shiini2 @tnolet let me know if there is any reason for withholding these recently added endpoints from our public API docs, otherwise I'll merge this on Monday. We can also add additional information if needed.

@tnolet
Copy link
Copy Markdown
Member

tnolet commented May 22, 2026

@miliberlin No specific reason to not add the GET /error-groups/. It think this was an oversight as this used to all be automated, but now it requires manual work to add them to the docs

@miliberlin
Copy link
Copy Markdown
Member Author

@tnolet thanks for the quick confirmation! There is indeed a workflow that creates a PR but then tags nobody as reviewers nor auto-updates. That needs to be improved. I'm trying to clean up and then will see if I can automate this again.

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