docs(api): refresh the v2 OpenAPI spec - #337
Merged
Merged
Conversation
The published copy was last synced at trunk2 2e4017940, so it predates five spec changes. The one that prompted this is trunk-io/trunk2#6021, which reshapes what the test-case endpoints report: `Label` drops `color`/`createdAt` for `assignedAt` plus a `sources` array carrying label provenance, `ActiveMonitor` gains `activeSince`, and `TestCaseSummary` gains `statusSince`. The rest rides along because the file is a verbatim copy of the generated spec: a `403 INSUFFICIENT_PERMISSIONS` response on the list endpoints, the `paths-filter` signal type, and a `generate-buildkite-plan` path. None of those reach the site — docs.json enumerates the seven flaky-tests operations it publishes, and the spec's merge-queue and Dynamic CI paths are not among them. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
TylerJang27
approved these changes
Sep 16, 2026
Contributor
|
Docs PR opened: #341 Added a changelog post covering the v2 Test Cases API response updates, including label provenance changes and new monitor timestamps. |
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
2 participants
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.
Re-syncs
openapi-v2.jsonwith the generated spec in trunk2 (ts/apps/public-api/openapi-v2.json). The published copy was a verbatim copy last taken at trunk22e4017940, so it predated five spec-touching commits.What prompted it
trunk-io/trunk2#6021 reshapes what the test-case endpoints report:
Label—colorandcreatedAtare gone;assignedAtand asources[]array (label provenance, folded one entry per label rather than one per assignment) take their place. This is a breaking change to a published response.ActiveMonitor— gains requiredactiveSince.TestCaseSummary— gains requiredstatusSince(nullable), how long a test has been in its current status.What rides along
The file is a verbatim copy, so the four intervening commits come with it:
403 INSUFFICIENT_PERMISSIONSresponse onGET /v2/test-casesandGET /v2/test-collections(and on the unpublished/v2/merge-queues,/v2/repositories)paths-filteradded toSignalType/v2/dynamic-ci/generate-buildkite-planpathNone of the merge-queue or Dynamic CI additions reach the site:
docs.jsonenumerates the seven flaky-tests operations it publishes, and those paths are not among them — same as before this change.Not changed
No nav change (no new flaky-tests endpoints) and no prose change. The pages that mention label colors describe the Settings → Test Labels UI, where colors still exist; only the API response dropped the field.
🤖 Generated with Claude Code