docs: add API reference pages for 5 undocumented endpoints#319
Open
miliberlin wants to merge 1 commit into
Open
docs: add API reference pages for 5 undocumented endpoints#319miliberlin wants to merge 1 commit into
miliberlin wants to merge 1 commit into
Conversation
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]>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Member
Author
This was referenced May 22, 2026
Member
|
@miliberlin No specific reason to not add the |
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
An audit of
api-reference/openapi.jsonagainst 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.POST/v1/test-sessions/triggerGET/v1/test-sessions/{testSessionId}GET/v1/test-sessions/{testSessionId}/completionGET/v1/error-groupsPOST/v1/status-pages/{statusPageId}/subscriptions/bulk3 of the 4
/v1/test-sessions/*endpoints were missing — onlycancel-a-test-sessionexisted.Changes
openapi:frontmatter to match the ~160 existing API reference pages.docs.json. Test Sessions is now orderedtrigger → retrieve → completion → cancel, matching the Check Sessions group.Verification
docs.jsonis valid JSON.🤖 Generated with Claude Code