feat(docs): document the batch status data type

[kozlek]

A batch's status.code appeared on the API reference as a bare list of
values with no explanation, and nowhere else in the docs. Readers seeing
a status in an API response, in the CLI, or on a dashboard chip had no
way to find out what it meant.

Add a Batch Status section to the data-types page, rendering a table
generated from the OpenAPI spec so the codes and their descriptions come
from the engine rather than being hand-maintained, and cross-reference it
from the monitoring and batches pages. The table goes through the shared
reader added earlier, so it already handles the shapes a synced schema
can arrive in — a $ref to a hoisted component in particular, which the
engine's enum deduplication produces.

Extend the anchor build gate to scan the API spec alongside the
configuration schema. This is the first data type marked in the API
spec, and schema syncs land as direct pushes to main, so the deploy
build is the only gate they pass through.

The bundled schemas are what the sync bot will deliver once the engine
side merges. They carry the per-value documentation as x-mergify-enum,
a positional array aligned with enum holding a description, an optional
display title and a deprecation flag, and the data-type marker under its
namespaced spelling. x-enum-descriptions is gone: that name is an
established openapi-generator convention for a positional array of
strings, and publishing a map under it would mislead the SDK generators
customers run against our spec.

Part of MRGFY-8330

Co-Authored-By: Claude Opus 5 (1M context) noreply@anthropic.com

[mergify]

Merge Protections

🟢 All 6 merge protections satisfied — ready to merge.

Show 6 satisfied protections

🟢 🤖 Continuous Integration

• all of:
  • check-success = build
  • check-success = lint
  • check-success = test
  • any of:
    • check-success = test-broken-links
    • label = ignore-broken-links
  • any of:
    • check-success=Cloudflare Pages
    • -head-repo-full-name~=^Mergifyio/

🟢 👀 Review Requirements

• any of:
  • #approved-reviews-by >= 2
  • author = dependabot[bot]
  • all of:
    • author = mergify-ci-bot
    • -head ~= ^docs-agent/

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

• title ~= ^(fix|feat|internal|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?!?:

🟢 🔎 Reviews

• #changes-requested-reviews-by = 0
• #review-requested = 0
• #review-threads-unresolved = 0

🟢 📕 PR description

• body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

[Copilot]

Pull request overview

Documents the merge queue batch status.code data type and ensures the docs build/CI gate catches future schema-driven anchor drift by validating both the configuration schema and the OpenAPI schema.

Changes:

• Adds a new Batch Status section to /configuration/data-types, rendering status codes/descriptions from the synced OpenAPI schema.
• Cross-references the new data type from merge queue monitoring and batch resolution docs.
• Extends the anchor validation gate (and its tests) to scan public/api-schemas.json in addition to the configuration schema.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/util/dataType.test.ts	Adds API schema coverage to the data-type anchor test suite and pins the new batch-status anchor.
src/content/docs/merge-queue/monitoring.mdx	Links readers to the Batch Status reference from the monitoring page.
src/content/docs/merge-queue/batches.mdx	References batch status codes during batch failure resolution/splitting explanation.
src/content/docs/configuration/data-types.mdx	Adds the Batch Status section and renders the new table component.
src/components/Tables/BatchStatusCodes.tsx	New table component that reads status enums + descriptions from the OpenAPI schema.
public/api-schemas.json	Updates BatchStatus schema metadata to include x-enum-descriptions and the x-has-data-type marker.
integrations/validate-data-type-anchors.ts	Extends the build-time anchor validation to check both synced schemas.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[kozlek]

Revision history

#	Type	Changes	Reason	Date
1	initial	e2af176		2026-07-30 13:20 UTC
2	content	e2af176 → 5e644c7		2026-07-30 13:20 UTC
3	content	5e644c7 → dc555d0		2026-08-03 19:22 UTC
4	content	dc555d0 → fad7e3e		2026-08-04 07:58 UTC
5	content	fad7e3e → c73d075		2026-08-04 17:09 UTC
6	rebase	c73d075 → 4c75840 (rebase only)		2026-08-05 13:05 UTC
7	content	4c75840 → f86e05f (raw)		2026-08-05 13:52 UTC
8	rebase	f86e05f → 62175a1 (rebase only)		2026-08-05 14:00 UTC
9	rebase	62175a1 → 1d8527e (rebase only)		2026-08-06 07:53 UTC
10	rebase	1d8527e → 088bcce (rebase only)		2026-08-06 09:53 UTC

[kozlek]

This pull request is part of a Mergify stack:

#	Pull Request	Link
1	refactor(docs): read documented enum values through one shared reader	#12293
2	fix(docs): sanitize the HTML the schema-driven tables inject	#12304
3	feat(docs): switch to the namespaced documented-data-type marker	#12319
4	feat(docs): document the batch status data type	#12263	👈

Pull request has been modified.

[mergify]

A predecessor in this stack was just merged, but I couldn't auto-rebase this PR: there's a conflict that needs manual resolution.

Conflict in: src/util/enumChoices.ts (replayed onto 377f628a).

Resolve with mergify stack sync && mergify stack push.

[mergify]

A predecessor in this stack was just merged, but I couldn't auto-rebase this PR: there's a conflict that needs manual resolution.

Conflict in: src/util/enumChoices.ts (replayed onto e6f51144).

Resolve by rebasing this branch onto the latest base and pushing.

[mergify]

@kozlek this pull request is now in conflict 😩

[mergify]

Merge Queue Status

• ✅ Entered queue — 2026-08-06 14:03 UTC · Rule: default · triggered by merge protections
• ✅ Checks passed · on draft merge queue: checking main (e6f5114) and #12263 together #12333
• ✅ Merged — 2026-08-06 14:06 UTC · at 088bccec1d8e8c76fd08e1bcff315c03099bc115 · squash

This pull request spent 2 minutes 51 seconds in the queue, including 2 minutes 20 seconds running CI.

Required conditions to merge

• github-review-approved [🛡 GitHub repository ruleset rule Require pull request for default branch]
  • feat(docs): document the batch status data type #12263
• schedule=Mon-Fri 09:00-17:30[Europe/Paris]
• all of [🛡 Merge Protections rule Enforce conventional commit]:
  • title ~= ^(fix|feat|internal|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?!?:
    • feat(docs): document the batch status data type #12263
• all of [🛡 Merge Protections rule 👀 Review Requirements]:
  • any of:
    • #approved-reviews-by >= 2
      • feat(docs): document the batch status data type #12263
    • author = dependabot[bot]
      • feat(docs): document the batch status data type #12263
    • all of:
      • author = mergify-ci-bot
        • feat(docs): document the batch status data type #12263
      • -head ~= ^docs-agent/
        • feat(docs): document the batch status data type #12263
• all of [🛡 Merge Protections rule 📕 PR description]:
  • body ~= (?ms:.{48,})
    • feat(docs): document the batch status data type #12263
• all of [🛡 Merge Protections rule 🔎 Reviews]:
  • #changes-requested-reviews-by = 0
    • feat(docs): document the batch status data type #12263
  • #review-requested = 0
    • feat(docs): document the batch status data type #12263
  • #review-threads-unresolved = 0
    • feat(docs): document the batch status data type #12263
• all of [🛡 Merge Protections rule 🤖 Continuous Integration]:
  • all of:
    • check-success = build
    • check-success = lint
    • check-success = test
    • any of:
      • check-success = test-broken-links
      • label = ignore-broken-links
        • feat(docs): document the batch status data type #12263
    • any of:
      • check-success=Cloudflare Pages
      • -head-repo-full-name~=^Mergifyio/
        • feat(docs): document the batch status data type #12263