Skip to content

Update Training API documentation#2104

Merged
mdlinville merged 4 commits intomainfrom
update-training-api-15
Feb 2, 2026
Merged

Update Training API documentation#2104
mdlinville merged 4 commits intomainfrom
update-training-api-15

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Feb 2, 2026

This PR updates the Training API documentation based on the latest OpenAPI specification.

Generated on: 2026-02-02 09:47:47 UTC
OpenAPI spec source: https://api.training.wandb.ai/openapi.json

Changes

  • Synced latest OpenAPI specification from the Training API service
  • Updated Training API landing page with current endpoints

Review Checklist

  • Verify new endpoints are correctly listed
  • Check that removed endpoints (if any) are intentional
  • Confirm all Training API links work correctly

This PR was automatically generated by the Training API update workflow.

@github-actions
Copy link
Contributor Author

github-actions bot commented Feb 2, 2026

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (1 total)

📄 Pages (1)

File Preview
training/api-reference.mdx Api Reference

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: c43ebe0 at 2026-02-02 09:51:14 UTC

@github-actions
Copy link
Contributor Author

github-actions bot commented Feb 2, 2026

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-update-training-api-15.mintlify.app

Removes redundant "API Reference" breadcrumb from
the reference pages.
Fixes the issue where health endpoints (health-check and system-check)
appeared under an extra 'API Reference' layer in the breadcrumb navigation.

Root cause: The upstream Training API OpenAPI spec was missing 'tags'
fields on the health endpoints, causing Mintlify to place them in a
default category.

Changes:
- Simplified OpenAPI config in docs.json (removed redundant directory param)
- Synced latest OpenAPI spec from production which includes health tags
- Added patch_spec() safety net in sync_openapi_spec.py
- Documented the issue and resolution in README.md

The upstream fix was already deployed on 2026-01-21 via
coreweave/serverless-training#213, so the production API now correctly
includes tags=['health'] for both /v1/health and /v1/system-check.

This should eliminate the redundant breadcrumb layer and provide proper
navigation hierarchy: Training > API Reference > Health Check
@mdlinville mdlinville marked this pull request as ready for review February 2, 2026 19:39
@mdlinville mdlinville requested a review from a team as a code owner February 2, 2026 19:40
@mdlinville mdlinville force-pushed the update-training-api-15 branch from eeeaf89 to 5b02670 Compare February 2, 2026 19:57
@mdlinville mdlinville merged commit c2388bb into main Feb 2, 2026
4 of 9 checks passed
@mdlinville mdlinville deleted the update-training-api-15 branch February 2, 2026 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated documentation Improvements or additions to documentation training-api

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant