Skip to content

docs(flaky-tests): rename the v2 test-cases reference to tests - #389

Merged
acatxnamedvirtue merged 2 commits into
mainfrom
tylerbeebe/flaky-tests-v2-tests-rename
Oct 5, 2026
Merged

acatxnamedvirtue merged 2 commits into
mainfrom
tylerbeebe/flaky-tests-v2-tests-rename

Conversation

@acatxnamedvirtue

Copy link
Copy Markdown
Contributor

Don't merge until trunk-io/trunk2#6695 is deployed to production. This group sits in the public Tests tab, so merging first would document /v2/tests endpoints the API doesn't serve yet. Before marking this ready, re-copy openapi-v2.json from trunk2 main once #6695 has merged. The copy here comes from that PR's branch.

The docs side of trunk-io/trunk2#6695, which renames the Flaky Tests v2 API from "test cases" to "tests": /v2/test-cases → /v2/tests, testCaseId → testId, TestCase → Test, repoId → repositoryId, testCaseCount → testCount.

Changes

  • openapi-v2.json: resynced from trunk2. The diff is large because docs2's copy was already behind trunk2 main (it had none of the newer CI schemas, for example). Only pages listed in docs.json render, so that adds no new pages.
  • docs.json: the Flaky Tests "API reference (v2)" group now lists the five /v2/tests… operations instead of /v2/test-cases….
  • flaky-tests/reference/api-reference.mdx:
    • The cards link to the regenerated pages. Mintlify builds those URLs from the tag and each summary, both of which changed, so …/v2/testcases/get-a-test-case is now …/v2/tests/get-a-test, and so on. The comparison table and the intro text use the new names.
    • Ticket linking: the page had no card for POST /v2/tests/{testId}/ticket, even though it was already in the nav, and its table said the collection API had "no equivalent yet". It now has the card, and the table names the endpoint.

Not changed

  • flaky-tests/reference/mcp-reference/fix-flaky-test.mdx documents the MCP tool's own testCaseId parameter, which the rename didn't touch.
  • changelog/2025-04-25-linear-integration.mdx mentions test-cases only in a dashboard link anchor.

Checks

  • All 38 v2 pages in docs.json, merge queue included, exist in the new spec.
  • Every v2 deep link in the .mdx files matches a page the new spec generates.
  • docs.json is valid JSON.
  • Not yet looked at in the preview deployment.

🤖 Generated with Claude Code

acatxnamedvirtue and others added 2 commits October 5, 2026 18:03
Resyncs openapi-v2.json for trunk-io/trunk2#6695, which renames the Flaky
Tests v2 surface: /v2/test-cases → /v2/tests, testCaseId → testId,
TestCase → Test, repoId → repositoryId, testCaseCount → testCount.

- docs.json: the "API reference (v2)" group lists the /v2/tests paths.
- api-reference.mdx: the cards link to the regenerated tests/... pages,
  and the comparison table uses the new endpoint names.

The resync also brings in spec changes already on trunk2 main since the
last sync. Every v2 page and deep link still resolves against it.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
POST /v2/tests/{testId}/ticket was already in the v2 nav, but the Flaky
Tests API page had no card for it and its comparison table said the
collection API had no way to link a ticket.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
trunk 🟢 Ready View Preview Oct 5, 2026, 6:06 PM

@acatxnamedvirtue
acatxnamedvirtue marked this pull request as ready for review October 5, 2026 20:06
@acatxnamedvirtue
acatxnamedvirtue merged commit ded53ea into main Oct 5, 2026
3 checks passed
@mintlify

mintlify Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Docs PR opened: #393

Added an October 5 changelog post covering the Flaky Tests v2 API rename from "test cases" to "tests".

This branch was successfully deployed

1 active deployment
staging — 607705fd Deployed Oct 5, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant