docs(api): publish the current v1 public API spec - #331
Merged
Merged
Conversation
Replace openapi.json with the current export of the v1 public API. Two endpoints are new — /getSubmittedPullRequests (the batch form of getSubmittedPullRequest) and /listMergeQueueTestingResults (completed testing over a time range) — and ten existing endpoints pick up new fields and sharper descriptions, notably getSubmittedPullRequest's optional `timeline`, /listPullRequests' `until` bound, and several new queue settings on get/updateQueue. Add both new endpoints to the Merge Queue API navigation and to the summary table and endpoint cards on the API reference landing page. The export carries forward the docs-side edits made to the previous spec (the labelled pr number/branch oneOf, the branch-resolution prose), so nothing hand-written here is lost. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
The endpoint has shipped since March and was announced in the changelog, but it had no reference page — it was in the spec and missing from the navigation. Add it, and explain on the landing page how it differs from the two getSubmittedPullRequest endpoints: those look up pull requests you can already name, this one is how you find out which pull requests are there. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The entry landed with `date: "2026-08-26T00:00:00.000Z"`, which `date.fromisoformat` cannot parse, so the changelog nav check has been failing on main since #315 and the sync job has never run on this entry. Every other entry uses a plain `YYYY-MM-DD`. Its title also disagreed with the two index pages: the frontmatter read "Browser Extension 1.0.0 : Out of beta", with a stray space before the colon, while #315 hand-wrote the tidier "Browser Extension 1.0: Out of beta" into both. Fix the frontmatter rather than regenerate the typo into the indexes — the generated pages then need no change at all. Unrelated to the API spec in this PR; it surfaced here because the check also runs on docs.json. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Docs PR opened: #332 Added a changelog entry announcing new Merge Queue API endpoints, a newly documented list endpoint, and expanded fields on existing endpoints. |
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
1 participant
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.
Replaces
openapi.jsonwith the current export of the v1 public API and wires the new endpoints into the docs.New endpoints
POST /getSubmittedPullRequestsgetSubmittedPullRequest; unsubmitted PRs come back innotFoundrather than failing the requestPOST /listMergeQueueTestingResultstestRunIdinto/getMergeQueueTestingDetailsAlso newly published:
/listPullRequestsNot new to the API — it shipped in March, was announced in the changelog, and has been in
openapi.jsonthe whole time. It just was never added to the navigation, so it had no reference page. It has one now.The landing page also gains a short note on choosing between the three read endpoints, since
/listPullRequestsand/getSubmittedPullRequestsare easy to confuse: thegetSubmittedPullRequest(s)pair looks up pull requests you can already name and returns the full record for each, while/listPullRequestsis the discovery endpoint — cursor-paginated, filtered by state or concluded time range, returning a summary row per PR.All three endpoints are added to the Merge Queue API navigation in
docs.jsonand to the summary table and endpoint cards onmerge-queue/reference/merge.mdx.Updated endpoints
Ten existing endpoints pick up fields and sharper descriptions. The notable ones:
getSubmittedPullRequest— optionalincludeTimeline, returning every state change with its cause (cancellation reasons, branch-protection block reasons, conflict culprit, failing checks)listPullRequests— theuntilbound on the concluded-time rangegetQueue/updateQueue—allowedBotSubmitters,stateLabelsEnabled,testBranchConstructionMode,notReadyTimeoutHours;pendingFailureDepthandtestingTimeoutMinutesnow accept0to disablegetMergeQueueTestingDetails— thePENDING/WAITING/REQUESTEDdeployment-gate check statesbazel_labelon test casesNo endpoints or schemas were removed, and the export carries forward the docs-side edits made to the previous spec (the labelled
prnumber/branchoneOfand its branch-resolution prose), so nothing hand-written is lost.Verification
mint validate— build validation passedmint broken-links— no broken links (confirmed the checker does resolve OpenAPI-generated slugs, by watching it fail on a deliberately bad one)🤖 Generated with Claude Code